xref: /freebsd/sys/dev/mlxfw/mlxfw_mfa2_tlv.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
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_H
33 #define _MLXFW_MFA2_TLV_H
34 
35 #include <linux/kernel.h>
36 #include "mlxfw_mfa2_file.h"
37 
38 struct mlxfw_mfa2_tlv {
39 	u8 version;
40 	u8 type;
41 	__be16 len;
42 	u8 data[0];
43 } __packed;
44 
45 static inline const struct mlxfw_mfa2_tlv *
mlxfw_mfa2_tlv_get(const struct mlxfw_mfa2_file * mfa2_file,const u8 * ptr)46 mlxfw_mfa2_tlv_get(const struct mlxfw_mfa2_file *mfa2_file, const u8 *ptr)
47 {
48 	if (!mlxfw_mfa2_valid_ptr(mfa2_file, ptr) ||
49 	    !mlxfw_mfa2_valid_ptr(mfa2_file, ptr + sizeof(struct mlxfw_mfa2_tlv)))
50 		return NULL;
51 	return (const struct mlxfw_mfa2_tlv *) ptr;
52 }
53 
54 static inline const void *
mlxfw_mfa2_tlv_payload_get(const struct mlxfw_mfa2_file * mfa2_file,const struct mlxfw_mfa2_tlv * tlv,u8 payload_type,size_t payload_size,bool varsize)55 mlxfw_mfa2_tlv_payload_get(const struct mlxfw_mfa2_file *mfa2_file,
56 			   const struct mlxfw_mfa2_tlv *tlv, u8 payload_type,
57 			   size_t payload_size, bool varsize)
58 {
59 	const u8 *tlv_top;
60 
61 	tlv_top = (const u8 *) tlv + be16_to_cpu(tlv->len) - 1;
62 	if (!mlxfw_mfa2_valid_ptr(mfa2_file, (const u8 *) tlv) ||
63 	    !mlxfw_mfa2_valid_ptr(mfa2_file, tlv_top))
64 		return NULL;
65 	if (tlv->type != payload_type)
66 		return NULL;
67 	if (varsize && (be16_to_cpu(tlv->len) < payload_size))
68 		return NULL;
69 	if (!varsize && (be16_to_cpu(tlv->len) != payload_size))
70 		return NULL;
71 
72 	return tlv->data;
73 }
74 
75 #define MLXFW_MFA2_TLV(name, payload_type, tlv_type)			       \
76 static inline const payload_type *					       \
77 mlxfw_mfa2_tlv_ ## name ## _get(const struct mlxfw_mfa2_file *mfa2_file,       \
78 				const struct mlxfw_mfa2_tlv *tlv)	       \
79 {									       \
80 	return mlxfw_mfa2_tlv_payload_get(mfa2_file, tlv,		       \
81 					  tlv_type, sizeof(payload_type),      \
82 					  false);			       \
83 }
84 
85 #define MLXFW_MFA2_TLV_VARSIZE(name, payload_type, tlv_type)		       \
86 static inline const payload_type *					       \
87 mlxfw_mfa2_tlv_ ## name ## _get(const struct mlxfw_mfa2_file *mfa2_file,       \
88 				const struct mlxfw_mfa2_tlv *tlv)	       \
89 {									       \
90 	return mlxfw_mfa2_tlv_payload_get(mfa2_file, tlv,		       \
91 					  tlv_type, sizeof(payload_type),      \
92 					  true);			       \
93 }
94 
95 #endif
96