Lines Matching +full:device +full:- +full:version
1 .. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
7 The ``devlink-info`` mechanism enables device drivers to report device
10 The original motivation for the ``devlink-info`` API was twofold:
12 - making it possible to automate device and firmware management in a fleet
13 of machines in a vendor-independent fashion (see also
14 :ref:`Documentation/networking/devlink/devlink-flash.rst <devlink_flash>`);
15 - name the per component FW versions (as opposed to the crowded ethtool
16 version string).
18 ``devlink-info`` supports reporting multiple types of objects. Reporting driver
19 versions is generally discouraged - here, and via any other Linux API.
21 .. list-table:: List of top level info objects
24 * - Name
25 - Description
26 * - ``driver``
27 - Name of the currently used device driver, also available through sysfs.
29 * - ``serial_number``
30 - Serial number of the device.
33 in PCI config space of the device in the *Device Serial Number*
36 The serial number should be unique per physical device.
37 Sometimes the serial number of the device is only 48 bits long (the
44 reported for two ports of the same device or on two hosts of
45 a multi-host device should be identical.
47 * - ``board.serial_number``
48 - Board serial number of the device.
53 * - ``fixed``
54 - Group for hardware identifiers, and versions of components
55 which are not field-updatable.
57 Versions in this section identify the device design. For example,
58 component identifiers or the board version reported in the PCI VPD.
59 Data in ``devlink-info`` should be broken into the smallest logical
61 to form the Part Number string, while in ``devlink-info`` all parts
66 :ref:`Documentation/networking/devlink/devlink-flash.rst <devlink_flash>`
69 * - ``running``
70 - Group for information about currently running software/firmware.
71 These versions often only update after a reboot, sometimes device reset.
73 * - ``stored``
74 - Group for software/firmware versions in device flash.
77 if reboot has not yet occurred. If device is not capable of updating
81 Each version can be reported at most once in each version group. Firmware
83 ``stored`` sections, if device is capable of reporting ``stored`` versions
84 (see :ref:`Documentation/networking/devlink/devlink-flash.rst <devlink_flash>`).
86 ``/lib/firmware``) only the running version should be reported via
93 version information. If a generic name for a given component doesn't exist yet,
94 driver authors should consult existing driver-specific versions and attempt
95 reuse. As last resort, if a component is truly unique, using driver-specific
96 names is allowed, but these should be documented in the driver-specific file.
100 .. list-table:: List of common version suffixes
103 * - Name
104 - Description
105 * - ``id``, ``revision``
106 - Identifiers of designs and revision, mostly used for hardware versions.
108 * - ``api``
109 - Version of API between components. API items are usually of limited
113 * - ``bundle_id``
114 - Identifier of a distribution package which was flashed onto the device.
117 :ref:`Documentation/networking/devlink/devlink-flash.rst <devlink_flash>`).
121 ``bundle_id`` was changed and no longer matches the version from
125 --------
130 ---------
135 -------
140 --------
145 -----------------
150 --
152 Overall firmware version, often representing the collection of
156 -------
158 Control unit firmware version. This firmware is responsible for house
159 keeping tasks, PHY control etc. but not the packet-by-packet data path
163 -----------
165 Firmware interface specification version of the software interfaces between
169 ------
171 Data path microcode controlling high-speed packet processing.
174 -------
179 -------
181 Version of the software responsible for supporting/handling the
185 -------
191 -------
193 RoCE firmware version which is responsible for handling roce
197 ------------
202 -------------
204 Version of the bootloader.
211 - on-disk firmware file names - drivers list the file names of firmware they
213 however, are per module, rather than per device. It'd be useful to list
214 the names of firmware files the driver will try to load for a given device,