summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorVladimir Oltean <vladimir.oltean@nxp.com>2022-07-16 21:53:36 +0300
committerDavid S. Miller <davem@davemloft.net>2022-07-18 12:44:37 +0100
commit3c87237ecd27fe5534f3324a4dccbce059c04e40 (patch)
tree25cfb558f45602c939108c542126516fdc6e2411 /Documentation
parentb763f50dc157c2796dded090fac3e05cb5147348 (diff)
docs: net: dsa: document port_setup and port_teardown
These methods were added without being documented, fix that. Fixes: fd292c189a97 ("net: dsa: tear down devlink port regions when tearing down the devlink port on error") Signed-off-by: Vladimir Oltean <vladimir.oltean@nxp.com> Reviewed-by: Andrew Lunn <andrew@lunn.ch> Reviewed-by: Florian Fainelli <f.fainelli@gmail.com> Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/networking/dsa/dsa.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/networking/dsa/dsa.rst b/Documentation/networking/dsa/dsa.rst
index e16eb2e5e787..eade80ed226b 100644
--- a/Documentation/networking/dsa/dsa.rst
+++ b/Documentation/networking/dsa/dsa.rst
@@ -620,6 +620,15 @@ Switch configuration
may have previously configured. The method responsible for undoing any
applicable allocations or operations done here is ``teardown``.
+- ``port_setup`` and ``port_teardown``: methods for initialization and
+ destruction of per-port data structures. It is mandatory for some operations
+ such as registering and unregistering devlink port regions to be done from
+ these methods, otherwise they are optional. A port will be torn down only if
+ it has been previously set up. It is possible for a port to be set up during
+ probing only to be torn down immediately afterwards, for example in case its
+ PHY cannot be found. In this case, probing of the DSA switch continues
+ without that particular port.
+
PHY devices and link management
-------------------------------