1 .. SPDX-License-Identifier: GPL-2.0-only 1 .. SPDX-License-Identifier: GPL-2.0-only
2 2
3 ================================== 3 ==================================
4 PLDM Firmware file format overview 4 PLDM Firmware file format overview
5 ================================== 5 ==================================
6 6
7 A PLDM firmware package is a binary file which 7 A PLDM firmware package is a binary file which contains a header that
8 describes the contents of the firmware package 8 describes the contents of the firmware package. This includes an initial
9 package header, one or more firmware records, 9 package header, one or more firmware records, and one or more components
10 describing the actual flash contents to progra 10 describing the actual flash contents to program.
11 11
12 This diagram provides an overview of the file 12 This diagram provides an overview of the file format::
13 13
14 overall file layout 14 overall file layout
15 +----------------------+ 15 +----------------------+
16 | | 16 | |
17 | Package Header | 17 | Package Header |
18 | | 18 | |
19 +----------------------+ 19 +----------------------+
20 | | 20 | |
21 | Device Records | 21 | Device Records |
22 | | 22 | |
23 +----------------------+ 23 +----------------------+
24 | | 24 | |
25 | Component Info | 25 | Component Info |
26 | | 26 | |
27 +----------------------+ 27 +----------------------+
28 | | 28 | |
29 | Package Header CRC | 29 | Package Header CRC |
30 | | 30 | |
31 +----------------------+ 31 +----------------------+
32 | | 32 | |
33 | Component Image 1 | 33 | Component Image 1 |
34 | | 34 | |
35 +----------------------+ 35 +----------------------+
36 | | 36 | |
37 | Component Image 2 | 37 | Component Image 2 |
38 | | 38 | |
39 +----------------------+ 39 +----------------------+
40 | | 40 | |
41 | ... | 41 | ... |
42 | | 42 | |
43 +----------------------+ 43 +----------------------+
44 | | 44 | |
45 | Component Image N | 45 | Component Image N |
46 | | 46 | |
47 +----------------------+ 47 +----------------------+
48 48
49 Package Header 49 Package Header
50 ============== 50 ==============
51 51
52 The package header begins with the UUID of the 52 The package header begins with the UUID of the PLDM file format, and
53 contains information about the version of the 53 contains information about the version of the format that the file uses. It
54 also includes the total header size, a release 54 also includes the total header size, a release date, the size of the
55 component bitmap, and an overall package versi 55 component bitmap, and an overall package version.
56 56
57 The following diagram provides an overview of 57 The following diagram provides an overview of the package header::
58 58
59 header layout 59 header layout
60 +-------------------------+ 60 +-------------------------+
61 | PLDM UUID | 61 | PLDM UUID |
62 +-------------------------+ 62 +-------------------------+
63 | Format Revision | 63 | Format Revision |
64 +-------------------------+ 64 +-------------------------+
65 | Header Size | 65 | Header Size |
66 +-------------------------+ 66 +-------------------------+
67 | Release Date | 67 | Release Date |
68 +-------------------------+ 68 +-------------------------+
69 | Component Bitmap Length | 69 | Component Bitmap Length |
70 +-------------------------+ 70 +-------------------------+
71 | Package Version Info | 71 | Package Version Info |
72 +-------------------------+ 72 +-------------------------+
73 73
74 Device Records 74 Device Records
75 ============== 75 ==============
76 76
77 The device firmware records area starts with a 77 The device firmware records area starts with a count indicating the total
78 number of records in the file, followed by eac 78 number of records in the file, followed by each record. A single device
79 record describes what device matches this reco 79 record describes what device matches this record. All valid PLDM firmware
80 files must contain at least one record, but op 80 files must contain at least one record, but optionally may contain more than
81 one record if they support multiple devices. 81 one record if they support multiple devices.
82 82
83 Each record will identify the device it suppor 83 Each record will identify the device it supports via TLVs that describe the
84 device, such as the PCI device and vendor info 84 device, such as the PCI device and vendor information. It will also indicate
85 which set of components that are used by this 85 which set of components that are used by this device. It is possible that
86 only subset of provided components will be use 86 only subset of provided components will be used by a given record. A record
87 may also optionally contain device-specific pa 87 may also optionally contain device-specific package data that will be used
88 by the device firmware during the update proce 88 by the device firmware during the update process.
89 89
90 The following diagram provides an overview of 90 The following diagram provides an overview of the device record area::
91 91
92 area layout 92 area layout
93 +---------------+ 93 +---------------+
94 | | 94 | |
95 | Record Count | 95 | Record Count |
96 | | 96 | |
97 +---------------+ 97 +---------------+
98 | | 98 | |
99 | Record 1 | 99 | Record 1 |
100 | | 100 | |
101 +---------------+ 101 +---------------+
102 | | 102 | |
103 | Record 2 | 103 | Record 2 |
104 | | 104 | |
105 +---------------+ 105 +---------------+
106 | | 106 | |
107 | ... | 107 | ... |
108 | | 108 | |
109 +---------------+ 109 +---------------+
110 | | 110 | |
111 | Record N | 111 | Record N |
112 | | 112 | |
113 +---------------+ 113 +---------------+
114 114
115 record layout 115 record layout
116 +-----------------------+ 116 +-----------------------+
117 | Record Length | 117 | Record Length |
118 +-----------------------+ 118 +-----------------------+
119 | Descriptor Count | 119 | Descriptor Count |
120 +-----------------------+ 120 +-----------------------+
121 | Option Flags | 121 | Option Flags |
122 +-----------------------+ 122 +-----------------------+
123 | Version Settings | 123 | Version Settings |
124 +-----------------------+ 124 +-----------------------+
125 | Package Data Length | 125 | Package Data Length |
126 +-----------------------+ 126 +-----------------------+
127 | Applicable Components | 127 | Applicable Components |
128 +-----------------------+ 128 +-----------------------+
129 | Version String | 129 | Version String |
130 +-----------------------+ 130 +-----------------------+
131 | Descriptor TLVs | 131 | Descriptor TLVs |
132 +-----------------------+ 132 +-----------------------+
133 | Package Data | 133 | Package Data |
134 +-----------------------+ 134 +-----------------------+
135 135
136 Component Info 136 Component Info
137 ============== 137 ==============
138 138
139 The component information area begins with a c 139 The component information area begins with a count of the number of
140 components. Following this count is a descript 140 components. Following this count is a description for each component. The
141 component information points to the location i 141 component information points to the location in the file where the component
142 data is stored, and includes version data used 142 data is stored, and includes version data used to identify the version of
143 the component. 143 the component.
144 144
145 The following diagram provides an overview of 145 The following diagram provides an overview of the component area::
146 146
147 area layout 147 area layout
148 +-----------------+ 148 +-----------------+
149 | | 149 | |
150 | Component Count | 150 | Component Count |
151 | | 151 | |
152 +-----------------+ 152 +-----------------+
153 | | 153 | |
154 | Component 1 | 154 | Component 1 |
155 | | 155 | |
156 +-----------------+ 156 +-----------------+
157 | | 157 | |
158 | Component 2 | 158 | Component 2 |
159 | | 159 | |
160 +-----------------+ 160 +-----------------+
161 | | 161 | |
162 | ... | 162 | ... |
163 | | 163 | |
164 +-----------------+ 164 +-----------------+
165 | | 165 | |
166 | Component N | 166 | Component N |
167 | | 167 | |
168 +-----------------+ 168 +-----------------+
169 169
170 component layout 170 component layout
171 +------------------------+ 171 +------------------------+
172 | Classification | 172 | Classification |
173 +------------------------+ 173 +------------------------+
174 | Component Identifier | 174 | Component Identifier |
175 +------------------------+ 175 +------------------------+
176 | Comparison Stamp | 176 | Comparison Stamp |
177 +------------------------+ 177 +------------------------+
178 | Component Options | 178 | Component Options |
179 +------------------------+ 179 +------------------------+
180 | Activation Method | 180 | Activation Method |
181 +------------------------+ 181 +------------------------+
182 | Location Offset | 182 | Location Offset |
183 +------------------------+ 183 +------------------------+
184 | Component Size | 184 | Component Size |
185 +------------------------+ 185 +------------------------+
186 | Component Version Info | 186 | Component Version Info |
187 +------------------------+ 187 +------------------------+
188 | Package Data | 188 | Package Data |
189 +------------------------+ 189 +------------------------+
190 190
191 191
192 Package Header CRC 192 Package Header CRC
193 ================== 193 ==================
194 194
195 Following the component information is a short 195 Following the component information is a short 4-byte CRC calculated over
196 the contents of all of the header information. 196 the contents of all of the header information.
197 197
198 Component Images 198 Component Images
199 ================ 199 ================
200 200
201 The component images follow the package header 201 The component images follow the package header information in the PLDM
202 firmware file. Each of these is simply a binar 202 firmware file. Each of these is simply a binary chunk with its start and
203 size defined by the matching component structu 203 size defined by the matching component structure in the component info area.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.