niansa-misc/linux
1
0
Fork 0
mirror of synced 2025-03-06 20:59:54 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: networking: convert netdevices.txt to ReST

Browse source 
- 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>
This commit is contained in:
Mauro Carvalho Chehab 2020-04-30 18:04:04 +02:00 • committed by David S. Miller
parent ea5bacaa2c
commit 482a4360c5
3 changed files with 16 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Documentation/networking/can.rst
View file

@ -1058,7 +1058,7 @@ drivers you mainly have to deal with:
- TX: Put the CAN frame from the socket buffer to the CAN controller. - 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. - 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: for writing CAN network device driver are described below:

1
Documentation/networking/index.rst
View file

@ -82,6 +82,7 @@ Contents:
multiqueue multiqueue
netconsole netconsole
netdev-features netdev-features
netdevices
.. only:: subproject and html .. only:: subproject and html

21
Documentation/networking/netdevices.txt → Documentation/networking/netdevices.rst
View file

@ -1,5 +1,8 @@
.. SPDX-License-Identifier: GPL-2.0
=====================================
Network Devices, the Kernel, and You! Network Devices, the Kernel, and You!
=====================================
Introduction Introduction
@ -75,11 +78,12 @@ ndo_start_xmit:
Don't use it for new drivers. Don't use it for new drivers.
Context: Process with BHs disabled or BH (timer), 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: Return codes:
o NETDEV_TX_OK everything ok.
o NETDEV_TX_BUSY Cannot transmit packet, try later * 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 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. the driver. Note: the driver must NOT put the skb in its DMA ring.
@ -95,10 +99,13 @@ ndo_set_rx_mode:
struct napi_struct synchronization rules struct napi_struct synchronization rules
======================================== ========================================
napi->poll: 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 driver's ndo_stop method will invoke napi_disable() on
all NAPI instances which will do a sleeping poll on the all NAPI instances which will do a sleeping poll on the
NAPI_STATE_SCHED napi->state bit, waiting for all pending NAPI_STATE_SCHED napi->state bit, waiting for all pending
NAPI activity to cease. NAPI activity to cease.
Context: softirq
will be called with interrupts disabled by netconsole. Context:
softirq
will be called with interrupts disabled by netconsole.