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