xref: /freebsd/sys/dev/mlxfw/mlxfw_mfa2_format.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1*3b2324c3SHans Petter Selasky /*-
2*3b2324c3SHans Petter Selasky  * SPDX-License-Identifier: BSD-3-Clause
3*3b2324c3SHans Petter Selasky  *
4*3b2324c3SHans Petter Selasky  * Copyright (c) 2017-2019 Mellanox Technologies.
5*3b2324c3SHans Petter Selasky  * All rights reserved.
6*3b2324c3SHans Petter Selasky  *
7*3b2324c3SHans Petter Selasky  * Redistribution and use in source and binary forms, with or without
8*3b2324c3SHans Petter Selasky  * modification, are permitted provided that the following conditions
9*3b2324c3SHans Petter Selasky  * are met:
10*3b2324c3SHans Petter Selasky  * 1. Redistributions of source code must retain the above copyright
11*3b2324c3SHans Petter Selasky  *    notice, this list of conditions and the following disclaimer.
12*3b2324c3SHans Petter Selasky  * 2. Redistributions in binary form must reproduce the above copyright
13*3b2324c3SHans Petter Selasky  *    notice, this list of conditions and the following disclaimer in the
14*3b2324c3SHans Petter Selasky  *    documentation and/or other materials provided with the distribution.
15*3b2324c3SHans Petter Selasky  * 3. Neither the name of Mellanox nor the names of contributors
16*3b2324c3SHans Petter Selasky  *    may be used to endorse or promote products derived from this software
17*3b2324c3SHans Petter Selasky  *    without specific prior written permission.
18*3b2324c3SHans Petter Selasky  *
19*3b2324c3SHans Petter Selasky  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20*3b2324c3SHans Petter Selasky  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21*3b2324c3SHans Petter Selasky  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22*3b2324c3SHans Petter Selasky  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23*3b2324c3SHans Petter Selasky  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24*3b2324c3SHans Petter Selasky  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25*3b2324c3SHans Petter Selasky  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26*3b2324c3SHans Petter Selasky  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27*3b2324c3SHans Petter Selasky  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28*3b2324c3SHans Petter Selasky  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29*3b2324c3SHans Petter Selasky  * SUCH DAMAGE.
30*3b2324c3SHans Petter Selasky  */
31*3b2324c3SHans Petter Selasky 
32*3b2324c3SHans Petter Selasky #ifndef _MLXFW_MFA2_FORMAT_H
33*3b2324c3SHans Petter Selasky #define _MLXFW_MFA2_FORMAT_H
34*3b2324c3SHans Petter Selasky 
35*3b2324c3SHans Petter Selasky #include "mlxfw_mfa2_file.h"
36*3b2324c3SHans Petter Selasky #include "mlxfw_mfa2_tlv.h"
37*3b2324c3SHans Petter Selasky 
38*3b2324c3SHans Petter Selasky enum mlxfw_mfa2_tlv_type {
39*3b2324c3SHans Petter Selasky 	MLXFW_MFA2_TLV_MULTI_PART = 0x01,
40*3b2324c3SHans Petter Selasky 	MLXFW_MFA2_TLV_PACKAGE_DESCRIPTOR = 0x02,
41*3b2324c3SHans Petter Selasky 	MLXFW_MFA2_TLV_COMPONENT_DESCRIPTOR = 0x04,
42*3b2324c3SHans Petter Selasky 	MLXFW_MFA2_TLV_COMPONENT_PTR = 0x22,
43*3b2324c3SHans Petter Selasky 	MLXFW_MFA2_TLV_PSID = 0x2A,
44*3b2324c3SHans Petter Selasky };
45*3b2324c3SHans Petter Selasky 
46*3b2324c3SHans Petter Selasky enum mlxfw_mfa2_compression_type {
47*3b2324c3SHans Petter Selasky 	MLXFW_MFA2_COMPRESSION_TYPE_NONE,
48*3b2324c3SHans Petter Selasky 	MLXFW_MFA2_COMPRESSION_TYPE_XZ,
49*3b2324c3SHans Petter Selasky };
50*3b2324c3SHans Petter Selasky 
51*3b2324c3SHans Petter Selasky struct mlxfw_mfa2_tlv_package_descriptor {
52*3b2324c3SHans Petter Selasky 	__be16 num_components;
53*3b2324c3SHans Petter Selasky 	__be16 num_devices;
54*3b2324c3SHans Petter Selasky 	__be32 cb_offset;
55*3b2324c3SHans Petter Selasky 	__be32 cb_archive_size;
56*3b2324c3SHans Petter Selasky 	__be32 cb_size_h;
57*3b2324c3SHans Petter Selasky 	__be32 cb_size_l;
58*3b2324c3SHans Petter Selasky 	u8 padding[3];
59*3b2324c3SHans Petter Selasky 	u8 cv_compression;
60*3b2324c3SHans Petter Selasky 	__be32 user_data_offset;
61*3b2324c3SHans Petter Selasky } __packed;
62*3b2324c3SHans Petter Selasky 
63*3b2324c3SHans Petter Selasky MLXFW_MFA2_TLV(package_descriptor, struct mlxfw_mfa2_tlv_package_descriptor,
64*3b2324c3SHans Petter Selasky 	       MLXFW_MFA2_TLV_PACKAGE_DESCRIPTOR);
65*3b2324c3SHans Petter Selasky 
66*3b2324c3SHans Petter Selasky struct mlxfw_mfa2_tlv_multi {
67*3b2324c3SHans Petter Selasky 	__be16 num_extensions;
68*3b2324c3SHans Petter Selasky 	__be16 total_len;
69*3b2324c3SHans Petter Selasky } __packed;
70*3b2324c3SHans Petter Selasky 
71*3b2324c3SHans Petter Selasky MLXFW_MFA2_TLV(multi, struct mlxfw_mfa2_tlv_multi,
72*3b2324c3SHans Petter Selasky 	       MLXFW_MFA2_TLV_MULTI_PART);
73*3b2324c3SHans Petter Selasky 
74*3b2324c3SHans Petter Selasky struct mlxfw_mfa2_tlv_psid {
75*3b2324c3SHans Petter Selasky 	u8 psid[0];
76*3b2324c3SHans Petter Selasky } __packed;
77*3b2324c3SHans Petter Selasky 
78*3b2324c3SHans Petter Selasky MLXFW_MFA2_TLV_VARSIZE(psid, struct mlxfw_mfa2_tlv_psid,
79*3b2324c3SHans Petter Selasky 		       MLXFW_MFA2_TLV_PSID);
80*3b2324c3SHans Petter Selasky 
81*3b2324c3SHans Petter Selasky struct mlxfw_mfa2_tlv_component_ptr {
82*3b2324c3SHans Petter Selasky 	__be16 storage_id;
83*3b2324c3SHans Petter Selasky 	__be16 component_index;
84*3b2324c3SHans Petter Selasky 	__be32 storage_address;
85*3b2324c3SHans Petter Selasky } __packed;
86*3b2324c3SHans Petter Selasky 
87*3b2324c3SHans Petter Selasky MLXFW_MFA2_TLV(component_ptr, struct mlxfw_mfa2_tlv_component_ptr,
88*3b2324c3SHans Petter Selasky 	       MLXFW_MFA2_TLV_COMPONENT_PTR);
89*3b2324c3SHans Petter Selasky 
90*3b2324c3SHans Petter Selasky struct mlxfw_mfa2_tlv_component_descriptor {
91*3b2324c3SHans Petter Selasky 	__be16 pldm_classification;
92*3b2324c3SHans Petter Selasky 	__be16 identifier;
93*3b2324c3SHans Petter Selasky 	__be32 cb_offset_h;
94*3b2324c3SHans Petter Selasky 	__be32 cb_offset_l;
95*3b2324c3SHans Petter Selasky 	__be32 size;
96*3b2324c3SHans Petter Selasky } __packed;
97*3b2324c3SHans Petter Selasky 
98*3b2324c3SHans Petter Selasky MLXFW_MFA2_TLV(component_descriptor, struct mlxfw_mfa2_tlv_component_descriptor,
99*3b2324c3SHans Petter Selasky 	       MLXFW_MFA2_TLV_COMPONENT_DESCRIPTOR);
100*3b2324c3SHans Petter Selasky 
101*3b2324c3SHans Petter Selasky #endif
102