Commit 9e087457 authored by Ido Schimmel's avatar Ido Schimmel Committed by David S. Miller
Browse files

Documentation: Add description of netdevsim traps 



Signed-off-by: default avatarIdo Schimmel <idosch@mellanox.com>
Acked-by: default avatarJiri Pirko <jiri@mellanox.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent da58f90f

Documentation/networking/devlink-trap-netdevsim.rst

0 → 100644
+20 −0
Original line number Diff line number Diff line 
.. 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

Documentation/networking/devlink-trap.rst

+11 −0
Original line number Diff line number Diff line
@@ -162,6 +162,17 @@ be added to the following table: 
     - Traps packets that the device decided to drop because they could not be

       enqueued to a transmission queue which is full



Driver-specific Packet Traps

============================



Device drivers can register driver-specific packet traps, but these must be

clearly documented. Such traps can correspond to device-specific exceptions and

help debug packet drops caused by these exceptions. The following list includes

links to the description of driver-specific traps registered by various device

drivers:



  * :doc:`/devlink-trap-netdevsim`



Generic Packet Trap Groups

==========================

Documentation/networking/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -15,6 +15,7 @@ Contents: 
   dsa/index

   devlink-info-versions

   devlink-trap

   devlink-trap-netdevsim

   ieee802154

   kapi

   z8530book

drivers/net/netdevsim/dev.c

+3 −0
Original line number Diff line number Diff line
@@ -323,6 +323,9 @@ struct nsim_trap_data { 
	spinlock_t trap_lock;	/* Protects trap_items_arr */

};



/* All driver-specific traps must be documented in

 * Documentation/networking/devlink-trap-netdevsim.rst

 */

enum {

	NSIM_TRAP_ID_BASE = DEVLINK_TRAP_GENERIC_ID_MAX,

	NSIM_TRAP_ID_FID_MISS,