Netdev Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Moshe Shemesh <moshe@mellanox.com>
To: "David S. Miller" <davem@davemloft.net>,
	Jakub Kicinski <kuba@kernel.org>, Jiri Pirko <jiri@mellanox.com>
Cc: netdev@vger.kernel.org, linux-kernel@vger.kernel.org,
	Moshe Shemesh <moshe@mellanox.com>
Subject: [PATCH net-next RFC v2 13/13] devlink: Add Documentation/networking/devlink/devlink-reload.rst
Date: Mon, 17 Aug 2020 12:37:52 +0300	[thread overview]
Message-ID: <1597657072-3130-14-git-send-email-moshe@mellanox.com> (raw)
In-Reply-To: <1597657072-3130-1-git-send-email-moshe@mellanox.com>

Add devlink reload rst documentation file.
Update index file to include it.

Signed-off-by: Moshe Shemesh <moshe@mellanox.com>
---
- Instead of reload levels driver,fw_reset,fw_live_patch have reload
  actions driver_reinit,fw_activate,fw_live_patch
---
 .../networking/devlink/devlink-reload.rst     | 54 +++++++++++++++++++
 Documentation/networking/devlink/index.rst    |  1 +
 2 files changed, 55 insertions(+)
 create mode 100644 Documentation/networking/devlink/devlink-reload.rst

diff --git a/Documentation/networking/devlink/devlink-reload.rst b/Documentation/networking/devlink/devlink-reload.rst
new file mode 100644
index 000000000000..9846ea727f3b
--- /dev/null
+++ b/Documentation/networking/devlink/devlink-reload.rst
@@ -0,0 +1,54 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==============
+Devlink Reload
+==============
+
+``devlink-reload`` provides mechanism to either reload driver entities,
+applying ``devlink-params`` and ``devlink-resources`` new values or firmware
+activation depends on reload action selected.
+
+Reload actions
+=============
+
+User may select a reload action.
+By default ``driver_reinit`` action is done.
+
+.. list-table:: Possible reload actions
+   :widths: 5 90
+
+   * - Name
+     - Description
+   * - ``driver-reinit``
+     - Driver entities re-initialization, including applying
+       new values to devlink entities which are used during driver
+       load such as ``devlink-params`` in configuration mode
+       ``driverinit`` or ``devlink-resources``
+   * - ``fw_activate``
+     - Firmware activate. Can be used for firmware reload or firmware
+       upgrade if new firmware is stored and driver supports such
+       firmware upgrade.
+   * - ``fw_live_patch``
+     - Firmware live patch, applies firmware changes without reset.
+
+Change namespace
+================
+
+All devlink instances are created in init_net and stay there for a
+lifetime. Allow user to be able to move devlink instances into
+namespaces during devlink reload operation. That ensures proper
+re-instantiation of driver objects, including netdevices.
+
+example usage
+-------------
+
+.. code:: shell
+
+    $ devlink dev reload help
+    $ devlink dev reload DEV [ netns { PID | NAME | ID } ] [ action { fw_live_patch | driver_reinit | fw_activate } ]
+
+    # Run reload command for devlink driver entities re-initialization:
+    $ devlink dev reload pci/0000:82:00.0 action driver_reinit
+
+    # Run reload command to activate firmware:
+    $ devlink dev reload pci/0000:82:00.0 action fw_activate
diff --git a/Documentation/networking/devlink/index.rst b/Documentation/networking/devlink/index.rst
index 7684ae5c4a4a..d82874760ae2 100644
--- a/Documentation/networking/devlink/index.rst
+++ b/Documentation/networking/devlink/index.rst
@@ -20,6 +20,7 @@ general.
    devlink-params
    devlink-region
    devlink-resource
+   devlink-reload
    devlink-trap
 
 Driver-specific documentation
-- 
2.17.1


  parent reply	other threads:[~2020-08-17  9:39 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-17  9:37 [PATCH net-next RFC v2 00/13] Add devlink reload action option Moshe Shemesh
2020-08-17  9:37 ` [PATCH net-next RFC v2 01/13] devlink: Add reload action option to devlink reload command Moshe Shemesh
2020-08-17 16:16   ` Jakub Kicinski
2020-08-18  9:06     ` Moshe Shemesh
2020-08-18 15:37       ` Jakub Kicinski
2020-08-17 16:36   ` Jiri Pirko
2020-08-18  9:10     ` Moshe Shemesh
2020-08-19  0:10       ` Jakub Kicinski
2020-08-19 12:18         ` Moshe Shemesh
2020-08-19 12:46           ` Jiri Pirko
2020-08-19 14:23             ` Moshe Shemesh
2020-08-19 15:18               ` Jiri Pirko
2020-08-19 16:25                 ` Jakub Kicinski
2020-08-19 18:55                   ` Jiri Pirko
2020-08-17  9:37 ` [PATCH net-next RFC v2 02/13] devlink: Add supported reload actions to dev get Moshe Shemesh
2020-08-17  9:37 ` [PATCH net-next RFC v2 03/13] net/mlx5: Add functions to set/query MFRL register Moshe Shemesh
2020-08-17  9:37 ` [PATCH net-next RFC v2 04/13] net/mlx5: Set cap for pci sync for fw update event Moshe Shemesh
2020-08-17  9:37 ` [PATCH net-next RFC v2 05/13] net/mlx5: Handle sync reset request event Moshe Shemesh
2020-08-17  9:37 ` [PATCH net-next RFC v2 06/13] net/mlx5: Handle sync reset now event Moshe Shemesh
2020-08-17  9:37 ` [PATCH net-next RFC v2 07/13] net/mlx5: Handle sync reset abort event Moshe Shemesh
2020-08-17  9:37 ` [PATCH net-next RFC v2 08/13] net/mlx5: Add support for devlink reload action fw activate Moshe Shemesh
2020-08-17  9:37 ` [PATCH net-next RFC v2 09/13] devlink: Add enable_remote_dev_reset generic parameter Moshe Shemesh
2020-08-17  9:37 ` [PATCH net-next RFC v2 10/13] net/mlx5: Add devlink param enable_remote_dev_reset support Moshe Shemesh
2020-08-17  9:37 ` [PATCH net-next RFC v2 11/13] net/mlx5: Add support for fw live patch event Moshe Shemesh
2020-08-17  9:37 ` [PATCH net-next RFC v2 12/13] net/mlx5: Add support for devlink reload action live patch Moshe Shemesh
2020-08-17  9:37 ` Moshe Shemesh [this message]
2020-08-17 16:39   ` [PATCH net-next RFC v2 13/13] devlink: Add Documentation/networking/devlink/devlink-reload.rst Jiri Pirko
2020-08-18  9:14     ` Moshe Shemesh
2020-08-18 11:07       ` Jiri Pirko
2020-08-18 20:04         ` Moshe Shemesh

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1597657072-3130-14-git-send-email-moshe@mellanox.com \
    --to=moshe@mellanox.com \
    --cc=davem@davemloft.net \
    --cc=jiri@mellanox.com \
    --cc=kuba@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --subject='Re: [PATCH net-next RFC v2 13/13] devlink: Add Documentation/networking/devlink/devlink-reload.rst' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).