GNU Linux-libre 4.19.264-gnu1
[releases.git] / drivers / net / ethernet / mellanox / mlxfw / mlxfw_mfa2_tlv.h
1 /*
2  * drivers/net/ethernet/mellanox/mlxfw/mlxfw_mfa2_tlv.h
3  * Copyright (c) 2017 Mellanox Technologies. All rights reserved.
4  * Copyright (c) 2017 Yotam Gigi <yotamg@mellanox.com>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. Neither the names of the copyright holders nor the names of its
15  *    contributors may be used to endorse or promote products derived from
16  *    this software without specific prior written permission.
17  *
18  * Alternatively, this software may be distributed under the terms of the
19  * GNU General Public License ("GPL") version 2 as published by the Free
20  * Software Foundation.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34
35 #ifndef _MLXFW_MFA2_TLV_H
36 #define _MLXFW_MFA2_TLV_H
37
38 #include <linux/kernel.h>
39 #include "mlxfw_mfa2_file.h"
40
41 struct mlxfw_mfa2_tlv {
42         u8 version;
43         u8 type;
44         __be16 len;
45         u8 data[0];
46 } __packed;
47
48 static inline const struct mlxfw_mfa2_tlv *
49 mlxfw_mfa2_tlv_get(const struct mlxfw_mfa2_file *mfa2_file, const void *ptr)
50 {
51         if (!mlxfw_mfa2_valid_ptr(mfa2_file, ptr) ||
52             !mlxfw_mfa2_valid_ptr(mfa2_file, ptr + sizeof(struct mlxfw_mfa2_tlv)))
53                 return NULL;
54         return ptr;
55 }
56
57 static inline const void *
58 mlxfw_mfa2_tlv_payload_get(const struct mlxfw_mfa2_file *mfa2_file,
59                            const struct mlxfw_mfa2_tlv *tlv, u8 payload_type,
60                            size_t payload_size, bool varsize)
61 {
62         void *tlv_top;
63
64         tlv_top = (void *) tlv + be16_to_cpu(tlv->len) - 1;
65         if (!mlxfw_mfa2_valid_ptr(mfa2_file, tlv) ||
66             !mlxfw_mfa2_valid_ptr(mfa2_file, tlv_top))
67                 return NULL;
68         if (tlv->type != payload_type)
69                 return NULL;
70         if (varsize && (be16_to_cpu(tlv->len) < payload_size))
71                 return NULL;
72         if (!varsize && (be16_to_cpu(tlv->len) != payload_size))
73                 return NULL;
74
75         return tlv->data;
76 }
77
78 #define MLXFW_MFA2_TLV(name, payload_type, tlv_type)                           \
79 static inline const payload_type *                                             \
80 mlxfw_mfa2_tlv_ ## name ## _get(const struct mlxfw_mfa2_file *mfa2_file,       \
81                                 const struct mlxfw_mfa2_tlv *tlv)              \
82 {                                                                              \
83         return mlxfw_mfa2_tlv_payload_get(mfa2_file, tlv,                      \
84                                           tlv_type, sizeof(payload_type),      \
85                                           false);                              \
86 }
87
88 #define MLXFW_MFA2_TLV_VARSIZE(name, payload_type, tlv_type)                   \
89 static inline const payload_type *                                             \
90 mlxfw_mfa2_tlv_ ## name ## _get(const struct mlxfw_mfa2_file *mfa2_file,       \
91                                 const struct mlxfw_mfa2_tlv *tlv)              \
92 {                                                                              \
93         return mlxfw_mfa2_tlv_payload_get(mfa2_file, tlv,                      \
94                                           tlv_type, sizeof(payload_type),      \
95                                           true);                               \
96 }
97
98 #endif