Commit 04e4272c authored by Jacob Keller's avatar Jacob Keller Committed by David S. Miller

devlink: rename and expand devlink-trap-netdevsim.rst

Rename the trap-specific netdevimsim.rst file, and expand it to include
documentation of all the devlink features currently implemented by the
netdevsim driver code.
Signed-off-by: default avatarJacob Keller <jacob.e.keller@intel.com>
Cc: Jakub Kicinski <jakub.kicinski@netronome.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent cf4cb322
.. SPDX-License-Identifier: GPL-2.0
======================
Devlink Trap netdevsim
======================
Driver-specific Traps
=====================
.. list-table:: List of Driver-specific Traps Registered by ``netdevsim``
:widths: 5 5 90
* - Name
- Type
- Description
* - ``fid_miss``
- ``exception``
- When a packet enters the device it is classified to a filtering
indentifier (FID) based on the ingress port and VLAN. This trap is used
to trap packets for which a FID could not be found
...@@ -233,7 +233,7 @@ help debug packet drops caused by these exceptions. The following list includes ...@@ -233,7 +233,7 @@ help debug packet drops caused by these exceptions. The following list includes
links to the description of driver-specific traps registered by various device links to the description of driver-specific traps registered by various device
drivers: drivers:
* :doc:`devlink-trap-netdevsim` * :doc:`netdevsim`
Generic Packet Trap Groups Generic Packet Trap Groups
========================== ==========================
......
...@@ -18,7 +18,6 @@ general. ...@@ -18,7 +18,6 @@ general.
devlink-params devlink-params
devlink-region devlink-region
devlink-trap devlink-trap
devlink-trap-netdevsim
Driver-specific documentation Driver-specific documentation
----------------------------- -----------------------------
...@@ -35,6 +34,7 @@ parameters, info versions, and other features it supports. ...@@ -35,6 +34,7 @@ parameters, info versions, and other features it supports.
mlx5 mlx5
mlxsw mlxsw
mv88e6xxx mv88e6xxx
netdevsim
nfp nfp
qed qed
ti-cpsw-switch ti-cpsw-switch
.. SPDX-License-Identifier: GPL-2.0
=========================
netdevsim devlink support
=========================
This document describes the ``devlink`` features supported by the
``netdevsim`` device driver.
Parameters
==========
.. list-table:: Generic parameters implemented
* - Name
- Mode
* - ``max_macs``
- driverinit
The ``netdevsim`` driver also implements the following driver-specific
parameters.
.. list-table:: Driver-specific parameters implemented
:widths: 5 5 5 85
* - Name
- Type
- Mode
- Description
* - ``test1``
- Boolean
- driverinit
- Test parameter used to show how a driver-specific devlink parameter
can be implemented.
The ``netdevsim`` driver supports reloading via ``DEVLINK_CMD_RELOAD``
Regions
=======
The ``netdevsim`` driver exposes a ``dummy`` region as an example of how the
devlink-region interfaces work. A snapshot is taken whenever the
``take_snapshot`` debugfs file is written to.
Resources
=========
The ``netdevsim`` driver exposes resources to control the number of FIB
entries and FIB rule entries that the driver will allow.
.. code:: shell
$ devlink resource set netdevsim/netdevsim0 path /IPv4/fib size 96
$ devlink resource set netdevsim/netdevsim0 path /IPv4/fib-rules size 16
$ devlink resource set netdevsim/netdevsim0 path /IPv6/fib size 64
$ devlink resource set netdevsim/netdevsim0 path /IPv6/fib-rules size 16
$ devlink dev reload netdevsim/netdevsim0
Driver-specific Traps
=====================
.. list-table:: List of Driver-specific Traps Registered by ``netdevsim``
:widths: 5 5 90
* - Name
- Type
- Description
* - ``fid_miss``
- ``exception``
- When a packet enters the device it is classified to a filtering
indentifier (FID) based on the ingress port and VLAN. This trap is used
to trap packets for which a FID could not be found
...@@ -270,7 +270,7 @@ struct nsim_trap_data { ...@@ -270,7 +270,7 @@ struct nsim_trap_data {
}; };
/* All driver-specific traps must be documented in /* All driver-specific traps must be documented in
* Documentation/networking/devlink/devlink-trap-netdevsim.rst * Documentation/networking/devlink/netdevsim.rst
*/ */
enum { enum {
NSIM_TRAP_ID_BASE = DEVLINK_TRAP_GENERIC_ID_MAX, NSIM_TRAP_ID_BASE = DEVLINK_TRAP_GENERIC_ID_MAX,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment