xref: /openbmc/linux/net/8021q/vlan_dev.c (revision 0545810f)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* -*- linux-c -*-
3  * INET		802.1Q VLAN
4  *		Ethernet-type device handling.
5  *
6  * Authors:	Ben Greear <greearb@candelatech.com>
7  *              Please send support related email to: netdev@vger.kernel.org
8  *              VLAN Home Page: http://www.candelatech.com/~greear/vlan.html
9  *
10  * Fixes:       Mar 22 2001: Martin Bokaemper <mbokaemper@unispherenetworks.com>
11  *                - reset skb->pkt_type on incoming packets when MAC was changed
12  *                - see that changed MAC is saddr for outgoing packets
13  *              Oct 20, 2001:  Ard van Breeman:
14  *                - Fix MC-list, finally.
15  *                - Flush MC-list on VLAN destroy.
16  */
17 
18 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 
20 #include <linux/module.h>
21 #include <linux/slab.h>
22 #include <linux/skbuff.h>
23 #include <linux/netdevice.h>
24 #include <linux/net_tstamp.h>
25 #include <linux/etherdevice.h>
26 #include <linux/ethtool.h>
27 #include <linux/phy.h>
28 #include <net/arp.h>
29 #include <net/macsec.h>
30 
31 #include "vlan.h"
32 #include "vlanproc.h"
33 #include <linux/if_vlan.h>
34 #include <linux/netpoll.h>
35 
36 /*
37  *	Create the VLAN header for an arbitrary protocol layer
38  *
39  *	saddr=NULL	means use device source address
40  *	daddr=NULL	means leave destination address (eg unresolved arp)
41  *
42  *  This is called when the SKB is moving down the stack towards the
43  *  physical devices.
44  */
45 static int vlan_dev_hard_header(struct sk_buff *skb, struct net_device *dev,
46 				unsigned short type,
47 				const void *daddr, const void *saddr,
48 				unsigned int len)
49 {
50 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
51 	struct vlan_hdr *vhdr;
52 	unsigned int vhdrlen = 0;
53 	u16 vlan_tci = 0;
54 	int rc;
55 
56 	if (!(vlan->flags & VLAN_FLAG_REORDER_HDR)) {
57 		vhdr = skb_push(skb, VLAN_HLEN);
58 
59 		vlan_tci = vlan->vlan_id;
60 		vlan_tci |= vlan_dev_get_egress_qos_mask(dev, skb->priority);
61 		vhdr->h_vlan_TCI = htons(vlan_tci);
62 
63 		/*
64 		 *  Set the protocol type. For a packet of type ETH_P_802_3/2 we
65 		 *  put the length in here instead.
66 		 */
67 		if (type != ETH_P_802_3 && type != ETH_P_802_2)
68 			vhdr->h_vlan_encapsulated_proto = htons(type);
69 		else
70 			vhdr->h_vlan_encapsulated_proto = htons(len);
71 
72 		skb->protocol = vlan->vlan_proto;
73 		type = ntohs(vlan->vlan_proto);
74 		vhdrlen = VLAN_HLEN;
75 	}
76 
77 	/* Before delegating work to the lower layer, enter our MAC-address */
78 	if (saddr == NULL)
79 		saddr = dev->dev_addr;
80 
81 	/* Now make the underlying real hard header */
82 	dev = vlan->real_dev;
83 	rc = dev_hard_header(skb, dev, type, daddr, saddr, len + vhdrlen);
84 	if (rc > 0)
85 		rc += vhdrlen;
86 	return rc;
87 }
88 
89 static inline netdev_tx_t vlan_netpoll_send_skb(struct vlan_dev_priv *vlan, struct sk_buff *skb)
90 {
91 #ifdef CONFIG_NET_POLL_CONTROLLER
92 	return netpoll_send_skb(vlan->netpoll, skb);
93 #else
94 	BUG();
95 	return NETDEV_TX_OK;
96 #endif
97 }
98 
99 static netdev_tx_t vlan_dev_hard_start_xmit(struct sk_buff *skb,
100 					    struct net_device *dev)
101 {
102 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
103 	struct vlan_ethhdr *veth = (struct vlan_ethhdr *)(skb->data);
104 	unsigned int len;
105 	int ret;
106 
107 	/* Handle non-VLAN frames if they are sent to us, for example by DHCP.
108 	 *
109 	 * NOTE: THIS ASSUMES DIX ETHERNET, SPECIFICALLY NOT SUPPORTING
110 	 * OTHER THINGS LIKE FDDI/TokenRing/802.3 SNAPs...
111 	 */
112 	if (veth->h_vlan_proto != vlan->vlan_proto ||
113 	    vlan->flags & VLAN_FLAG_REORDER_HDR) {
114 		u16 vlan_tci;
115 		vlan_tci = vlan->vlan_id;
116 		vlan_tci |= vlan_dev_get_egress_qos_mask(dev, skb->priority);
117 		__vlan_hwaccel_put_tag(skb, vlan->vlan_proto, vlan_tci);
118 	}
119 
120 	skb->dev = vlan->real_dev;
121 	len = skb->len;
122 	if (unlikely(netpoll_tx_running(dev)))
123 		return vlan_netpoll_send_skb(vlan, skb);
124 
125 	ret = dev_queue_xmit(skb);
126 
127 	if (likely(ret == NET_XMIT_SUCCESS || ret == NET_XMIT_CN)) {
128 		struct vlan_pcpu_stats *stats;
129 
130 		stats = this_cpu_ptr(vlan->vlan_pcpu_stats);
131 		u64_stats_update_begin(&stats->syncp);
132 		u64_stats_inc(&stats->tx_packets);
133 		u64_stats_add(&stats->tx_bytes, len);
134 		u64_stats_update_end(&stats->syncp);
135 	} else {
136 		this_cpu_inc(vlan->vlan_pcpu_stats->tx_dropped);
137 	}
138 
139 	return ret;
140 }
141 
142 static int vlan_dev_change_mtu(struct net_device *dev, int new_mtu)
143 {
144 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
145 	unsigned int max_mtu = real_dev->mtu;
146 
147 	if (netif_reduces_vlan_mtu(real_dev))
148 		max_mtu -= VLAN_HLEN;
149 	if (max_mtu < new_mtu)
150 		return -ERANGE;
151 
152 	dev->mtu = new_mtu;
153 
154 	return 0;
155 }
156 
157 void vlan_dev_set_ingress_priority(const struct net_device *dev,
158 				   u32 skb_prio, u16 vlan_prio)
159 {
160 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
161 
162 	if (vlan->ingress_priority_map[vlan_prio & 0x7] && !skb_prio)
163 		vlan->nr_ingress_mappings--;
164 	else if (!vlan->ingress_priority_map[vlan_prio & 0x7] && skb_prio)
165 		vlan->nr_ingress_mappings++;
166 
167 	vlan->ingress_priority_map[vlan_prio & 0x7] = skb_prio;
168 }
169 
170 int vlan_dev_set_egress_priority(const struct net_device *dev,
171 				 u32 skb_prio, u16 vlan_prio)
172 {
173 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
174 	struct vlan_priority_tci_mapping *mp = NULL;
175 	struct vlan_priority_tci_mapping *np;
176 	u32 vlan_qos = (vlan_prio << VLAN_PRIO_SHIFT) & VLAN_PRIO_MASK;
177 
178 	/* See if a priority mapping exists.. */
179 	mp = vlan->egress_priority_map[skb_prio & 0xF];
180 	while (mp) {
181 		if (mp->priority == skb_prio) {
182 			if (mp->vlan_qos && !vlan_qos)
183 				vlan->nr_egress_mappings--;
184 			else if (!mp->vlan_qos && vlan_qos)
185 				vlan->nr_egress_mappings++;
186 			mp->vlan_qos = vlan_qos;
187 			return 0;
188 		}
189 		mp = mp->next;
190 	}
191 
192 	/* Create a new mapping then. */
193 	mp = vlan->egress_priority_map[skb_prio & 0xF];
194 	np = kmalloc(sizeof(struct vlan_priority_tci_mapping), GFP_KERNEL);
195 	if (!np)
196 		return -ENOBUFS;
197 
198 	np->next = mp;
199 	np->priority = skb_prio;
200 	np->vlan_qos = vlan_qos;
201 	/* Before inserting this element in hash table, make sure all its fields
202 	 * are committed to memory.
203 	 * coupled with smp_rmb() in vlan_dev_get_egress_qos_mask()
204 	 */
205 	smp_wmb();
206 	vlan->egress_priority_map[skb_prio & 0xF] = np;
207 	if (vlan_qos)
208 		vlan->nr_egress_mappings++;
209 	return 0;
210 }
211 
212 /* Flags are defined in the vlan_flags enum in
213  * include/uapi/linux/if_vlan.h file.
214  */
215 int vlan_dev_change_flags(const struct net_device *dev, u32 flags, u32 mask)
216 {
217 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
218 	u32 old_flags = vlan->flags;
219 
220 	if (mask & ~(VLAN_FLAG_REORDER_HDR | VLAN_FLAG_GVRP |
221 		     VLAN_FLAG_LOOSE_BINDING | VLAN_FLAG_MVRP |
222 		     VLAN_FLAG_BRIDGE_BINDING))
223 		return -EINVAL;
224 
225 	vlan->flags = (old_flags & ~mask) | (flags & mask);
226 
227 	if (netif_running(dev) && (vlan->flags ^ old_flags) & VLAN_FLAG_GVRP) {
228 		if (vlan->flags & VLAN_FLAG_GVRP)
229 			vlan_gvrp_request_join(dev);
230 		else
231 			vlan_gvrp_request_leave(dev);
232 	}
233 
234 	if (netif_running(dev) && (vlan->flags ^ old_flags) & VLAN_FLAG_MVRP) {
235 		if (vlan->flags & VLAN_FLAG_MVRP)
236 			vlan_mvrp_request_join(dev);
237 		else
238 			vlan_mvrp_request_leave(dev);
239 	}
240 	return 0;
241 }
242 
243 void vlan_dev_get_realdev_name(const struct net_device *dev, char *result, size_t size)
244 {
245 	strscpy_pad(result, vlan_dev_priv(dev)->real_dev->name, size);
246 }
247 
248 bool vlan_dev_inherit_address(struct net_device *dev,
249 			      struct net_device *real_dev)
250 {
251 	if (dev->addr_assign_type != NET_ADDR_STOLEN)
252 		return false;
253 
254 	eth_hw_addr_set(dev, real_dev->dev_addr);
255 	call_netdevice_notifiers(NETDEV_CHANGEADDR, dev);
256 	return true;
257 }
258 
259 static int vlan_dev_open(struct net_device *dev)
260 {
261 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
262 	struct net_device *real_dev = vlan->real_dev;
263 	int err;
264 
265 	if (!(real_dev->flags & IFF_UP) &&
266 	    !(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
267 		return -ENETDOWN;
268 
269 	if (!ether_addr_equal(dev->dev_addr, real_dev->dev_addr) &&
270 	    !vlan_dev_inherit_address(dev, real_dev)) {
271 		err = dev_uc_add(real_dev, dev->dev_addr);
272 		if (err < 0)
273 			goto out;
274 	}
275 
276 	if (dev->flags & IFF_ALLMULTI) {
277 		err = dev_set_allmulti(real_dev, 1);
278 		if (err < 0)
279 			goto del_unicast;
280 	}
281 	if (dev->flags & IFF_PROMISC) {
282 		err = dev_set_promiscuity(real_dev, 1);
283 		if (err < 0)
284 			goto clear_allmulti;
285 	}
286 
287 	ether_addr_copy(vlan->real_dev_addr, real_dev->dev_addr);
288 
289 	if (vlan->flags & VLAN_FLAG_GVRP)
290 		vlan_gvrp_request_join(dev);
291 
292 	if (vlan->flags & VLAN_FLAG_MVRP)
293 		vlan_mvrp_request_join(dev);
294 
295 	if (netif_carrier_ok(real_dev) &&
296 	    !(vlan->flags & VLAN_FLAG_BRIDGE_BINDING))
297 		netif_carrier_on(dev);
298 	return 0;
299 
300 clear_allmulti:
301 	if (dev->flags & IFF_ALLMULTI)
302 		dev_set_allmulti(real_dev, -1);
303 del_unicast:
304 	if (!ether_addr_equal(dev->dev_addr, real_dev->dev_addr))
305 		dev_uc_del(real_dev, dev->dev_addr);
306 out:
307 	netif_carrier_off(dev);
308 	return err;
309 }
310 
311 static int vlan_dev_stop(struct net_device *dev)
312 {
313 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
314 	struct net_device *real_dev = vlan->real_dev;
315 
316 	dev_mc_unsync(real_dev, dev);
317 	dev_uc_unsync(real_dev, dev);
318 	if (dev->flags & IFF_ALLMULTI)
319 		dev_set_allmulti(real_dev, -1);
320 	if (dev->flags & IFF_PROMISC)
321 		dev_set_promiscuity(real_dev, -1);
322 
323 	if (!ether_addr_equal(dev->dev_addr, real_dev->dev_addr))
324 		dev_uc_del(real_dev, dev->dev_addr);
325 
326 	if (!(vlan->flags & VLAN_FLAG_BRIDGE_BINDING))
327 		netif_carrier_off(dev);
328 	return 0;
329 }
330 
331 static int vlan_dev_set_mac_address(struct net_device *dev, void *p)
332 {
333 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
334 	struct sockaddr *addr = p;
335 	int err;
336 
337 	if (!is_valid_ether_addr(addr->sa_data))
338 		return -EADDRNOTAVAIL;
339 
340 	if (!(dev->flags & IFF_UP))
341 		goto out;
342 
343 	if (!ether_addr_equal(addr->sa_data, real_dev->dev_addr)) {
344 		err = dev_uc_add(real_dev, addr->sa_data);
345 		if (err < 0)
346 			return err;
347 	}
348 
349 	if (!ether_addr_equal(dev->dev_addr, real_dev->dev_addr))
350 		dev_uc_del(real_dev, dev->dev_addr);
351 
352 out:
353 	eth_hw_addr_set(dev, addr->sa_data);
354 	return 0;
355 }
356 
357 static int vlan_dev_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
358 {
359 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
360 	const struct net_device_ops *ops = real_dev->netdev_ops;
361 	struct ifreq ifrr;
362 	int err = -EOPNOTSUPP;
363 
364 	strscpy_pad(ifrr.ifr_name, real_dev->name, IFNAMSIZ);
365 	ifrr.ifr_ifru = ifr->ifr_ifru;
366 
367 	switch (cmd) {
368 	case SIOCSHWTSTAMP:
369 		if (!net_eq(dev_net(dev), dev_net(real_dev)))
370 			break;
371 		fallthrough;
372 	case SIOCGMIIPHY:
373 	case SIOCGMIIREG:
374 	case SIOCSMIIREG:
375 	case SIOCGHWTSTAMP:
376 		if (netif_device_present(real_dev) && ops->ndo_eth_ioctl)
377 			err = ops->ndo_eth_ioctl(real_dev, &ifrr, cmd);
378 		break;
379 	}
380 
381 	if (!err)
382 		ifr->ifr_ifru = ifrr.ifr_ifru;
383 
384 	return err;
385 }
386 
387 static int vlan_dev_neigh_setup(struct net_device *dev, struct neigh_parms *pa)
388 {
389 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
390 	const struct net_device_ops *ops = real_dev->netdev_ops;
391 	int err = 0;
392 
393 	if (netif_device_present(real_dev) && ops->ndo_neigh_setup)
394 		err = ops->ndo_neigh_setup(real_dev, pa);
395 
396 	return err;
397 }
398 
399 #if IS_ENABLED(CONFIG_FCOE)
400 static int vlan_dev_fcoe_ddp_setup(struct net_device *dev, u16 xid,
401 				   struct scatterlist *sgl, unsigned int sgc)
402 {
403 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
404 	const struct net_device_ops *ops = real_dev->netdev_ops;
405 	int rc = 0;
406 
407 	if (ops->ndo_fcoe_ddp_setup)
408 		rc = ops->ndo_fcoe_ddp_setup(real_dev, xid, sgl, sgc);
409 
410 	return rc;
411 }
412 
413 static int vlan_dev_fcoe_ddp_done(struct net_device *dev, u16 xid)
414 {
415 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
416 	const struct net_device_ops *ops = real_dev->netdev_ops;
417 	int len = 0;
418 
419 	if (ops->ndo_fcoe_ddp_done)
420 		len = ops->ndo_fcoe_ddp_done(real_dev, xid);
421 
422 	return len;
423 }
424 
425 static int vlan_dev_fcoe_enable(struct net_device *dev)
426 {
427 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
428 	const struct net_device_ops *ops = real_dev->netdev_ops;
429 	int rc = -EINVAL;
430 
431 	if (ops->ndo_fcoe_enable)
432 		rc = ops->ndo_fcoe_enable(real_dev);
433 	return rc;
434 }
435 
436 static int vlan_dev_fcoe_disable(struct net_device *dev)
437 {
438 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
439 	const struct net_device_ops *ops = real_dev->netdev_ops;
440 	int rc = -EINVAL;
441 
442 	if (ops->ndo_fcoe_disable)
443 		rc = ops->ndo_fcoe_disable(real_dev);
444 	return rc;
445 }
446 
447 static int vlan_dev_fcoe_ddp_target(struct net_device *dev, u16 xid,
448 				    struct scatterlist *sgl, unsigned int sgc)
449 {
450 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
451 	const struct net_device_ops *ops = real_dev->netdev_ops;
452 	int rc = 0;
453 
454 	if (ops->ndo_fcoe_ddp_target)
455 		rc = ops->ndo_fcoe_ddp_target(real_dev, xid, sgl, sgc);
456 
457 	return rc;
458 }
459 #endif
460 
461 #ifdef NETDEV_FCOE_WWNN
462 static int vlan_dev_fcoe_get_wwn(struct net_device *dev, u64 *wwn, int type)
463 {
464 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
465 	const struct net_device_ops *ops = real_dev->netdev_ops;
466 	int rc = -EINVAL;
467 
468 	if (ops->ndo_fcoe_get_wwn)
469 		rc = ops->ndo_fcoe_get_wwn(real_dev, wwn, type);
470 	return rc;
471 }
472 #endif
473 
474 static void vlan_dev_change_rx_flags(struct net_device *dev, int change)
475 {
476 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
477 
478 	if (dev->flags & IFF_UP) {
479 		if (change & IFF_ALLMULTI)
480 			dev_set_allmulti(real_dev, dev->flags & IFF_ALLMULTI ? 1 : -1);
481 		if (change & IFF_PROMISC)
482 			dev_set_promiscuity(real_dev, dev->flags & IFF_PROMISC ? 1 : -1);
483 	}
484 }
485 
486 static void vlan_dev_set_rx_mode(struct net_device *vlan_dev)
487 {
488 	dev_mc_sync(vlan_dev_priv(vlan_dev)->real_dev, vlan_dev);
489 	dev_uc_sync(vlan_dev_priv(vlan_dev)->real_dev, vlan_dev);
490 }
491 
492 /*
493  * vlan network devices have devices nesting below it, and are a special
494  * "super class" of normal network devices; split their locks off into a
495  * separate class since they always nest.
496  */
497 static struct lock_class_key vlan_netdev_xmit_lock_key;
498 static struct lock_class_key vlan_netdev_addr_lock_key;
499 
500 static void vlan_dev_set_lockdep_one(struct net_device *dev,
501 				     struct netdev_queue *txq,
502 				     void *unused)
503 {
504 	lockdep_set_class(&txq->_xmit_lock, &vlan_netdev_xmit_lock_key);
505 }
506 
507 static void vlan_dev_set_lockdep_class(struct net_device *dev)
508 {
509 	lockdep_set_class(&dev->addr_list_lock,
510 			  &vlan_netdev_addr_lock_key);
511 	netdev_for_each_tx_queue(dev, vlan_dev_set_lockdep_one, NULL);
512 }
513 
514 static __be16 vlan_parse_protocol(const struct sk_buff *skb)
515 {
516 	struct vlan_ethhdr *veth = (struct vlan_ethhdr *)(skb->data);
517 
518 	return __vlan_get_protocol(skb, veth->h_vlan_proto, NULL);
519 }
520 
521 static const struct header_ops vlan_header_ops = {
522 	.create	 = vlan_dev_hard_header,
523 	.parse	 = eth_header_parse,
524 	.parse_protocol = vlan_parse_protocol,
525 };
526 
527 static int vlan_passthru_hard_header(struct sk_buff *skb, struct net_device *dev,
528 				     unsigned short type,
529 				     const void *daddr, const void *saddr,
530 				     unsigned int len)
531 {
532 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
533 	struct net_device *real_dev = vlan->real_dev;
534 
535 	if (saddr == NULL)
536 		saddr = dev->dev_addr;
537 
538 	return dev_hard_header(skb, real_dev, type, daddr, saddr, len);
539 }
540 
541 static const struct header_ops vlan_passthru_header_ops = {
542 	.create	 = vlan_passthru_hard_header,
543 	.parse	 = eth_header_parse,
544 	.parse_protocol = vlan_parse_protocol,
545 };
546 
547 static struct device_type vlan_type = {
548 	.name	= "vlan",
549 };
550 
551 static const struct net_device_ops vlan_netdev_ops;
552 
553 static int vlan_dev_init(struct net_device *dev)
554 {
555 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
556 	struct net_device *real_dev = vlan->real_dev;
557 
558 	netif_carrier_off(dev);
559 
560 	/* IFF_BROADCAST|IFF_MULTICAST; ??? */
561 	dev->flags  = real_dev->flags & ~(IFF_UP | IFF_PROMISC | IFF_ALLMULTI |
562 					  IFF_MASTER | IFF_SLAVE);
563 	dev->state  = (real_dev->state & ((1<<__LINK_STATE_NOCARRIER) |
564 					  (1<<__LINK_STATE_DORMANT))) |
565 		      (1<<__LINK_STATE_PRESENT);
566 
567 	if (vlan->flags & VLAN_FLAG_BRIDGE_BINDING)
568 		dev->state |= (1 << __LINK_STATE_NOCARRIER);
569 
570 	dev->hw_features = NETIF_F_HW_CSUM | NETIF_F_SG |
571 			   NETIF_F_FRAGLIST | NETIF_F_GSO_SOFTWARE |
572 			   NETIF_F_GSO_ENCAP_ALL |
573 			   NETIF_F_HIGHDMA | NETIF_F_SCTP_CRC |
574 			   NETIF_F_ALL_FCOE;
575 
576 	if (real_dev->vlan_features & NETIF_F_HW_MACSEC)
577 		dev->hw_features |= NETIF_F_HW_MACSEC;
578 
579 	dev->features |= dev->hw_features | NETIF_F_LLTX;
580 	netif_inherit_tso_max(dev, real_dev);
581 	if (dev->features & NETIF_F_VLAN_FEATURES)
582 		netdev_warn(real_dev, "VLAN features are set incorrectly.  Q-in-Q configurations may not work correctly.\n");
583 
584 	dev->vlan_features = real_dev->vlan_features & ~NETIF_F_ALL_FCOE;
585 	dev->hw_enc_features = vlan_tnl_features(real_dev);
586 	dev->mpls_features = real_dev->mpls_features;
587 
588 	/* ipv6 shared card related stuff */
589 	dev->dev_id = real_dev->dev_id;
590 
591 	if (is_zero_ether_addr(dev->dev_addr)) {
592 		eth_hw_addr_set(dev, real_dev->dev_addr);
593 		dev->addr_assign_type = NET_ADDR_STOLEN;
594 	}
595 	if (is_zero_ether_addr(dev->broadcast))
596 		memcpy(dev->broadcast, real_dev->broadcast, dev->addr_len);
597 
598 #if IS_ENABLED(CONFIG_FCOE)
599 	dev->fcoe_ddp_xid = real_dev->fcoe_ddp_xid;
600 #endif
601 
602 	dev->needed_headroom = real_dev->needed_headroom;
603 	if (vlan_hw_offload_capable(real_dev->features, vlan->vlan_proto)) {
604 		dev->header_ops      = &vlan_passthru_header_ops;
605 		dev->hard_header_len = real_dev->hard_header_len;
606 	} else {
607 		dev->header_ops      = &vlan_header_ops;
608 		dev->hard_header_len = real_dev->hard_header_len + VLAN_HLEN;
609 	}
610 
611 	dev->netdev_ops = &vlan_netdev_ops;
612 
613 	SET_NETDEV_DEVTYPE(dev, &vlan_type);
614 
615 	vlan_dev_set_lockdep_class(dev);
616 
617 	vlan->vlan_pcpu_stats = netdev_alloc_pcpu_stats(struct vlan_pcpu_stats);
618 	if (!vlan->vlan_pcpu_stats)
619 		return -ENOMEM;
620 
621 	/* Get vlan's reference to real_dev */
622 	netdev_hold(real_dev, &vlan->dev_tracker, GFP_KERNEL);
623 
624 	return 0;
625 }
626 
627 /* Note: this function might be called multiple times for the same device. */
628 void vlan_dev_free_egress_priority(const struct net_device *dev)
629 {
630 	struct vlan_priority_tci_mapping *pm;
631 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
632 	int i;
633 
634 	for (i = 0; i < ARRAY_SIZE(vlan->egress_priority_map); i++) {
635 		while ((pm = vlan->egress_priority_map[i]) != NULL) {
636 			vlan->egress_priority_map[i] = pm->next;
637 			kfree(pm);
638 		}
639 	}
640 }
641 
642 static void vlan_dev_uninit(struct net_device *dev)
643 {
644 	vlan_dev_free_egress_priority(dev);
645 }
646 
647 static netdev_features_t vlan_dev_fix_features(struct net_device *dev,
648 	netdev_features_t features)
649 {
650 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
651 	netdev_features_t old_features = features;
652 	netdev_features_t lower_features;
653 
654 	lower_features = netdev_intersect_features((real_dev->vlan_features |
655 						    NETIF_F_RXCSUM),
656 						   real_dev->features);
657 
658 	/* Add HW_CSUM setting to preserve user ability to control
659 	 * checksum offload on the vlan device.
660 	 */
661 	if (lower_features & (NETIF_F_IP_CSUM|NETIF_F_IPV6_CSUM))
662 		lower_features |= NETIF_F_HW_CSUM;
663 	features = netdev_intersect_features(features, lower_features);
664 	features |= old_features & (NETIF_F_SOFT_FEATURES | NETIF_F_GSO_SOFTWARE);
665 	features |= NETIF_F_LLTX;
666 
667 	return features;
668 }
669 
670 static int vlan_ethtool_get_link_ksettings(struct net_device *dev,
671 					   struct ethtool_link_ksettings *cmd)
672 {
673 	const struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
674 
675 	return __ethtool_get_link_ksettings(vlan->real_dev, cmd);
676 }
677 
678 static void vlan_ethtool_get_drvinfo(struct net_device *dev,
679 				     struct ethtool_drvinfo *info)
680 {
681 	strscpy(info->driver, vlan_fullname, sizeof(info->driver));
682 	strscpy(info->version, vlan_version, sizeof(info->version));
683 	strscpy(info->fw_version, "N/A", sizeof(info->fw_version));
684 }
685 
686 static int vlan_ethtool_get_ts_info(struct net_device *dev,
687 				    struct ethtool_ts_info *info)
688 {
689 	const struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
690 	const struct ethtool_ops *ops = vlan->real_dev->ethtool_ops;
691 	struct phy_device *phydev = vlan->real_dev->phydev;
692 
693 	if (phy_has_tsinfo(phydev)) {
694 		return phy_ts_info(phydev, info);
695 	} else if (ops->get_ts_info) {
696 		return ops->get_ts_info(vlan->real_dev, info);
697 	} else {
698 		info->so_timestamping = SOF_TIMESTAMPING_RX_SOFTWARE |
699 			SOF_TIMESTAMPING_SOFTWARE;
700 		info->phc_index = -1;
701 	}
702 
703 	return 0;
704 }
705 
706 static void vlan_dev_get_stats64(struct net_device *dev,
707 				 struct rtnl_link_stats64 *stats)
708 {
709 	struct vlan_pcpu_stats *p;
710 	u32 rx_errors = 0, tx_dropped = 0;
711 	int i;
712 
713 	for_each_possible_cpu(i) {
714 		u64 rxpackets, rxbytes, rxmulticast, txpackets, txbytes;
715 		unsigned int start;
716 
717 		p = per_cpu_ptr(vlan_dev_priv(dev)->vlan_pcpu_stats, i);
718 		do {
719 			start = u64_stats_fetch_begin(&p->syncp);
720 			rxpackets	= u64_stats_read(&p->rx_packets);
721 			rxbytes		= u64_stats_read(&p->rx_bytes);
722 			rxmulticast	= u64_stats_read(&p->rx_multicast);
723 			txpackets	= u64_stats_read(&p->tx_packets);
724 			txbytes		= u64_stats_read(&p->tx_bytes);
725 		} while (u64_stats_fetch_retry(&p->syncp, start));
726 
727 		stats->rx_packets	+= rxpackets;
728 		stats->rx_bytes		+= rxbytes;
729 		stats->multicast	+= rxmulticast;
730 		stats->tx_packets	+= txpackets;
731 		stats->tx_bytes		+= txbytes;
732 		/* rx_errors & tx_dropped are u32 */
733 		rx_errors	+= READ_ONCE(p->rx_errors);
734 		tx_dropped	+= READ_ONCE(p->tx_dropped);
735 	}
736 	stats->rx_errors  = rx_errors;
737 	stats->tx_dropped = tx_dropped;
738 }
739 
740 #ifdef CONFIG_NET_POLL_CONTROLLER
741 static void vlan_dev_poll_controller(struct net_device *dev)
742 {
743 	return;
744 }
745 
746 static int vlan_dev_netpoll_setup(struct net_device *dev, struct netpoll_info *npinfo)
747 {
748 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
749 	struct net_device *real_dev = vlan->real_dev;
750 	struct netpoll *netpoll;
751 	int err = 0;
752 
753 	netpoll = kzalloc(sizeof(*netpoll), GFP_KERNEL);
754 	err = -ENOMEM;
755 	if (!netpoll)
756 		goto out;
757 
758 	err = __netpoll_setup(netpoll, real_dev);
759 	if (err) {
760 		kfree(netpoll);
761 		goto out;
762 	}
763 
764 	vlan->netpoll = netpoll;
765 
766 out:
767 	return err;
768 }
769 
770 static void vlan_dev_netpoll_cleanup(struct net_device *dev)
771 {
772 	struct vlan_dev_priv *vlan= vlan_dev_priv(dev);
773 	struct netpoll *netpoll = vlan->netpoll;
774 
775 	if (!netpoll)
776 		return;
777 
778 	vlan->netpoll = NULL;
779 	__netpoll_free(netpoll);
780 }
781 #endif /* CONFIG_NET_POLL_CONTROLLER */
782 
783 static int vlan_dev_get_iflink(const struct net_device *dev)
784 {
785 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
786 
787 	return real_dev->ifindex;
788 }
789 
790 static int vlan_dev_fill_forward_path(struct net_device_path_ctx *ctx,
791 				      struct net_device_path *path)
792 {
793 	struct vlan_dev_priv *vlan = vlan_dev_priv(ctx->dev);
794 
795 	path->type = DEV_PATH_VLAN;
796 	path->encap.id = vlan->vlan_id;
797 	path->encap.proto = vlan->vlan_proto;
798 	path->dev = ctx->dev;
799 	ctx->dev = vlan->real_dev;
800 	if (ctx->num_vlans >= ARRAY_SIZE(ctx->vlan))
801 		return -ENOSPC;
802 
803 	ctx->vlan[ctx->num_vlans].id = vlan->vlan_id;
804 	ctx->vlan[ctx->num_vlans].proto = vlan->vlan_proto;
805 	ctx->num_vlans++;
806 
807 	return 0;
808 }
809 
810 #if IS_ENABLED(CONFIG_MACSEC)
811 
812 static const struct macsec_ops *vlan_get_macsec_ops(const struct macsec_context *ctx)
813 {
814 	return vlan_dev_priv(ctx->netdev)->real_dev->macsec_ops;
815 }
816 
817 static int vlan_macsec_offload(int (* const func)(struct macsec_context *),
818 			       struct macsec_context *ctx)
819 {
820 	if (unlikely(!func))
821 		return 0;
822 
823 	return (*func)(ctx);
824 }
825 
826 static int vlan_macsec_dev_open(struct macsec_context *ctx)
827 {
828 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
829 
830 	if (!ops)
831 		return -EOPNOTSUPP;
832 
833 	return vlan_macsec_offload(ops->mdo_dev_open, ctx);
834 }
835 
836 static int vlan_macsec_dev_stop(struct macsec_context *ctx)
837 {
838 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
839 
840 	if (!ops)
841 		return -EOPNOTSUPP;
842 
843 	return vlan_macsec_offload(ops->mdo_dev_stop, ctx);
844 }
845 
846 static int vlan_macsec_add_secy(struct macsec_context *ctx)
847 {
848 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
849 
850 	if (!ops)
851 		return -EOPNOTSUPP;
852 
853 	return vlan_macsec_offload(ops->mdo_add_secy, ctx);
854 }
855 
856 static int vlan_macsec_upd_secy(struct macsec_context *ctx)
857 {
858 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
859 
860 	if (!ops)
861 		return -EOPNOTSUPP;
862 
863 	return vlan_macsec_offload(ops->mdo_upd_secy, ctx);
864 }
865 
866 static int vlan_macsec_del_secy(struct macsec_context *ctx)
867 {
868 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
869 
870 	if (!ops)
871 		return -EOPNOTSUPP;
872 
873 	return vlan_macsec_offload(ops->mdo_del_secy, ctx);
874 }
875 
876 static int vlan_macsec_add_rxsc(struct macsec_context *ctx)
877 {
878 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
879 
880 	if (!ops)
881 		return -EOPNOTSUPP;
882 
883 	return vlan_macsec_offload(ops->mdo_add_rxsc, ctx);
884 }
885 
886 static int vlan_macsec_upd_rxsc(struct macsec_context *ctx)
887 {
888 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
889 
890 	if (!ops)
891 		return -EOPNOTSUPP;
892 
893 	return vlan_macsec_offload(ops->mdo_upd_rxsc, ctx);
894 }
895 
896 static int vlan_macsec_del_rxsc(struct macsec_context *ctx)
897 {
898 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
899 
900 	if (!ops)
901 		return -EOPNOTSUPP;
902 
903 	return vlan_macsec_offload(ops->mdo_del_rxsc, ctx);
904 }
905 
906 static int vlan_macsec_add_rxsa(struct macsec_context *ctx)
907 {
908 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
909 
910 	if (!ops)
911 		return -EOPNOTSUPP;
912 
913 	return vlan_macsec_offload(ops->mdo_add_rxsa, ctx);
914 }
915 
916 static int vlan_macsec_upd_rxsa(struct macsec_context *ctx)
917 {
918 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
919 
920 	if (!ops)
921 		return -EOPNOTSUPP;
922 
923 	return vlan_macsec_offload(ops->mdo_upd_rxsa, ctx);
924 }
925 
926 static int vlan_macsec_del_rxsa(struct macsec_context *ctx)
927 {
928 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
929 
930 	if (!ops)
931 		return -EOPNOTSUPP;
932 
933 	return vlan_macsec_offload(ops->mdo_del_rxsa, ctx);
934 }
935 
936 static int vlan_macsec_add_txsa(struct macsec_context *ctx)
937 {
938 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
939 
940 	if (!ops)
941 		return -EOPNOTSUPP;
942 
943 	return vlan_macsec_offload(ops->mdo_add_txsa, ctx);
944 }
945 
946 static int vlan_macsec_upd_txsa(struct macsec_context *ctx)
947 {
948 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
949 
950 	if (!ops)
951 		return -EOPNOTSUPP;
952 
953 	return vlan_macsec_offload(ops->mdo_upd_txsa, ctx);
954 }
955 
956 static int vlan_macsec_del_txsa(struct macsec_context *ctx)
957 {
958 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
959 
960 	if (!ops)
961 		return -EOPNOTSUPP;
962 
963 	return vlan_macsec_offload(ops->mdo_del_txsa, ctx);
964 }
965 
966 static int vlan_macsec_get_dev_stats(struct macsec_context *ctx)
967 {
968 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
969 
970 	if (!ops)
971 		return -EOPNOTSUPP;
972 
973 	return vlan_macsec_offload(ops->mdo_get_dev_stats, ctx);
974 }
975 
976 static int vlan_macsec_get_tx_sc_stats(struct macsec_context *ctx)
977 {
978 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
979 
980 	if (!ops)
981 		return -EOPNOTSUPP;
982 
983 	return vlan_macsec_offload(ops->mdo_get_tx_sc_stats, ctx);
984 }
985 
986 static int vlan_macsec_get_tx_sa_stats(struct macsec_context *ctx)
987 {
988 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
989 
990 	if (!ops)
991 		return -EOPNOTSUPP;
992 
993 	return vlan_macsec_offload(ops->mdo_get_tx_sa_stats, ctx);
994 }
995 
996 static int vlan_macsec_get_rx_sc_stats(struct macsec_context *ctx)
997 {
998 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
999 
1000 	if (!ops)
1001 		return -EOPNOTSUPP;
1002 
1003 	return vlan_macsec_offload(ops->mdo_get_rx_sc_stats, ctx);
1004 }
1005 
1006 static int vlan_macsec_get_rx_sa_stats(struct macsec_context *ctx)
1007 {
1008 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
1009 
1010 	if (!ops)
1011 		return -EOPNOTSUPP;
1012 
1013 	return vlan_macsec_offload(ops->mdo_get_rx_sa_stats, ctx);
1014 }
1015 
1016 static const struct macsec_ops macsec_offload_ops = {
1017 	/* Device wide */
1018 	.mdo_dev_open = vlan_macsec_dev_open,
1019 	.mdo_dev_stop = vlan_macsec_dev_stop,
1020 	/* SecY */
1021 	.mdo_add_secy = vlan_macsec_add_secy,
1022 	.mdo_upd_secy = vlan_macsec_upd_secy,
1023 	.mdo_del_secy = vlan_macsec_del_secy,
1024 	/* Security channels */
1025 	.mdo_add_rxsc = vlan_macsec_add_rxsc,
1026 	.mdo_upd_rxsc = vlan_macsec_upd_rxsc,
1027 	.mdo_del_rxsc = vlan_macsec_del_rxsc,
1028 	/* Security associations */
1029 	.mdo_add_rxsa = vlan_macsec_add_rxsa,
1030 	.mdo_upd_rxsa = vlan_macsec_upd_rxsa,
1031 	.mdo_del_rxsa = vlan_macsec_del_rxsa,
1032 	.mdo_add_txsa = vlan_macsec_add_txsa,
1033 	.mdo_upd_txsa = vlan_macsec_upd_txsa,
1034 	.mdo_del_txsa = vlan_macsec_del_txsa,
1035 	/* Statistics */
1036 	.mdo_get_dev_stats = vlan_macsec_get_dev_stats,
1037 	.mdo_get_tx_sc_stats = vlan_macsec_get_tx_sc_stats,
1038 	.mdo_get_tx_sa_stats = vlan_macsec_get_tx_sa_stats,
1039 	.mdo_get_rx_sc_stats = vlan_macsec_get_rx_sc_stats,
1040 	.mdo_get_rx_sa_stats = vlan_macsec_get_rx_sa_stats,
1041 };
1042 
1043 #endif
1044 
1045 static const struct ethtool_ops vlan_ethtool_ops = {
1046 	.get_link_ksettings	= vlan_ethtool_get_link_ksettings,
1047 	.get_drvinfo	        = vlan_ethtool_get_drvinfo,
1048 	.get_link		= ethtool_op_get_link,
1049 	.get_ts_info		= vlan_ethtool_get_ts_info,
1050 };
1051 
1052 static const struct net_device_ops vlan_netdev_ops = {
1053 	.ndo_change_mtu		= vlan_dev_change_mtu,
1054 	.ndo_init		= vlan_dev_init,
1055 	.ndo_uninit		= vlan_dev_uninit,
1056 	.ndo_open		= vlan_dev_open,
1057 	.ndo_stop		= vlan_dev_stop,
1058 	.ndo_start_xmit =  vlan_dev_hard_start_xmit,
1059 	.ndo_validate_addr	= eth_validate_addr,
1060 	.ndo_set_mac_address	= vlan_dev_set_mac_address,
1061 	.ndo_set_rx_mode	= vlan_dev_set_rx_mode,
1062 	.ndo_change_rx_flags	= vlan_dev_change_rx_flags,
1063 	.ndo_eth_ioctl		= vlan_dev_ioctl,
1064 	.ndo_neigh_setup	= vlan_dev_neigh_setup,
1065 	.ndo_get_stats64	= vlan_dev_get_stats64,
1066 #if IS_ENABLED(CONFIG_FCOE)
1067 	.ndo_fcoe_ddp_setup	= vlan_dev_fcoe_ddp_setup,
1068 	.ndo_fcoe_ddp_done	= vlan_dev_fcoe_ddp_done,
1069 	.ndo_fcoe_enable	= vlan_dev_fcoe_enable,
1070 	.ndo_fcoe_disable	= vlan_dev_fcoe_disable,
1071 	.ndo_fcoe_ddp_target	= vlan_dev_fcoe_ddp_target,
1072 #endif
1073 #ifdef NETDEV_FCOE_WWNN
1074 	.ndo_fcoe_get_wwn	= vlan_dev_fcoe_get_wwn,
1075 #endif
1076 #ifdef CONFIG_NET_POLL_CONTROLLER
1077 	.ndo_poll_controller	= vlan_dev_poll_controller,
1078 	.ndo_netpoll_setup	= vlan_dev_netpoll_setup,
1079 	.ndo_netpoll_cleanup	= vlan_dev_netpoll_cleanup,
1080 #endif
1081 	.ndo_fix_features	= vlan_dev_fix_features,
1082 	.ndo_get_iflink		= vlan_dev_get_iflink,
1083 	.ndo_fill_forward_path	= vlan_dev_fill_forward_path,
1084 };
1085 
1086 static void vlan_dev_free(struct net_device *dev)
1087 {
1088 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
1089 
1090 	free_percpu(vlan->vlan_pcpu_stats);
1091 	vlan->vlan_pcpu_stats = NULL;
1092 
1093 	/* Get rid of the vlan's reference to real_dev */
1094 	netdev_put(vlan->real_dev, &vlan->dev_tracker);
1095 }
1096 
1097 void vlan_setup(struct net_device *dev)
1098 {
1099 	ether_setup(dev);
1100 
1101 	dev->priv_flags		|= IFF_802_1Q_VLAN | IFF_NO_QUEUE;
1102 	dev->priv_flags		|= IFF_UNICAST_FLT;
1103 	dev->priv_flags		&= ~IFF_TX_SKB_SHARING;
1104 	netif_keep_dst(dev);
1105 
1106 	dev->netdev_ops		= &vlan_netdev_ops;
1107 	dev->needs_free_netdev	= true;
1108 	dev->priv_destructor	= vlan_dev_free;
1109 	dev->ethtool_ops	= &vlan_ethtool_ops;
1110 
1111 #if IS_ENABLED(CONFIG_MACSEC)
1112 	dev->macsec_ops		= &macsec_offload_ops;
1113 #endif
1114 	dev->min_mtu		= 0;
1115 	dev->max_mtu		= ETH_MAX_MTU;
1116 
1117 	eth_zero_addr(dev->broadcast);
1118 }
1119