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