diff options
author | stephen hemminger <shemminger@vyatta.com> | 2012-05-17 01:17:28 -0400 |
---|---|---|
committer | David S. Miller <davem@davemloft.net> | 2012-05-17 15:36:35 -0400 |
commit | 048b899ce38c3e1db88cb4464547090ef28630f8 (patch) | |
tree | 86aeb087790aac7fc5b5a2093ec44bbad5e743e0 /include/linux/etherdevice.h | |
parent | 3b12bb60437eb69cd9ff58e5dee23b525d01d069 (diff) |
etherdevice: fix comments
Fix some minor problems in comments of etherdevice.h
* Warning is out dated, file hasn't moved or disappeared in many years and
is unlikely to do so soon.
* Capitalize Ethernet consistently since it is a proper name
* Fix descriptive comment of padding
* Spelling and grammar fix for alignment comment
Signed-off-by: Stephen Hemminger <shemminger@vyatta.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'include/linux/etherdevice.h')
-rw-r--r-- | include/linux/etherdevice.h | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/include/linux/etherdevice.h b/include/linux/etherdevice.h index dc85c1d2173b..3d406e0ede6d 100644 --- a/include/linux/etherdevice.h +++ b/include/linux/etherdevice.h | |||
@@ -18,8 +18,6 @@ | |||
18 | * as published by the Free Software Foundation; either version | 18 | * as published by the Free Software Foundation; either version |
19 | * 2 of the License, or (at your option) any later version. | 19 | * 2 of the License, or (at your option) any later version. |
20 | * | 20 | * |
21 | * WARNING: This move may well be temporary. This file will get merged with others RSN. | ||
22 | * | ||
23 | */ | 21 | */ |
24 | #ifndef _LINUX_ETHERDEVICE_H | 22 | #ifndef _LINUX_ETHERDEVICE_H |
25 | #define _LINUX_ETHERDEVICE_H | 23 | #define _LINUX_ETHERDEVICE_H |
@@ -159,7 +157,7 @@ static inline void eth_hw_addr_random(struct net_device *dev) | |||
159 | * @addr1: Pointer to a six-byte array containing the Ethernet address | 157 | * @addr1: Pointer to a six-byte array containing the Ethernet address |
160 | * @addr2: Pointer other six-byte array containing the Ethernet address | 158 | * @addr2: Pointer other six-byte array containing the Ethernet address |
161 | * | 159 | * |
162 | * Compare two ethernet addresses, returns 0 if equal, non-zero otherwise. | 160 | * Compare two Ethernet addresses, returns 0 if equal, non-zero otherwise. |
163 | * Unlike memcmp(), it doesn't return a value suitable for sorting. | 161 | * Unlike memcmp(), it doesn't return a value suitable for sorting. |
164 | */ | 162 | */ |
165 | static inline unsigned compare_ether_addr(const u8 *addr1, const u8 *addr2) | 163 | static inline unsigned compare_ether_addr(const u8 *addr1, const u8 *addr2) |
@@ -176,7 +174,7 @@ static inline unsigned compare_ether_addr(const u8 *addr1, const u8 *addr2) | |||
176 | * @addr1: Pointer to a six-byte array containing the Ethernet address | 174 | * @addr1: Pointer to a six-byte array containing the Ethernet address |
177 | * @addr2: Pointer other six-byte array containing the Ethernet address | 175 | * @addr2: Pointer other six-byte array containing the Ethernet address |
178 | * | 176 | * |
179 | * Compare two ethernet addresses, returns true if equal | 177 | * Compare two Ethernet addresses, returns true if equal |
180 | */ | 178 | */ |
181 | static inline bool ether_addr_equal(const u8 *addr1, const u8 *addr2) | 179 | static inline bool ether_addr_equal(const u8 *addr1, const u8 *addr2) |
182 | { | 180 | { |
@@ -197,13 +195,13 @@ static inline unsigned long zap_last_2bytes(unsigned long value) | |||
197 | * @addr1: Pointer to an array of 8 bytes | 195 | * @addr1: Pointer to an array of 8 bytes |
198 | * @addr2: Pointer to an other array of 8 bytes | 196 | * @addr2: Pointer to an other array of 8 bytes |
199 | * | 197 | * |
200 | * Compare two ethernet addresses, returns true if equal, false otherwise. | 198 | * Compare two Ethernet addresses, returns true if equal, false otherwise. |
201 | * | 199 | * |
202 | * The function doesn't need any conditional branches and possibly uses | 200 | * The function doesn't need any conditional branches and possibly uses |
203 | * word memory accesses on CPU allowing cheap unaligned memory reads. | 201 | * word memory accesses on CPU allowing cheap unaligned memory reads. |
204 | * arrays = { byte1, byte2, byte3, byte4, byte6, byte7, pad1, pad2} | 202 | * arrays = { byte1, byte2, byte3, byte4, byte5, byte6, pad1, pad2 } |
205 | * | 203 | * |
206 | * Please note that alignment of addr1 & addr2 is only guaranted to be 16 bits. | 204 | * Please note that alignment of addr1 & addr2 are only guaranteed to be 16 bits. |
207 | */ | 205 | */ |
208 | 206 | ||
209 | static inline bool ether_addr_equal_64bits(const u8 addr1[6+2], | 207 | static inline bool ether_addr_equal_64bits(const u8 addr1[6+2], |
@@ -257,7 +255,7 @@ static inline bool is_etherdev_addr(const struct net_device *dev, | |||
257 | * @a: Pointer to Ethernet header | 255 | * @a: Pointer to Ethernet header |
258 | * @b: Pointer to Ethernet header | 256 | * @b: Pointer to Ethernet header |
259 | * | 257 | * |
260 | * Compare two ethernet headers, returns 0 if equal. | 258 | * Compare two Ethernet headers, returns 0 if equal. |
261 | * This assumes that the network header (i.e., IP header) is 4-byte | 259 | * This assumes that the network header (i.e., IP header) is 4-byte |
262 | * aligned OR the platform can handle unaligned access. This is the | 260 | * aligned OR the platform can handle unaligned access. This is the |
263 | * case for all packets coming into netif_receive_skb or similar | 261 | * case for all packets coming into netif_receive_skb or similar |