|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/ixgbemodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/zh_TW/networking/devlink/ixgbemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/it_IT/networking/devlink/ixgbemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/ja_JP/networking/devlink/ixgbemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/ko_KR/networking/devlink/ixgbemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/sp_SP/networking/devlink/ixgbemodnameN 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:spacepreserveuh1hhhhhhF/var/lib/git/docbuild/linux/Documentation/networking/devlink/ixgbe.rsthKubhsection)}(hhh](htitle)}(hixgbe devlink supporth]hixgbe devlink support}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(hXThis document describes the devlink features implemented by the ``ixgbe`` device driver.h](h@This document describes the devlink features implemented by the }(hhhhhNhNubhliteral)}(h ``ixgbe``h]hixgbe}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhubh device driver.}(hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hhh](h)}(h Info versionsh]h Info versions}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhK ubh)}(hAny of the versions dealing with the security presented by ``devlink-info`` is purely informational. Devlink does not use a secure channel to communicate with the device.h](h;Any of the versions dealing with the security presented by }(hhhhhNhNubh)}(h``devlink-info``h]h devlink-info}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhubh_ is purely informational. Devlink does not use a secure channel to communicate with the device.}(hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh)}(h3The ``ixgbe`` driver reports the following versionsh](hThe }(hjhhhNhNubh)}(h ``ixgbe``h]hixgbe}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh& driver reports the following versions}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubhtable)}(hhh](h)}(h!devlink info versions implementedh]h!devlink info versions implemented}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj@ubhtgroup)}(hhh](hcolspec)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jVhjSubjW)}(hhh]h}(h]h ]h"]h$]h&]jaKuh1jVhjSubjW)}(hhh]h}(h]h ]h"]h$]h&]jaKuh1jVhjSubjW)}(hhh]h}(h]h ]h"]h$]h&]jaKZuh1jVhjSubhtbody)}(hhh](hrow)}(hhh](hentry)}(hhh]h)}(hNameh]hName}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hTypeh]hType}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hExampleh]hExample}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h Descriptionh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h ``board.id``h]h)}(hjh]hboard.id}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hfixedh]hfixed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h H49289-000h]h H49289-000}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj%ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(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&]uh1hhhhKhj<ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h ``fw.undi``h]h)}(hjah]hfw.undi}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhj_ubah}(h]h ]h"]h$]h&]uh1hhhhKhj\ubah}(h]h ]h"]h$]h&]uh1jhjYubj)}(hhh]h)}(hrunningh]hrunning}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj|ubah}(h]h ]h"]h$]h&]uh1jhjYubj)}(hhh]h)}(h1.1937.0h]h1.1937.0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hjubah}(h]h ]h"]h$]h&]uh1jhjYubj)}(hhh]h)}(hXVersion of the Option ROM containing the UEFI driver. The version is reported in ``major.minor.patch`` format. The major version is incremented whenever a major breaking change occurs, or when the minor version would overflow. The minor version is incremented for non-breaking changes and reset to 1 when the major version is incremented. The patch version is normally 0 but is incremented when a fix is delivered as a patch against an older base Option ROM.h](hQVersion of the Option ROM containing the UEFI driver. The version is reported in }(hjhhhNhNubh)}(h``major.minor.patch``h]hmajor.minor.patch}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubhXd format. The major version is incremented whenever a major breaking change occurs, or when the minor version would overflow. The minor version is incremented for non-breaking changes and reset to 1 when the major version is incremented. The patch version is normally 0 but is incremented when a fix is delivered as a patch against an older base Option ROM.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK!hjubah}(h]h ]h"]h$]h&]uh1jhjYubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h``fw.undi.srev``h]h)}(hjh]h fw.undi.srev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhK(hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hrunningh]hrunning}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK)hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h4h]h4}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK*hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h:Number indicating the security revision of the Option ROM.h]h:Number indicating the security revision of the Option ROM.}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK+hj*ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h``fw.bundle_id``h]h)}(hjOh]h fw.bundle_id}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjMubah}(h]h ]h"]h$]h&]uh1hhhhK,hjJubah}(h]h ]h"]h$]h&]uh1jhjGubj)}(hhh]h)}(hrunningh]hrunning}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK-hjjubah}(h]h ]h"]h$]h&]uh1jhjGubj)}(hhh]h)}(h 0x80000d0dh]h 0x80000d0d}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK.hjubah}(h]h ]h"]h$]h&]uh1jhjGubj)}(hhh]h)}(hUnique identifier of the firmware image file that was loaded onto the device. Also referred to as the EETRACK identifier of the NVM.h]hUnique identifier of the firmware image file that was loaded onto the device. Also referred to as the EETRACK identifier of the NVM.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK/hjubah}(h]h ]h"]h$]h&]uh1jhjGubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h``fw.mgmt.api``h]h)}(hjh]h fw.mgmt.api}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhK1hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hrunningh]hrunning}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK2hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h1.5.1h]h1.5.1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK3hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(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).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK4hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h``fw.mgmt.build``h]h)}(hj+h]h fw.mgmt.build}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj)ubah}(h]h ]h"]h$]h&]uh1hhhhK8hj&ubah}(h]h ]h"]h$]h&]uh1jhj#ubj)}(hhh]h)}(hrunningh]hrunning}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK9hjFubah}(h]h ]h"]h$]h&]uh1jhj#ubj)}(hhh]h)}(h 0x305d955fh]h 0x305d955f}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK:hj]ubah}(h]h ]h"]h$]h&]uh1jhj#ubj)}(hhh]h)}(hhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h8Number indicating the security revision of the firmware.h]h8Number indicating the security revision of the firmware.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK?hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h``fw.psid.api``h]h)}(hjh]h fw.psid.api}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhK@hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hrunningh]hrunning}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKAhj"ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h0.80h]h0.80}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKBhj9ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h2Version defining the format of the flash contents.h]h2Version defining the format of the flash contents.}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKChjPubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h``fw.netlist``h]h)}(hjuh]h fw.netlist}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjsubah}(h]h ]h"]h$]h&]uh1hhhhKDhjpubah}(h]h ]h"]h$]h&]uh1jhjmubj)}(hhh]h)}(hrunningh]hrunning}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKEhjubah}(h]h ]h"]h$]h&]uh1jhjmubj)}(hhh]h)}(h1.1.2000-6.7.0h]h1.1.2000-6.7.0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKFhjubah}(h]h ]h"]h$]h&]uh1jhjmubj)}(hhh]h)}(hThe version of the netlist module. This module defines the device's Ethernet capabilities and default settings, and is used by the management firmware as part of managing link and device connectivity.h]hThe version of the netlist module. This module defines the device’s Ethernet capabilities and default settings, and is used by the management firmware as part of managing link and device connectivity.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKGhjubah}(h]h ]h"]h$]h&]uh1jhjmubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h``fw.netlist.build``h]h)}(hjh]hfw.netlist.build}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hrunningh]hrunning}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKLhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h 0xee16ced7h]h 0xee16ced7}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKMhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h=The first 4 bytes of the hash of the netlist module contents.h]h=The first 4 bytes of the hash of the netlist module contents.}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKNhj,ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j}hjSubeh}(h]h ]h"]h$]h&]colsKuh1jQhj@ubeh}(h]id1ah ]colwidths-givenah"]h$]h&]uh1j>hhhhhNhNubeh}(h] info-versionsah ]h"] info versionsah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(h Flash Updateh]h Flash Update}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhjfhhhhhKQubh)}(hThe ``ixgbe`` 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 }(hjwhhhNhNubh)}(h ``ixgbe``h]hixgbe}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjwubh6 driver implements support for flash update using the }(hjwhhhNhNubh)}(h``devlink-flash``h]h devlink-flash}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjwubha interface. It supports updating the device flash using a combined flash image that contains the }(hjwhhhNhNubh)}(h ``fw.mgmt``h]hfw.mgmt}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjwubh, }(hjwhhhNhNubh)}(h ``fw.undi``h]hfw.undi}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjwubh, and }(hjwhhhNhNubh)}(h``fw.netlist``h]h fw.netlist}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjwubh components.}(hjwhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKShjfhhubj?)}(hhh](h)}(h!List of supported overwrite modesh]h!List of supported overwrite modes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKXhjubjR)}(hhh](jW)}(hhh]h}(h]h ]h"]h$]h&]jaKuh1jVhjubjW)}(hhh]h}(h]h ]h"]h$]h&]jaK_uh1jVhjubj~)}(hhh](j)}(hhh](j)}(hhh]h)}(hBitsh]hBits}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK[hj ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hBehaviorh]hBehavior}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK\hj"ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h$``DEVLINK_FLASH_OVERWRITE_SETTINGS``h]h)}(hjGh]h DEVLINK_FLASH_OVERWRITE_SETTINGS}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjEubah}(h]h ]h"]h$]h&]uh1hhhhK]hjBubah}(h]h ]h"]h$]h&]uh1jhj?ubj)}(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.}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK^hjbubah}(h]h ]h"]h$]h&]uh1jhj?ubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(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}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh and }(hjhhhNhNubh)}(h'``DEVLINK_FLASH_OVERWRITE_IDENTIFIERS``h]h#DEVLINK_FLASH_OVERWRITE_IDENTIFIERS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]uh1hhhhKbhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hXDo 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, Vital product Data (VPD) area, and device serial number. It is expected that this combination be used with an image customized for the specific device.h]hXDo 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, Vital product Data (VPD) area, and device serial number. It is expected that this combination be used with an image customized for the specific device.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKchjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j}hjubeh}(h]h ]h"]h$]h&]colsKuh1jQhjubeh}(h]id2ah ]jZah"]h$]h&]uh1j>hjfhhhNhNubeh}(h] flash-updateah ]h"] flash updateah$]h&]uh1hhhhhhhhKQubh)}(hhh](h)}(hReloadh]hReload}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKkubh)}(hThe ``ixgbe`` 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 ``ixgbe``h]hixgbe}(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}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh action.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKmhjhhubh 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}hjEsbah}(h]h ]h"]h$]h&]forcehighlight_args}hhlanguageshelluh1jChhhKqhjhhubh)}(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.}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKuhjhhubh)}(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 }(hjfhhhNhNubh)}(h'``DEVLINK_RELOAD_ACTION_DRIVER_REINIT``h]h#DEVLINK_RELOAD_ACTION_DRIVER_REINIT}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjfubh.}(hjfhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKyhjhhubeh}(h]reloadah ]h"]reloadah$]h&]uh1hhhhhhhhKkubh)}(hhh](h)}(hRegionsh]hRegions}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK}ubh)}(hYThe ``ixgbe`` driver implements the following regions for accessing internal device data.h](hThe }(hjhhhNhNubh)}(h ``ixgbe``h]hixgbe}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubhL driver implements the following regions for accessing internal device data.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj?)}(hhh](h)}(hregions implementedh]hregions implemented}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubjR)}(hhh](jW)}(hhh]h}(h]h ]h"]h$]h&]jaKuh1jVhjubjW)}(hhh]h}(h]h ]h"]h$]h&]jaKUuh1jVhjubj~)}(hhh](j)}(hhh](j)}(hhh]h)}(hNameh]hName}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h Descriptionh]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h ``nvm-flash``h]h)}(hj' h]h nvm-flash}(hj) hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj% ubah}(h]h ]h"]h$]h&]uh1hhhhKhj" ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(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.}(hjE hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjB ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h``shadow-ram``h]h)}(hjg h]h shadow-ram}(hji hhhNhNubah}(h]h ]h"]h$]h&]uh1hhje ubah}(h]h ]h"]h$]h&]uh1hhhhKhjb ubah}(h]h ]h"]h$]h&]uh1jhj_ ubj)}(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&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj_ ubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h``device-caps``h]h)}(hj h]h device-caps}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(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.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j}hjubeh}(h]h ]h"]h$]h&]colsKuh1jQhjubeh}(h]id3ah ]jZah"]h$]h&]uh1j>hjhhhNhNubh)}(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 }(hj hhhNhNubh)}(h ``nvm-flash``h]h nvm-flash}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubh and }(hj hhhNhNubh)}(h``shadow-ram``h]h shadow-ram}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubh1 regions can be accessed without a snapshot. The }(hj hhhNhNubh)}(h``device-caps``h]h device-caps}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubhj region requires a snapshot as the contents are sent by firmware and can’t be split into separate reads.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(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 }(hj7 hhhNhNubh)}(h``DEVLINK_CMD_REGION_NEW``h]hDEVLINK_CMD_REGION_NEW}(hj? hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7 ubh command.}(hj7 hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubjD)}(hX$ 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 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/device-caps snapshot 1h]hX$ 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 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/device-caps snapshot 1}hjW sbah}(h]h ]h"]h$]h&]forcehighlight_args}hhjVshelluh1jChhhKhjhhubeh}(h]regionsah ]h"]regionsah$]h&]uh1hhhhhhhhK}ubeh}(h]ixgbe-devlink-supportah ]h"]ixgbe devlink supportah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksjfootnote_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_handlerj error_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh _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}(jv js jcj`jjjjjn jk u nametypes}(jv jcjjjn uh}(js hj`hjjfjjjk jjXj@jjj ju 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.