docs: net: dsa: document port_fast_age

The provided information about FDB flushing is not really up to date. The DSA core automatically calls port_fast_age() when necessary, and drivers should just implement that rather than hooking it to port_bridge_leave, port_stp_state_set and others.

Vladimir Oltean committed 4 years ago

Commit 0cb86821 parent 3c872371 file · +8 −6Browse files

Unified · Split

Documentation/networking/dsa/dsa.rst+8−6

 - ``port_bridge_leave``: bridge layer function invoked when a given switch port is
   removed from a bridge, this function should do what's necessary at the
   switch level to deny the leaving port from ingress/egress traffic from the
-  remaining bridge members. When the port leaves the bridge, it should be aged
+  remaining bridge members.
-  out at the switch hardware for the switch to (re) learn MAC addresses behind
-  this port.
 - ``port_stp_state_set``: bridge layer function invoked when a given switch port STP
   state is computed by the bridge layer and should be propagated to switch
-  hardware to forward/block/learn traffic. The switch driver is responsible for
+  hardware to forward/block/learn traffic.
-  computing a STP state change based on current and asked parameters and perform
-  the relevant ageing based on the intersection results
 - ``port_bridge_flags``: bridge layer function invoked when a port must
   configure its settings for e.g. flooding of unknown traffic or source address
 - ``port_bridge_tx_fwd_unoffload``: bridge layer function invoked when a driver
   leaves a bridge port which had the TX forwarding offload feature enabled.
+- ``port_fast_age``: bridge layer function invoked when flushing the
+  dynamically learned FDB entries on the port is necessary. This is called when
+  transitioning from an STP state where learning should take place to an STP
+  state where it shouldn't, or when leaving a bridge, or when address learning
+  is turned off via ``port_bridge_flags``.
 Bridge VLAN filtering
 ---------------------