xref: /freebsd/sys/dev/mlxfw/mlxfw_mfa2_tlv_multi.h (revision a64729f5077d77e13b9497cb33ecb3c82e606ee8)
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 
32 #ifndef _MLXFW_MFA2_TLV_MULTI_H
33 #define _MLXFW_MFA2_TLV_MULTI_H
34 
35 #include "mlxfw_mfa2_tlv.h"
36 #include "mlxfw_mfa2_format.h"
37 #include "mlxfw_mfa2_file.h"
38 
39 const struct mlxfw_mfa2_tlv *
40 mlxfw_mfa2_tlv_multi_child(const struct mlxfw_mfa2_file *mfa2_file,
41 			   const struct mlxfw_mfa2_tlv_multi *multi);
42 
43 const struct mlxfw_mfa2_tlv *
44 mlxfw_mfa2_tlv_next(const struct mlxfw_mfa2_file *mfa2_file,
45 		    const struct mlxfw_mfa2_tlv *tlv);
46 
47 const struct mlxfw_mfa2_tlv *
48 mlxfw_mfa2_tlv_advance(const struct mlxfw_mfa2_file *mfa2_file,
49 		       const struct mlxfw_mfa2_tlv *from_tlv, u16 count);
50 
51 const struct mlxfw_mfa2_tlv *
52 mlxfw_mfa2_tlv_multi_child_find(const struct mlxfw_mfa2_file *mfa2_file,
53 				const struct mlxfw_mfa2_tlv_multi *multi,
54 				enum mlxfw_mfa2_tlv_type type, u16 index);
55 
56 int mlxfw_mfa2_tlv_multi_child_count(const struct mlxfw_mfa2_file *mfa2_file,
57 				     const struct mlxfw_mfa2_tlv_multi *multi,
58 				     enum mlxfw_mfa2_tlv_type type,
59 				     u16 *p_count);
60 
61 #define mlxfw_mfa2_tlv_foreach(mfa2_file, tlv, idx, from_tlv, count) \
62 	for (idx = 0, tlv = from_tlv; idx < (count); \
63 	     idx++, tlv = mlxfw_mfa2_tlv_next(mfa2_file, tlv))
64 
65 #define mlxfw_mfa2_tlv_multi_foreach(mfa2_file, tlv, idx, multi) \
66 	mlxfw_mfa2_tlv_foreach(mfa2_file, tlv, idx, \
67 			       mlxfw_mfa2_tlv_multi_child(mfa2_file, multi), \
68 			       be16_to_cpu(multi->num_extensions) + 1)
69 #endif
70