sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget*/translations/zh_CN/networking/devlink/icemodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/zh_TW/networking/devlink/icemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/it_IT/networking/devlink/icemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/ja_JP/networking/devlink/icemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/ko_KR/networking/devlink/icemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/pt_BR/networking/devlink/icemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/sp_SP/networking/devlink/icemodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h SPDX-License-Identifier: GPL-2.0h]h SPDX-License-Identifier: GPL-2.0}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhD/var/lib/git/docbuild/linux/Documentation/networking/devlink/ice.rsthKubhsection)}(hhh](htitle)}(hice devlink supporth]hice devlink support}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(hVThis document describes the devlink features implemented by the ``ice`` device driver.h](h@This document describes the devlink features implemented by the }(hhhhhNhNubhliteral)}(h``ice``h]hice}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhubh device driver.}(hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hhh](h)}(h Parametersh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK ubhtable)}(hhh](h)}(hGeneric parameters implementedh]hGeneric parameters implemented}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hjubhtgroup)}(hhh](hcolspec)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1j*hj'ubj+)}(hhh]h}(h]h ]h"]h$]h&]j5Kuh1j*hj'ubj+)}(hhh]h}(h]h ]h"]h$]h&]j5KZuh1j*hj'ubhtbody)}(hhh](hrow)}(hhh](hentry)}(hhh]h)}(hNameh]hName}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjTubah}(h]h ]h"]h$]h&]uh1jRhjOubjS)}(hhh]h)}(hModeh]hMode}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjkubah}(h]h ]h"]h$]h&]uh1jRhjOubjS)}(hhh]h)}(hNotesh]hNotes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jRhjOubeh}(h]h ]h"]h$]h&]uh1jMhjJubjN)}(hhh](jS)}(hhh]h)}(h``enable_roce``h]h)}(hjh]h enable_roce}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(hruntimeh]hruntime}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(h(mutually exclusive with ``enable_iwarp``h](hmutually exclusive with }(hjhhhNhNubh)}(h``enable_iwarp``h]h enable_iwarp}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjJubjN)}(hhh](jS)}(hhh]h)}(h``enable_iwarp``h]h)}(hj h]h enable_iwarp}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(hruntimeh]hruntime}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj'ubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(h'mutually exclusive with ``enable_roce``h](hmutually exclusive with }(hjAhhhNhNubh)}(h``enable_roce``h]h enable_roce}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjAubeh}(h]h ]h"]h$]h&]uh1hhhhKhj>ubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjJubjN)}(hhh](jS)}(hhh]h)}(h``tx_scheduling_layers``h]h)}(hjqh]htx_scheduling_layers}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhjoubah}(h]h ]h"]h$]h&]uh1hhhhKhjlubah}(h]h ]h"]h$]h&]uh1jRhjiubjS)}(hhh]h)}(h permanenth]h permanent}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jRhjiubjS)}(hhh](h)}(hXThe ice hardware uses hierarchical scheduling for Tx with a fixed number of layers in the scheduling tree. Each of them are decision points. Root node represents a port, while all the leaves represent the queues. This way of configuring the Tx scheduler allows features like DCB or devlink-rate (documented below) to configure how much bandwidth is given to any given queue or group of queues, enabling fine-grained control because scheduling parameters can be configured at any given layer of the tree.h]hXThe ice hardware uses hierarchical scheduling for Tx with a fixed number of layers in the scheduling tree. Each of them are decision points. Root node represents a port, while all the leaves represent the queues. This way of configuring the Tx scheduler allows features like DCB or devlink-rate (documented below) to configure how much bandwidth is given to any given queue or group of queues, enabling fine-grained control because scheduling parameters can be configured at any given layer of the tree.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hXThe default 9-layer tree topology was deemed best for most workloads, as it gives an optimal ratio of performance to configurability. However, for some specific cases, this 9-layer topology might not be desired. One example would be sending traffic to queues that are not a multiple of 8. Because the maximum radix is limited to 8 in 9-layer topology, the 9th queue has a different parent than the rest, and it's given more bandwidth credits. This causes a problem when the system is sending traffic to 9 queues:h]hXThe default 9-layer tree topology was deemed best for most workloads, as it gives an optimal ratio of performance to configurability. However, for some specific cases, this 9-layer topology might not be desired. One example would be sending traffic to queues that are not a multiple of 8. Because the maximum radix is limited to 8 in 9-layer topology, the 9th queue has a different parent than the rest, and it’s given more bandwidth credits. This causes a problem when the system is sending traffic to 9 queues:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK$hjubh line_block)}(hhh](hh)}(htx_queue_0_packets: 24163396h]htx_queue_0_packets: 24163396}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hindentKhjhhhKubj)}(htx_queue_1_packets: 24164623h]htx_queue_1_packets: 24164623}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hjKhjhhhKubj)}(htx_queue_2_packets: 24163188h]htx_queue_2_packets: 24163188}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hjKhjhhhKubj)}(htx_queue_3_packets: 24163701h]htx_queue_3_packets: 24163701}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hjKhjhhhKubj)}(htx_queue_4_packets: 24163683h]htx_queue_4_packets: 24163683}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hjKhjhhhKubj)}(htx_queue_5_packets: 24164668h]htx_queue_5_packets: 24164668}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hjKhjhhhKubj)}(htx_queue_6_packets: 23327200h]htx_queue_6_packets: 23327200}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hjKhjhhhKubj)}(htx_queue_7_packets: 24163853h]htx_queue_7_packets: 24163853}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hjKhjhhhKubj)}(h@tx_queue_8_packets: 91101417 < Too much traffic is sent from 9thh]h@tx_queue_8_packets: 91101417 < Too much traffic is sent from 9th}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hjKhjhhhKubeh}(h]h ]h"]h$]h&]uh1jhjubh)}(hX;To address this need, you can switch to a 5-layer topology, which changes the maximum topology radix to 512. With this enhancement, the performance characteristic is equal as all queues can be assigned to the same parent in the tree. The obvious drawback of this solution is a lower configuration depth of the tree.h]hX;To address this need, you can switch to a 5-layer topology, which changes the maximum topology radix to 512. With this enhancement, the performance characteristic is equal as all queues can be assigned to the same parent in the tree. The obvious drawback of this solution is a lower configuration depth of the tree.}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK7hjubh)}(hX6Use the ``tx_scheduling_layer`` parameter with the devlink command to change the transmit scheduler topology. To use 5-layer topology, use a value of 5. For example: $ devlink dev param set pci/0000:16:00.0 name tx_scheduling_layers value 5 cmode permanent Use a value of 9 to set it back to the default value.h](hUse the }(hj[hhhNhNubh)}(h``tx_scheduling_layer``h]htx_scheduling_layer}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[ubhX parameter with the devlink command to change the transmit scheduler topology. To use 5-layer topology, use a value of 5. For example: $ devlink dev param set pci/0000:16:00.0 name tx_scheduling_layers value 5 cmode permanent Use a value of 9 to set it back to the default value.}(hj[hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK=hjubh)}(hIYou must do PCI slot powercycle for the selected topology to take effect.h]hIYou must do PCI slot powercycle for the selected topology to take effect.}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKDhjubh)}(hfTo verify that value has been set: $ devlink dev param show pci/0000:16:00.0 name tx_scheduling_layersh]hfTo verify that value has been set: $ devlink dev param show pci/0000:16:00.0 name tx_scheduling_layers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKFhjubeh}(h]h ]h"]h$]h&]uh1jRhjiubeh}(h]h ]h"]h$]h&]uh1jMhjJubjN)}(hhh](jS)}(hhh]h)}(h``msix_vec_per_pf_max``h]h)}(hjh]hmsix_vec_per_pf_max}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKHhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(h driverinith]h driverinit}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKIhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(hSet the max MSI-X that can be used by the PF, rest can be utilized for SRIOV. The range is from min value set in msix_vec_per_pf_min to 2k/number of ports.h]hSet the max MSI-X that can be used by the PF, rest can be utilized for SRIOV. The range is from min value set in msix_vec_per_pf_min to 2k/number of ports.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKJhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjJubjN)}(hhh](jS)}(hhh]h)}(h``msix_vec_per_pf_min``h]h)}(hjh]hmsix_vec_per_pf_min}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKMhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(h driverinith]h driverinit}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKNhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(hSet the min MSI-X that will be used by the PF. This value inform how many MSI-X will be allocated statically. The range is from 2 to value set in msix_vec_per_pf_max.h]hSet the min MSI-X that will be used by the PF. This value inform how many MSI-X will be allocated statically. The range is from 2 to value set in msix_vec_per_pf_max.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKOhj4ubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjJubeh}(h]h ]h"]h$]h&]uh1jHhj'ubeh}(h]h ]h"]h$]h&]colsKuh1j%hjubeh}(h]id1ah ]colwidths-givenah"]h$]h&]uh1jhjhhhNhNubj)}(hhh](h)}(h&Driver specific parameters implementedh]h&Driver specific parameters implemented}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKShjfubj&)}(hhh](j+)}(hhh]h}(h]h ]h"]h$]h&]j5Kuh1j*hjwubj+)}(hhh]h}(h]h ]h"]h$]h&]j5Kuh1j*hjwubj+)}(hhh]h}(h]h ]h"]h$]h&]j5KZuh1j*hjwubjI)}(hhh](jN)}(hhh](jS)}(hhh]h)}(hNameh]hName}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKVhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(hModeh]hMode}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKWhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(h Descriptionh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKXhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjubjN)}(hhh](jS)}(hhh]h)}(h``local_forwarding``h]h)}(hjh]hlocal_forwarding}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKYhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(hruntimeh]hruntime}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKZhj ubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh](h)}(hControls loopback behavior by tuning scheduler bandwidth. It impacts all kinds of functions: physical, virtual and subfunctions. Supported values are:h]hControls loopback behavior by tuning scheduler bandwidth. It impacts all kinds of functions: physical, virtual and subfunctions. Supported values are:}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK[hj ubh)}(h1``enabled`` - loopback traffic is allowed on porth](h)}(h ``enabled``h]henabled}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj1ubh& - loopback traffic is allowed on port}(hj1hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK`hj ubh)}(h;``disabled`` - loopback traffic is not allowed on this porth](h)}(h ``disabled``h]hdisabled}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjMubh/ - loopback traffic is not allowed on this port}(hjMhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKbhj ubh)}(h>``prioritized`` - loopback traffic is prioritized on this porth](h)}(h``prioritized``h]h prioritized}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjiubh/ - loopback traffic is prioritized on this port}(hjihhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKdhj ubh)}(hX/Default value of ``local_forwarding`` parameter is ``enabled``. ``prioritized`` provides ability to adjust loopback traffic rate to increase one port capacity at cost of the another. User needs to disable local forwarding on one of the ports in order have increased capacity on the ``prioritized`` port.h](hDefault value of }(hjhhhNhNubh)}(h``local_forwarding``h]hlocal_forwarding}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh parameter is }(hjhhhNhNubh)}(h ``enabled``h]henabled}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh. }(hjhhhNhNubh)}(h``prioritized``h]h prioritized}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh provides ability to adjust loopback traffic rate to increase one port capacity at cost of the another. User needs to disable local forwarding on one of the ports in order have increased capacity on the }(hjhhhNhNubh)}(h``prioritized``h]h prioritized}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh port.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKfhj ubeh}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjubeh}(h]h ]h"]h$]h&]uh1jHhjwubeh}(h]h ]h"]h$]h&]colsKuh1j%hjfubeh}(h]id2ah ]jbah"]h$]h&]uh1jhjhhhNhNubeh}(h] parametersah ]h"] parametersah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(h Info versionsh]h Info versions}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKmubh)}(h1The ``ice`` driver reports the following versionsh](hThe }(hjhhhNhNubh)}(h``ice``h]hice}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh& driver reports the following versions}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKohjhhubj)}(hhh](h)}(h!devlink info versions implementedh]h!devlink info versions implemented}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKqhj4ubj&)}(hhh](j+)}(hhh]h}(h]h ]h"]h$]h&]j5Kuh1j*hjEubj+)}(hhh]h}(h]h ]h"]h$]h&]j5Kuh1j*hjEubj+)}(hhh]h}(h]h ]h"]h$]h&]j5Kuh1j*hjEubj+)}(hhh]h}(h]h ]h"]h$]h&]j5KZuh1j*hjEubjI)}(hhh](jN)}(hhh](jS)}(hhh]h)}(hNameh]hName}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKthjrubah}(h]h ]h"]h$]h&]uh1jRhjoubjS)}(hhh]h)}(hTypeh]hType}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKuhjubah}(h]h ]h"]h$]h&]uh1jRhjoubjS)}(hhh]h)}(hExampleh]hExample}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKvhjubah}(h]h ]h"]h$]h&]uh1jRhjoubjS)}(hhh]h)}(h Descriptionh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKwhjubah}(h]h ]h"]h$]h&]uh1jRhjoubeh}(h]h ]h"]h$]h&]uh1jMhjlubjN)}(hhh](jS)}(hhh]h)}(h ``board.id``h]h)}(hjh]hboard.id}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKxhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(hfixedh]hfixed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKyhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(h K65390-000h]h K65390-000}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKzhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(h9The Product Board Assembly (PBA) identifier of the board.h]h9The Product Board Assembly (PBA) identifier of the board.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK{hj%ubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjlubjN)}(hhh](jS)}(hhh]h)}(h ``cgu.id``h]h)}(hjJh]hcgu.id}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjHubah}(h]h ]h"]h$]h&]uh1hhhhK|hjEubah}(h]h ]h"]h$]h&]uh1jRhjBubjS)}(hhh]h)}(hfixedh]hfixed}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK}hjeubah}(h]h ]h"]h$]h&]uh1jRhjBubjS)}(hhh]h)}(h36h]h36}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK~hj|ubah}(h]h ]h"]h$]h&]uh1jRhjBubjS)}(hhh]h)}(h=The Clock Generation Unit (CGU) hardware revision identifier.h]h=The Clock Generation Unit (CGU) hardware revision identifier.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jRhjBubeh}(h]h ]h"]h$]h&]uh1jMhjlubjN)}(hhh](jS)}(hhh]h)}(h ``fw.mgmt``h]h)}(hjh]hfw.mgmt}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(hrunningh]hrunning}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(h2.1.7h]h2.1.7}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(h3-digit version number of the management firmware running on the Embedded Management Processor of the device. It controls the PHY, link, access to device resources, etc. Intel documentation refers to this as the EMP firmware.h]h3-digit version number of the management firmware running on the Embedded Management Processor of the device. It controls the PHY, link, access to device resources, etc. Intel documentation refers to this as the EMP firmware.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjlubjN)}(hhh](jS)}(hhh]h)}(h``fw.mgmt.api``h]h)}(hj&h]h fw.mgmt.api}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$ubah}(h]h ]h"]h$]h&]uh1hhhhKhj!ubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(hrunningh]hrunning}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjAubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(h1.5.1h]h1.5.1}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjXubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(h3-digit version number (major.minor.patch) of the API exported over the AdminQ by the management firmware. Used by the driver to identify what commands are supported. Historical versions of the kernel only displayed a 2-digit version number (major.minor).h]h3-digit version number (major.minor.patch) of the API exported over the AdminQ by the management firmware. Used by the driver to identify what commands are supported. Historical versions of the kernel only displayed a 2-digit version number (major.minor).}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjoubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjlubjN)}(hhh](jS)}(hhh]h)}(h``fw.mgmt.build``h]h)}(hjh]h fw.mgmt.build}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(hrunningh]hrunning}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(h 0x305d955fh]h 0x305d955f}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(h...h]hjThe version of Clock Generation Unit (CGU). Format: ...}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jRhj ubeh}(h]h ]h"]h$]h&]uh1jMhjlubeh}(h]h ]h"]h$]h&]uh1jHhjEubeh}(h]h ]h"]h$]h&]colsKuh1j%hj4ubeh}(h]id3ah ]jbah"]h$]h&]uh1jhjhhhNhNubeh}(h] info-versionsah ]h"] info versionsah$]h&]uh1hhhhhhhhKmubh)}(hhh](h)}(h Flash Updateh]h Flash Update}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhKubh)}(hThe ``ice`` driver implements support for flash update using the ``devlink-flash`` interface. It supports updating the device flash using a combined flash image that contains the ``fw.mgmt``, ``fw.undi``, and ``fw.netlist`` components.h](hThe }(hj) hhhNhNubh)}(h``ice``h]hice}(hj1 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj) ubh6 driver implements support for flash update using the }(hj) hhhNhNubh)}(h``devlink-flash``h]h devlink-flash}(hjC hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj) ubha interface. It supports updating the device flash using a combined flash image that contains the }(hj) hhhNhNubh)}(h ``fw.mgmt``h]hfw.mgmt}(hjU hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj) ubh, }(hj) hhhNhNubh)}(h ``fw.undi``h]hfw.undi}(hjg hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj) ubh, and }(hj) hhhNhNubh)}(h``fw.netlist``h]h fw.netlist}(hjy hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj) ubh components.}(hj) hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj hhubj)}(hhh](h)}(h!List of supported overwrite modesh]h!List of supported overwrite modes}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubj&)}(hhh](j+)}(hhh]h}(h]h ]h"]h$]h&]j5Kuh1j*hj ubj+)}(hhh]h}(h]h ]h"]h$]h&]j5K_uh1j*hj ubjI)}(hhh](jN)}(hhh](jS)}(hhh]h)}(hBitsh]hBits}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jRhj ubjS)}(hhh]h)}(hBehaviorh]hBehavior}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jRhj ubeh}(h]h ]h"]h$]h&]uh1jMhj ubjN)}(hhh](jS)}(hhh]h)}(h$``DEVLINK_FLASH_OVERWRITE_SETTINGS``h]h)}(hj h]h DEVLINK_FLASH_OVERWRITE_SETTINGS}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jRhj ubjS)}(hhh]h)}(hDo not preserve settings stored in the flash components being updated. This includes overwriting the port configuration that determines the number of physical functions the device will initialize with.h]hDo not preserve settings stored in the flash components being updated. This includes overwriting the port configuration that determines the number of physical functions the device will initialize with.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jRhj ubeh}(h]h ]h"]h$]h&]uh1jMhj ubjN)}(hhh](jS)}(hhh]h)}(hP``DEVLINK_FLASH_OVERWRITE_SETTINGS`` and ``DEVLINK_FLASH_OVERWRITE_IDENTIFIERS``h](h)}(h$``DEVLINK_FLASH_OVERWRITE_SETTINGS``h]h DEVLINK_FLASH_OVERWRITE_SETTINGS}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7ubh and }(hj7hhhNhNubh)}(h'``DEVLINK_FLASH_OVERWRITE_IDENTIFIERS``h]h#DEVLINK_FLASH_OVERWRITE_IDENTIFIERS}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7ubeh}(h]h ]h"]h$]h&]uh1hhhhKhj4ubah}(h]h ]h"]h$]h&]uh1jRhj1ubjS)}(hhh]h)}(hXqDo not preserve either settings or identifiers. Overwrite everything in the flash with the contents from the provided image, without performing any preservation. This includes overwriting device identifying fields such as the MAC address, VPD area, and device serial number. It is expected that this combination be used with an image customized for the specific device.h]hXqDo not preserve either settings or identifiers. Overwrite everything in the flash with the contents from the provided image, without performing any preservation. This includes overwriting device identifying fields such as the MAC address, VPD area, and device serial number. It is expected that this combination be used with an image customized for the specific device.}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjgubah}(h]h ]h"]h$]h&]uh1jRhj1ubeh}(h]h ]h"]h$]h&]uh1jMhj ubeh}(h]h ]h"]h$]h&]uh1jHhj ubeh}(h]h ]h"]h$]h&]colsKuh1j%hj ubeh}(h]id4ah ]jbah"]h$]h&]uh1jhj hhhNhNubh)}(hX(The ice hardware does not support overwriting only identifiers while preserving settings, and thus ``DEVLINK_FLASH_OVERWRITE_IDENTIFIERS`` on its own will be rejected. If no overwrite mask is provided, the firmware will be instructed to preserve all settings and identifying fields when updating.h](hcThe ice hardware does not support overwriting only identifiers while preserving settings, and thus }(hjhhhNhNubh)}(h'``DEVLINK_FLASH_OVERWRITE_IDENTIFIERS``h]h#DEVLINK_FLASH_OVERWRITE_IDENTIFIERS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh on its own will be rejected. If no overwrite mask is provided, the firmware will be instructed to preserve all settings and identifying fields when updating.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj hhubeh}(h] flash-updateah ]h"] flash updateah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hReloadh]hReload}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hThe ``ice`` driver supports activating new firmware after a flash update using ``DEVLINK_CMD_RELOAD`` with the ``DEVLINK_RELOAD_ACTION_FW_ACTIVATE`` action.h](hThe }(hjhhhNhNubh)}(h``ice``h]hice}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubhD driver supports activating new firmware after a flash update using }(hjhhhNhNubh)}(h``DEVLINK_CMD_RELOAD``h]hDEVLINK_CMD_RELOAD}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh with the }(hjhhhNhNubh)}(h%``DEVLINK_RELOAD_ACTION_FW_ACTIVATE``h]h!DEVLINK_RELOAD_ACTION_FW_ACTIVATE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh action.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh literal_block)}(h?$ devlink dev reload pci/0000:01:00.0 reload action fw_activateh]h?$ devlink dev reload pci/0000:01:00.0 reload action fw_activate}hjsbah}(h]h ]h"]h$]h&]forcehighlight_args}hhƌlanguageshelluh1jhhhKhjhhubh)}(hThe new firmware is activated by issuing a device specific Embedded Management Processor reset which requests the device to reset and reload the EMP firmware image.h]hThe new firmware is activated by issuing a device specific Embedded Management Processor reset which requests the device to reset and reload the EMP firmware image.}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hgThe driver does not currently support reloading the driver via ``DEVLINK_RELOAD_ACTION_DRIVER_REINIT``.h](h?The driver does not currently support reloading the driver via }(hj8hhhNhNubh)}(h'``DEVLINK_RELOAD_ACTION_DRIVER_REINIT``h]h#DEVLINK_RELOAD_ACTION_DRIVER_REINIT}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj8ubh.}(hj8hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h]reloadah ]h"]reloadah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Port splith]h Port split}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhj`hhhhhKubh)}(hThe ``ice`` driver supports port splitting only for port 0, as the FW has a predefined set of available port split options for the whole device.h](hThe }(hjqhhhNhNubh)}(h``ice``h]hice}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjqubh driver supports port splitting only for port 0, as the FW has a predefined set of available port split options for the whole device.}(hjqhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj`hhubh)}(h9A system reboot is required for port split to be applied.h]h9A system reboot is required for port split to be applied.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj`hhubh)}(hEThe following command will select the port split option with 4 ports:h]hEThe following command will select the port split option with 4 ports:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj`hhubj)}(h/$ devlink port split pci/0000:16:00.0/0 count 4h]h/$ devlink port split pci/0000:16:00.0/0 count 4}hjsbah}(h]h ]h"]h$]h&]forcehighlight_args}hhj(shelluh1jhhhMhj`hhubh)}(hThe list of all available port options will be printed to dynamic debug after each ``split`` and ``unsplit`` command. The first option is the default.h](hSThe list of all available port options will be printed to dynamic debug after each }(hjhhhNhNubh)}(h ``split``h]hsplit}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh and }(hjhhhNhNubh)}(h ``unsplit``h]hunsplit}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh* command. The first option is the default.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj`hhubj)}(hXFice 0000:16:00.0: Available port split options and max port speeds (Gbps): ice 0000:16:00.0: Status Split Quad 0 Quad 1 ice 0000:16:00.0: count L0 L1 L2 L3 L4 L5 L6 L7 ice 0000:16:00.0: Active 2 100 - - - 100 - - - ice 0000:16:00.0: 2 50 - 50 - - - - - ice 0000:16:00.0: Pending 4 25 25 25 25 - - - - ice 0000:16:00.0: 4 25 25 - - 25 25 - - ice 0000:16:00.0: 8 10 10 10 10 10 10 10 10 ice 0000:16:00.0: 1 100 - - - - - - -h]hXFice 0000:16:00.0: Available port split options and max port speeds (Gbps): ice 0000:16:00.0: Status Split Quad 0 Quad 1 ice 0000:16:00.0: count L0 L1 L2 L3 L4 L5 L6 L7 ice 0000:16:00.0: Active 2 100 - - - 100 - - - ice 0000:16:00.0: 2 50 - 50 - - - - - ice 0000:16:00.0: Pending 4 25 25 25 25 - - - - ice 0000:16:00.0: 4 25 25 - - 25 25 - - ice 0000:16:00.0: 8 10 10 10 10 10 10 10 10 ice 0000:16:00.0: 1 100 - - - - - - -}hjsbah}(h]h ]h"]h$]h&]forcehighlight_args}hhj(shelluh1jhhhM hj`hhubh)}(hThere could be multiple FW port options with the same port split count. When the same port split count request is issued again, the next FW port option with the same port split count will be selected.h]hThere could be multiple FW port options with the same port split count. When the same port split count request is issued again, the next FW port option with the same port split count will be selected.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj`hhubh)}(h``devlink port unsplit`` will select the option with a split count of 1. If there is no FW option available with split count 1, you will receive an error.h](h)}(h``devlink port unsplit``h]hdevlink port unsplit}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh will select the option with a split count of 1. If there is no FW option available with split count 1, you will receive an error.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj`hhubeh}(h] port-splitah ]h"] port splitah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hRegionsh]hRegions}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5hhhhhMubh)}(hWThe ``ice`` driver implements the following regions for accessing internal device data.h](hThe }(hjFhhhNhNubh)}(h``ice``h]hice}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFubhL driver implements the following regions for accessing internal device data.}(hjFhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM hj5hhubj)}(hhh](h)}(hregions implementedh]hregions implemented}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM#hjfubj&)}(hhh](j+)}(hhh]h}(h]h ]h"]h$]h&]j5Kuh1j*hjwubj+)}(hhh]h}(h]h ]h"]h$]h&]j5KUuh1j*hjwubjI)}(hhh](jN)}(hhh](jS)}(hhh]h)}(hNameh]hName}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM&hjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(h Descriptionh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM'hjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjubjN)}(hhh](jS)}(hhh]h)}(h ``nvm-flash``h]h)}(hjh]h nvm-flash}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhM(hjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(haThe contents of the entire flash chip, sometimes referred to as the device's Non Volatile Memory.h]hcThe contents of the entire flash chip, sometimes referred to as the device’s Non Volatile Memory.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM)hjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjubjN)}(hhh](jS)}(hhh]h)}(h``shadow-ram``h]h)}(hjh]h shadow-ram}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1hhhhM+hj ubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(hThe contents of the Shadow RAM, which is loaded from the beginning of the flash. Although the contents are primarily from the flash, this area also contains data generated during device boot which is not stored in flash.h]hThe contents of the Shadow RAM, which is loaded from the beginning of the flash. Although the contents are primarily from the flash, this area also contains data generated during device boot which is not stored in flash.}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM,hj)ubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjubjN)}(hhh](jS)}(hhh]h)}(h``device-caps``h]h)}(hjNh]h device-caps}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjLubah}(h]h ]h"]h$]h&]uh1hhhhM0hjIubah}(h]h ]h"]h$]h&]uh1jRhjFubjS)}(hhh]h)}(hThe contents of the device firmware's capabilities buffer. Useful to determine the current state and configuration of the device.h]hThe contents of the device firmware’s capabilities buffer. Useful to determine the current state and configuration of the device.}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM1hjiubah}(h]h ]h"]h$]h&]uh1jRhjFubeh}(h]h ]h"]h$]h&]uh1jMhjubeh}(h]h ]h"]h$]h&]uh1jHhjwubeh}(h]h ]h"]h$]h&]colsKuh1j%hjfubeh}(h]id5ah ]jbah"]h$]h&]uh1jhj5hhhNhNubh)}(hBoth the ``nvm-flash`` and ``shadow-ram`` regions can be accessed without a snapshot. The ``device-caps`` region requires a snapshot as the contents are sent by firmware and can't be split into separate reads.h](h Both the }(hjhhhNhNubh)}(h ``nvm-flash``h]h nvm-flash}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh and }(hjhhhNhNubh)}(h``shadow-ram``h]h shadow-ram}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh1 regions can be accessed without a snapshot. The }(hjhhhNhNubh)}(h``device-caps``h]h device-caps}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubhj region requires a snapshot as the contents are sent by firmware and can’t be split into separate reads.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM4hj5hhubh)}(hvUsers can request an immediate capture of a snapshot for all three regions via the ``DEVLINK_CMD_REGION_NEW`` command.h](hSUsers can request an immediate capture of a snapshot for all three regions via the }(hjhhhNhNubh)}(h``DEVLINK_CMD_REGION_NEW``h]hDEVLINK_CMD_REGION_NEW}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh command.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM8hj5hhubj)}(hXM $ devlink region show pci/0000:01:00.0/nvm-flash: size 10485760 snapshot [] max 1 pci/0000:01:00.0/device-caps: size 4096 snapshot [] max 10 $ devlink region new pci/0000:01:00.0/nvm-flash snapshot 1 $ devlink region dump pci/0000:01:00.0/nvm-flash snapshot 1 $ devlink region dump pci/0000:01:00.0/nvm-flash snapshot 1 0000000000000000 0014 95dc 0014 9514 0035 1670 0034 db30 0000000000000010 0000 0000 ffff ff04 0029 8c00 0028 8cc8 0000000000000020 0016 0bb8 0016 1720 0000 0000 c00f 3ffc 0000000000000030 bada cce5 bada cce5 bada cce5 bada cce5 $ devlink region read pci/0000:01:00.0/nvm-flash snapshot 1 address 0 length 16 0000000000000000 0014 95dc 0014 9514 0035 1670 0034 db30 $ devlink region delete pci/0000:01:00.0/nvm-flash snapshot 1 $ devlink region new pci/0000:01:00.0/device-caps snapshot 1 $ devlink region dump pci/0000:01:00.0/device-caps snapshot 1 0000000000000000 01 00 01 00 00 00 00 00 01 00 00 00 00 00 00 00 0000000000000010 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000020 02 00 02 01 32 03 00 00 0a 00 00 00 25 00 00 00 0000000000000030 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000040 04 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00 0000000000000050 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000060 05 00 01 00 03 00 00 00 00 00 00 00 00 00 00 00 0000000000000070 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000080 06 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00 0000000000000090 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00000000000000a0 08 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00000000000000b0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00000000000000c0 12 00 01 00 01 00 00 00 01 00 01 00 00 00 00 00 00000000000000d0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00000000000000e0 13 00 01 00 00 01 00 00 00 00 00 00 00 00 00 00 00000000000000f0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000100 14 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00 0000000000000110 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000120 15 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00 0000000000000130 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000140 16 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00 0000000000000150 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000160 17 00 01 00 06 00 00 00 00 00 00 00 00 00 00 00 0000000000000170 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000180 18 00 01 00 01 00 00 00 01 00 00 00 08 00 00 00 0000000000000190 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00000000000001a0 22 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00 00000000000001b0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00000000000001c0 40 00 01 00 00 08 00 00 08 00 00 00 00 00 00 00 00000000000001d0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00000000000001e0 41 00 01 00 00 08 00 00 00 00 00 00 00 00 00 00 00000000000001f0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000200 42 00 01 00 00 08 00 00 00 00 00 00 00 00 00 00 0000000000000210 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 $ devlink region delete pci/0000:01:00.0/device-caps snapshot 1h]hXM $ devlink region show pci/0000:01:00.0/nvm-flash: size 10485760 snapshot [] max 1 pci/0000:01:00.0/device-caps: size 4096 snapshot [] max 10 $ devlink region new pci/0000:01:00.0/nvm-flash snapshot 1 $ devlink region dump pci/0000:01:00.0/nvm-flash snapshot 1 $ devlink region dump pci/0000:01:00.0/nvm-flash snapshot 1 0000000000000000 0014 95dc 0014 9514 0035 1670 0034 db30 0000000000000010 0000 0000 ffff ff04 0029 8c00 0028 8cc8 0000000000000020 0016 0bb8 0016 1720 0000 0000 c00f 3ffc 0000000000000030 bada cce5 bada cce5 bada cce5 bada cce5 $ devlink region read pci/0000:01:00.0/nvm-flash snapshot 1 address 0 length 16 0000000000000000 0014 95dc 0014 9514 0035 1670 0034 db30 $ devlink region delete pci/0000:01:00.0/nvm-flash snapshot 1 $ devlink region new pci/0000:01:00.0/device-caps snapshot 1 $ devlink region dump pci/0000:01:00.0/device-caps snapshot 1 0000000000000000 01 00 01 00 00 00 00 00 01 00 00 00 00 00 00 00 0000000000000010 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000020 02 00 02 01 32 03 00 00 0a 00 00 00 25 00 00 00 0000000000000030 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000040 04 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00 0000000000000050 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000060 05 00 01 00 03 00 00 00 00 00 00 00 00 00 00 00 0000000000000070 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000080 06 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00 0000000000000090 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00000000000000a0 08 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00000000000000b0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00000000000000c0 12 00 01 00 01 00 00 00 01 00 01 00 00 00 00 00 00000000000000d0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00000000000000e0 13 00 01 00 00 01 00 00 00 00 00 00 00 00 00 00 00000000000000f0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000100 14 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00 0000000000000110 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000120 15 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00 0000000000000130 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000140 16 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00 0000000000000150 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000160 17 00 01 00 06 00 00 00 00 00 00 00 00 00 00 00 0000000000000170 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000180 18 00 01 00 01 00 00 00 01 00 00 00 08 00 00 00 0000000000000190 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00000000000001a0 22 00 01 00 01 00 00 00 00 00 00 00 00 00 00 00 00000000000001b0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00000000000001c0 40 00 01 00 00 08 00 00 08 00 00 00 00 00 00 00 00000000000001d0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00000000000001e0 41 00 01 00 00 08 00 00 00 00 00 00 00 00 00 00 00000000000001f0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 0000000000000200 42 00 01 00 00 08 00 00 00 00 00 00 00 00 00 00 0000000000000210 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 $ devlink region delete pci/0000:01:00.0/device-caps snapshot 1}hjsbah}(h]h ]h"]h$]h&]forcehighlight_args}hhj(shelluh1jhhhM;hj5hhubeh}(h]regionsah ]h"]regionsah$]h&]uh1hhhhhhhhMubh)}(hhh](h)}(h Devlink Rateh]h Devlink Rate}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMwubh)}(hXThe ``ice`` driver implements devlink-rate API. It allows for offload of the Hierarchical QoS to the hardware. It enables user to group Virtual Functions in a tree structure and assign supported parameters: tx_share, tx_max, tx_priority and tx_weight to each node in a tree. So effectively user gains an ability to control how much bandwidth is allocated for each VF group. This is later enforced by the HW.h](hThe }(hj)hhhNhNubh)}(h``ice``h]hice}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj)ubhX driver implements devlink-rate API. It allows for offload of the Hierarchical QoS to the hardware. It enables user to group Virtual Functions in a tree structure and assign supported parameters: tx_share, tx_max, tx_priority and tx_weight to each node in a tree. So effectively user gains an ability to control how much bandwidth is allocated for each VF group. This is later enforced by the HW.}(hj)hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMyhjhhubh)}(hXUIt is assumed that this feature is mutually exclusive with DCB performed in FW and ADQ, or any driver feature that would trigger changes in QoS, for example creation of the new traffic class. The driver will prevent DCB or ADQ configuration if user started making any changes to the nodes using devlink-rate API. To configure those features a driver reload is necessary. Correspondingly if ADQ or DCB will get configured the driver won't export hierarchy at all, or will remove the untouched hierarchy if those features are enabled after the hierarchy is exported, but before any changes are made.h]hXWIt is assumed that this feature is mutually exclusive with DCB performed in FW and ADQ, or any driver feature that would trigger changes in QoS, for example creation of the new traffic class. The driver will prevent DCB or ADQ configuration if user started making any changes to the nodes using devlink-rate API. To configure those features a driver reload is necessary. Correspondingly if ADQ or DCB will get configured the driver won’t export hierarchy at all, or will remove the untouched hierarchy if those features are enabled after the hierarchy is exported, but before any changes are made.}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hThis feature is also dependent on switchdev being enabled in the system. It's required because devlink-rate requires devlink-port objects to be present, and those objects are only created in switchdev mode.h]hThis feature is also dependent on switchdev being enabled in the system. It’s required because devlink-rate requires devlink-port objects to be present, and those objects are only created in switchdev mode.}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXIf the driver is set to the switchdev mode, it will export internal hierarchy the moment VF's are created. Root of the tree is always represented by the node_0. This node can't be deleted by the user. Leaf nodes and nodes with children also can't be deleted.h]hXIf the driver is set to the switchdev mode, it will export internal hierarchy the moment VF’s are created. Root of the tree is always represented by the node_0. This node can’t be deleted by the user. Leaf nodes and nodes with children also can’t be deleted.}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(hhh](h)}(hAttributes supportedh]hAttributes supported}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjsubj&)}(hhh](j+)}(hhh]h}(h]h ]h"]h$]h&]j5Kuh1j*hjubj+)}(hhh]h}(h]h ]h"]h$]h&]j5KUuh1j*hjubjI)}(hhh](jN)}(hhh](jS)}(hhh]h)}(hNameh]hName}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(h Descriptionh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjubjN)}(hhh](jS)}(hhh]h)}(h ``tx_max``h]h)}(hjh]htx_max}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(hXImaximum bandwidth to be consumed by the tree Node. Rate Limit is an absolute number specifying a maximum amount of bytes a Node may consume during the course of one second. Rate limit guarantees that a link will not oversaturate the receiver on the remote end and also enforces an SLA between the subscriber and network provider.h]hXImaximum bandwidth to be consumed by the tree Node. Rate Limit is an absolute number specifying a maximum amount of bytes a Node may consume during the course of one second. Rate limit guarantees that a link will not oversaturate the receiver on the remote end and also enforces an SLA between the subscriber and network provider.}(hjhhhNh)Nubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjubjN)}(hhh](jS)}(hhh]h)}(h ``tx_share``h]h)}(hjh]htx_share}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(hminimum bandwidth allocated to a tree node when it is not blocked. It specifies an absolute BW. While tx_max defines the maximum bandwidth the node may consume, the tx_share marks committed BW for the Node.h]hminimum bandwidth allocated to a tree node when it is not blocked. It specifies an absolute BW. While tx_max defines the maximum bandwidth the node may consume, the tx_share marks committed BW for the Node.}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj6ubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjubjN)}(hhh](jS)}(hhh]h)}(h``tx_priority``h]h)}(hj[h]h tx_priority}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjYubah}(h]h ]h"]h$]h&]uh1hhhhMhjVubah}(h]h ]h"]h$]h&]uh1jRhjSubjS)}(hhh]h)}(hXallows for usage of strict priority arbiter among siblings. This arbitration scheme attempts to schedule nodes based on their priority as long as the nodes remain within their bandwidth limit. Range 0-7. Nodes with priority 7 have the highest priority and are selected first, while nodes with priority 0 have the lowest priority. Nodes that have the same priority are treated equally.h]hXallows for usage of strict priority arbiter among siblings. This arbitration scheme attempts to schedule nodes based on their priority as long as the nodes remain within their bandwidth limit. Range 0-7. Nodes with priority 7 have the highest priority and are selected first, while nodes with priority 0 have the lowest priority. Nodes that have the same priority are treated equally.}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjvubah}(h]h ]h"]h$]h&]uh1jRhjSubeh}(h]h ]h"]h$]h&]uh1jMhjubjN)}(hhh](jS)}(hhh]h)}(h ``tx_weight``h]h)}(hjh]h tx_weight}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jRhjubjS)}(hhh]h)}(hallows for usage of Weighted Fair Queuing arbitration scheme among siblings. This arbitration scheme can be used simultaneously with the strict priority. Range 1-200. Only relative values matter for arbitration.h]hallows for usage of Weighted Fair Queuing arbitration scheme among siblings. This arbitration scheme can be used simultaneously with the strict priority. Range 1-200. Only relative values matter for arbitration.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1jMhjubeh}(h]h ]h"]h$]h&]uh1jHhjubeh}(h]h ]h"]h$]h&]colsKuh1j%hjsubeh}(h]id6ah ]jbah"]h$]h&]uh1jhjhhhNhNubh)}(h``tx_priority`` and ``tx_weight`` can be used simultaneously. In that case nodes with the same priority form a WFQ subgroup in the sibling group and arbitration among them is based on assigned weights.h](h)}(h``tx_priority``h]h tx_priority}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh and }(hjhhhNhNubh)}(h ``tx_weight``h]h tx_weight}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh can be used simultaneously. In that case nodes with the same priority form a WFQ subgroup in the sibling group and arbitration among them is based on assigned weights.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(hX# enable switchdev $ devlink dev eswitch set pci/0000:4b:00.0 mode switchdev # at this point driver should export internal hierarchy $ echo 2 > /sys/class/net/ens785np0/device/sriov_numvfs $ devlink port function rate show pci/0000:4b:00.0/node_25: type node parent node_24 pci/0000:4b:00.0/node_24: type node parent node_0 pci/0000:4b:00.0/node_32: type node parent node_31 pci/0000:4b:00.0/node_31: type node parent node_30 pci/0000:4b:00.0/node_30: type node parent node_16 pci/0000:4b:00.0/node_19: type node parent node_18 pci/0000:4b:00.0/node_18: type node parent node_17 pci/0000:4b:00.0/node_17: type node parent node_16 pci/0000:4b:00.0/node_14: type node parent node_5 pci/0000:4b:00.0/node_5: type node parent node_3 pci/0000:4b:00.0/node_13: type node parent node_4 pci/0000:4b:00.0/node_12: type node parent node_4 pci/0000:4b:00.0/node_11: type node parent node_4 pci/0000:4b:00.0/node_10: type node parent node_4 pci/0000:4b:00.0/node_9: type node parent node_4 pci/0000:4b:00.0/node_8: type node parent node_4 pci/0000:4b:00.0/node_7: type node parent node_4 pci/0000:4b:00.0/node_6: type node parent node_4 pci/0000:4b:00.0/node_4: type node parent node_3 pci/0000:4b:00.0/node_3: type node parent node_16 pci/0000:4b:00.0/node_16: type node parent node_15 pci/0000:4b:00.0/node_15: type node parent node_0 pci/0000:4b:00.0/node_2: type node parent node_1 pci/0000:4b:00.0/node_1: type node parent node_0 pci/0000:4b:00.0/node_0: type node pci/0000:4b:00.0/1: type leaf parent node_25 pci/0000:4b:00.0/2: type leaf parent node_25 # let's create some custom node $ devlink port function rate add pci/0000:4b:00.0/node_custom parent node_0 # second custom node $ devlink port function rate add pci/0000:4b:00.0/node_custom_1 parent node_custom # reassign second VF to newly created branch $ devlink port function rate set pci/0000:4b:00.0/2 parent node_custom_1 # assign tx_weight to the VF $ devlink port function rate set pci/0000:4b:00.0/2 tx_weight 5 # assign tx_share to the VF $ devlink port function rate set pci/0000:4b:00.0/2 tx_share 500Mbpsh]hX# enable switchdev $ devlink dev eswitch set pci/0000:4b:00.0 mode switchdev # at this point driver should export internal hierarchy $ echo 2 > /sys/class/net/ens785np0/device/sriov_numvfs $ devlink port function rate show pci/0000:4b:00.0/node_25: type node parent node_24 pci/0000:4b:00.0/node_24: type node parent node_0 pci/0000:4b:00.0/node_32: type node parent node_31 pci/0000:4b:00.0/node_31: type node parent node_30 pci/0000:4b:00.0/node_30: type node parent node_16 pci/0000:4b:00.0/node_19: type node parent node_18 pci/0000:4b:00.0/node_18: type node parent node_17 pci/0000:4b:00.0/node_17: type node parent node_16 pci/0000:4b:00.0/node_14: type node parent node_5 pci/0000:4b:00.0/node_5: type node parent node_3 pci/0000:4b:00.0/node_13: type node parent node_4 pci/0000:4b:00.0/node_12: type node parent node_4 pci/0000:4b:00.0/node_11: type node parent node_4 pci/0000:4b:00.0/node_10: type node parent node_4 pci/0000:4b:00.0/node_9: type node parent node_4 pci/0000:4b:00.0/node_8: type node parent node_4 pci/0000:4b:00.0/node_7: type node parent node_4 pci/0000:4b:00.0/node_6: type node parent node_4 pci/0000:4b:00.0/node_4: type node parent node_3 pci/0000:4b:00.0/node_3: type node parent node_16 pci/0000:4b:00.0/node_16: type node parent node_15 pci/0000:4b:00.0/node_15: type node parent node_0 pci/0000:4b:00.0/node_2: type node parent node_1 pci/0000:4b:00.0/node_1: type node parent node_0 pci/0000:4b:00.0/node_0: type node pci/0000:4b:00.0/1: type leaf parent node_25 pci/0000:4b:00.0/2: type leaf parent node_25 # let's create some custom node $ devlink port function rate add pci/0000:4b:00.0/node_custom parent node_0 # second custom node $ devlink port function rate add pci/0000:4b:00.0/node_custom_1 parent node_custom # reassign second VF to newly created branch $ devlink port function rate set pci/0000:4b:00.0/2 parent node_custom_1 # assign tx_weight to the VF $ devlink port function rate set pci/0000:4b:00.0/2 tx_weight 5 # assign tx_share to the VF $ devlink port function rate set pci/0000:4b:00.0/2 tx_share 500Mbps}hjsbah}(h]h ]h"]h$]h&]forcehighlight_args}hhj(shelluh1jhhhMhjhhubeh}(h] devlink-rateah ]h"] devlink rateah$]h&]uh1hhhhhhhhMwubeh}(h]ice-devlink-supportah ]h"]ice devlink supportah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksjRfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjYerror_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehnj _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}(j4j1jjj j jjj]jZj2j/jjj,j)u nametypes}(j4jj jj]j2jj,uh}(j1hjjj jjj jZjj/j`jj5j)jj`jjjfj j4jj jjfjjsu footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}jgKsRparse_messages]transform_messages] transformerN include_log] decorationNhhub.