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
22
33 Transmit path guidelines:
44
5−1) The hard_start_xmit method must never return '1' under any
5+1) The ndo_start_xmit method must never return '1' under any
66 normal circumstances. It is considered a hard error unless
77 there is no way your device can tell ahead of time when it's
88 transmit function will become busy.
@@ -61,10 +61,10 @@ Transmit path guidelines: · 52 unmodified lines
6161 2) Do not forget to update netdev->trans_start to jiffies after
6262 each new tx packet is given to the hardware.
6363
64−3) A hard_start_xmit method must not modify the shared parts of a
64+3) An ndo_start_xmit method must not modify the shared parts of a
6565 cloned SKB.
6666
67−4) Do not forget that once you return 0 from your hard_start_xmit
67+4) Do not forget that once you return 0 from your ndo_start_xmit
6868 method, it is your driver's responsibility to free up the SKB
6969 and in some finite amount of time.
7070
@@ -74,7 +74,7 @@ Transmit path guidelines: · 3 unmodified lines
7474 This error can deadlock sockets waiting for send buffer room
7575 to be freed up.
7676
77− If you return 1 from the hard_start_xmit method, you must not keep
77+ If you return 1 from the ndo_start_xmit method, you must not keep
7878 any reference to that SKB and you must not attempt to free it up.
7979
8080 Probing guidelines:
@@ -85,10 +85,10 @@ Probing guidelines: · 4 unmodified lines
8585
8686 Close/stop guidelines:
8787
88−1) After the dev->stop routine has been called, the hardware must
88+1) After the ndo_stop routine has been called, the hardware must
8989 not receive or transmit any data. All in flight packets must
9090 be aborted. If necessary, poll or wait for completion of
9191 any reset commands.
9292
93−2) The dev->stop routine will be called by unregister_netdevice
93+2) The ndo_stop routine will be called by unregister_netdevice
9494 if device is still UP.
Documentation/networking/netdevices.txt+8−8
@@ -47,24 +47,24 @@ packets is preferred. · 46 unmodified lines
4747
4848 struct net_device synchronization rules
4949 =======================================
50−dev->open:
50+ndo_open:
5151 Synchronization: rtnl_lock() semaphore.
5252 Context: process
5353
54−dev->stop:
54+ndo_stop:
5555 Synchronization: rtnl_lock() semaphore.
5656 Context: process
5757 Note: netif_running() is guaranteed false
5858
59−dev->do_ioctl:
59+ndo_do_ioctl:
6060 Synchronization: rtnl_lock() semaphore.
6161 Context: process
6262
63−dev->get_stats:
63+ndo_get_stats:
6464 Synchronization: dev_base_lock rwlock.
6565 Context: nominally process, but don't sleep inside an rwlock
6666
67−dev->hard_start_xmit:
67+ndo_start_xmit:
6868 Synchronization: __netif_tx_lock spinlock.
6969
7070 When the driver sets NETIF_F_LLTX in dev->features this will be
@@ -86,12 +86,12 @@ dev->hard_start_xmit: · 15 unmodified lines
8686 o NETDEV_TX_LOCKED Locking failed, please retry quickly.
8787 Only valid when NETIF_F_LLTX is set.
8888
89−dev->tx_timeout:
89+ndo_tx_timeout:
9090 Synchronization: netif_tx_lock spinlock; all TX queues frozen.
9191 Context: BHs disabled
9292 Notes: netif_queue_stopped() is guaranteed true
9393
94−dev->set_rx_mode:
94+ndo_set_rx_mode:
9595 Synchronization: netif_addr_lock spinlock.
9696 Context: BHs disabled
9797
@@ -99,7 +99,7 @@ struct napi_struct synchronization rules · 1 unmodified line
9999 ========================================
100100 napi->poll:
101101 Synchronization: NAPI_STATE_SCHED bit in napi->state. Device
102− driver's dev->close method will invoke napi_disable() on
102+ driver's ndo_stop method will invoke napi_disable() on
103103 all NAPI instances which will do a sleeping poll on the
104104 NAPI_STATE_SCHED napi->state bit, waiting for all pending
105105 NAPI activity to cease.