diff options
author | Ben Hutchings <bhutchings@solarflare.com> | 2012-04-05 10:39:47 -0400 |
---|---|---|
committer | David S. Miller <davem@davemloft.net> | 2012-04-06 02:43:12 -0400 |
commit | b3cf65457fc0c8d183bdb9bc4358e5706aa63cc5 (patch) | |
tree | ca499f8c186b35d7ae035810f4592e783c8ce0d0 /Documentation/networking/driver.txt | |
parent | 04fd3d3515612b71f96b851db7888bfe58ef2142 (diff) |
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.
Signed-off-by: Ben Hutchings <bhutchings@solarflare.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'Documentation/networking/driver.txt')
-rw-r--r-- | Documentation/networking/driver.txt | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Documentation/networking/driver.txt b/Documentation/networking/driver.txt index 03283daa64fe..83ce06080ceb 100644 --- a/Documentation/networking/driver.txt +++ b/Documentation/networking/driver.txt | |||
@@ -2,7 +2,7 @@ Document about softnet driver issues | |||
2 | 2 | ||
3 | Transmit path guidelines: | 3 | Transmit path guidelines: |
4 | 4 | ||
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 |
6 | normal circumstances. It is considered a hard error unless | 6 | normal circumstances. It is considered a hard error unless |
7 | there is no way your device can tell ahead of time when it's | 7 | 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: | |||
61 | 2) Do not forget to update netdev->trans_start to jiffies after | 61 | 2) 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 | ||
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 |
65 | cloned SKB. | 65 | cloned SKB. |
66 | 66 | ||
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 |
68 | method, it is your driver's responsibility to free up the SKB | 68 | 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: | |||
74 | This error can deadlock sockets waiting for send buffer room | 74 | 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 keep | 77 | 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 | ||
80 | Probing guidelines: | 80 | Probing guidelines: |
@@ -85,10 +85,10 @@ Probing guidelines: | |||
85 | 85 | ||
86 | Close/stop guidelines: | 86 | Close/stop guidelines: |
87 | 87 | ||
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 |
89 | not receive or transmit any data. All in flight packets must | 89 | 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 | ||
93 | 2) The dev->stop routine will be called by unregister_netdevice | 93 | 2) The ndo_stop routine will be called by unregister_netdevice |
94 | if device is still UP. | 94 | if device is still UP. |