€•P-Œ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Œ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Ô)”}”(hhòh]”hŒ .match_record”…””}”(hhôhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÓhhðubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hhíhž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”…””}”(hjhž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 hhíhž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”…””}”(hj/hž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 Khhíhž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Ô)”}”(hjTh]”hŒ.send_package_data”…””}”(hjVhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÓhjRubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjOhž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 ”…””}”(hjihžhhŸNh NubhÔ)”}”(hŒ``.send_package_data``”h]”hŒ.send_package_data”…””}”(hjqhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÓhjiubhŒŽ operation is used to send the device-specific package data in a record to the device firmware. If the matching record provides package data, ”…””}”(hjihžhhŸNh NubhÔ)”}”(hŒ ``pldmfw``”h]”hŒpldmfw”…””}”(hjƒhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÓhjiubhŒ will call the ”…””}”(hjihžhhŸNh NubhÔ)”}”(hŒ``.send_package_data``”h]”hŒ.send_package_data”…””}”(hj•hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÓhjiubhŒƒ function with a pointer to the package data and with the package data length. The device driver should send this data to firmware.”…””}”(hjihžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KhjOhž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Ô)”}”(hjüh]”hŒ.flash_component”…””}”(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Ê)”}”(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 ”…””}”(hjhžhhŸNh NubhÔ)”}”(hŒ``.flash_component``”h]”hŒ.flash_component”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÓhjubhŒ  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.”…””}”(hjhž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Ô)”}”(hj>h]”hŒ.finalize_update”…””}”(hj@hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÓhj<ubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj9hž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 ”…””}”(hjShžhhŸNh NubhÔ)”}”(hŒ``.finalize_update``”h]”hŒ.finalize_update”…””}”(hj[hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÓhjSubhŒ operation is used by the ”…””}”(hjShžhhŸNh NubhÔ)”}”(hŒ ``pldmfw``”h]”hŒpldmfw”…””}”(hjmhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÓhjSubhŒx library in order to allow the device driver to perform any remaining device specific logic needed to finish the update.”…””}”(hjShžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K6hj9hž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’jjLjIj²j¯jôjñj6j3jŠj‡uŒ nametypes”}”(j’‰jL‰j²‰jô‰j6‰jЉuh}”(jh¶jIhíj¯jOjñjµj3j÷j‡j9uŒ 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.