Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit b3cf6545 authored by Ben Hutchings's avatar Ben Hutchings Committed by David S. Miller
Browse files

doc, net: Update netdev operation names 



Commits d314774c ('netdev: network
device operations infrastructure') and
00829823 ('netdev: add more functions
to netdevice ops') moved and renamed net device operation pointers.

Signed-off-by: default avatarBen Hutchings <bhutchings@solarflare.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 04fd3d35

Documentation/networking/driver.txt

+6 −6
Original line number Original line Diff line number Diff line
@@ -2,7 +2,7 @@ Document about softnet driver issues 




Transmit path guidelines:

Transmit path guidelines:





1) The hard_start_xmit method must never return '1' under any

1) The ndo_start_xmit method must never return '1' under any

   normal circumstances.  It is considered a hard error unless

   normal circumstances.  It is considered a hard error unless

   there is no way your device can tell ahead of time when it's

   there is no way your device can tell ahead of time when it's

   transmit function will become busy.

   transmit function will become busy.
@@ -61,10 +61,10 @@ Transmit path guidelines: 
2) Do not forget to update netdev->trans_start to jiffies after

2) Do not forget to update netdev->trans_start to jiffies after

   each new tx packet is given to the hardware.

   each new tx packet is given to the hardware.





3) A hard_start_xmit method must not modify the shared parts of a

3) An ndo_start_xmit method must not modify the shared parts of a

   cloned SKB.

   cloned SKB.





4) Do not forget that once you return 0 from your hard_start_xmit

4) Do not forget that once you return 0 from your ndo_start_xmit

   method, it is your driver's responsibility to free up the SKB

   method, it is your driver's responsibility to free up the SKB

   and in some finite amount of time.

   and in some finite amount of time.
@@ -74,7 +74,7 @@ Transmit path guidelines: 
   This error can deadlock sockets waiting for send buffer room

   This error can deadlock sockets waiting for send buffer room

   to be freed up.

   to be freed up.





   If you return 1 from the hard_start_xmit method, you must not keep

   If you return 1 from the ndo_start_xmit method, you must not keep

   any reference to that SKB and you must not attempt to free it up.

   any reference to that SKB and you must not attempt to free it up.





Probing guidelines:

Probing guidelines:
@@ -85,10 +85,10 @@ Probing guidelines: 




Close/stop guidelines:

Close/stop guidelines:





1) After the dev->stop routine has been called, the hardware must

1) After the ndo_stop routine has been called, the hardware must

   not receive or transmit any data.  All in flight packets must

   not receive or transmit any data.  All in flight packets must

   be aborted. If necessary, poll or wait for completion of 

   be aborted. If necessary, poll or wait for completion of 

   any reset commands.

   any reset commands.





2) The dev->stop routine will be called by unregister_netdevice

2) The ndo_stop routine will be called by unregister_netdevice

   if device is still UP.
 
   if device is still UP.

Documentation/networking/netdevices.txt

+8 −8
Original line number Original line Diff line number Diff line
@@ -47,24 +47,24 @@ packets is preferred. 




struct net_device synchronization rules

struct net_device synchronization rules

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

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

dev->open:

ndo_open:

	Synchronization: rtnl_lock() semaphore.

	Synchronization: rtnl_lock() semaphore.

	Context: process

	Context: process





dev->stop:

ndo_stop:

	Synchronization: rtnl_lock() semaphore.

	Synchronization: rtnl_lock() semaphore.

	Context: process

	Context: process

	Note: netif_running() is guaranteed false

	Note: netif_running() is guaranteed false





dev->do_ioctl:

ndo_do_ioctl:

	Synchronization: rtnl_lock() semaphore.

	Synchronization: rtnl_lock() semaphore.

	Context: process

	Context: process





dev->get_stats:

ndo_get_stats:

	Synchronization: dev_base_lock rwlock.

	Synchronization: dev_base_lock rwlock.

	Context: nominally process, but don't sleep inside an rwlock

	Context: nominally process, but don't sleep inside an rwlock





dev->hard_start_xmit:

ndo_start_xmit:

	Synchronization: __netif_tx_lock spinlock.

	Synchronization: __netif_tx_lock spinlock.





	When the driver sets NETIF_F_LLTX in dev->features this will be

	When the driver sets NETIF_F_LLTX in dev->features this will be
@@ -86,12 +86,12 @@ dev->hard_start_xmit: 
	o NETDEV_TX_LOCKED Locking failed, please retry quickly.

	o NETDEV_TX_LOCKED Locking failed, please retry quickly.

	  Only valid when NETIF_F_LLTX is set.

	  Only valid when NETIF_F_LLTX is set.





dev->tx_timeout:

ndo_tx_timeout:

	Synchronization: netif_tx_lock spinlock; all TX queues frozen.

	Synchronization: netif_tx_lock spinlock; all TX queues frozen.

	Context: BHs disabled

	Context: BHs disabled

	Notes: netif_queue_stopped() is guaranteed true

	Notes: netif_queue_stopped() is guaranteed true





dev->set_rx_mode:

ndo_set_rx_mode:

	Synchronization: netif_addr_lock spinlock.

	Synchronization: netif_addr_lock spinlock.

	Context: BHs disabled

	Context: BHs disabled
@@ -99,7 +99,7 @@ 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 dev->close 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.