€•°D      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ1/translations/zh_CN/driver-api/pldmfw/file-format”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ1/translations/zh_TW/driver-api/pldmfw/file-format”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ1/translations/it_IT/driver-api/pldmfw/file-format”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ1/translations/ja_JP/driver-api/pldmfw/file-format”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ1/translations/ko_KR/driver-api/pldmfw/file-format”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ1/translations/sp_SP/driver-api/pldmfw/file-format”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ%SPDX-License-Identifier: GPL-2.0-only”h]”hŒ%SPDX-License-Identifier: GPL-2.0-only”…””}”hh£sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1h¡hhhžhhŸŒK/var/lib/git/docbuild/linux/Documentation/driver-api/pldmfw/file-format.rst”h KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒ"PLDM Firmware file format overview”h]”hŒ"PLDM Firmware file format overview”…””}”(hh»hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hh¶hžhhŸh³h KubhŒ	paragraph”“”)”}”(hX  A PLDM firmware package is a binary file which contains a header that
describes the contents of the firmware package. This includes an initial
package header, one or more firmware records, and one or more components
describing the actual flash contents to program.”h]”hX  A PLDM firmware package is a binary file which contains a header that
describes the contents of the firmware package. This includes an initial
package header, one or more firmware records, and one or more components
describing the actual flash contents to program.”…””}”(hhËhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhÊ)”}”(hŒ6This diagram provides an overview of the file format::”h]”hŒ5This diagram provides an overview of the file format:”…””}”(hhÙhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhŒliteral_block”“”)”}”(hXN    overall file layout
+----------------------+
|                      |
|  Package Header      |
|                      |
+----------------------+
|                      |
|  Device Records      |
|                      |
+----------------------+
|                      |
|  Component Info      |
|                      |
+----------------------+
|                      |
|  Package Header CRC  |
|                      |
+----------------------+
|                      |
|  Component Image 1   |
|                      |
+----------------------+
|                      |
|  Component Image 2   |
|                      |
+----------------------+
|                      |
|         ...          |
|                      |
+----------------------+
|                      |
|  Component Image N   |
|                      |
+----------------------+”h]”hXN    overall file layout
+----------------------+
|                      |
|  Package Header      |
|                      |
+----------------------+
|                      |
|  Device Records      |
|                      |
+----------------------+
|                      |
|  Component Info      |
|                      |
+----------------------+
|                      |
|  Package Header CRC  |
|                      |
+----------------------+
|                      |
|  Component Image 1   |
|                      |
+----------------------+
|                      |
|  Component Image 2   |
|                      |
+----------------------+
|                      |
|         ...          |
|                      |
+----------------------+
|                      |
|  Component Image N   |
|                      |
+----------------------+”…””}”hhésbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1hçhŸh³h Khh¶hžhubhµ)”}”(hhh]”(hº)”}”(hŒPackage Header”h]”hŒPackage Header”…””}”(hhúhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hh÷hžhhŸh³h K2ubhÊ)”}”(hX  The package header begins with the UUID of the PLDM file format, and
contains information about the version of the format that the file uses. It
also includes the total header size, a release date, the size of the
component bitmap, and an overall package version.”h]”hX  The package header begins with the UUID of the PLDM file format, and
contains information about the version of the format that the file uses. It
also includes the total header size, a release date, the size of the
component bitmap, and an overall package version.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K4hh÷hžhubhÊ)”}”(hŒBThe following diagram provides an overview of the package header::”h]”hŒAThe following diagram provides an overview of the package header:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K9hh÷hžhubhè)”}”(hX€         header layout
+-------------------------+
| PLDM UUID               |
+-------------------------+
| Format Revision         |
+-------------------------+
| Header Size             |
+-------------------------+
| Release Date            |
+-------------------------+
| Component Bitmap Length |
+-------------------------+
| Package Version Info    |
+-------------------------+”h]”hX€         header layout
+-------------------------+
| PLDM UUID               |
+-------------------------+
| Format Revision         |
+-------------------------+
| Header Size             |
+-------------------------+
| Release Date            |
+-------------------------+
| Component Bitmap Length |
+-------------------------+
| Package Version Info    |
+-------------------------+”…””}”hj$  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1hçhŸh³h K;hh÷hžhubeh}”(h]”Œpackage-header”ah ]”h"]”Œpackage header”ah$]”h&]”uh1h´hh¶hžhhŸh³h K2ubhµ)”}”(hhh]”(hº)”}”(hŒDevice Records”h]”hŒDevice Records”…””}”(hj=  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj:  hžhhŸh³h KKubhÊ)”}”(hXU  The device firmware records area starts with a count indicating the total
number of records in the file, followed by each record. A single device
record describes what device matches this record. All valid PLDM firmware
files must contain at least one record, but optionally may contain more than
one record if they support multiple devices.”h]”hXU  The device firmware records area starts with a count indicating the total
number of records in the file, followed by each record. A single device
record describes what device matches this record. All valid PLDM firmware
files must contain at least one record, but optionally may contain more than
one record if they support multiple devices.”…””}”(hjK  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KMhj:  hžhubhÊ)”}”(hX«  Each record will identify the device it supports via TLVs that describe the
device, such as the PCI device and vendor information. It will also indicate
which set of components that are used by this device. It is possible that
only subset of provided components will be used by a given record. A record
may also optionally contain device-specific package data that will be used
by the device firmware during the update process.”h]”hX«  Each record will identify the device it supports via TLVs that describe the
device, such as the PCI device and vendor information. It will also indicate
which set of components that are used by this device. It is possible that
only subset of provided components will be used by a given record. A record
may also optionally contain device-specific package data that will be used
by the device firmware during the update process.”…””}”(hjY  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KShj:  hžhubhÊ)”}”(hŒFThe following diagram provides an overview of the device record area::”h]”hŒEThe following diagram provides an overview of the device record area:”…””}”(hjg  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KZhj:  hžhubhè)”}”(hXŠ     area layout
+---------------+
|               |
|  Record Count |
|               |
+---------------+
|               |
|  Record 1     |
|               |
+---------------+
|               |
|  Record 2     |
|               |
+---------------+
|               |
|      ...      |
|               |
+---------------+
|               |
|  Record N     |
|               |
+---------------+

     record layout
+-----------------------+
| Record Length         |
+-----------------------+
| Descriptor Count      |
+-----------------------+
| Option Flags          |
+-----------------------+
| Version Settings      |
+-----------------------+
| Package Data Length   |
+-----------------------+
| Applicable Components |
+-----------------------+
| Version String        |
+-----------------------+
| Descriptor TLVs       |
+-----------------------+
| Package Data          |
+-----------------------+”h]”hXŠ     area layout
+---------------+
|               |
|  Record Count |
|               |
+---------------+
|               |
|  Record 1     |
|               |
+---------------+
|               |
|  Record 2     |
|               |
+---------------+
|               |
|      ...      |
|               |
+---------------+
|               |
|  Record N     |
|               |
+---------------+

     record layout
+-----------------------+
| Record Length         |
+-----------------------+
| Descriptor Count      |
+-----------------------+
| Option Flags          |
+-----------------------+
| Version Settings      |
+-----------------------+
| Package Data Length   |
+-----------------------+
| Applicable Components |
+-----------------------+
| Version String        |
+-----------------------+
| Descriptor TLVs       |
+-----------------------+
| Package Data          |
+-----------------------+”…””}”hju  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1hçhŸh³h K\hj:  hžhubeh}”(h]”Œdevice-records”ah ]”h"]”Œdevice records”ah$]”h&]”uh1h´hh¶hžhhŸh³h KKubhµ)”}”(hhh]”(hº)”}”(hŒComponent Info”h]”hŒComponent Info”…””}”(hjŽ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj‹  hžhhŸh³h K‰ubhÊ)”}”(hX3  The component information area begins with a count of the number of
components. Following this count is a description for each component. The
component information points to the location in the file where the component
data is stored, and includes version data used to identify the version of
the component.”h]”hX3  The component information area begins with a count of the number of
components. Following this count is a description for each component. The
component information points to the location in the file where the component
data is stored, and includes version data used to identify the version of
the component.”…””}”(hjœ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K‹hj‹  hžhubhÊ)”}”(hŒBThe following diagram provides an overview of the component area::”h]”hŒAThe following diagram provides an overview of the component area:”…””}”(hjª  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K‘hj‹  hžhubhè)”}”(hXÊ     area layout
+-----------------+
|                 |
| Component Count |
|                 |
+-----------------+
|                 |
| Component 1     |
|                 |
+-----------------+
|                 |
| Component 2     |
|                 |
+-----------------+
|                 |
|     ...         |
|                 |
+-----------------+
|                 |
| Component N     |
|                 |
+-----------------+

     component layout
+------------------------+
| Classification         |
+------------------------+
| Component Identifier   |
+------------------------+
| Comparison Stamp       |
+------------------------+
| Component Options      |
+------------------------+
| Activation Method      |
+------------------------+
| Location Offset        |
+------------------------+
| Component Size         |
+------------------------+
| Component Version Info |
+------------------------+
| Package Data           |
+------------------------+”h]”hXÊ     area layout
+-----------------+
|                 |
| Component Count |
|                 |
+-----------------+
|                 |
| Component 1     |
|                 |
+-----------------+
|                 |
| Component 2     |
|                 |
+-----------------+
|                 |
|     ...         |
|                 |
+-----------------+
|                 |
| Component N     |
|                 |
+-----------------+

     component layout
+------------------------+
| Classification         |
+------------------------+
| Component Identifier   |
+------------------------+
| Comparison Stamp       |
+------------------------+
| Component Options      |
+------------------------+
| Activation Method      |
+------------------------+
| Location Offset        |
+------------------------+
| Component Size         |
+------------------------+
| Component Version Info |
+------------------------+
| Package Data           |
+------------------------+”…””}”hj¸  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1hçhŸh³h K“hj‹  hžhubeh}”(h]”Œcomponent-info”ah ]”h"]”Œcomponent info”ah$]”h&]”uh1h´hh¶hžhhŸh³h K‰ubhµ)”}”(hhh]”(hº)”}”(hŒPackage Header CRC”h]”hŒPackage Header CRC”…””}”(hjÑ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjÎ  hžhhŸh³h KÁubhÊ)”}”(hŒxFollowing the component information is a short 4-byte CRC calculated over
the contents of all of the header information.”h]”hŒxFollowing the component information is a short 4-byte CRC calculated over
the contents of all of the header information.”…””}”(hjß  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÃhjÎ  hžhubeh}”(h]”Œpackage-header-crc”ah ]”h"]”Œpackage header crc”ah$]”h&]”uh1h´hh¶hžhhŸh³h KÁubhµ)”}”(hhh]”(hº)”}”(hŒComponent Images”h]”hŒComponent Images”…””}”(hjø  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjõ  hžhhŸh³h KÇubhÊ)”}”(hŒÜThe component images follow the package header information in the PLDM
firmware file. Each of these is simply a binary chunk with its start and
size defined by the matching component structure in the component info area.”h]”hŒÜThe component images follow the package header information in the PLDM
firmware file. Each of these is simply a binary chunk with its start and
size defined by the matching component structure in the component info area.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÉhjõ  hžhubeh}”(h]”Œcomponent-images”ah ]”h"]”Œcomponent images”ah$]”h&]”uh1h´hh¶hžhhŸh³h KÇubeh}”(h]”Œ"pldm-firmware-file-format-overview”ah ]”h"]”Œ"pldm firmware file format overview”ah$]”h&]”uh1h´hhhžhhŸh³h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h³uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¹NŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jG  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h³Œ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(j!  j  j7  j4  jˆ  j…  jË  jÈ  jò  jï  j  j  uŒ	nametypes”}”(j!  ‰j7  ‰jˆ  ‰jË  ‰jò  ‰j  ‰uh}”(j  h¶j4  h÷j…  j:  jÈ  j‹  jï  jÎ  j  jõ  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.