1.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) 2 3============ 4Devlink Info 5============ 6 7The ``devlink-info`` mechanism enables device drivers to report device 8information in a generic fashion. It is extensible, and enables exporting 9even device or driver specific information. 10 11devlink supports representing the following types of versions 12 13.. list-table:: List of version types 14 :widths: 5 95 15 16 * - Type 17 - Description 18 * - ``fixed`` 19 - Represents fixed versions, which cannot change. For example, 20 component identifiers or the board version reported in the PCI VPD. 21 * - ``running`` 22 - Represents the version of the currently running component. For 23 example the running version of firmware. These versions generally 24 only update after a reboot. 25 * - ``stored`` 26 - Represents the version of a component as stored, such as after a 27 flash update. Stored values should update to reflect changes in the 28 flash even if a reboot has not yet occurred. 29 30Generic Versions 31================ 32 33It is expected that drivers use the following generic names for exporting 34version information. Other information may be exposed using driver-specific 35names, but these should be documented in the driver-specific file. 36 37board.id 38-------- 39 40Unique identifier of the board design. 41 42board.rev 43--------- 44 45Board design revision. 46 47asic.id 48------- 49 50ASIC design identifier. 51 52asic.rev 53-------- 54 55ASIC design revision. 56 57board.manufacture 58----------------- 59 60An identifier of the company or the facility which produced the part. 61 62fw 63-- 64 65Overall firmware version, often representing the collection of 66fw.mgmt, fw.app, etc. 67 68fw.mgmt 69------- 70 71Control unit firmware version. This firmware is responsible for house 72keeping tasks, PHY control etc. but not the packet-by-packet data path 73operation. 74 75fw.app 76------ 77 78Data path microcode controlling high-speed packet processing. 79 80fw.undi 81------- 82 83UNDI software, may include the UEFI driver, firmware or both. 84 85fw.ncsi 86------- 87 88Version of the software responsible for supporting/handling the 89Network Controller Sideband Interface. 90 91fw.psid 92------- 93 94Unique identifier of the firmware parameter set. 95 96fw.roce 97------- 98 99RoCE firmware version which is responsible for handling roce 100management. 101