History

doc, net: Update netdev operation names

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

Ben Hutchings committed 14 years ago

Commit b3cf6541 parent 04fd3d32 files · +14 −14Browse files

Unified · Split

2 files
  1. Documentation/networking/driver.txt +6 −6
  2. Documentation/networking/netdevices.txt +8 −8
Documentation/networking/driver.txt+6−6
@@ -2,7 +2,7 @@ Document about softnet driver issues · 1 unmodified line
2 2
3Transmit path guidelines:3Transmit path guidelines:
4 4
51) The hard_start_xmit method must never return '1' under any51) The ndo_start_xmit method must never return '1' under any
6 normal circumstances. It is considered a hard error unless6 normal circumstances. It is considered a hard error unless
7 there is no way your device can tell ahead of time when it's7 there is no way your device can tell ahead of time when it's
8 transmit function will become busy.8 transmit function will become busy.
@@ -61,10 +61,10 @@ Transmit path guidelines: · 52 unmodified lines
612) Do not forget to update netdev->trans_start to jiffies after612) Do not forget to update netdev->trans_start to jiffies after
62 each new tx packet is given to the hardware.62 each new tx packet is given to the hardware.
63 63
643) A hard_start_xmit method must not modify the shared parts of a643) An ndo_start_xmit method must not modify the shared parts of a
65 cloned SKB.65 cloned SKB.
66 66
674) Do not forget that once you return 0 from your hard_start_xmit674) Do not forget that once you return 0 from your ndo_start_xmit
68 method, it is your driver's responsibility to free up the SKB68 method, it is your driver's responsibility to free up the SKB
69 and in some finite amount of time.69 and in some finite amount of time.
70 70
@@ -74,7 +74,7 @@ Transmit path guidelines: · 3 unmodified lines
74 This error can deadlock sockets waiting for send buffer room74 This error can deadlock sockets waiting for send buffer room
75 to be freed up.75 to be freed up.
76 76
77 If you return 1 from the hard_start_xmit method, you must not keep77 If you return 1 from the ndo_start_xmit method, you must not keep
78 any reference to that SKB and you must not attempt to free it up.78 any reference to that SKB and you must not attempt to free it up.
79 79
80Probing guidelines:80Probing guidelines:
@@ -85,10 +85,10 @@ Probing guidelines: · 4 unmodified lines
85 85
86Close/stop guidelines:86Close/stop guidelines:
87 87
881) After the dev->stop routine has been called, the hardware must881) After the ndo_stop routine has been called, the hardware must
89 not receive or transmit any data. All in flight packets must89 not receive or transmit any data. All in flight packets must
90 be aborted. If necessary, poll or wait for completion of 90 be aborted. If necessary, poll or wait for completion of
91 any reset commands.91 any reset commands.
92 92
932) The dev->stop routine will be called by unregister_netdevice932) The ndo_stop routine will be called by unregister_netdevice
94 if device is still UP.94 if device is still UP.
Documentation/networking/netdevices.txt+8−8
@@ -47,24 +47,24 @@ packets is preferred. · 46 unmodified lines
47 47
48struct net_device synchronization rules48struct net_device synchronization rules
49=======================================49=======================================
50dev->open:50ndo_open:
51 Synchronization: rtnl_lock() semaphore.51 Synchronization: rtnl_lock() semaphore.
52 Context: process52 Context: process
53 53
54dev->stop:54ndo_stop:
55 Synchronization: rtnl_lock() semaphore.55 Synchronization: rtnl_lock() semaphore.
56 Context: process56 Context: process
57 Note: netif_running() is guaranteed false57 Note: netif_running() is guaranteed false
58 58
59dev->do_ioctl:59ndo_do_ioctl:
60 Synchronization: rtnl_lock() semaphore.60 Synchronization: rtnl_lock() semaphore.
61 Context: process61 Context: process
62 62
63dev->get_stats:63ndo_get_stats:
64 Synchronization: dev_base_lock rwlock.64 Synchronization: dev_base_lock rwlock.
65 Context: nominally process, but don't sleep inside an rwlock65 Context: nominally process, but don't sleep inside an rwlock
66 66
67dev->hard_start_xmit:67ndo_start_xmit:
68 Synchronization: __netif_tx_lock spinlock.68 Synchronization: __netif_tx_lock spinlock.
69 69
70 When the driver sets NETIF_F_LLTX in dev->features this will be70 When the driver sets NETIF_F_LLTX in dev->features this will be
@@ -86,12 +86,12 @@ dev->hard_start_xmit: · 15 unmodified lines
86 o NETDEV_TX_LOCKED Locking failed, please retry quickly.86 o NETDEV_TX_LOCKED Locking failed, please retry quickly.
87 Only valid when NETIF_F_LLTX is set.87 Only valid when NETIF_F_LLTX is set.
88 88
89dev->tx_timeout:89ndo_tx_timeout:
90 Synchronization: netif_tx_lock spinlock; all TX queues frozen.90 Synchronization: netif_tx_lock spinlock; all TX queues frozen.
91 Context: BHs disabled91 Context: BHs disabled
92 Notes: netif_queue_stopped() is guaranteed true92 Notes: netif_queue_stopped() is guaranteed true
93 93
94dev->set_rx_mode:94ndo_set_rx_mode:
95 Synchronization: netif_addr_lock spinlock.95 Synchronization: netif_addr_lock spinlock.
96 Context: BHs disabled96 Context: BHs disabled
97 97
@@ -99,7 +99,7 @@ struct napi_struct synchronization rules · 1 unmodified line
99========================================99========================================
100napi->poll:100napi->poll:
101 Synchronization: NAPI_STATE_SCHED bit in napi->state. Device101 Synchronization: NAPI_STATE_SCHED bit in napi->state. Device
102 driver's dev->close method will invoke napi_disable() on102 driver's ndo_stop method will invoke napi_disable() on
103 all NAPI instances which will do a sleeping poll on the103 all NAPI instances which will do a sleeping poll on the
104 NAPI_STATE_SCHED napi->state bit, waiting for all pending104 NAPI_STATE_SCHED napi->state bit, waiting for all pending
105 NAPI activity to cease.105 NAPI activity to cease.