€•A.Œsphinx.addnodes”Œdocument”“”)”}”(Œ rawsource”Œ”Œchildren”]”(Œ translations”Œ LanguagesNode”“”)”}”(hhh]”(hŒ pending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ refdomain”Œstd”Œreftype”Œdoc”Œ reftarget”Œ0/translations/zh_CN/driver-api/pldmfw/driver-ops”Œmodname”NŒ classname”NŒ refexplicit”ˆuŒtagname”hhh ubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ0/translations/zh_TW/driver-api/pldmfw/driver-ops”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ0/translations/it_IT/driver-api/pldmfw/driver-ops”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ0/translations/ja_JP/driver-api/pldmfw/driver-ops”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ0/translations/ko_KR/driver-api/pldmfw/driver-ops”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒPortuguese (Brazilian)”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ0/translations/pt_BR/driver-api/pldmfw/driver-ops”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒSpanish”…””}”hh–sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ0/translations/sp_SP/driver-api/pldmfw/driver-ops”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h hhŒ _document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ%SPDX-License-Identifier: GPL-2.0-only”h]”hŒ%SPDX-License-Identifier: GPL-2.0-only”…””}”hh·sbah}”(h]”h ]”h"]”h$]”h&]”Œ xml:space”Œpreserve”uh1hµhhh²hh³ŒJ/var/lib/git/docbuild/linux/Documentation/driver-api/pldmfw/driver-ops.rst”h´KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒDriver-specific callbacks”h]”hŒDriver-specific callbacks”…””}”(hhÏh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhhÊh²hh³hÇh´KubhŒ paragraph”“”)”}”(hŒ{The ``pldmfw`` module relies on the device driver for implementing device specific behavior using the following operations.”h]”(hŒThe ”…””}”(hhßh²hh³Nh´NubhŒliteral”“”)”}”(hŒ ``pldmfw``”h]”hŒpldmfw”…””}”(hhéh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhhßubhŒm module relies on the device driver for implementing device specific behavior using the following operations.”…””}”(hhßh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KhhÊh²hubhÉ)”}”(hhh]”(hÎ)”}”(hŒ``.match_record``”h]”hè)”}”(hjh]”hŒ .match_record”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhjubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhjh²hh³hÇh´K ubhÞ)”}”(hXRThe ``.match_record`` operation is used to determine whether a given PLDM record matches the device being updated. This requires comparing the record descriptors in the record with information from the device. Many record descriptors are defined by the PLDM standard, but it is also allowed for devices to implement their own descriptors.”h]”(hŒThe ”…””}”(hjh²hh³Nh´Nubhè)”}”(hŒ``.match_record``”h]”hŒ .match_record”…””}”(hj#h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhjubhX= operation is used to determine whether a given PLDM record matches the device being updated. This requires comparing the record descriptors in the record with information from the device. Many record descriptors are defined by the PLDM standard, but it is also allowed for devices to implement their own descriptors.”…””}”(hjh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K hjh²hubhÞ)”}”(hŒXThe ``.match_record`` operation should return true if a given record matches the device.”h]”(hŒThe ”…””}”(hj;h²hh³Nh´Nubhè)”}”(hŒ``.match_record``”h]”hŒ .match_record”…””}”(hjCh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhj;ubhŒC operation should return true if a given record matches the device.”…””}”(hj;h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Khjh²hubeh}”(h]”Œ match-record”ah ]”h"]”Œ .match_record”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´K ubhÉ)”}”(hhh]”(hÎ)”}”(hŒ``.send_package_data``”h]”hè)”}”(hjhh]”hŒ.send_package_data”…””}”(hjjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhjfubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhjch²hh³hÇh´KubhÞ)”}”(hXZThe ``.send_package_data`` operation is used to send the device-specific package data in a record to the device firmware. If the matching record provides package data, ``pldmfw`` will call the ``.send_package_data`` function with a pointer to the package data and with the package data length. The device driver should send this data to firmware.”h]”(hŒThe ”…””}”(hj}h²hh³Nh´Nubhè)”}”(hŒ``.send_package_data``”h]”hŒ.send_package_data”…””}”(hj…h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhj}ubhŒŽ operation is used to send the device-specific package data in a record to the device firmware. If the matching record provides package data, ”…””}”(hj}h²hh³Nh´Nubhè)”}”(hŒ ``pldmfw``”h]”hŒpldmfw”…””}”(hj—h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhj}ubhŒ will call the ”…””}”(hj}h²hh³Nh´Nubhè)”}”(hŒ``.send_package_data``”h]”hŒ.send_package_data”…””}”(hj©h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhj}ubhŒƒ function with a pointer to the package data and with the package data length. The device driver should send this data to firmware.”…””}”(hj}h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Khjch²hubeh}”(h]”Œsend-package-data”ah ]”h"]”Œ.send_package_data”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´KubhÉ)”}”(hhh]”(hÎ)”}”(hŒ``.send_component_table``”h]”hè)”}”(hjÎh]”hŒ.send_component_table”…””}”(hjÐh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhjÌubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhjÉh²hh³hÇh´K ubhÞ)”}”(hX…The ``.send_component_table`` operation is used to forward component information to the device. It is called once for each applicable component, that is, for each component indicated by the matching record. The device driver should send the component information to the device firmware, and wait for a response. The provided transfer flag indicates whether this is the first, last, or a middle component, and is expected to be forwarded to firmware as part of the component table information. The driver should an error in the case when the firmware indicates that the component cannot be updated, or return zero if the component can be updated.”h]”(hŒThe ”…””}”(hjãh²hh³Nh´Nubhè)”}”(hŒ``.send_component_table``”h]”hŒ.send_component_table”…””}”(hjëh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhjãubhXh operation is used to forward component information to the device. It is called once for each applicable component, that is, for each component indicated by the matching record. The device driver should send the component information to the device firmware, and wait for a response. The provided transfer flag indicates whether this is the first, last, or a middle component, and is expected to be forwarded to firmware as part of the component table information. The driver should an error in the case when the firmware indicates that the component cannot be updated, or return zero if the component can be updated.”…””}”(hjãh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K"hjÉh²hubeh}”(h]”Œsend-component-table”ah ]”h"]”Œ.send_component_table”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´K ubhÉ)”}”(hhh]”(hÎ)”}”(hŒ``.flash_component``”h]”hè)”}”(hjh]”hŒ.flash_component”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhjubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhj h²hh³hÇh´K-ubhÞ)”}”(hŒ¸The ``.flash_component`` operation is used to inform the device driver to flash a given component. The driver must perform any steps necessary to send the component data to the device.”h]”(hŒThe ”…””}”(hj%h²hh³Nh´Nubhè)”}”(hŒ``.flash_component``”h]”hŒ.flash_component”…””}”(hj-h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhj%ubhŒ  operation is used to inform the device driver to flash a given component. The driver must perform any steps necessary to send the component data to the device.”…””}”(hj%h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K/hj h²hubeh}”(h]”Œflash-component”ah ]”h"]”Œ.flash_component”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´K-ubhÉ)”}”(hhh]”(hÎ)”}”(hŒ``.finalize_update``”h]”hè)”}”(hjRh]”hŒ.finalize_update”…””}”(hjTh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhjPubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhjMh²hh³hÇh´K4ubhÞ)”}”(hŒ´The ``.finalize_update`` operation is used by the ``pldmfw`` library in order to allow the device driver to perform any remaining device specific logic needed to finish the update.”h]”(hŒThe ”…””}”(hjgh²hh³Nh´Nubhè)”}”(hŒ``.finalize_update``”h]”hŒ.finalize_update”…””}”(hjoh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhjgubhŒ operation is used by the ”…””}”(hjgh²hh³Nh´Nubhè)”}”(hŒ ``pldmfw``”h]”hŒpldmfw”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhjgubhŒx library in order to allow the device driver to perform any remaining device specific logic needed to finish the update.”…””}”(hjgh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K6hjMh²hubeh}”(h]”Œfinalize-update”ah ]”h"]”Œ.finalize_update”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´K4ubeh}”(h]”Œdriver-specific-callbacks”ah ]”h"]”Œdriver-specific callbacks”ah$]”h&]”uh1hÈhhh²hh³hÇh´Kubeh}”(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”jÌŒ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£j`j]jÆjÃjjjJjGjžj›uŒ nametypes”}”(j¦‰j`‰jƉj‰jJ‰jž‰uh}”(j£hÊj]jjÃjcjjÉjGj j›jMuŒ 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.