xref: /linux/Documentation/networking/devlink/devlink-info.rst (revision c90977a3c22735dc974f513f624703d9bcbc2a1d)
12dfaaae5SJacob Keller.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
22dfaaae5SJacob Keller
32dfaaae5SJacob Keller============
42dfaaae5SJacob KellerDevlink Info
52dfaaae5SJacob Keller============
62dfaaae5SJacob Keller
72dfaaae5SJacob KellerThe ``devlink-info`` mechanism enables device drivers to report device
82dfaaae5SJacob Kellerinformation in a generic fashion. It is extensible, and enables exporting
92dfaaae5SJacob Kellereven device or driver specific information.
102dfaaae5SJacob Keller
112dfaaae5SJacob Kellerdevlink supports representing the following types of versions
122dfaaae5SJacob Keller
132dfaaae5SJacob Keller.. list-table:: List of version types
142dfaaae5SJacob Keller   :widths: 5 95
152dfaaae5SJacob Keller
162dfaaae5SJacob Keller   * - Type
172dfaaae5SJacob Keller     - Description
182dfaaae5SJacob Keller   * - ``fixed``
192dfaaae5SJacob Keller     - Represents fixed versions, which cannot change. For example,
202dfaaae5SJacob Keller       component identifiers or the board version reported in the PCI VPD.
212dfaaae5SJacob Keller   * - ``running``
222dfaaae5SJacob Keller     - Represents the version of the currently running component. For
232dfaaae5SJacob Keller       example the running version of firmware. These versions generally
242dfaaae5SJacob Keller       only update after a reboot.
252dfaaae5SJacob Keller   * - ``stored``
262dfaaae5SJacob Keller     - Represents the version of a component as stored, such as after a
272dfaaae5SJacob Keller       flash update. Stored values should update to reflect changes in the
282dfaaae5SJacob Keller       flash even if a reboot has not yet occurred.
292dfaaae5SJacob Keller
302dfaaae5SJacob KellerGeneric Versions
312dfaaae5SJacob Keller================
322dfaaae5SJacob Keller
332dfaaae5SJacob KellerIt is expected that drivers use the following generic names for exporting
342dfaaae5SJacob Kellerversion information. Other information may be exposed using driver-specific
352dfaaae5SJacob Kellernames, but these should be documented in the driver-specific file.
362dfaaae5SJacob Keller
372dfaaae5SJacob Kellerboard.id
382dfaaae5SJacob Keller--------
392dfaaae5SJacob Keller
402dfaaae5SJacob KellerUnique identifier of the board design.
412dfaaae5SJacob Keller
422dfaaae5SJacob Kellerboard.rev
432dfaaae5SJacob Keller---------
442dfaaae5SJacob Keller
452dfaaae5SJacob KellerBoard design revision.
462dfaaae5SJacob Keller
472dfaaae5SJacob Kellerasic.id
482dfaaae5SJacob Keller-------
492dfaaae5SJacob Keller
502dfaaae5SJacob KellerASIC design identifier.
512dfaaae5SJacob Keller
522dfaaae5SJacob Kellerasic.rev
532dfaaae5SJacob Keller--------
542dfaaae5SJacob Keller
552dfaaae5SJacob KellerASIC design revision.
562dfaaae5SJacob Keller
572dfaaae5SJacob Kellerboard.manufacture
582dfaaae5SJacob Keller-----------------
592dfaaae5SJacob Keller
602dfaaae5SJacob KellerAn identifier of the company or the facility which produced the part.
612dfaaae5SJacob Keller
622dfaaae5SJacob Kellerfw
632dfaaae5SJacob Keller--
642dfaaae5SJacob Keller
652dfaaae5SJacob KellerOverall firmware version, often representing the collection of
662dfaaae5SJacob Kellerfw.mgmt, fw.app, etc.
672dfaaae5SJacob Keller
682dfaaae5SJacob Kellerfw.mgmt
692dfaaae5SJacob Keller-------
702dfaaae5SJacob Keller
712dfaaae5SJacob KellerControl unit firmware version. This firmware is responsible for house
722dfaaae5SJacob Kellerkeeping tasks, PHY control etc. but not the packet-by-packet data path
732dfaaae5SJacob Kelleroperation.
742dfaaae5SJacob Keller
752dfaaae5SJacob Kellerfw.app
762dfaaae5SJacob Keller------
772dfaaae5SJacob Keller
782dfaaae5SJacob KellerData path microcode controlling high-speed packet processing.
792dfaaae5SJacob Keller
802dfaaae5SJacob Kellerfw.undi
812dfaaae5SJacob Keller-------
822dfaaae5SJacob Keller
832dfaaae5SJacob KellerUNDI software, may include the UEFI driver, firmware or both.
842dfaaae5SJacob Keller
852dfaaae5SJacob Kellerfw.ncsi
862dfaaae5SJacob Keller-------
872dfaaae5SJacob Keller
882dfaaae5SJacob KellerVersion of the software responsible for supporting/handling the
892dfaaae5SJacob KellerNetwork Controller Sideband Interface.
902dfaaae5SJacob Keller
912dfaaae5SJacob Kellerfw.psid
922dfaaae5SJacob Keller-------
932dfaaae5SJacob Keller
942dfaaae5SJacob KellerUnique identifier of the firmware parameter set.
9541c0d917SVasundhara Volam
9641c0d917SVasundhara Volamfw.roce
9741c0d917SVasundhara Volam-------
9841c0d917SVasundhara Volam
9941c0d917SVasundhara VolamRoCE firmware version which is responsible for handling roce
10041c0d917SVasundhara Volammanagement.
101*c90977a3SJacob Keller
102*c90977a3SJacob Kellerfw.bundle_id
103*c90977a3SJacob Keller------------
104*c90977a3SJacob Keller
105*c90977a3SJacob KellerUnique identifier of the entire firmware bundle.
106