sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget5/translations/zh_CN/networking/devlink/devlink-paramsmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget5/translations/zh_TW/networking/devlink/devlink-paramsmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget5/translations/it_IT/networking/devlink/devlink-paramsmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget5/translations/ja_JP/networking/devlink/devlink-paramsmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget5/translations/ko_KR/networking/devlink/devlink-paramsmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget5/translations/pt_BR/networking/devlink/devlink-paramsmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget5/translations/sp_SP/networking/devlink/devlink-paramsmodnameN 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:spacepreserveuh1hhhhhhO/var/lib/git/docbuild/linux/Documentation/networking/devlink/devlink-params.rsthKubhsection)}(hhh](htitle)}(hDevlink Paramsh]hDevlink Params}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(h``devlink`` provides capability for a driver to expose device parameters for low level device functionality. Since devlink can operate at the device-wide level, it can be used to provide configuration that may affect multiple ports on a single device.h](hliteral)}(h ``devlink``h]hdevlink}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhubh provides capability for a driver to expose device parameters for low level device functionality. Since devlink can operate at the device-wide level, it can be used to provide configuration that may affect multiple ports on a single device.}(hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hThis document describes a number of generic parameters that are supported across multiple drivers. Each driver is also free to add their own parameters. Each driver must document the specific parameters they support, whether generic or not.h]hThis document describes a number of generic parameters that are supported across multiple drivers. Each driver is also free to add their own parameters. Each driver must document the specific parameters they support, whether generic or not.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh)}(hhh](h)}(hConfiguration modesh]hConfiguration modes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhKubh)}(h7Parameters may be set in different configuration modes.h]h7Parameters may be set in different configuration modes.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj hhubhtable)}(hhh](h)}(hPossible configuration modesh]hPossible configuration modes}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj,ubhtgroup)}(hhh](hcolspec)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jBhj?ubjC)}(hhh]h}(h]h ]h"]h$]h&]jMKZuh1jBhj?ubhtbody)}(hhh](hrow)}(hhh](hentry)}(hhh]h)}(hNameh]hName}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjcubah}(h]h ]h"]h$]h&]uh1jahj^ubjb)}(hhh]h)}(h Descriptionh]h Description}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjzubah}(h]h ]h"]h$]h&]uh1jahj^ubeh}(h]h ]h"]h$]h&]uh1j\hjYubj])}(hhh](jb)}(hhh]h)}(h ``runtime``h]h)}(hjh]hruntime}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jahjubjb)}(hhh]h)}(hTset while the driver is running, and takes effect immediately. No reset is required.h]hTset while the driver is running, and takes effect immediately. No reset is required.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1j\hjYubj])}(hhh](jb)}(hhh]h)}(h``driverinit``h]h)}(hjh]h driverinit}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jahjubjb)}(hhh]h)}(hsapplied while the driver initializes. Requires the user to restart the driver using the ``devlink`` reload command.h](hXapplied while the driver initializes. Requires the user to restart the driver using the }(hjhhhNhNubh)}(h ``devlink``h]hdevlink}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh reload command.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1j\hjYubj])}(hhh](jb)}(hhh]h)}(h ``permanent``h]h)}(hj1h]h permanent}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/ubah}(h]h ]h"]h$]h&]uh1hhhhK!hj,ubah}(h]h ]h"]h$]h&]uh1jahj)ubjb)}(hhh]h)}(h\written to the device's non-volatile memory. A hard reset is required for it to take effect.h]h^written to the device’s non-volatile memory. A hard reset is required for it to take effect.}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK"hjLubah}(h]h ]h"]h$]h&]uh1jahj)ubeh}(h]h ]h"]h$]h&]uh1j\hjYubeh}(h]h ]h"]h$]h&]uh1jWhj?ubeh}(h]h ]h"]h$]h&]colsKuh1j=hj,ubeh}(h]id1ah ]colwidths-givenah"]h$]h&]uh1j*hj hhhNhNubh)}(hhh](h)}(h Reloadingh]h Reloading}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj~hhhhhK&ubh)}(hIn order for ``driverinit`` parameters to take effect, the driver must support reloading via the ``devlink-reload`` command. This command will request a reload of the device driver.h](h In order for }(hjhhhNhNubh)}(h``driverinit``h]h driverinit}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubhF parameters to take effect, the driver must support reloading via the }(hjhhhNhNubh)}(h``devlink-reload``h]hdevlink-reload}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubhB command. This command will request a reload of the device driver.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK(hj~hhubeh}(h] reloadingah ]h"] reloadingah$]h&]uh1hhj hhhhhK&ubeh}(h]configuration-modesah ]h"]configuration modesah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hDefault parameter valuesh]hDefault parameter values}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK-ubh)}(hXDrivers may optionally export default values for parameters of cmode ``runtime`` and ``permanent``. For ``driverinit`` parameters, the last value set by the driver will be used as the default value. Drivers can also support resetting params with cmode ``runtime`` and ``permanent`` to their default values. Resetting ``driverinit`` params is supported by devlink core without additional driver support needed.h](hEDrivers may optionally export default values for parameters of cmode }(hjhhhNhNubh)}(h ``runtime``h]hruntime}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh and }(hjhhhNhNubh)}(h ``permanent``h]h permanent}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh. For }(hjhhhNhNubh)}(h``driverinit``h]h driverinit}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh parameters, the last value set by the driver will be used as the default value. Drivers can also support resetting params with cmode }(hjhhhNhNubh)}(h ``runtime``h]hruntime}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh and }hjsbh)}(h ``permanent``h]h permanent}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh$ to their default values. Resetting }(hjhhhNhNubh)}(h``driverinit``h]h driverinit}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubhN params is supported by devlink core without additional driver support needed.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK/hjhhubhtarget)}(h.. _devlink_params_generic:h]h}(h]h ]h"]h$]h&]refiddevlink-params-genericuh1j\hK6hjhhhhubeh}(h]default-parameter-valuesah ]h"]default parameter valuesah$]h&]uh1hhhhhhhhK-ubh)}(hhh](h)}(h Generic configuration parametersh]h Generic configuration parameters}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjrhhhhhK9ubh)}(hThe following is a list of generic configuration parameters that drivers may add. Use of generic parameters is preferred over each driver creating their own name.h]hThe following is a list of generic configuration parameters that drivers may add. Use of generic parameters is preferred over each driver creating their own name.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK:hjrhhubj+)}(hhh](h)}(hList of generic parametersh]hList of generic parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK>hjubj>)}(hhh](jC)}(hhh]h}(h]h ]h"]h$]h&]jMKuh1jBhjubjC)}(hhh]h}(h]h ]h"]h$]h&]jMKuh1jBhjubjC)}(hhh]h}(h]h ]h"]h$]h&]jMKZuh1jBhjubjX)}(hhh](j])}(hhh](jb)}(hhh]h)}(hNameh]hName}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKAhjubah}(h]h ]h"]h$]h&]uh1jahjubjb)}(hhh]h)}(hTypeh]hType}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKBhjubah}(h]h ]h"]h$]h&]uh1jahjubjb)}(hhh]h)}(h Descriptionh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKChjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1j\hjubj])}(hhh](jb)}(hhh]h)}(h``enable_sriov``h]h)}(hjh]h enable_sriov}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhKDhjubah}(h]h ]h"]h$]h&]uh1jahjubjb)}(hhh]h)}(hBooleanh]hBoolean}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKEhj4ubah}(h]h ]h"]h$]h&]uh1jahjubjb)}(hhh]h)}(h