sys/dev/mlxfw/mlxfw_mfa2_tlv.h

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