networking/devlink/ice.rst

1 .. SPDX-License-Identifier: GPL-2.0
13 .. list-table:: Generic parameters implemented
15    * - Name
16      - Mode
17      - Notes
18    * - ``enable_roce``
19      - runtime
20      - mutually exclusive with ``enable_iwarp``
21    * - ``enable_iwarp``
22      - runtime
23      - mutually exclusive with ``enable_roce``
30 .. list-table:: devlink info versions implemented
33     * - Name
34       - Type
35       - Example
36       - Description
37     * - ``board.id``
38       - fixed
39       - K65390-000
40       - The Product Board Assembly (PBA) identifier of the board.
41     * - ``fw.mgmt``
42       - running
43       - 2.1.7
44       - 3-digit version number of the management firmware running on the
48     * - ``fw.mgmt.api``
49       - running
50       - 1.5.1
51       - 3-digit version number (major.minor.patch) of the API exported over
54         kernel only displayed a 2-digit version number (major.minor).
55     * - ``fw.mgmt.build``
56       - running
57       - 0x305d955f
58       - Unique identifier of the source for the management firmware.
59     * - ``fw.undi``
60       - running
61       - 1.2581.0
62       - Version of the Option ROM containing the UEFI driver. The version is
63         reported in ``major.minor.patch`` format. The major version is
65         minor version would overflow. The minor version is incremented for
66         non-breaking changes and reset to 1 when the major version is
67         incremented. The patch version is normally 0 but is incremented when
69     * - ``fw.psid.api``
70       - running
71       - 0.80
72       - Version defining the format of the flash contents.
73     * - ``fw.bundle_id``
74       - running
75       - 0x80002ec0
76       - Unique identifier of the firmware image file that was loaded onto
78     * - ``fw.app.name``
79       - running
80       - ICE OS Default Package
81       - The name of the DDP package that is active in the device. The DDP
84     * - ``fw.app``
85       - running
86       - 1.3.1.0
87       - The version of the DDP package that is active in the device. Note
88         that both the name (as reported by ``fw.app.name``) and version are
90     * - ``fw.app.bundle_id``
91       - running
92       - 0xc0000001
93       - Unique identifier for the DDP package loaded in the device. Also
96     * - ``fw.netlist``
97       - running
98       - 1.1.2000-6.7.0
99       - The version of the netlist module. This module defines the device's
103     * - ``fw.netlist.build``
104       - running
105       - 0xee16ced7
106       - The first 4 bytes of the hash of the netlist module contents.
112 ``devlink-flash`` interface. It supports updating the device flash using a
116 .. list-table:: List of supported overwrite modes
119    * - Bits
120      - Behavior
121    * - ``DEVLINK_FLASH_OVERWRITE_SETTINGS``
122      - Do not preserve settings stored in the flash components being
126    * - ``DEVLINK_FLASH_OVERWRITE_SETTINGS`` and ``DEVLINK_FLASH_OVERWRITE_IDENTIFIERS``
127      - Do not preserve either settings or identifiers. Overwrite everything
179     ice 0000:16:00.0: Active  2     100   -   -   - 100   -   -   -
180     ice 0000:16:00.0:         2      50   -  50   -   -   -   -   -
181     ice 0000:16:00.0: Pending 4      25  25  25  25   -   -   -   -
182     ice 0000:16:00.0:         4      25  25   -   -  25  25   -   -
184     ice 0000:16:00.0:         1     100   -   -   -   -   -   -   -
199 .. list-table:: regions implemented
202     * - Name
203       - Description
204     * - ``nvm-flash``
205       - The contents of the entire flash chip, sometimes referred to as
207     * - ``shadow-ram``
208       - The contents of the Shadow RAM, which is loaded from the beginning
212     * - ``device-caps``
213       - The contents of the device firmware's capabilities buffer. Useful to
216 Both the ``nvm-flash`` and ``shadow-ram`` regions can be accessed without a
217 snapshot. The ``device-caps`` region requires a snapshot as the contents are
226     pci/0000:01:00.0/nvm-flash: size 10485760 snapshot [] max 1
227     pci/0000:01:00.0/device-caps: size 4096 snapshot [] max 10
229     $ devlink region new pci/0000:01:00.0/nvm-flash snapshot 1
230     $ devlink region dump pci/0000:01:00.0/nvm-flash snapshot 1
232     $ devlink region dump pci/0000:01:00.0/nvm-flash snapshot 1
238     $ devlink region read pci/0000:01:00.0/nvm-flash snapshot 1 address 0 length 16
241     $ devlink region delete pci/0000:01:00.0/nvm-flash snapshot 1
243     $ devlink region new pci/0000:01:00.0/device-caps snapshot 1
244     $ devlink region dump pci/0000:01:00.0/device-caps snapshot 1
280     $ devlink region delete pci/0000:01:00.0/device-caps snapshot 1
285 The ``ice`` driver implements devlink-rate API. It allows for offload of
288 tx_max, tx_priority and tx_weight to each node in a tree. So effectively
296 devlink-rate API. To configure those features a driver reload is necessary.
303 It's required because devlink-rate requires devlink-port objects to be
308 represented by the node_0. This node can't be deleted by the user. Leaf
311 .. list-table:: Attributes supported
314     * - Name
315       - Description
316     * - ``tx_max``
317       - maximum bandwidth to be consumed by the tree Node. Rate Limit is
318         an absolute number specifying a maximum amount of bytes a Node may
323     * - ``tx_share``
324       - minimum bandwidth allocated to a tree node when it is not blocked.
326         bandwidth the node may consume, the tx_share marks committed BW
327         for the Node.
328     * - ``tx_priority``
329       - allows for usage of strict priority arbiter among siblings. This
332         Range 0-7. Nodes with priority 7 have the highest priority and are
335     * - ``tx_weight``
336       - allows for usage of Weighted Fair Queuing arbitration scheme among
338         the strict priority. Range 1-200. Only relative values matter for
354     pci/0000:4b:00.0/node_25: type node parent node_24
355     pci/0000:4b:00.0/node_24: type node parent node_0
356     pci/0000:4b:00.0/node_32: type node parent node_31
357     pci/0000:4b:00.0/node_31: type node parent node_30
358     pci/0000:4b:00.0/node_30: type node parent node_16
359     pci/0000:4b:00.0/node_19: type node parent node_18
360     pci/0000:4b:00.0/node_18: type node parent node_17
361     pci/0000:4b:00.0/node_17: type node parent node_16
362     pci/0000:4b:00.0/node_14: type node parent node_5
363     pci/0000:4b:00.0/node_5: type node parent node_3
364     pci/0000:4b:00.0/node_13: type node parent node_4
365     pci/0000:4b:00.0/node_12: type node parent node_4
366     pci/0000:4b:00.0/node_11: type node parent node_4
367     pci/0000:4b:00.0/node_10: type node parent node_4
368     pci/0000:4b:00.0/node_9: type node parent node_4
369     pci/0000:4b:00.0/node_8: type node parent node_4
370     pci/0000:4b:00.0/node_7: type node parent node_4
371     pci/0000:4b:00.0/node_6: type node parent node_4
372     pci/0000:4b:00.0/node_4: type node parent node_3
373     pci/0000:4b:00.0/node_3: type node parent node_16
374     pci/0000:4b:00.0/node_16: type node parent node_15
375     pci/0000:4b:00.0/node_15: type node parent node_0
376     pci/0000:4b:00.0/node_2: type node parent node_1
377     pci/0000:4b:00.0/node_1: type node parent node_0
378     pci/0000:4b:00.0/node_0: type node
382     # let's create some custom node
385     # second custom node