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