ice.rst 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  1. .. SPDX-License-Identifier: GPL-2.0
  2. ===================
  3. ice devlink support
  4. ===================
  5. This document describes the devlink features implemented by the ``ice``
  6. device driver.
  7. Info versions
  8. =============
  9. The ``ice`` driver reports the following versions
  10. .. list-table:: devlink info versions implemented
  11. :widths: 5 5 5 90
  12. * - Name
  13. - Type
  14. - Example
  15. - Description
  16. * - ``board.id``
  17. - fixed
  18. - K65390-000
  19. - The Product Board Assembly (PBA) identifier of the board.
  20. * - ``fw.mgmt``
  21. - running
  22. - 2.1.7
  23. - 3-digit version number of the management firmware that controls the
  24. PHY, link, etc.
  25. * - ``fw.mgmt.api``
  26. - running
  27. - 1.5
  28. - 2-digit version number of the API exported over the AdminQ by the
  29. management firmware. Used by the driver to identify what commands
  30. are supported.
  31. * - ``fw.mgmt.build``
  32. - running
  33. - 0x305d955f
  34. - Unique identifier of the source for the management firmware.
  35. * - ``fw.undi``
  36. - running
  37. - 1.2581.0
  38. - Version of the Option ROM containing the UEFI driver. The version is
  39. reported in ``major.minor.patch`` format. The major version is
  40. incremented whenever a major breaking change occurs, or when the
  41. minor version would overflow. The minor version is incremented for
  42. non-breaking changes and reset to 1 when the major version is
  43. incremented. The patch version is normally 0 but is incremented when
  44. a fix is delivered as a patch against an older base Option ROM.
  45. * - ``fw.psid.api``
  46. - running
  47. - 0.80
  48. - Version defining the format of the flash contents.
  49. * - ``fw.bundle_id``
  50. - running
  51. - 0x80002ec0
  52. - Unique identifier of the firmware image file that was loaded onto
  53. the device. Also referred to as the EETRACK identifier of the NVM.
  54. * - ``fw.app.name``
  55. - running
  56. - ICE OS Default Package
  57. - The name of the DDP package that is active in the device. The DDP
  58. package is loaded by the driver during initialization. Each
  59. variation of the DDP package has a unique name.
  60. * - ``fw.app``
  61. - running
  62. - 1.3.1.0
  63. - The version of the DDP package that is active in the device. Note
  64. that both the name (as reported by ``fw.app.name``) and version are
  65. required to uniquely identify the package.
  66. * - ``fw.app.bundle_id``
  67. - running
  68. - 0xc0000001
  69. - Unique identifier for the DDP package loaded in the device. Also
  70. referred to as the DDP Track ID. Can be used to uniquely identify
  71. the specific DDP package.
  72. * - ``fw.netlist``
  73. - running
  74. - 1.1.2000-6.7.0
  75. - The version of the netlist module. This module defines the device's
  76. Ethernet capabilities and default settings, and is used by the
  77. management firmware as part of managing link and device
  78. connectivity.
  79. * - ``fw.netlist.build``
  80. - running
  81. - 0xee16ced7
  82. - The first 4 bytes of the hash of the netlist module contents.
  83. Flash Update
  84. ============
  85. The ``ice`` driver implements support for flash update using the
  86. ``devlink-flash`` interface. It supports updating the device flash using a
  87. combined flash image that contains the ``fw.mgmt``, ``fw.undi``, and
  88. ``fw.netlist`` components.
  89. .. list-table:: List of supported overwrite modes
  90. :widths: 5 95
  91. * - Bits
  92. - Behavior
  93. * - ``DEVLINK_FLASH_OVERWRITE_SETTINGS``
  94. - Do not preserve settings stored in the flash components being
  95. updated. This includes overwriting the port configuration that
  96. determines the number of physical functions the device will
  97. initialize with.
  98. * - ``DEVLINK_FLASH_OVERWRITE_SETTINGS`` and ``DEVLINK_FLASH_OVERWRITE_IDENTIFIERS``
  99. - Do not preserve either settings or identifiers. Overwrite everything
  100. in the flash with the contents from the provided image, without
  101. performing any preservation. This includes overwriting device
  102. identifying fields such as the MAC address, VPD area, and device
  103. serial number. It is expected that this combination be used with an
  104. image customized for the specific device.
  105. The ice hardware does not support overwriting only identifiers while
  106. preserving settings, and thus ``DEVLINK_FLASH_OVERWRITE_IDENTIFIERS`` on its
  107. own will be rejected. If no overwrite mask is provided, the firmware will be
  108. instructed to preserve all settings and identifying fields when updating.
  109. Regions
  110. =======
  111. The ``ice`` driver implements the following regions for accessing internal
  112. device data.
  113. .. list-table:: regions implemented
  114. :widths: 15 85
  115. * - Name
  116. - Description
  117. * - ``nvm-flash``
  118. - The contents of the entire flash chip, sometimes referred to as
  119. the device's Non Volatile Memory.
  120. * - ``device-caps``
  121. - The contents of the device firmware's capabilities buffer. Useful to
  122. determine the current state and configuration of the device.
  123. Users can request an immediate capture of a snapshot via the
  124. ``DEVLINK_CMD_REGION_NEW``
  125. .. code:: shell
  126. $ devlink region new pci/0000:01:00.0/nvm-flash snapshot 1
  127. $ devlink region dump pci/0000:01:00.0/nvm-flash snapshot 1
  128. $ devlink region dump pci/0000:01:00.0/nvm-flash snapshot 1
  129. 0000000000000000 0014 95dc 0014 9514 0035 1670 0034 db30
  130. 0000000000000010 0000 0000 ffff ff04 0029 8c00 0028 8cc8
  131. 0000000000000020 0016 0bb8 0016 1720 0000 0000 c00f 3ffc
  132. 0000000000000030 bada cce5 bada cce5 bada cce5 bada cce5
  133. $ devlink region read pci/0000:01:00.0/nvm-flash snapshot 1 address 0 length 16
  134. 0000000000000000 0014 95dc 0014 9514 0035 1670 0034 db30
  135. $ devlink region delete pci/0000:01:00.0/nvm-flash snapshot 1
  136. $ devlink region new pci/0000:01:00.0/device-caps snapshot 1
  137. $ devlink region dump pci/0000:01:00.0/device-caps snapshot 1
  138. 0000000000000000 01 00 01 00 00 00 00 00 01 00 00 00 00 00 00 00
  139. 0000000000000010 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  140. 0000000000000020 02 00 02 01 32 03 00 00 0a 00 00 00 25 00 00 00
  141. 0000000000000030 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  142. 0000000000000040 04 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00
  143. 0000000000000050 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  144. 0000000000000060 05 00 01 00 03 00 00 00 00 00 00 00 00 00 00 00
  145. 0000000000000070 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  146. 0000000000000080 06 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00
  147. 0000000000000090 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  148. 00000000000000a0 08 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00
  149. 00000000000000b0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  150. 00000000000000c0 12 00 01 00 01 00 00 00 01 00 01 00 00 00 00 00
  151. 00000000000000d0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  152. 00000000000000e0 13 00 01 00 00 01 00 00 00 00 00 00 00 00 00 00
  153. 00000000000000f0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  154. 0000000000000100 14 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00
  155. 0000000000000110 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  156. 0000000000000120 15 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00
  157. 0000000000000130 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  158. 0000000000000140 16 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00
  159. 0000000000000150 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  160. 0000000000000160 17 00 01 00 06 00 00 00 00 00 00 00 00 00 00 00
  161. 0000000000000170 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  162. 0000000000000180 18 00 01 00 01 00 00 00 01 00 00 00 08 00 00 00
  163. 0000000000000190 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  164. 00000000000001a0 22 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00
  165. 00000000000001b0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  166. 00000000000001c0 40 00 01 00 00 08 00 00 08 00 00 00 00 00 00 00
  167. 00000000000001d0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  168. 00000000000001e0 41 00 01 00 00 08 00 00 00 00 00 00 00 00 00 00
  169. 00000000000001f0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  170. 0000000000000200 42 00 01 00 00 08 00 00 00 00 00 00 00 00 00 00
  171. 0000000000000210 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  172. $ devlink region delete pci/0000:01:00.0/device-caps snapshot 1