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