Skip to content

Commit da4f0f8

Browse files
committed
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>
1 parent d2f5c68 commit da4f0f8

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

Documentation/networking/driver.rst

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,33 @@
44
Softnet Driver Issues
55
=====================
66

7+
Probing guidelines
8+
==================
9+
10+
Address validation
11+
------------------
12+
13+
Any hardware layer address you obtain for your device should
14+
be verified. For example, for ethernet check it with
15+
linux/etherdevice.h:is_valid_ether_addr()
16+
17+
Close/stop guidelines
18+
=====================
19+
20+
Quiescence
21+
----------
22+
23+
After the ndo_stop routine has been called, the hardware must
24+
not receive or transmit any data. All in flight packets must
25+
be aborted. If necessary, poll or wait for completion of
26+
any reset commands.
27+
28+
Auto-close
29+
----------
30+
31+
The ndo_stop routine will be called by unregister_netdevice
32+
if device is still UP.
33+
734
Transmit path guidelines
835
========================
936

@@ -89,30 +116,3 @@ to be freed up.
89116
If you return NETDEV_TX_BUSY from the ndo_start_xmit method, you
90117
must not keep any reference to that SKB and you must not attempt
91118
to free it up.
92-
93-
Probing guidelines
94-
==================
95-
96-
Address validation
97-
------------------
98-
99-
Any hardware layer address you obtain for your device should
100-
be verified. For example, for ethernet check it with
101-
linux/etherdevice.h:is_valid_ether_addr()
102-
103-
Close/stop guidelines
104-
=====================
105-
106-
Quiescence
107-
----------
108-
109-
After the ndo_stop routine has been called, the hardware must
110-
not receive or transmit any data. All in flight packets must
111-
be aborted. If necessary, poll or wait for completion of
112-
any reset commands.
113-
114-
Auto-close
115-
----------
116-
117-
The ndo_stop routine will be called by unregister_netdevice
118-
if device is still UP.

0 commit comments

Comments
 (0)