2 * INET An implementation of the TCP/IP protocol suite for the LINUX
3 * operating system. INET is implemented using the BSD Socket
4 * interface as the means of communication with the user level.
6 * Ethernet-type device handling.
8 * Version: @(#)eth.c 1.0.7 05/25/93
11 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
12 * Mark Evans, <evansmp@uhura.aston.ac.uk>
13 * Florian La Roche, <rzsfl@rz.uni-sb.de>
14 * Alan Cox, <gw4pts@gw4pts.ampr.org>
17 * Mr Linux : Arp problems
18 * Alan Cox : Generic queue tidyup (very tiny here)
19 * Alan Cox : eth_header ntohs should be htons
20 * Alan Cox : eth_rebuild_header missing an htons and
22 * Tegge : Arp bug fixes.
23 * Florian : Removed many unnecessary functions, code cleanup
24 * and changes for new arp and skbuff.
25 * Alan Cox : Redid header building to reflect new format.
26 * Alan Cox : ARP only when compiled with CONFIG_INET
27 * Greg Page : 802.2 and SNAP stuff.
28 * Alan Cox : MAC layer pointers/new format.
29 * Paul Gortmaker : eth_copy_and_sum shouldn't csum padding.
30 * Alan Cox : Protect against forwarding explosions with
31 * older network drivers and IFF_ALLMULTI.
32 * Christer Weinigel : Better rebuild header message.
33 * Andrew Morton : 26Feb01: kill ether_setup() - use netdev_boot_setup().
35 * This program is free software; you can redistribute it and/or
36 * modify it under the terms of the GNU General Public License
37 * as published by the Free Software Foundation; either version
38 * 2 of the License, or (at your option) any later version.
40 #include <linux/module.h>
41 #include <linux/types.h>
42 #include <linux/kernel.h>
43 #include <linux/string.h>
45 #include <linux/socket.h>
47 #include <linux/inet.h>
49 #include <linux/netdevice.h>
50 #include <linux/nvmem-consumer.h>
51 #include <linux/etherdevice.h>
52 #include <linux/skbuff.h>
53 #include <linux/errno.h>
54 #include <linux/init.h>
55 #include <linux/if_ether.h>
56 #include <linux/of_net.h>
57 #include <linux/pci.h>
64 #include <net/flow_dissector.h>
65 #include <linux/uaccess.h>
66 #include <net/pkt_sched.h>
68 __setup("ether=", netdev_boot_setup
);
71 * eth_header - create the Ethernet header
72 * @skb: buffer to alter
74 * @type: Ethernet type field
75 * @daddr: destination address (NULL leave destination address)
76 * @saddr: source address (NULL use device source address)
77 * @len: packet length (<= skb->len)
80 * Set the protocol type. For a packet of type ETH_P_802_3/2 we put the length
83 int eth_header(struct sk_buff
*skb
, struct net_device
*dev
,
85 const void *daddr
, const void *saddr
, unsigned int len
)
87 struct ethhdr
*eth
= skb_push(skb
, ETH_HLEN
);
89 if (type
!= ETH_P_802_3
&& type
!= ETH_P_802_2
)
90 eth
->h_proto
= htons(type
);
92 eth
->h_proto
= htons(len
);
95 * Set the source hardware address.
99 saddr
= dev
->dev_addr
;
100 memcpy(eth
->h_source
, saddr
, ETH_ALEN
);
103 memcpy(eth
->h_dest
, daddr
, ETH_ALEN
);
108 * Anyway, the loopback-device should never use this function...
111 if (dev
->flags
& (IFF_LOOPBACK
| IFF_NOARP
)) {
112 eth_zero_addr(eth
->h_dest
);
118 EXPORT_SYMBOL(eth_header
);
121 * eth_get_headlen - determine the length of header for an ethernet frame
122 * @dev: pointer to network device
123 * @data: pointer to start of frame
124 * @len: total length of frame
126 * Make a best effort attempt to pull the length for all of the headers for
127 * a given frame in a linear buffer.
129 u32
eth_get_headlen(const struct net_device
*dev
, void *data
, unsigned int len
)
131 const unsigned int flags
= FLOW_DISSECTOR_F_PARSE_1ST_FRAG
;
132 const struct ethhdr
*eth
= (const struct ethhdr
*)data
;
133 struct flow_keys_basic keys
;
135 /* this should never happen, but better safe than sorry */
136 if (unlikely(len
< sizeof(*eth
)))
139 /* parse any remaining L2/L3 headers, check for L4 */
140 if (!skb_flow_dissect_flow_keys_basic(dev_net(dev
), NULL
, &keys
, data
,
141 eth
->h_proto
, sizeof(*eth
),
143 return max_t(u32
, keys
.control
.thoff
, sizeof(*eth
));
145 /* parse for any L4 headers */
146 return min_t(u32
, __skb_get_poff(NULL
, data
, &keys
, len
), len
);
148 EXPORT_SYMBOL(eth_get_headlen
);
151 * eth_type_trans - determine the packet's protocol ID.
152 * @skb: received socket data
153 * @dev: receiving network device
155 * The rule here is that we
156 * assume 802.3 if the type field is short enough to be a length.
157 * This is normal practice and works for any 'now in use' protocol.
159 __be16
eth_type_trans(struct sk_buff
*skb
, struct net_device
*dev
)
161 unsigned short _service_access_point
;
162 const unsigned short *sap
;
163 const struct ethhdr
*eth
;
166 skb_reset_mac_header(skb
);
168 eth
= (struct ethhdr
*)skb
->data
;
169 skb_pull_inline(skb
, ETH_HLEN
);
171 if (unlikely(!ether_addr_equal_64bits(eth
->h_dest
,
173 if (unlikely(is_multicast_ether_addr_64bits(eth
->h_dest
))) {
174 if (ether_addr_equal_64bits(eth
->h_dest
, dev
->broadcast
))
175 skb
->pkt_type
= PACKET_BROADCAST
;
177 skb
->pkt_type
= PACKET_MULTICAST
;
179 skb
->pkt_type
= PACKET_OTHERHOST
;
184 * Some variants of DSA tagging don't have an ethertype field
185 * at all, so we check here whether one of those tagging
186 * variants has been configured on the receiving interface,
187 * and if so, set skb->protocol without looking at the packet.
188 * The DSA tagging protocol may be able to decode some but not all
189 * traffic (for example only for management). In that case give it the
190 * option to filter the packets from which it can decode source port
193 if (unlikely(netdev_uses_dsa(dev
)) && dsa_can_decode(skb
, dev
))
194 return htons(ETH_P_XDSA
);
196 if (likely(eth_proto_is_802_3(eth
->h_proto
)))
200 * This is a magic hack to spot IPX packets. Older Novell breaks
201 * the protocol design and runs IPX over 802.3 without an 802.2 LLC
202 * layer. We look for FFFF which isn't a used 802.2 SSAP/DSAP. This
203 * won't work for fault tolerant netware but does for the rest.
205 sap
= skb_header_pointer(skb
, 0, sizeof(*sap
), &_service_access_point
);
206 if (sap
&& *sap
== 0xFFFF)
207 return htons(ETH_P_802_3
);
212 return htons(ETH_P_802_2
);
214 EXPORT_SYMBOL(eth_type_trans
);
217 * eth_header_parse - extract hardware address from packet
218 * @skb: packet to extract header from
219 * @haddr: destination buffer
221 int eth_header_parse(const struct sk_buff
*skb
, unsigned char *haddr
)
223 const struct ethhdr
*eth
= eth_hdr(skb
);
224 memcpy(haddr
, eth
->h_source
, ETH_ALEN
);
227 EXPORT_SYMBOL(eth_header_parse
);
230 * eth_header_cache - fill cache entry from neighbour
231 * @neigh: source neighbour
232 * @hh: destination cache entry
233 * @type: Ethernet type field
235 * Create an Ethernet header template from the neighbour.
237 int eth_header_cache(const struct neighbour
*neigh
, struct hh_cache
*hh
, __be16 type
)
240 const struct net_device
*dev
= neigh
->dev
;
242 eth
= (struct ethhdr
*)
243 (((u8
*) hh
->hh_data
) + (HH_DATA_OFF(sizeof(*eth
))));
245 if (type
== htons(ETH_P_802_3
))
249 memcpy(eth
->h_source
, dev
->dev_addr
, ETH_ALEN
);
250 memcpy(eth
->h_dest
, neigh
->ha
, ETH_ALEN
);
251 hh
->hh_len
= ETH_HLEN
;
254 EXPORT_SYMBOL(eth_header_cache
);
257 * eth_header_cache_update - update cache entry
258 * @hh: destination cache entry
259 * @dev: network device
260 * @haddr: new hardware address
262 * Called by Address Resolution module to notify changes in address.
264 void eth_header_cache_update(struct hh_cache
*hh
,
265 const struct net_device
*dev
,
266 const unsigned char *haddr
)
268 memcpy(((u8
*) hh
->hh_data
) + HH_DATA_OFF(sizeof(struct ethhdr
)),
271 EXPORT_SYMBOL(eth_header_cache_update
);
274 * eth_header_parser_protocol - extract protocol from L2 header
275 * @skb: packet to extract protocol from
277 __be16
eth_header_parse_protocol(const struct sk_buff
*skb
)
279 const struct ethhdr
*eth
= eth_hdr(skb
);
283 EXPORT_SYMBOL(eth_header_parse_protocol
);
286 * eth_prepare_mac_addr_change - prepare for mac change
287 * @dev: network device
290 int eth_prepare_mac_addr_change(struct net_device
*dev
, void *p
)
292 struct sockaddr
*addr
= p
;
294 if (!(dev
->priv_flags
& IFF_LIVE_ADDR_CHANGE
) && netif_running(dev
))
296 if (!is_valid_ether_addr(addr
->sa_data
))
297 return -EADDRNOTAVAIL
;
300 EXPORT_SYMBOL(eth_prepare_mac_addr_change
);
303 * eth_commit_mac_addr_change - commit mac change
304 * @dev: network device
307 void eth_commit_mac_addr_change(struct net_device
*dev
, void *p
)
309 struct sockaddr
*addr
= p
;
311 memcpy(dev
->dev_addr
, addr
->sa_data
, ETH_ALEN
);
313 EXPORT_SYMBOL(eth_commit_mac_addr_change
);
316 * eth_mac_addr - set new Ethernet hardware address
317 * @dev: network device
320 * Change hardware address of device.
322 * This doesn't change hardware matching, so needs to be overridden
323 * for most real devices.
325 int eth_mac_addr(struct net_device
*dev
, void *p
)
329 ret
= eth_prepare_mac_addr_change(dev
, p
);
332 eth_commit_mac_addr_change(dev
, p
);
335 EXPORT_SYMBOL(eth_mac_addr
);
338 * eth_change_mtu - set new MTU size
339 * @dev: network device
340 * @new_mtu: new Maximum Transfer Unit
342 * Allow changing MTU size. Needs to be overridden for devices
343 * supporting jumbo frames.
345 int eth_change_mtu(struct net_device
*dev
, int new_mtu
)
347 netdev_warn(dev
, "%s is deprecated\n", __func__
);
351 EXPORT_SYMBOL(eth_change_mtu
);
353 int eth_validate_addr(struct net_device
*dev
)
355 if (!is_valid_ether_addr(dev
->dev_addr
))
356 return -EADDRNOTAVAIL
;
360 EXPORT_SYMBOL(eth_validate_addr
);
362 const struct header_ops eth_header_ops ____cacheline_aligned
= {
363 .create
= eth_header
,
364 .parse
= eth_header_parse
,
365 .cache
= eth_header_cache
,
366 .cache_update
= eth_header_cache_update
,
367 .parse_protocol
= eth_header_parse_protocol
,
371 * ether_setup - setup Ethernet network device
372 * @dev: network device
374 * Fill in the fields of the device structure with Ethernet-generic values.
376 void ether_setup(struct net_device
*dev
)
378 dev
->header_ops
= ð_header_ops
;
379 dev
->type
= ARPHRD_ETHER
;
380 dev
->hard_header_len
= ETH_HLEN
;
381 dev
->min_header_len
= ETH_HLEN
;
382 dev
->mtu
= ETH_DATA_LEN
;
383 dev
->min_mtu
= ETH_MIN_MTU
;
384 dev
->max_mtu
= ETH_DATA_LEN
;
385 dev
->addr_len
= ETH_ALEN
;
386 dev
->tx_queue_len
= DEFAULT_TX_QUEUE_LEN
;
387 dev
->flags
= IFF_BROADCAST
|IFF_MULTICAST
;
388 dev
->priv_flags
|= IFF_TX_SKB_SHARING
;
390 eth_broadcast_addr(dev
->broadcast
);
393 EXPORT_SYMBOL(ether_setup
);
396 * alloc_etherdev_mqs - Allocates and sets up an Ethernet device
397 * @sizeof_priv: Size of additional driver-private structure to be allocated
398 * for this Ethernet device
399 * @txqs: The number of TX queues this device has.
400 * @rxqs: The number of RX queues this device has.
402 * Fill in the fields of the device structure with Ethernet-generic
403 * values. Basically does everything except registering the device.
405 * Constructs a new net device, complete with a private data area of
406 * size (sizeof_priv). A 32-byte (not bit) alignment is enforced for
407 * this private data area.
410 struct net_device
*alloc_etherdev_mqs(int sizeof_priv
, unsigned int txqs
,
413 return alloc_netdev_mqs(sizeof_priv
, "eth%d", NET_NAME_UNKNOWN
,
414 ether_setup
, txqs
, rxqs
);
416 EXPORT_SYMBOL(alloc_etherdev_mqs
);
418 static void devm_free_netdev(struct device
*dev
, void *res
)
420 free_netdev(*(struct net_device
**)res
);
423 struct net_device
*devm_alloc_etherdev_mqs(struct device
*dev
, int sizeof_priv
,
424 unsigned int txqs
, unsigned int rxqs
)
426 struct net_device
**dr
;
427 struct net_device
*netdev
;
429 dr
= devres_alloc(devm_free_netdev
, sizeof(*dr
), GFP_KERNEL
);
433 netdev
= alloc_etherdev_mqs(sizeof_priv
, txqs
, rxqs
);
444 EXPORT_SYMBOL(devm_alloc_etherdev_mqs
);
446 ssize_t
sysfs_format_mac(char *buf
, const unsigned char *addr
, int len
)
448 return scnprintf(buf
, PAGE_SIZE
, "%*phC\n", len
, addr
);
450 EXPORT_SYMBOL(sysfs_format_mac
);
452 struct sk_buff
*eth_gro_receive(struct list_head
*head
, struct sk_buff
*skb
)
454 const struct packet_offload
*ptype
;
455 unsigned int hlen
, off_eth
;
456 struct sk_buff
*pp
= NULL
;
457 struct ethhdr
*eh
, *eh2
;
462 off_eth
= skb_gro_offset(skb
);
463 hlen
= off_eth
+ sizeof(*eh
);
464 eh
= skb_gro_header_fast(skb
, off_eth
);
465 if (skb_gro_header_hard(skb
, hlen
)) {
466 eh
= skb_gro_header_slow(skb
, hlen
, off_eth
);
473 list_for_each_entry(p
, head
, list
) {
474 if (!NAPI_GRO_CB(p
)->same_flow
)
477 eh2
= (struct ethhdr
*)(p
->data
+ off_eth
);
478 if (compare_ether_header(eh
, eh2
)) {
479 NAPI_GRO_CB(p
)->same_flow
= 0;
487 ptype
= gro_find_receive_by_type(type
);
493 skb_gro_pull(skb
, sizeof(*eh
));
494 skb_gro_postpull_rcsum(skb
, eh
, sizeof(*eh
));
495 pp
= call_gro_receive(ptype
->callbacks
.gro_receive
, head
, skb
);
500 skb_gro_flush_final(skb
, pp
, flush
);
504 EXPORT_SYMBOL(eth_gro_receive
);
506 int eth_gro_complete(struct sk_buff
*skb
, int nhoff
)
508 struct ethhdr
*eh
= (struct ethhdr
*)(skb
->data
+ nhoff
);
509 __be16 type
= eh
->h_proto
;
510 struct packet_offload
*ptype
;
513 if (skb
->encapsulation
)
514 skb_set_inner_mac_header(skb
, nhoff
);
517 ptype
= gro_find_complete_by_type(type
);
519 err
= ptype
->callbacks
.gro_complete(skb
, nhoff
+
520 sizeof(struct ethhdr
));
525 EXPORT_SYMBOL(eth_gro_complete
);
527 static struct packet_offload eth_packet_offload __read_mostly
= {
528 .type
= cpu_to_be16(ETH_P_TEB
),
531 .gro_receive
= eth_gro_receive
,
532 .gro_complete
= eth_gro_complete
,
536 static int __init
eth_offload_init(void)
538 dev_add_offload(ð_packet_offload
);
543 fs_initcall(eth_offload_init
);
545 unsigned char * __weak
arch_get_platform_mac_address(void)
550 int eth_platform_get_mac_address(struct device
*dev
, u8
*mac_addr
)
552 const unsigned char *addr
;
553 struct device_node
*dp
;
556 dp
= pci_device_to_OF_node(to_pci_dev(dev
));
562 addr
= of_get_mac_address(dp
);
563 if (IS_ERR_OR_NULL(addr
))
564 addr
= arch_get_platform_mac_address();
569 ether_addr_copy(mac_addr
, addr
);
572 EXPORT_SYMBOL(eth_platform_get_mac_address
);
575 * Obtain the MAC address from an nvmem cell named 'mac-address' associated
578 * @dev: Device with which the mac-address cell is associated.
579 * @addrbuf: Buffer to which the MAC address will be copied on success.
581 * Returns 0 on success or a negative error number on failure.
583 int nvmem_get_mac_address(struct device
*dev
, void *addrbuf
)
585 struct nvmem_cell
*cell
;
589 cell
= nvmem_cell_get(dev
, "mac-address");
591 return PTR_ERR(cell
);
593 mac
= nvmem_cell_read(cell
, &len
);
594 nvmem_cell_put(cell
);
599 if (len
!= ETH_ALEN
|| !is_valid_ether_addr(mac
)) {
604 ether_addr_copy(addrbuf
, mac
);
609 EXPORT_SYMBOL(nvmem_get_mac_address
);