From: Jakub Kicinski <kuba@kernel.org>
To: davem@davemloft.net
Cc: netdev@vger.kernel.org, edumazet@google.com, pabeni@redhat.com,
herbert@gondor.apana.org.au, alexander.duyck@gmail.com,
hkallweit1@gmail.com, andrew@lunn.ch, willemb@google.com,
Jakub Kicinski <kuba@kernel.org>
Subject: [PATCH net-next v3 2/7] docs: net: move the probe and open/close sections of driver.rst up
Date: Wed, 5 Apr 2023 15:31:29 -0700 [thread overview]
Message-ID: <20230405223134.94665-3-kuba@kernel.org> (raw)
In-Reply-To: <20230405223134.94665-1-kuba@kernel.org>
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>
---
Documentation/networking/driver.rst | 54 ++++++++++++++---------------
1 file 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.
--
2.39.2
next prev parent reply other threads:[~2023-04-05 22:32 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-05 22:31 [PATCH net-next v3 0/7] net: lockless stop/wake combo macros Jakub Kicinski
2023-04-05 22:31 ` [PATCH net-next v3 1/7] docs: net: reformat driver.rst from a list to sections Jakub Kicinski
2023-04-05 22:31 ` Jakub Kicinski [this message]
2023-04-05 22:31 ` [PATCH net-next v3 3/7] docs: net: use C syntax highlight in driver.rst Jakub Kicinski
2023-04-05 22:31 ` [PATCH net-next v3 4/7] net: provide macros for commonly copied lockless queue stop/wake code Jakub Kicinski
2023-04-06 7:22 ` Herbert Xu
2023-04-05 22:31 ` [PATCH net-next v3 5/7] ixgbe: use new queue try_stop/try_wake macros Jakub Kicinski
2023-04-05 22:31 ` [PATCH net-next v3 6/7] bnxt: " Jakub Kicinski
2023-04-05 22:31 ` [PATCH net-next v3 7/7] net: piggy back on the memory barrier in bql when waking queues Jakub Kicinski
2023-04-06 7:35 ` Herbert Xu
2023-04-07 0:41 ` Jakub Kicinski
2023-04-12 6:06 ` Herbert Xu
2023-04-12 13:54 ` Jakub Kicinski
2023-04-13 2:31 ` Herbert Xu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230405223134.94665-3-kuba@kernel.org \
--to=kuba@kernel.org \
--cc=alexander.duyck@gmail.com \
--cc=andrew@lunn.ch \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=herbert@gondor.apana.org.au \
--cc=hkallweit1@gmail.com \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=willemb@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.