networking/devlink/ice.rst

1 .. SPDX-License-Identifier: GPL-2.0
13 .. list-table:: Generic parameters implemented
16    * - Name
17      - Mode
18      - Notes
19    * - ``enable_roce``
20      - runtime
21      - mutually exclusive with ``enable_iwarp``
22    * - ``enable_iwarp``
23      - runtime
24      - mutually exclusive with ``enable_roce``
25    * - ``tx_scheduling_layers``
26      - permanent
27      - The ice hardware uses hierarchical scheduling for Tx with a fixed
31        like DCB or devlink-rate (documented below) to configure how much
33        fine-grained control because scheduling parameters can be configured
36        The default 9-layer tree topology was deemed best for most workloads,
38        for some specific cases, this 9-layer topology might not be desired.
40        of 8. Because the maximum radix is limited to 8 in 9-layer topology,
55        To address this need, you can switch to a 5-layer topology, which
62        to change the transmit scheduler topology. To use 5-layer topology,
72 .. list-table:: Driver specific parameters implemented
75     * - Name
76       - Mode
77       - Description
78     * - ``local_forwarding``
79       - runtime
80       - Controls loopback behavior by tuning scheduler bandwidth.
85         ``enabled`` - loopback traffic is allowed on port
87         ``disabled`` - loopback traffic is not allowed on this port
89         ``prioritized`` - loopback traffic is prioritized on this port
102 .. list-table:: devlink info versions implemented
105     * - Name
106       - Type
107       - Example
108       - Description
109     * - ``board.id``
110       - fixed
111       - K65390-000
112       - The Product Board Assembly (PBA) identifier of the board.
113     * - ``cgu.id``
114       - fixed
115       - 36
116       - The Clock Generation Unit (CGU) hardware revision identifier.
117     * - ``fw.mgmt``
118       - running
119       - 2.1.7
120       - 3-digit version number of the management firmware running on the
121         Embedded Management Processor of the device. It controls the PHY,
124     * - ``fw.mgmt.api``
125       - running
126       - 1.5.1
127       - 3-digit version number (major.minor.patch) of the API exported over
130         kernel only displayed a 2-digit version number (major.minor).
131     * - ``fw.mgmt.build``
132       - running
133       - 0x305d955f
134       - Unique identifier of the source for the management firmware.
135     * - ``fw.undi``
136       - running
137       - 1.2581.0
138       - Version of the Option ROM containing the UEFI driver. The version is
142         non-breaking changes and reset to 1 when the major version is
145     * - ``fw.psid.api``
146       - running
147       - 0.80
148       - Version defining the format of the flash contents.
149     * - ``fw.bundle_id``
150       - running
151       - 0x80002ec0
152       - Unique identifier of the firmware image file that was loaded onto
154     * - ``fw.app.name``
155       - running
156       - ICE OS Default Package
157       - The name of the DDP package that is active in the device. The DDP
158         package is loaded by the driver during initialization. Each
159         variation of the DDP package has a unique name.
160     * - ``fw.app``
161       - running
162       - 1.3.1.0
163       - The version of the DDP package that is active in the device. Note
165         required to uniquely identify the package.
166     * - ``fw.app.bundle_id``
167       - running
168       - 0xc0000001
169       - Unique identifier for the DDP package loaded in the device. Also
171         the specific DDP package.
172     * - ``fw.netlist``
173       - running
174       - 1.1.2000-6.7.0
175       - The version of the netlist module. This module defines the device's
176         Ethernet capabilities and default settings, and is used by the
179     * - ``fw.netlist.build``
180       - running
181       - 0xee16ced7
182       - The first 4 bytes of the hash of the netlist module contents.
183     * - ``fw.cgu``
184       - running
185       - 8032.16973825.6021
186       - The version of Clock Generation Unit (CGU). Format:
193 ``devlink-flash`` interface. It supports updating the device flash using a
197 .. list-table:: List of supported overwrite modes
200    * - Bits
201      - Behavior
202    * - ``DEVLINK_FLASH_OVERWRITE_SETTINGS``
203      - Do not preserve settings stored in the flash components being
207    * - ``DEVLINK_FLASH_OVERWRITE_SETTINGS`` and ``DEVLINK_FLASH_OVERWRITE_IDENTIFIERS``
208      - Do not preserve either settings or identifiers. Overwrite everything
260     ice 0000:16:00.0: Active  2     100   -   -   - 100   -   -   -
261     ice 0000:16:00.0:         2      50   -  50   -   -   -   -   -
262     ice 0000:16:00.0: Pending 4      25  25  25  25   -   -   -   -
263     ice 0000:16:00.0:         4      25  25   -   -  25  25   -   -
265     ice 0000:16:00.0:         1     100   -   -   -   -   -   -   -
280 .. list-table:: regions implemented
283     * - Name
284       - Description
285     * - ``nvm-flash``
286       - The contents of the entire flash chip, sometimes referred to as
288     * - ``shadow-ram``
289       - The contents of the Shadow RAM, which is loaded from the beginning
293     * - ``device-caps``
294       - The contents of the device firmware's capabilities buffer. Useful to
297 Both the ``nvm-flash`` and ``shadow-ram`` regions can be accessed without a
298 snapshot. The ``device-caps`` region requires a snapshot as the contents are
307     pci/0000:01:00.0/nvm-flash: size 10485760 snapshot [] max 1
308     pci/0000:01:00.0/device-caps: size 4096 snapshot [] max 10
310     $ devlink region new pci/0000:01:00.0/nvm-flash snapshot 1
311     $ devlink region dump pci/0000:01:00.0/nvm-flash snapshot 1
313     $ devlink region dump pci/0000:01:00.0/nvm-flash snapshot 1
319     $ devlink region read pci/0000:01:00.0/nvm-flash snapshot 1 address 0 length 16
322     $ devlink region delete pci/0000:01:00.0/nvm-flash snapshot 1
324     $ devlink region new pci/0000:01:00.0/device-caps snapshot 1
325     $ devlink region dump pci/0000:01:00.0/device-caps snapshot 1
361     $ devlink region delete pci/0000:01:00.0/device-caps snapshot 1
366 The ``ice`` driver implements devlink-rate API. It allows for offload of
377 devlink-rate API. To configure those features a driver reload is necessary.
384 It's required because devlink-rate requires devlink-port objects to be
392 .. list-table:: Attributes supported
395     * - Name
396       - Description
397     * - ``tx_max``
398       - maximum bandwidth to be consumed by the tree Node. Rate Limit is
404     * - ``tx_share``
405       - minimum bandwidth allocated to a tree node when it is not blocked.
409     * - ``tx_priority``
410       - allows for usage of strict priority arbiter among siblings. This
413         Range 0-7. Nodes with priority 7 have the highest priority and are
416     * - ``tx_weight``
417       - allows for usage of Weighted Fair Queuing arbitration scheme among
419         the strict priority. Range 1-200. Only relative values matter for