1 /*
2  * drivers/net/ethernet/mellanox/mlxfw/mlxfw_mfa2_format.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 #ifndef _MLXFW_MFA2_FORMAT_H
35 #define _MLXFW_MFA2_FORMAT_H
36 
37 #include "mlxfw_mfa2_file.h"
38 #include "mlxfw_mfa2_tlv.h"
39 
40 enum mlxfw_mfa2_tlv_type {
41 	MLXFW_MFA2_TLV_MULTI_PART = 0x01,
42 	MLXFW_MFA2_TLV_PACKAGE_DESCRIPTOR = 0x02,
43 	MLXFW_MFA2_TLV_COMPONENT_DESCRIPTOR = 0x04,
44 	MLXFW_MFA2_TLV_COMPONENT_PTR = 0x22,
45 	MLXFW_MFA2_TLV_PSID = 0x2A,
46 };
47 
48 enum mlxfw_mfa2_compression_type {
49 	MLXFW_MFA2_COMPRESSION_TYPE_NONE,
50 	MLXFW_MFA2_COMPRESSION_TYPE_XZ,
51 };
52 
53 struct mlxfw_mfa2_tlv_package_descriptor {
54 	__be16 num_components;
55 	__be16 num_devices;
56 	__be32 cb_offset;
57 	__be32 cb_archive_size;
58 	__be32 cb_size_h;
59 	__be32 cb_size_l;
60 	u8 padding[3];
61 	u8 cv_compression;
62 	__be32 user_data_offset;
63 } __packed;
64 
65 MLXFW_MFA2_TLV(package_descriptor, struct mlxfw_mfa2_tlv_package_descriptor,
66 	       MLXFW_MFA2_TLV_PACKAGE_DESCRIPTOR);
67 
68 struct mlxfw_mfa2_tlv_multi {
69 	__be16 num_extensions;
70 	__be16 total_len;
71 } __packed;
72 
73 MLXFW_MFA2_TLV(multi, struct mlxfw_mfa2_tlv_multi,
74 	       MLXFW_MFA2_TLV_MULTI_PART);
75 
76 struct mlxfw_mfa2_tlv_psid {
77 	u8 psid[0];
78 } __packed;
79 
80 MLXFW_MFA2_TLV_VARSIZE(psid, struct mlxfw_mfa2_tlv_psid,
81 		       MLXFW_MFA2_TLV_PSID);
82 
83 struct mlxfw_mfa2_tlv_component_ptr {
84 	__be16 storage_id;
85 	__be16 component_index;
86 	__be32 storage_address;
87 } __packed;
88 
89 MLXFW_MFA2_TLV(component_ptr, struct mlxfw_mfa2_tlv_component_ptr,
90 	       MLXFW_MFA2_TLV_COMPONENT_PTR);
91 
92 struct mlxfw_mfa2_tlv_component_descriptor {
93 	__be16 pldm_classification;
94 	__be16 identifier;
95 	__be32 cb_offset_h;
96 	__be32 cb_offset_l;
97 	__be32 size;
98 } __packed;
99 
100 MLXFW_MFA2_TLV(component_descriptor, struct mlxfw_mfa2_tlv_component_descriptor,
101 	       MLXFW_MFA2_TLV_COMPONENT_DESCRIPTOR);
102 
103 #endif
104