1 .. SPDX-License-Identifier: GPL-2.0-only 2 3 ========================= 4 Driver-specific callbacks 5 ========================= 6 7 The ``pldmfw`` module relies on the device driver for implementing device 8 specific behavior using the following operations. 9 10 ``.match_record`` 11 ----------------- 12 13 The ``.match_record`` operation is used to determine whether a given PLDM 14 record matches the device being updated. This requires comparing the record 15 descriptors in the record with information from the device. Many record 16 descriptors are defined by the PLDM standard, but it is also allowed for 17 devices to implement their own descriptors. 18 19 The ``.match_record`` operation should return true if a given record matches 20 the device. 21 22 ``.send_package_data`` 23 ---------------------- 24 25 The ``.send_package_data`` operation is used to send the device-specific 26 package data in a record to the device firmware. If the matching record 27 provides package data, ``pldmfw`` will call the ``.send_package_data`` 28 function with a pointer to the package data and with the package data 29 length. The device driver should send this data to firmware. 30 31 ``.send_component_table`` 32 ------------------------- 33 34 The ``.send_component_table`` operation is used to forward component 35 information to the device. It is called once for each applicable component, 36 that is, for each component indicated by the matching record. The 37 device driver should send the component information to the device firmware, 38 and wait for a response. The provided transfer flag indicates whether this 39 is the first, last, or a middle component, and is expected to be forwarded 40 to firmware as part of the component table information. The driver should an 41 error in the case when the firmware indicates that the component cannot be 42 updated, or return zero if the component can be updated. 43 44 ``.flash_component`` 45 -------------------- 46 47 The ``.flash_component`` operation is used to inform the device driver to 48 flash a given component. The driver must perform any steps necessary to send 49 the component data to the device. 50 51 ``.finalize_update`` 52 -------------------- 53 54 The ``.finalize_update`` operation is used by the ``pldmfw`` library in 55 order to allow the device driver to perform any remaining device specific 56 logic needed to finish the update.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.