xref: /freebsd/sys/dev/mlxfw/mlxfw_mfa2_tlv_multi.h (revision 18054d0220cfc8df9c9568c437bd6fbb59d53c3c)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2017-2019 Mellanox Technologies.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of Mellanox nor the names of contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  * $FreeBSD$
32  */
33 
34 #ifndef _MLXFW_MFA2_TLV_MULTI_H
35 #define _MLXFW_MFA2_TLV_MULTI_H
36 
37 #include "mlxfw_mfa2_tlv.h"
38 #include "mlxfw_mfa2_format.h"
39 #include "mlxfw_mfa2_file.h"
40 
41 const struct mlxfw_mfa2_tlv *
42 mlxfw_mfa2_tlv_multi_child(const struct mlxfw_mfa2_file *mfa2_file,
43 			   const struct mlxfw_mfa2_tlv_multi *multi);
44 
45 const struct mlxfw_mfa2_tlv *
46 mlxfw_mfa2_tlv_next(const struct mlxfw_mfa2_file *mfa2_file,
47 		    const struct mlxfw_mfa2_tlv *tlv);
48 
49 const struct mlxfw_mfa2_tlv *
50 mlxfw_mfa2_tlv_advance(const struct mlxfw_mfa2_file *mfa2_file,
51 		       const struct mlxfw_mfa2_tlv *from_tlv, u16 count);
52 
53 const struct mlxfw_mfa2_tlv *
54 mlxfw_mfa2_tlv_multi_child_find(const struct mlxfw_mfa2_file *mfa2_file,
55 				const struct mlxfw_mfa2_tlv_multi *multi,
56 				enum mlxfw_mfa2_tlv_type type, u16 index);
57 
58 int mlxfw_mfa2_tlv_multi_child_count(const struct mlxfw_mfa2_file *mfa2_file,
59 				     const struct mlxfw_mfa2_tlv_multi *multi,
60 				     enum mlxfw_mfa2_tlv_type type,
61 				     u16 *p_count);
62 
63 #define mlxfw_mfa2_tlv_foreach(mfa2_file, tlv, idx, from_tlv, count) \
64 	for (idx = 0, tlv = from_tlv; idx < (count); \
65 	     idx++, tlv = mlxfw_mfa2_tlv_next(mfa2_file, tlv))
66 
67 #define mlxfw_mfa2_tlv_multi_foreach(mfa2_file, tlv, idx, multi) \
68 	mlxfw_mfa2_tlv_foreach(mfa2_file, tlv, idx, \
69 			       mlxfw_mfa2_tlv_multi_child(mfa2_file, multi), \
70 			       be16_to_cpu(multi->num_extensions) + 1)
71 #endif
72