diff options
| author | Jakub Kicinski <kuba@kernel.org> | 2023-04-06 18:25:31 -0700 |
|---|---|---|
| committer | Jakub Kicinski <kuba@kernel.org> | 2023-04-10 17:56:17 -0700 |
| commit | da4f0f82ee9d5a128b48c959e8db7f41b59848c8 (patch) | |
| tree | ccf91a1a44e824c424c39045d05fdac502560f2b /Documentation/networking/driver.rst | |
| parent | d2f5c68e3f7157e874a759e382a5eaffa775b869 (diff) | |
| download | linux-stable-da4f0f82ee9d5a128b48c959e8db7f41b59848c8.tar.gz linux-stable-da4f0f82ee9d5a128b48c959e8db7f41b59848c8.tar.bz2 linux-stable-da4f0f82ee9d5a128b48c959e8db7f41b59848c8.zip | |
docs: net: move the probe and open/close sections of driver.rst up
Somehow it feels more right to start from the probe then open,
then tx... Much like the lifetime of the driver itself.
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Diffstat (limited to 'Documentation/networking/driver.rst')
| -rw-r--r-- | Documentation/networking/driver.rst | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/Documentation/networking/driver.rst b/Documentation/networking/driver.rst index 3040a74d421c..bfbd66871bb3 100644 --- a/Documentation/networking/driver.rst +++ b/Documentation/networking/driver.rst @@ -4,6 +4,33 @@ Softnet Driver Issues ===================== +Probing guidelines +================== + +Address validation +------------------ + +Any hardware layer address you obtain for your device should +be verified. For example, for ethernet check it with +linux/etherdevice.h:is_valid_ether_addr() + +Close/stop guidelines +===================== + +Quiescence +---------- + +After the ndo_stop routine has been called, the hardware must +not receive or transmit any data. All in flight packets must +be aborted. If necessary, poll or wait for completion of +any reset commands. + +Auto-close +---------- + +The ndo_stop routine will be called by unregister_netdevice +if device is still UP. + Transmit path guidelines ======================== @@ -89,30 +116,3 @@ to be freed up. If you return NETDEV_TX_BUSY from the ndo_start_xmit method, you must not keep any reference to that SKB and you must not attempt to free it up. - -Probing guidelines -================== - -Address validation ------------------- - -Any hardware layer address you obtain for your device should -be verified. For example, for ethernet check it with -linux/etherdevice.h:is_valid_ether_addr() - -Close/stop guidelines -===================== - -Quiescence ----------- - -After the ndo_stop routine has been called, the hardware must -not receive or transmit any data. All in flight packets must -be aborted. If necessary, poll or wait for completion of -any reset commands. - -Auto-close ----------- - -The ndo_stop routine will be called by unregister_netdevice -if device is still UP. |