Dsphinx.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/mlx5modnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/zh_TW/networking/devlink/mlx5modnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/it_IT/networking/devlink/mlx5modnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/ja_JP/networking/devlink/mlx5modnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/ko_KR/networking/devlink/mlx5modnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/pt_BR/networking/devlink/mlx5modnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/sp_SP/networking/devlink/mlx5modnameN 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:spacepreserveuh1hhhhhhE/var/lib/git/docbuild/linux/Documentation/networking/devlink/mlx5.rsthKubhsection)}(hhh](htitle)}(hmlx5 devlink supporth]hmlx5 devlink support}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(hWThis document describes the devlink features implemented by the ``mlx5`` device driver.h](h@This document describes the devlink features implemented by the }(hhhhhNhNubhliteral)}(h``mlx5``h]hmlx5}(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&]j5Kuh1j*hj'ubj+)}(hhh]h}(h]h ]h"]h$]h&]j5Kuh1j*hj'ubhtbody)}(hhh](hrow)}(hhh](hentry)}(hhh]h)}(hNameh]hName}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj]ubah}(h]h ]h"]h$]h&]uh1j[hjXubj\)}(hhh]h)}(hModeh]hMode}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjtubah}(h]h ]h"]h$]h&]uh1j[hjXubj\)}(hhh]h)}(h Validationh]h Validation}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j[hjXubj\)}(hhh]h)}(hNotesh]hNotes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j[hjXubeh}(h]h ]h"]h$]h&]uh1jVhjSubjW)}(hhh](j\)}(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&]uh1j[hjubj\)}(hhh]h)}(h driverinith]h driverinit}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(hBooleanh]hBoolean}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(hIf the device supports RoCE disablement, RoCE enablement state controls device support for RoCE capability. Otherwise, the control occurs in the driver stack. When RoCE is disabled at the driver level, only raw ethernet QPs are supported.h]hIf the device supports RoCE disablement, RoCE enablement state controls device support for RoCE capability. Otherwise, the control occurs in the driver stack. When RoCE is disabled at the driver level, only raw ethernet QPs are supported.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]uh1jVhjSubjW)}(hhh](j\)}(hhh]h)}(h``io_eq_size``h]h)}(hj5h]h io_eq_size}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj3ubah}(h]h ]h"]h$]h&]uh1hhhhKhj0ubah}(h]h ]h"]h$]h&]uh1j[hj-ubj\)}(hhh]h)}(h driverinith]h driverinit}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjPubah}(h]h ]h"]h$]h&]uh1j[hj-ubj\)}(hhh]h)}(h!The range is between 64 and 4096.h]h!The range is between 64 and 4096.}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjgubah}(h]h ]h"]h$]h&]uh1j[hj-ubj\)}(hhh]h}(h]h ]h"]h$]h&]uh1j[hj-ubeh}(h]h ]h"]h$]h&]uh1jVhjSubjW)}(hhh](j\)}(hhh]h)}(h``event_eq_size``h]h)}(hjh]h event_eq_size}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(h driverinith]h driverinit}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(h!The range is between 64 and 4096.h]h!The range is between 64 and 4096.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]uh1jVhjSubjW)}(hhh](j\)}(hhh]h)}(h ``max_macs``h]h)}(hjh]hmax_macs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhK"hjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(h driverinith]h driverinit}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK#hjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(hFThe range is between 1 and 2^31. Only power of 2 values are supported.h]hFThe range is between 1 and 2^31. Only power of 2 values are supported.}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK$hj'ubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]uh1jVhjSubjW)}(hhh](j\)}(hhh]h)}(h``enable_sriov``h]h)}(hjUh]h enable_sriov}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjSubah}(h]h ]h"]h$]h&]uh1hhhhK&hjPubah}(h]h ]h"]h$]h&]uh1j[hjMubj\)}(hhh]h)}(h permanenth]h permanent}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK'hjpubah}(h]h ]h"]h$]h&]uh1j[hjMubj\)}(hhh]h)}(hBooleanh]hBoolean}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK(hjubah}(h]h ]h"]h$]h&]uh1j[hjMubj\)}(hhh]h)}(hApplies to each physical function (PF) independently, if the device supports it. Otherwise, it applies symmetrically to all PFs.h]hApplies to each physical function (PF) independently, if the device supports it. Otherwise, it applies symmetrically to all PFs.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK)hjubah}(h]h ]h"]h$]h&]uh1j[hjMubeh}(h]h ]h"]h$]h&]uh1jVhjSubjW)}(hhh](j\)}(hhh]h)}(h ``total_vfs``h]h)}(hjh]h total_vfs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhK+hjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(h permanenth]h permanent}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK,hjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(h1The range is between 1 and a device-specific max.h]h1The range is between 1 and a device-specific max.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK-hjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(hApplies to each physical function (PF) independently, if the device supports it. Otherwise, it applies symmetrically to all PFs.h]hApplies to each physical function (PF) independently, if the device supports it. Otherwise, it applies symmetrically to all PFs.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK.hj ubah}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]uh1jVhjSubjW)}(hhh](j\)}(hhh]h)}(h ``max_sfs``h]h)}(hj1h]hmax_sfs}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/ubah}(h]h ]h"]h$]h&]uh1hhhhK0hj,ubah}(h]h ]h"]h$]h&]uh1j[hj)ubj\)}(hhh]h)}(h permanenth]h permanent}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK1hjLubah}(h]h ]h"]h$]h&]uh1j[hj)ubj\)}(hhh]h)}(h1The range is between 0 and a device-specific max.h]h1The range is between 0 and a device-specific max.}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK2hjcubah}(h]h ]h"]h$]h&]uh1j[hj)ubj\)}(hhh]h)}(h5Applies to each physical function (PF) independently.h]h5Applies to each physical function (PF) independently.}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK3hjzubah}(h]h ]h"]h$]h&]uh1j[hj)ubeh}(h]h ]h"]h$]h&]uh1jVhjSubeh}(h]h ]h"]h$]h&]uh1jQhj'ubeh}(h]h ]h"]h$]h&]colsKuh1j%hjubeh}(h]id1ah ]h"]h$]h&]uh1jhjhhhNhNubhdefinition_list)}(hhh]hdefinition_list_item)}(hsNote: permanent parameters such as ``enable_sriov``, ``total_vfs`` and ``max_sfs`` require FW reset to take effect h](hterm)}(hRNote: permanent parameters such as ``enable_sriov``, ``total_vfs`` and ``max_sfs``h](h#Note: permanent parameters such as }(hjhhhNhNubh)}(h``enable_sriov``h]h enable_sriov}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh, }(hjhhhNhNubh)}(h ``total_vfs``h]h total_vfs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh and }(hjhhhNhNubh)}(h ``max_sfs``h]hmax_sfs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]uh1jhhhK6hjubh definition)}(hhh]h)}(hrequire FW reset to take effecth]hrequire FW reset to take effect}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK6hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhK6hjubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubh literal_block)}(hX_# setup parameters devlink dev param set pci/0000:01:00.0 name enable_sriov value true cmode permanent devlink dev param set pci/0000:01:00.0 name total_vfs value 8 cmode permanent # Fw reset devlink dev reload pci/0000:01:00.0 action fw_activate # for PCI related config such as sriov PCI reset/rescan is required: echo 1 >/sys/bus/pci/devices/0000:01:00.0/remove echo 1 >/sys/bus/pci/rescan grep ^ /sys/bus/pci/devices/0000:01:00.0/sriov_* * - ``num_doorbells`` - driverinit - This controls the number of channel doorbells used by the netdev. In all cases, an additional doorbell is allocated and used for non-channel communication (e.g. for PTP, HWS, etc.). Supported values are: - 0: No channel-specific doorbells, use the global one for everything. - [1, max_num_channels]: Spread netdev channels equally across these doorbells.h]hX_# setup parameters devlink dev param set pci/0000:01:00.0 name enable_sriov value true cmode permanent devlink dev param set pci/0000:01:00.0 name total_vfs value 8 cmode permanent # Fw reset devlink dev reload pci/0000:01:00.0 action fw_activate # for PCI related config such as sriov PCI reset/rescan is required: echo 1 >/sys/bus/pci/devices/0000:01:00.0/remove echo 1 >/sys/bus/pci/rescan grep ^ /sys/bus/pci/devices/0000:01:00.0/sriov_* * - ``num_doorbells`` - driverinit - This controls the number of channel doorbells used by the netdev. In all cases, an additional doorbell is allocated and used for non-channel communication (e.g. for PTP, HWS, etc.). Supported values are: - 0: No channel-specific doorbells, use the global one for everything. - [1, max_num_channels]: Spread netdev channels equally across these doorbells.}hjsbah}(h]h ]h"]h$]h&]hhƌforcelanguagebashhighlight_args}uh1jhhhK8hjhhubh)}(hMThe ``mlx5`` driver also implements the following driver-specific parameters.h](hThe }(hj2hhhNhNubh)}(h``mlx5``h]hmlx5}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2ubhA driver also implements the following driver-specific parameters.}(hj2hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKPhjhhubj)}(hhh](h)}(h&Driver-specific parameters implementedh]h&Driver-specific parameters implemented}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKShjRubj&)}(hhh](j+)}(hhh]h}(h]h ]h"]h$]h&]j5Kuh1j*hjcubj+)}(hhh]h}(h]h ]h"]h$]h&]j5Kuh1j*hjcubj+)}(hhh]h}(h]h ]h"]h$]h&]j5Kuh1j*hjcubj+)}(hhh]h}(h]h ]h"]h$]h&]j5KUuh1j*hjcubjR)}(hhh](jW)}(hhh](j\)}(hhh]h)}(hNameh]hName}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKVhjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(hTypeh]hType}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKWhjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(hModeh]hMode}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKXhjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(h Descriptionh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKYhjubah}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]uh1jVhjubjW)}(hhh](j\)}(hhh]h)}(h``flow_steering_mode``h]h)}(hjh]hflow_steering_mode}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKZhjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(hstringh]hstring}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK[hjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(hruntimeh]hruntime}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK\hj,ubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh](h)}(h-Controls the flow steering mode of the driverh]h-Controls the flow steering mode of the driver}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK]hjCubh bullet_list)}(hhh](h list_item)}(hw``dmfs`` Device managed flow steering. In DMFS mode, the HW steering entities are created and managed through firmware.h]h)}(hw``dmfs`` Device managed flow steering. In DMFS mode, the HW steering entities are created and managed through firmware.h](h)}(h``dmfs``h]hdmfs}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhj_ubho Device managed flow steering. In DMFS mode, the HW steering entities are created and managed through firmware.}(hj_hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK_hj[ubah}(h]h ]h"]h$]h&]uh1jYhjVubjZ)}(h``smfs`` Software managed flow steering. In SMFS mode, the HW steering entities are created and manage through the driver without firmware intervention.h]h)}(h``smfs`` Software managed flow steering. In SMFS mode, the HW steering entities are created and manage through the driver without firmware intervention.h](h)}(h``smfs``h]hsmfs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh Software managed flow steering. In SMFS mode, the HW steering entities are created and manage through the driver without firmware intervention.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKahjubah}(h]h ]h"]h$]h&]uh1jYhjVubjZ)}(h``hmfs`` Hardware managed flow steering. In HMFS mode, the driver is configuring steering rules directly to the HW using Work Queues with a special new type of WQE (Work Queue Element). h]h)}(h``hmfs`` Hardware managed flow steering. In HMFS mode, the driver is configuring steering rules directly to the HW using Work Queues with a special new type of WQE (Work Queue Element).h](h)}(h``hmfs``h]hhmfs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh Hardware managed flow steering. In HMFS mode, the driver is configuring steering rules directly to the HW using Work Queues with a special new type of WQE (Work Queue Element).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKdhjubah}(h]h ]h"]h$]h&]uh1jYhjVubeh}(h]h ]h"]h$]h&]bullet*uh1jThhhK_hjCubh)}(hZSMFS mode is faster and provides better rule insertion rate compared to default DMFS mode.h]hZSMFS mode is faster and provides better rule insertion rate compared to default DMFS mode.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhjCubeh}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]uh1jVhjubjW)}(hhh](j\)}(hhh]h)}(h``fdb_large_groups``h]h)}(hjh]hfdb_large_groups}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKjhjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(hu32h]hu32}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKkhjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(h driverinith]h driverinit}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKlhj)ubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh](h)}(h?Control the number of large groups (size > 1) in the FDB table.h]h?Control the number of large groups (size > 1) in the FDB table.}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKmhj@ubjU)}(hhh]jZ)}(h=The default value is 15, and the range is between 1 and 1024.h]h)}(hjVh]h=The default value is 15, and the range is between 1 and 1024.}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKohjTubah}(h]h ]h"]h$]h&]uh1jYhjQubah}(h]h ]h"]h$]h&]jjuh1jThhhKohj@ubeh}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]uh1jVhjubjW)}(hhh](j\)}(hhh]h)}(h``esw_multiport``h]h)}(hjh]h esw_multiport}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKphjubah}(h]h ]h"]h$]h&]uh1j[hj}ubj\)}(hhh]h)}(hBooleanh]hBoolean}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKqhjubah}(h]h ]h"]h$]h&]uh1j[hj}ubj\)}(hhh]h)}(hruntimeh]hruntime}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKrhjubah}(h]h ]h"]h$]h&]uh1j[hj}ubj\)}(hhh](h)}(h+Control MultiPort E-Switch shared fdb mode.h]h+Control MultiPort E-Switch shared fdb mode.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKshjubh)}(hzAn experimental mode where a single E-Switch is used and all the vports and physical ports on the NIC are connected to it.h]hzAn experimental mode where a single E-Switch is used and all the vports and physical ports on the NIC are connected to it.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKuhjubh)}(h~An example is to send traffic from a VF that is created on PF0 to an uplink that is natively associated with the uplink of PF1h]h~An example is to send traffic from a VF that is created on PF0 to an uplink that is natively associated with the uplink of PF1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKxhjubh)}(hNote: Future devices, ConnectX-8 and onward, will eventually have this as the default to allow forwarding between all NIC ports in a single E-switch environment and the dual E-switch mode will likely get deprecated.h]hNote: Future devices, ConnectX-8 and onward, will eventually have this as the default to allow forwarding between all NIC ports in a single E-switch environment and the dual E-switch mode will likely get deprecated.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK{hjubh)}(hDefault: disabledh]hDefault: disabled}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1j[hj}ubeh}(h]h ]h"]h$]h&]uh1jVhjubjW)}(hhh](j\)}(hhh]h)}(h``esw_port_metadata``h]h)}(hj+h]hesw_port_metadata}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj)ubah}(h]h ]h"]h$]h&]uh1hhhhKhj&ubah}(h]h ]h"]h$]h&]uh1j[hj#ubj\)}(hhh]h)}(hBooleanh]hBoolean}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjFubah}(h]h ]h"]h$]h&]uh1j[hj#ubj\)}(hhh]h)}(hruntimeh]hruntime}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj]ubah}(h]h ]h"]h$]h&]uh1j[hj#ubj\)}(hhh](h)}(hzWhen applicable, disabling eswitch metadata can increase packet rate up to 20% depending on the use case and packet sizes.h]hzWhen applicable, disabling eswitch metadata can increase packet rate up to 20% depending on the use case and packet sizes.}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjtubh)}(hXEswitch port metadata state controls whether to internally tag packets with metadata. Metadata tagging must be enabled for multi-port RoCE, failover between representors and stacked devices. By default metadata is enabled on the supported devices in E-switch. Metadata is applicable only for E-switch in switchdev mode and users may disable it when NONE of the below use cases will be in use: 1. HCA is in Dual/multi-port RoCE mode. 2. VF/SF representor bonding (Usually used for Live migration) 3. Stacked devicesh]hXEswitch port metadata state controls whether to internally tag packets with metadata. Metadata tagging must be enabled for multi-port RoCE, failover between representors and stacked devices. By default metadata is enabled on the supported devices in E-switch. Metadata is applicable only for E-switch in switchdev mode and users may disable it when NONE of the below use cases will be in use: 1. HCA is in Dual/multi-port RoCE mode. 2. VF/SF representor bonding (Usually used for Live migration) 3. Stacked devices}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjtubh)}(hcWhen metadata is disabled, the above use cases will fail to initialize if users try to enable them.h]hcWhen metadata is disabled, the above use cases will fail to initialize if users try to enable them.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjtubh)}(hNote: Setting this parameter does not take effect immediately. Setting must happen in legacy mode and eswitch port metadata takes effect after enabling switchdev mode.h]hNote: Setting this parameter does not take effect immediately. Setting must happen in legacy mode and eswitch port metadata takes effect after enabling switchdev mode.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjtubeh}(h]h ]h"]h$]h&]uh1j[hj#ubeh}(h]h ]h"]h$]h&]uh1jVhjubjW)}(hhh](j\)}(hhh]h)}(h``hairpin_num_queues``h]h)}(hjh]hhairpin_num_queues}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(hu32h]hu32}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(h driverinith]h driverinit}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh](h)}(hWe refer to a TC NIC rule that involves forwarding as "hairpin". Hairpin queues are mlx5 hardware specific implementation for hardware forwarding of such packets.h]hWe refer to a TC NIC rule that involves forwarding as “hairpin”. Hairpin queues are mlx5 hardware specific implementation for hardware forwarding of such packets.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(h%Control the number of hairpin queues.h]h%Control the number of hairpin queues.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubeh}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]uh1jVhjubjW)}(hhh](j\)}(hhh]h)}(h``hairpin_queue_size``h]h)}(hj? h]hhairpin_queue_size}(hjA hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj= ubah}(h]h ]h"]h$]h&]uh1hhhhKhj: ubah}(h]h ]h"]h$]h&]uh1j[hj7 ubj\)}(hhh]h)}(hu32h]hu32}(hj] hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjZ ubah}(h]h ]h"]h$]h&]uh1j[hj7 ubj\)}(hhh]h)}(h driverinith]h driverinit}(hjt hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjq ubah}(h]h ]h"]h$]h&]uh1j[hj7 ubj\)}(hhh]h)}(h4Control the size (in packets) of the hairpin queues.h]h4Control the size (in packets) of the hairpin queues.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j[hj7 ubeh}(h]h ]h"]h$]h&]uh1jVhjubjW)}(hhh](j\)}(hhh]h)}(h``pcie_cong_inbound_high``h]h)}(hj h]hpcie_cong_inbound_high}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j[hj ubj\)}(hhh]h)}(hu16h]hu16}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j[hj ubj\)}(hhh]h)}(h driverinith]h driverinit}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j[hj ubj\)}(hhh](h)}(hHigh threshold configuration for PCIe congestion events. The firmware will send an event once device side inbound PCIe traffic went above the configured high threshold for a long enough period (at least 200ms).h]hHigh threshold configuration for PCIe congestion events. The firmware will send an event once device side inbound PCIe traffic went above the configured high threshold for a long enough period (at least 200ms).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(h%See pci_bw_inbound_high ethtool stat.h]h%See pci_bw_inbound_high ethtool stat.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(hUnits are 0.01 %. Accepted values are in range [0, 10000]. pcie_cong_inbound_low < pcie_cong_inbound_high. Default value: 9000 (Corresponds to 90%).h]hUnits are 0.01 %. Accepted values are in range [0, 10000]. pcie_cong_inbound_low < pcie_cong_inbound_high. Default value: 9000 (Corresponds to 90%).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubeh}(h]h ]h"]h$]h&]uh1j[hj ubeh}(h]h ]h"]h$]h&]uh1jVhjubjW)}(hhh](j\)}(hhh]h)}(h``pcie_cong_inbound_low``h]h)}(hj7 h]hpcie_cong_inbound_low}(hj9 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5 ubah}(h]h ]h"]h$]h&]uh1hhhhKhj2 ubah}(h]h ]h"]h$]h&]uh1j[hj/ ubj\)}(hhh]h)}(hu16h]hu16}(hjU hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjR ubah}(h]h ]h"]h$]h&]uh1j[hj/ ubj\)}(hhh]h)}(h driverinith]h driverinit}(hjl hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhji ubah}(h]h ]h"]h$]h&]uh1j[hj/ ubj\)}(hhh](h)}(hLow threshold configuration for PCIe congestion events. The firmware will send an event once device side inbound PCIe traffic went below the configured low threshold, only after having been previously in a congested state.h]hLow threshold configuration for PCIe congestion events. The firmware will send an event once device side inbound PCIe traffic went below the configured low threshold, only after having been previously in a congested state.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(h$See pci_bw_inbound_low ethtool stat.h]h$See pci_bw_inbound_low ethtool stat.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(hUnits are 0.01 %. Accepted values are in range [0, 10000]. pcie_cong_inbound_low < pcie_cong_inbound_high. Default value: 7500.h]hUnits are 0.01 %. Accepted values are in range [0, 10000]. pcie_cong_inbound_low < pcie_cong_inbound_high. Default value: 7500.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubeh}(h]h ]h"]h$]h&]uh1j[hj/ ubeh}(h]h ]h"]h$]h&]uh1jVhjubjW)}(hhh](j\)}(hhh]h)}(h``pcie_cong_outbound_high``h]h)}(hj h]hpcie_cong_outbound_high}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j[hj ubj\)}(hhh]h)}(hu16h]hu16}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j[hj ubj\)}(hhh]h)}(h driverinith]h driverinit}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j[hj ubj\)}(hhh](h)}(hHigh threshold configuration for PCIe congestion events. The firmware will send an event once device side outbound PCIe traffic went above the configured high threshold for a long enough period (at least 200ms).h]hHigh threshold configuration for PCIe congestion events. The firmware will send an event once device side outbound PCIe traffic went above the configured high threshold for a long enough period (at least 200ms).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(h&See pci_bw_outbound_high ethtool stat.h]h&See pci_bw_outbound_high ethtool stat.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(hUnits are 0.01 %. Accepted values are in range [0, 10000]. pcie_cong_outbound_low < pcie_cong_outbound_high. Default value: 9000 (Corresponds to 90%).h]hUnits are 0.01 %. Accepted values are in range [0, 10000]. pcie_cong_outbound_low < pcie_cong_outbound_high. Default value: 9000 (Corresponds to 90%).}(hj) hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubeh}(h]h ]h"]h$]h&]uh1j[hj ubeh}(h]h ]h"]h$]h&]uh1jVhjubjW)}(hhh](j\)}(hhh]h)}(h``pcie_cong_outbound_low``h]h)}(hjK h]hpcie_cong_outbound_low}(hjM hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjI ubah}(h]h ]h"]h$]h&]uh1hhhhKhjF ubah}(h]h ]h"]h$]h&]uh1j[hjC ubj\)}(hhh]h)}(hu16h]hu16}(hji hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjf ubah}(h]h ]h"]h$]h&]uh1j[hjC ubj\)}(hhh]h)}(h driverinith]h driverinit}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj} ubah}(h]h ]h"]h$]h&]uh1j[hjC ubj\)}(hhh](h)}(hLow threshold configuration for PCIe congestion events. The firmware will send an event once device side outbound PCIe traffic went below the configured low threshold, only after having been previously in a congested state.h]hLow threshold configuration for PCIe congestion events. The firmware will send an event once device side outbound PCIe traffic went below the configured low threshold, only after having been previously in a congested state.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(h%See pci_bw_outbound_low ethtool stat.h]h%See pci_bw_outbound_low ethtool stat.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(hUnits are 0.01 %. Accepted values are in range [0, 10000]. pcie_cong_outbound_low < pcie_cong_outbound_high. Default value: 7500.h]hUnits are 0.01 %. Accepted values are in range [0, 10000]. pcie_cong_outbound_low < pcie_cong_outbound_high. Default value: 7500.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubeh}(h]h ]h"]h$]h&]uh1j[hjC ubeh}(h]h ]h"]h$]h&]uh1jVhjubjW)}(hhh](j\)}(hhh]h)}(h``cqe_compress_type``h]h)}(hj h]hcqe_compress_type}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j[hj ubj\)}(hhh]h)}(hstringh]hstring}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j[hj ubj\)}(hhh]h)}(h permanenth]h permanent}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j[hj ubj\)}(hhh]h)}(hX#Configure which mechanism/algorithm should be used by the NIC that will affect the rate (aggressiveness) of compressed CQEs depending on PCIe bus conditions and other internal NIC factors. This mode affects all queues that enable compression. * ``balanced`` : Merges fewer CQEs, resulting in a moderate compression ratio but maintaining a balance between bandwidth savings and performance * ``aggressive`` : Merges more CQEs into a single entry, achieving a higher compression rate and maximizing performance, particularly under high traffic loadsh](hConfigure which mechanism/algorithm should be used by the NIC that will affect the rate (aggressiveness) of compressed CQEs depending on PCIe bus conditions and other internal NIC factors. This mode affects all queues that enable compression. * }(hj! hhhNhNubh)}(h ``balanced``h]hbalanced}(hj) hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj! ubh : Merges fewer CQEs, resulting in a moderate compression ratio but maintaining a balance between bandwidth savings and performance * }(hj! hhhNhNubh)}(h``aggressive``h]h aggressive}(hj; hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj! ubh : Merges more CQEs into a single entry, achieving a higher compression rate and maximizing performance, particularly under high traffic loads}(hj! hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j[hj ubeh}(h]h ]h"]h$]h&]uh1jVhjubjW)}(hhh](j\)}(hhh]h)}(h``swp_l4_csum_mode``h]h)}(hjg h]hswp_l4_csum_mode}(hji hhhNhNubah}(h]h ]h"]h$]h&]uh1hhje ubah}(h]h ]h"]h$]h&]uh1hhhhKhjb ubah}(h]h ]h"]h$]h&]uh1j[hj_ ubj\)}(hhh]h)}(hstringh]hstring}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j[hj_ ubj\)}(hhh]h)}(h permanenth]h permanent}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j[hj_ ubj\)}(hhh](h)}(hvConfigure how the L4 checksum is calculated by the device when using Software Parser (SWP) hints for header locations.h]hvConfigure how the L4 checksum is calculated by the device when using Software Parser (SWP) hints for header locations.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubjU)}(hhh](jZ)}(hX``default`` : Use the device's default checksum calculation mode. The driver will discover during init whether or full_csum or l4_only is in use. Setting this value explicitly from userspace is not allowed, but some firmware versions may return this value on param read.h]h)}(hX``default`` : Use the device's default checksum calculation mode. The driver will discover during init whether or full_csum or l4_only is in use. Setting this value explicitly from userspace is not allowed, but some firmware versions may return this value on param read.h](h)}(h ``default``h]hdefault}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubhX : Use the device’s default checksum calculation mode. The driver will discover during init whether or full_csum or l4_only is in use. Setting this value explicitly from userspace is not allowed, but some firmware versions may return this value on param read.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jYhj ubjZ)}(hC``full_csum`` : Calculate full checksum including the pseudo-headerh]h)}(hj h](h)}(h ``full_csum``h]h full_csum}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubh6 : Calculate full checksum including the pseudo-header}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jYhj ubjZ)}(hE``l4_only`` : Calculate L4-only checksum, excluding the pseudo-headerh]h)}(hj h](h)}(h ``l4_only``h]hl4_only}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubh: : Calculate L4-only checksum, excluding the pseudo-header}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jYhj ubeh}(h]h ]h"]h$]h&]jjuh1jThhhKhj ubeh}(h]h ]h"]h$]h&]uh1j[hj_ ubeh}(h]h ]h"]h$]h&]uh1jVhjubeh}(h]h ]h"]h$]h&]uh1jQhjcubeh}(h]h ]h"]h$]h&]colsKuh1j%hjRubeh}(h]id2ah ]colwidths-givenah"]h$]h&]uh1jhjhhhNhNubh)}(hAThe ``mlx5`` driver supports reloading via ``DEVLINK_CMD_RELOAD``h](hThe }(hj[ hhhNhNubh)}(h``mlx5``h]hmlx5}(hjc hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[ ubh driver supports reloading via }(hj[ hhhNhNubh)}(h``DEVLINK_CMD_RELOAD``h]hDEVLINK_CMD_RELOAD}(hju hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[ ubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h] parametersah ]h"] parametersah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(h Info versionsh]h Info versions}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhKubh)}(h2The ``mlx5`` driver reports the following versionsh](hThe }(hj hhhNhNubh)}(h``mlx5``h]hmlx5}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubh& driver reports the following versions}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj hhubj)}(hhh](h)}(h!devlink info versions implementedh]h!devlink info versions implemented}(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&]j5Kuh1j*hj ubj+)}(hhh]h}(h]h ]h"]h$]h&]j5KZuh1j*hj ubjR)}(hhh](jW)}(hhh](j\)}(hhh]h)}(hNameh]hName}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j[hj ubj\)}(hhh]h)}(hTypeh]hType}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j[hj ubj\)}(hhh]h)}(h Descriptionh]h Description}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj%ubah}(h]h ]h"]h$]h&]uh1j[hj ubeh}(h]h ]h"]h$]h&]uh1jVhj ubjW)}(hhh](j\)}(hhh]h)}(h ``fw.psid``h]h)}(hjJh]hfw.psid}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjHubah}(h]h ]h"]h$]h&]uh1hhhhKhjEubah}(h]h ]h"]h$]h&]uh1j[hjBubj\)}(hhh]h)}(hfixedh]hfixed}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjeubah}(h]h ]h"]h$]h&]uh1j[hjBubj\)}(hhh]h)}(h-Used to represent the board id of the device.h]h-Used to represent the board id of the device.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj|ubah}(h]h ]h"]h$]h&]uh1j[hjBubeh}(h]h ]h"]h$]h&]uh1jVhj ubjW)}(hhh](j\)}(hhh]h)}(h``fw.version``h]h)}(hjh]h fw.version}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(hstored, runningh]hstored, running}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j[hjubj\)}(hhh]h)}(h9Three digit major.minor.subminor firmware version number.h]h9Three digit major.minor.subminor firmware version number.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]uh1jVhj ubeh}(h]h ]h"]h$]h&]uh1jQhj ubeh}(h]h ]h"]h$]h&]colsKuh1j%hj ubeh}(h]id3ah ]jW ah"]h$]h&]uh1jhj hhhNhNubeh}(h] info-versionsah ]h"] info versionsah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hHealth reportersh]hHealth reporters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMubh)}(hhh](h)}(h tx reporterh]h tx reporter}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hcThe tx reporter is responsible for reporting and recovering of the following three error scenarios:h]hcThe tx reporter is responsible for reporting and recovering of the following three error scenarios:}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjhhubjU)}(hhh](jZ)}(h[tx timeout Report on kernel tx timeout detection. Recover by searching lost interrupts.h]j)}(hhh]j)}(hWtx timeout Report on kernel tx timeout detection. Recover by searching lost interrupts.h](j)}(h tx timeouth]h tx timeout}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhM hjFubj)}(hhh]h)}(hLReport on kernel tx timeout detection. Recover by searching lost interrupts.h]hLReport on kernel tx timeout detection. Recover by searching lost interrupts.}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjXubah}(h]h ]h"]h$]h&]uh1jhjFubeh}(h]h ]h"]h$]h&]uh1jhhhM hjCubah}(h]h ]h"]h$]h&]uh1jhj?ubah}(h]h ]h"]h$]h&]uh1jYhj<hhhNhNubjZ)}(hetx error completion Report on error tx completion. Recover by flushing the tx queue and reset it.h]j)}(hhh]j)}(hatx error completion Report on error tx completion. Recover by flushing the tx queue and reset it.h](j)}(htx error completionh]htx error completion}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhjubj)}(hhh]h)}(hMReport on error tx completion. Recover by flushing the tx queue and reset it.h]hMReport on error tx completion. Recover by flushing the tx queue and reset it.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jYhj<hhhNhNubjZ)}(htx PTP port timestamping CQ unhealthy Report too many CQEs never delivered on port ts CQ. Recover by flushing and re-creating all PTP channels. h]j)}(hhh]j)}(htx PTP port timestamping CQ unhealthy Report too many CQEs never delivered on port ts CQ. Recover by flushing and re-creating all PTP channels. h](j)}(h%tx PTP port timestamping CQ unhealthyh]h%tx PTP port timestamping CQ unhealthy}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhjubj)}(hhh]h)}(hiReport too many CQEs never delivered on port ts CQ. Recover by flushing and re-creating all PTP channels.h]hiReport too many CQEs never delivered on port ts CQ. Recover by flushing and re-creating all PTP channels.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jYhj<hhhNhNubeh}(h]h ]h"]h$]h&]j-uh1jThhhM hjhhubh)}(h{tx reporter also support on demand diagnose callback, on which it provides real time information of its send queues status.h]h{tx reporter also support on demand diagnose callback, on which it provides real time information of its send queues status.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hUser commands examples:h]hUser commands examples:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubjU)}(hhh]jZ)}(hXDiagnose send queues status:: $ devlink health diagnose pci/0000:82:00.0 reporter tx h](h)}(hDiagnose send queues status::h]hDiagnose send queues status:}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj+ubj)}(h6$ devlink health diagnose pci/0000:82:00.0 reporter txh]h6$ devlink health diagnose pci/0000:82:00.0 reporter tx}hj=sbah}(h]h ]h"]h$]h&]hhuh1jhhhMhj+ubeh}(h]h ]h"]h$]h&]uh1jYhj(hhhhhNubah}(h]h ]h"]h$]h&]jj uh1jThhhMhjhhubhnote)}(h`This command has valid output only when interface is up, otherwise the command has empty output.h]h)}(hj[h]h`This command has valid output only when interface is up, otherwise the command has empty output.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjYubah}(h]h ]h"]h$]h&]uh1jWhjhhhhhNubjU)}(hhh]jZ)}(hShow number of tx errors indicated, number of recover flows ended successfully, is autorecover enabled and graceful period from last recover:: $ devlink health show pci/0000:82:00.0 reporter tx h](h)}(hShow number of tx errors indicated, number of recover flows ended successfully, is autorecover enabled and graceful period from last recover::h]hShow number of tx errors indicated, number of recover flows ended successfully, is autorecover enabled and graceful period from last recover:}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM!hjsubj)}(h2$ devlink health show pci/0000:82:00.0 reporter txh]h2$ devlink health show pci/0000:82:00.0 reporter tx}hjsbah}(h]h ]h"]h$]h&]hhuh1jhhhM$hjsubeh}(h]h ]h"]h$]h&]uh1jYhjphhhhhNubah}(h]h ]h"]h$]h&]jj uh1jThhhM!hjhhubeh}(h] tx-reporterah ]h"] tx reporterah$]h&]uh1hhj hhhhhMubh)}(hhh](h)}(h rx reporterh]h rx reporter}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM'ubh)}(haThe rx reporter is responsible for reporting and recovering of the following two error scenarios:h]haThe rx reporter is responsible for reporting and recovering of the following two error scenarios:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM(hjhhubjU)}(hhh](jZ)}(hX;rx queues' initialization (population) timeout Population of rx queues' descriptors on ring initialization is done in napi context via triggering an irq. In case of a failure to get the minimum amount of descriptors, a timeout would occur, and descriptors could be recovered by polling the EQ (Event Queue).h]j)}(hhh]j)}(hX3rx queues' initialization (population) timeout Population of rx queues' descriptors on ring initialization is done in napi context via triggering an irq. In case of a failure to get the minimum amount of descriptors, a timeout would occur, and descriptors could be recovered by polling the EQ (Event Queue).h](j)}(h.rx queues' initialization (population) timeouth]h0rx queues’ initialization (population) timeout}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhM-hjubj)}(hhh]h)}(hXPopulation of rx queues' descriptors on ring initialization is done in napi context via triggering an irq. In case of a failure to get the minimum amount of descriptors, a timeout would occur, and descriptors could be recovered by polling the EQ (Event Queue).h]hXPopulation of rx queues’ descriptors on ring initialization is done in napi context via triggering an irq. In case of a failure to get the minimum amount of descriptors, a timeout would occur, and descriptors could be recovered by polling the EQ (Event Queue).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM+hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhM-hjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jYhjhhhNhNubjZ)}(hrx completions with errors (reported by HW on interrupt context) Report on rx completion error. Recover (if needed) by flushing the related queue and reset it. h]j)}(hhh]j)}(hrx completions with errors (reported by HW on interrupt context) Report on rx completion error. Recover (if needed) by flushing the related queue and reset it. h](j)}(h@rx completions with errors (reported by HW on interrupt context)h]h@rx completions with errors (reported by HW on interrupt context)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhM1hjubj)}(hhh]h)}(h^Report on rx completion error. Recover (if needed) by flushing the related queue and reset it.h]h^Report on rx completion error. Recover (if needed) by flushing the related queue and reset it.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM0hj$ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhM1hjubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jYhjhhhNhNubeh}(h]h ]h"]h$]h&]jj uh1jThhhM*hjhhubh)}(hrx reporter also supports on demand diagnose callback, on which it provides real time information of its receive queues' status.h]hrx reporter also supports on demand diagnose callback, on which it provides real time information of its receive queues’ status.}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM3hjhhubjU)}(hhh]jZ)}(hzDiagnose rx queues' status and corresponding completion queue:: $ devlink health diagnose pci/0000:82:00.0 reporter rx h](h)}(h?Diagnose rx queues' status and corresponding completion queue::h]h@Diagnose rx queues’ status and corresponding completion queue:}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM6hjdubj)}(h6$ devlink health diagnose pci/0000:82:00.0 reporter rxh]h6$ devlink health diagnose pci/0000:82:00.0 reporter rx}hjvsbah}(h]h ]h"]h$]h&]hhuh1jhhhM8hjdubeh}(h]h ]h"]h$]h&]uh1jYhjahhhhhNubah}(h]h ]h"]h$]h&]jj uh1jThhhM6hjhhubjX)}(haThis command has valid output only when interface is up. Otherwise, the command has empty output.h]h)}(hjh]haThis command has valid output only when interface is up. Otherwise, the command has empty output.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM;hjubah}(h]h ]h"]h$]h&]uh1jWhjhhhhhNubjU)}(hhh]jZ)}(hShow number of rx errors indicated, number of recover flows ended successfully, is autorecover enabled, and graceful period from last recover:: $ devlink health show pci/0000:82:00.0 reporter rx h](h)}(hShow number of rx errors indicated, number of recover flows ended successfully, is autorecover enabled, and graceful period from last recover::h]hShow number of rx errors indicated, number of recover flows ended successfully, is autorecover enabled, and graceful period from last recover:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM=hjubj)}(h2$ devlink health show pci/0000:82:00.0 reporter rxh]h2$ devlink health show pci/0000:82:00.0 reporter rx}hjsbah}(h]h ]h"]h$]h&]hhuh1jhhhM@hjubeh}(h]h ]h"]h$]h&]uh1jYhjhhhhhNubah}(h]h ]h"]h$]h&]jj uh1jThhhM=hjhhubeh}(h] rx-reporterah ]h"] rx reporterah$]h&]uh1hhj hhhhhM'ubh)}(hhh](h)}(h fw reporterh]h fw reporter}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMCubh)}(hXThe fw reporter implements `diagnose` and `dump` callbacks. It follows symptoms of fw error such as fw syndrome by triggering fw core dump and storing it into the dump buffer. The fw reporter diagnose command can be triggered any time by the user to check current fw status.h](hThe fw reporter implements }(hjhhhNhNubhtitle_reference)}(h `diagnose`h]hdiagnose}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }(hjhhhNhNubj)}(h`dump`h]hdump}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh callbacks. It follows symptoms of fw error such as fw syndrome by triggering fw core dump and storing it into the dump buffer. The fw reporter diagnose command can be triggered any time by the user to check current fw status.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMDhjhhubh)}(hUser commands examples:h]hUser commands examples:}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMJhjhhubjU)}(hhh](jZ)}(hRCheck fw heath status:: $ devlink health diagnose pci/0000:82:00.0 reporter fw h](h)}(hCheck fw heath status::h]hCheck fw heath status:}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMLhj4ubj)}(h6$ devlink health diagnose pci/0000:82:00.0 reporter fwh]h6$ devlink health diagnose pci/0000:82:00.0 reporter fw}hjFsbah}(h]h ]h"]h$]h&]hhuh1jhhhMNhj4ubeh}(h]h ]h"]h$]h&]uh1jYhj1hhhhhNubjZ)}(htRead FW core dump if already stored or trigger new one:: $ devlink health dump show pci/0000:82:00.0 reporter fw h](h)}(h8Read FW core dump if already stored or trigger new one::h]h7Read FW core dump if already stored or trigger new one:}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMPhjZubj)}(h7$ devlink health dump show pci/0000:82:00.0 reporter fwh]h7$ devlink health dump show pci/0000:82:00.0 reporter fw}hjlsbah}(h]h ]h"]h$]h&]hhuh1jhhhMRhjZubeh}(h]h ]h"]h$]h&]uh1jYhj1hhhhhNubeh}(h]h ]h"]h$]h&]jj uh1jThhhMLhjhhubjX)}(hThis command can run only on the PF which has fw tracer ownership, running it on other PF or any VF will return "Operation not permitted".h]h)}(hThis command can run only on the PF which has fw tracer ownership, running it on other PF or any VF will return "Operation not permitted".h]hThis command can run only on the PF which has fw tracer ownership, running it on other PF or any VF will return “Operation not permitted”.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMUhjubah}(h]h ]h"]h$]h&]uh1jWhjhhhhhNubeh}(h] fw-reporterah ]h"] fw reporterah$]h&]uh1hhj hhhhhMCubh)}(hhh](h)}(hfw fatal reporterh]hfw fatal reporter}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMYubh)}(hXThe fw fatal reporter implements `dump` and `recover` callbacks. It follows fatal errors indications by CR-space dump and recover flow. The CR-space dump uses vsc interface which is valid even if the FW command interface is not functional, which is the case in most FW fatal errors. The recover function runs recover flow which reloads the driver and triggers fw reset if needed. On firmware error, the health buffer is dumped into the dmesg. The log level is derived from the error's severity (given in health buffer).h](h!The fw fatal reporter implements }(hjhhhNhNubj)}(h`dump`h]hdump}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }(hjhhhNhNubj)}(h `recover`h]hrecover}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhX callbacks. It follows fatal errors indications by CR-space dump and recover flow. The CR-space dump uses vsc interface which is valid even if the FW command interface is not functional, which is the case in most FW fatal errors. The recover function runs recover flow which reloads the driver and triggers fw reset if needed. On firmware error, the health buffer is dumped into the dmesg. The log level is derived from the error’s severity (given in health buffer).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMZhjhhubh)}(hUser commands examples:h]hUser commands examples:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMchjhhubjU)}(hhh](jZ)}(h^Run fw recover flow manually:: $ devlink health recover pci/0000:82:00.0 reporter fw_fatal h](h)}(hRun fw recover flow manually::h]hRun fw recover flow manually:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMehjubj)}(h;$ devlink health recover pci/0000:82:00.0 reporter fw_fatalh]h;$ devlink health recover pci/0000:82:00.0 reporter fw_fatal}hj sbah}(h]h ]h"]h$]h&]hhuh1jhhhMghjubeh}(h]h ]h"]h$]h&]uh1jYhjhhhhhNubjZ)}(h~Read FW CR-space dump if already stored or trigger new one:: $ devlink health dump show pci/0000:82:00.1 reporter fw_fatal h](h)}(hnumber of times an EQ mapped to completion events was overrun.h]h>number of times an EQ mapped to completion events was overrun.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jYhjhhhNhNubjZ)}(hXquota_exceeded_command number of commands issued and failed due to quota exceeded.h]j)}(hhh]j)}(hRquota_exceeded_command number of commands issued and failed due to quota exceeded.h](j)}(hquota_exceeded_commandh]hquota_exceeded_command}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhjubj)}(hhh]h)}(h;number of commands issued and failed due to quota exceeded.h]h;number of commands issued and failed due to quota exceeded.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jYhjhhhNhNubjZ)}(hninvalid_command number of commands issued and failed dues to any reason other than quota exceeded.h]j)}(hhh]j)}(hbinvalid_command number of commands issued and failed dues to any reason other than quota exceeded.h](j)}(hinvalid_commandh]hinvalid_command}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhj@ubj)}(hhh]h)}(hRnumber of commands issued and failed dues to any reason other than quota exceeded.h]hRnumber of commands issued and failed dues to any reason other than quota exceeded.}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjRubah}(h]h ]h"]h$]h&]uh1jhj@ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj=ubah}(h]h ]h"]h$]h&]uh1jhj9ubah}(h]h ]h"]h$]h&]uh1jYhjhhhNhNubjZ)}(hnic_receive_steering_discard number of packets that completed RX flow steering but were discarded due to a mismatch in flow table.h]j)}(hhh]j)}(hnic_receive_steering_discard number of packets that completed RX flow steering but were discarded due to a mismatch in flow table.h](j)}(hnic_receive_steering_discardh]hnic_receive_steering_discard}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhjubj)}(hhh]h)}(henumber of packets that completed RX flow steering but were discarded due to a mismatch in flow table.h]henumber of packets that completed RX flow steering but were discarded due to a mismatch in flow table.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubah}(h]h ]h"]h$]h&]uh1jhj{ubah}(h]h ]h"]h$]h&]uh1jYhjhhhNhNubjZ)}(hgenerated_pkt_steering_fail number of packets generated by the VNIC experiencing unexpected steering failure (at any point in steering flow).h]j)}(hhh]j)}(hgenerated_pkt_steering_fail number of packets generated by the VNIC experiencing unexpected steering failure (at any point in steering flow).h](j)}(hgenerated_pkt_steering_failh]hgenerated_pkt_steering_fail}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhjubj)}(hhh]h)}(hqnumber of packets generated by the VNIC experiencing unexpected steering failure (at any point in steering flow).h]hqnumber of packets generated by the VNIC experiencing unexpected steering failure (at any point in steering flow).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jYhjhhhNhNubjZ)}(hhandled_pkt_steering_fail number of packets handled by the VNIC experiencing unexpected steering failure (at any point in steering flow owned by the VNIC, including the FDB for the eswitch owner).h]j)}(hhh]j)}(hhandled_pkt_steering_fail number of packets handled by the VNIC experiencing unexpected steering failure (at any point in steering flow owned by the VNIC, including the FDB for the eswitch owner).h](j)}(hhandled_pkt_steering_failh]hhandled_pkt_steering_fail}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhjubj)}(hhh]h)}(hnumber of packets handled by the VNIC experiencing unexpected steering failure (at any point in steering flow owned by the VNIC, including the FDB for the eswitch owner).h]hnumber of packets handled by the VNIC experiencing unexpected steering failure (at any point in steering flow owned by the VNIC, including the FDB for the eswitch owner).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jYhjhhhNhNubjZ)}(hicm_consumption amount of Interconnect Host Memory (ICM) consumed by the vnic in granularity of 4KB. ICM is host memory allocated by SW upon HCA request and is used for storing data structures that control HCA operation.h]j)}(hhh]j)}(hicm_consumption amount of Interconnect Host Memory (ICM) consumed by the vnic in granularity of 4KB. ICM is host memory allocated by SW upon HCA request and is used for storing data structures that control HCA operation.h](j)}(hicm_consumptionh]hicm_consumption}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhjHubj)}(hhh]h)}(hamount of Interconnect Host Memory (ICM) consumed by the vnic in granularity of 4KB. ICM is host memory allocated by SW upon HCA request and is used for storing data structures that control HCA operation.h]hamount of Interconnect Host Memory (ICM) consumed by the vnic in granularity of 4KB. ICM is host memory allocated by SW upon HCA request and is used for storing data structures that control HCA operation.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjZubah}(h]h ]h"]h$]h&]uh1jhjHubeh}(h]h ]h"]h$]h&]uh1jhhhMhjEubah}(h]h ]h"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&]uh1jYhjhhhNhNubjZ)}(hZbar_uar_access number of WRITE or READ access operations to the UAR on the PCIe BAR.h]j)}(hhh]j)}(hTbar_uar_access number of WRITE or READ access operations to the UAR on the PCIe BAR.h](j)}(hbar_uar_accessh]hbar_uar_access}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhjubj)}(hhh]h)}(hEnumber of WRITE or READ access operations to the UAR on the PCIe BAR.h]hEnumber of WRITE or READ access operations to the UAR on the PCIe BAR.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jYhjhhhNhNubjZ)}(hXodp_local_triggered_page_fault number of locally-triggered page-faults due to ODP.h]j)}(hhh]j)}(hRodp_local_triggered_page_fault number of locally-triggered page-faults due to ODP.h](j)}(hodp_local_triggered_page_faulth]hodp_local_triggered_page_fault}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhjubj)}(hhh]h)}(h3number of locally-triggered page-faults due to ODP.h]h3number of locally-triggered page-faults due to ODP.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jYhjhhhNhNubjZ)}(hZodp_remote_triggered_page_fault number of remotly-triggered page-faults due to ODP. h]j)}(hhh]j)}(hTodp_remote_triggered_page_fault number of remotly-triggered page-faults due to ODP. h](j)}(hodp_remote_triggered_page_faulth]hodp_remote_triggered_page_fault}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhjubj)}(hhh]h)}(h3number of remotly-triggered page-faults due to ODP.h]h3number of remotly-triggered page-faults due to ODP.}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhj ubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jYhjhhhNhNubeh}(h]h ]h"]h$]h&]jj uh1jThhhMxhjkhhubh)}(hUser commands examples:h]hUser commands examples:}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjkhhubjU)}(hhh](jZ)}(h_Diagnose PF/VF vnic counters:: $ devlink health diagnose pci/0000:82:00.1 reporter vnic h](h)}(hDiagnose PF/VF vnic counters::h]hDiagnose PF/VF vnic counters:}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj`ubj)}(h8$ devlink health diagnose pci/0000:82:00.1 reporter vnich]h8$ devlink health diagnose pci/0000:82:00.1 reporter vnic}hjrsbah}(h]h ]h"]h$]h&]hhuh1jhhhMhj`ubeh}(h]h ]h"]h$]h&]uh1jYhj]hhhhhNubjZ)}(hDiagnose representor vnic counters (performed by supplying devlink port of the representor, which can be obtained via devlink port command):: $ devlink health diagnose pci/0000:82:00.1/65537 reporter vnic h](h)}(hDiagnose representor vnic counters (performed by supplying devlink port of the representor, which can be obtained via devlink port command)::h]hDiagnose representor vnic counters (performed by supplying devlink port of the representor, which can be obtained via devlink port command):}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubj)}(h>$ devlink health diagnose pci/0000:82:00.1/65537 reporter vnich]h>$ devlink health diagnose pci/0000:82:00.1/65537 reporter vnic}hjsbah}(h]h ]h"]h$]h&]hhuh1jhhhMhjubeh}(h]h ]h"]h$]h&]uh1jYhj]hhhhhNubeh}(h]h ]h"]h$]h&]jj uh1jThhhMhjkhhubjX)}(hMThis command can run over all interfaces such as PF/VF and representor ports.h]h)}(hjh]hMThis command can run over all interfaces such as PF/VF and representor ports.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jWhjkhhhhhNubeh}(h] vnic-reporterah ]h"] vnic reporterah$]h&]uh1hhj hhhhhMqubeh}(h]health-reportersah ]h"]health reportersah$]h&]uh1hhhhhhhhMubh)}(hhh](h)}(hRatesh]hRates}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(htmlx5 devices can limit transmission of individual VFs or a group of them via the devlink-rate API in switchdev mode.h]htmlx5 devices can limit transmission of individual VFs or a group of them via the devlink-rate API in switchdev mode.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hUser commands examples:h]hUser commands examples:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubjU)}(hhh](jZ)}(h@Print the existing rates:: $ devlink port function rate show h](h)}(hPrint the existing rates::h]hPrint the existing rates:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubj)}(h!$ devlink port function rate showh]h!$ devlink port function rate show}hjsbah}(h]h ]h"]h$]h&]hhuh1jhhhMhj ubeh}(h]h ]h"]h$]h&]uh1jYhjhhhhhNubjZ)}(hnSet a max tx limit on traffic from VF0:: $ devlink port function rate set pci/0000:82:00.0/1 tx_max 10Gbit h](h)}(h(Set a max tx limit on traffic from VF0::h]h'Set a max tx limit on traffic from VF0:}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj/ubj)}(hA$ devlink port function rate set pci/0000:82:00.0/1 tx_max 10Gbith]hA$ devlink port function rate set pci/0000:82:00.0/1 tx_max 10Gbit}hjAsbah}(h]h ]h"]h$]h&]hhuh1jhhhMhj/ubeh}(h]h ]h"]h$]h&]uh1jYhjhhhhhNubjZ)}(hXCreate a rate group with a max tx limit and add two VFs to it:: $ devlink port function rate add pci/0000:82:00.0/group1 tx_max 10Gbit $ devlink port function rate set pci/0000:82:00.0/1 parent group1 $ devlink port function rate set pci/0000:82:00.0/2 parent group1 h](h)}(h?Create a rate group with a max tx limit and add two VFs to it::h]h>Create a rate group with a max tx limit and add two VFs to it:}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjUubj)}(h$ devlink port function rate add pci/0000:82:00.0/group1 tx_max 10Gbit $ devlink port function rate set pci/0000:82:00.0/1 parent group1 $ devlink port function rate set pci/0000:82:00.0/2 parent group1h]h$ devlink port function rate add pci/0000:82:00.0/group1 tx_max 10Gbit $ devlink port function rate set pci/0000:82:00.0/1 parent group1 $ devlink port function rate set pci/0000:82:00.0/2 parent group1}hjgsbah}(h]h ]h"]h$]h&]hhuh1jhhhMhjUubeh}(h]h ]h"]h$]h&]uh1jYhjhhhhhNubjZ)}(hX0Same scenario, with a min guarantee of 20% of the bandwidth for the first VF:: $ devlink port function rate add pci/0000:82:00.0/group1 tx_max 10Gbit $ devlink port function rate set pci/0000:82:00.0/1 parent group1 tx_share 2Gbit $ devlink port function rate set pci/0000:82:00.0/2 parent group1 h](h)}(hNSame scenario, with a min guarantee of 20% of the bandwidth for the first VF::h]hMSame scenario, with a min guarantee of 20% of the bandwidth for the first VF:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj{ubj)}(h$ devlink port function rate add pci/0000:82:00.0/group1 tx_max 10Gbit $ devlink port function rate set pci/0000:82:00.0/1 parent group1 tx_share 2Gbit $ devlink port function rate set pci/0000:82:00.0/2 parent group1h]h$ devlink port function rate add pci/0000:82:00.0/group1 tx_max 10Gbit $ devlink port function rate set pci/0000:82:00.0/1 parent group1 tx_share 2Gbit $ devlink port function rate set pci/0000:82:00.0/2 parent group1}hjsbah}(h]h ]h"]h$]h&]hhuh1jhhhMhj{ubeh}(h]h ]h"]h$]h&]uh1jYhjhhhhhNubjZ)}(hCross-device scheduling:: $ devlink port function rate add pci/0000:82:00.0/group1 tx_max 10Gbit $ devlink port function rate set pci/0000:82:00.1/32769 parent pci/0000:82:00.0/group1h](h)}(hCross-device scheduling::h]hCross-device scheduling:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubj)}(h$ devlink port function rate add pci/0000:82:00.0/group1 tx_max 10Gbit $ devlink port function rate set pci/0000:82:00.1/32769 parent pci/0000:82:00.0/group1h]h$ devlink port function rate add pci/0000:82:00.0/group1 tx_max 10Gbit $ devlink port function rate set pci/0000:82:00.1/32769 parent pci/0000:82:00.0/group1}hjsbah}(h]h ]h"]h$]h&]hhuh1jhhhMhjubeh}(h]h ]h"]h$]h&]uh1jYhjhhhhhNubeh}(h]h ]h"]h$]h&]jj uh1jThhhMhjhhubeh}(h]ratesah ]h"]ratesah$]h&]uh1hhhhhhhhMubeh}(h]mlx5-devlink-supportah ]h"]mlx5 devlink supportah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksj[footnote_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_handlerjerror_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}(jjj j j jjjjjjjjjjhjejjjju nametypes}(jj j jjjjjhjjuh}(jhj jjj jj jjjjjjjejjjkjjjjjU jRjj u footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}j KsRparse_messages]transform_messages] transformerN include_log] decorationNhhub.