Skip to content

Commit

Permalink
docs: networking: convert netdevices.txt to ReST
Browse files Browse the repository at this point in the history
- add SPDX header;
- adjust title markup;
- mark lists as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
  • Loading branch information
Mauro Carvalho Chehab authored and David S. Miller committed Apr 30, 2020
1 parent ea5baca commit 482a436
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 8 deletions.
2 changes: 1 addition & 1 deletion Documentation/networking/can.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1058,7 +1058,7 @@ drivers you mainly have to deal with:
- TX: Put the CAN frame from the socket buffer to the CAN controller.
- RX: Put the CAN frame from the CAN controller to the socket buffer.

See e.g. at Documentation/networking/netdevices.txt . The differences
See e.g. at Documentation/networking/netdevices.rst . The differences
for writing CAN network device driver are described below:


Expand Down
1 change: 1 addition & 0 deletions Documentation/networking/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ Contents:
multiqueue
netconsole
netdev-features
netdevices

.. only:: subproject and html

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
.. SPDX-License-Identifier: GPL-2.0
=====================================
Network Devices, the Kernel, and You!
=====================================


Introduction
Expand Down Expand Up @@ -75,11 +78,12 @@ ndo_start_xmit:
Don't use it for new drivers.

Context: Process with BHs disabled or BH (timer),
will be called with interrupts disabled by netconsole.
will be called with interrupts disabled by netconsole.

Return codes:
o NETDEV_TX_OK everything ok.
o NETDEV_TX_BUSY Cannot transmit packet, try later
Return codes:

* NETDEV_TX_OK everything ok.
* NETDEV_TX_BUSY Cannot transmit packet, try later
Usually a bug, means queue start/stop flow control is broken in
the driver. Note: the driver must NOT put the skb in its DMA ring.

Expand All @@ -95,10 +99,13 @@ ndo_set_rx_mode:
struct napi_struct synchronization rules
========================================
napi->poll:
Synchronization: NAPI_STATE_SCHED bit in napi->state. Device
Synchronization:
NAPI_STATE_SCHED bit in napi->state. Device
driver's ndo_stop method will invoke napi_disable() on
all NAPI instances which will do a sleeping poll on the
NAPI_STATE_SCHED napi->state bit, waiting for all pending
NAPI activity to cease.
Context: softirq
will be called with interrupts disabled by netconsole.

Context:
softirq
will be called with interrupts disabled by netconsole.

0 comments on commit 482a436

Please sign in to comment.