Commit 482a4360 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by David S. Miller
Browse files

docs: networking: convert netdevices.txt to ReST 



- add SPDX header;
- adjust title markup;
- mark lists as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent ea5bacaa

Documentation/networking/can.rst

+1 −1
Original line number Diff line number Diff line
@@ -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:

Documentation/networking/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -82,6 +82,7 @@ Contents: 
   multiqueue

   netconsole

   netdev-features

   netdevices



.. only::  subproject and html

Documentation/networking/netdevices.txt→Documentation/networking/netdevices.rst

+14 −7
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



=====================================

Network Devices, the Kernel, and You!

=====================================





Introduction
@@ -78,8 +81,9 @@ ndo_start_xmit: 
		 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 



	* 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.
@@ -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



	Context:

		 softirq

		 will be called with interrupts disabled by netconsole.