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 */
45static 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
89static 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
99static 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 (vlan->flags & VLAN_FLAG_REORDER_HDR ||
113	    veth->h_vlan_proto != vlan->vlan_proto) {
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
142static 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	WRITE_ONCE(dev->mtu, new_mtu);
153
154	return 0;
155}
156
157void 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
170int 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 */
215int 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
243void 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
248bool 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
259static 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
300clear_allmulti:
301	if (dev->flags & IFF_ALLMULTI)
302		dev_set_allmulti(real_dev, -1);
303del_unicast:
304	if (!ether_addr_equal(dev->dev_addr, real_dev->dev_addr))
305		dev_uc_del(real_dev, dev->dev_addr);
306out:
307	netif_carrier_off(dev);
308	return err;
309}
310
311static 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
331static 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
352out:
353	eth_hw_addr_set(dev, addr->sa_data);
354	return 0;
355}
356
357static int vlan_hwtstamp_get(struct net_device *dev,
358			     struct kernel_hwtstamp_config *cfg)
359{
360	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
361
362	return generic_hwtstamp_get_lower(real_dev, cfg);
363}
364
365static int vlan_hwtstamp_set(struct net_device *dev,
366			     struct kernel_hwtstamp_config *cfg,
367			     struct netlink_ext_ack *extack)
368{
369	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
370
371	if (!net_eq(dev_net(dev), dev_net(real_dev)))
372		return -EOPNOTSUPP;
373
374	return generic_hwtstamp_set_lower(real_dev, cfg, extack);
375}
376
377static int vlan_dev_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
378{
379	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
380	const struct net_device_ops *ops = real_dev->netdev_ops;
381	struct ifreq ifrr;
382	int err = -EOPNOTSUPP;
383
384	strscpy_pad(ifrr.ifr_name, real_dev->name, IFNAMSIZ);
385	ifrr.ifr_ifru = ifr->ifr_ifru;
386
387	switch (cmd) {
388	case SIOCGMIIPHY:
389	case SIOCGMIIREG:
390	case SIOCSMIIREG:
391		if (netif_device_present(real_dev) && ops->ndo_eth_ioctl)
392			err = ops->ndo_eth_ioctl(real_dev, &ifrr, cmd);
393		break;
394	}
395
396	if (!err)
397		ifr->ifr_ifru = ifrr.ifr_ifru;
398
399	return err;
400}
401
402static int vlan_dev_neigh_setup(struct net_device *dev, struct neigh_parms *pa)
403{
404	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
405	const struct net_device_ops *ops = real_dev->netdev_ops;
406	int err = 0;
407
408	if (netif_device_present(real_dev) && ops->ndo_neigh_setup)
409		err = ops->ndo_neigh_setup(real_dev, pa);
410
411	return err;
412}
413
414#if IS_ENABLED(CONFIG_FCOE)
415static int vlan_dev_fcoe_ddp_setup(struct net_device *dev, u16 xid,
416				   struct scatterlist *sgl, unsigned int sgc)
417{
418	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
419	const struct net_device_ops *ops = real_dev->netdev_ops;
420	int rc = 0;
421
422	if (ops->ndo_fcoe_ddp_setup)
423		rc = ops->ndo_fcoe_ddp_setup(real_dev, xid, sgl, sgc);
424
425	return rc;
426}
427
428static int vlan_dev_fcoe_ddp_done(struct net_device *dev, u16 xid)
429{
430	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
431	const struct net_device_ops *ops = real_dev->netdev_ops;
432	int len = 0;
433
434	if (ops->ndo_fcoe_ddp_done)
435		len = ops->ndo_fcoe_ddp_done(real_dev, xid);
436
437	return len;
438}
439
440static int vlan_dev_fcoe_enable(struct net_device *dev)
441{
442	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
443	const struct net_device_ops *ops = real_dev->netdev_ops;
444	int rc = -EINVAL;
445
446	if (ops->ndo_fcoe_enable)
447		rc = ops->ndo_fcoe_enable(real_dev);
448	return rc;
449}
450
451static int vlan_dev_fcoe_disable(struct net_device *dev)
452{
453	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
454	const struct net_device_ops *ops = real_dev->netdev_ops;
455	int rc = -EINVAL;
456
457	if (ops->ndo_fcoe_disable)
458		rc = ops->ndo_fcoe_disable(real_dev);
459	return rc;
460}
461
462static int vlan_dev_fcoe_ddp_target(struct net_device *dev, u16 xid,
463				    struct scatterlist *sgl, unsigned int sgc)
464{
465	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
466	const struct net_device_ops *ops = real_dev->netdev_ops;
467	int rc = 0;
468
469	if (ops->ndo_fcoe_ddp_target)
470		rc = ops->ndo_fcoe_ddp_target(real_dev, xid, sgl, sgc);
471
472	return rc;
473}
474#endif
475
476#ifdef NETDEV_FCOE_WWNN
477static int vlan_dev_fcoe_get_wwn(struct net_device *dev, u64 *wwn, int type)
478{
479	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
480	const struct net_device_ops *ops = real_dev->netdev_ops;
481	int rc = -EINVAL;
482
483	if (ops->ndo_fcoe_get_wwn)
484		rc = ops->ndo_fcoe_get_wwn(real_dev, wwn, type);
485	return rc;
486}
487#endif
488
489static void vlan_dev_change_rx_flags(struct net_device *dev, int change)
490{
491	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
492
493	if (dev->flags & IFF_UP) {
494		if (change & IFF_ALLMULTI)
495			dev_set_allmulti(real_dev, dev->flags & IFF_ALLMULTI ? 1 : -1);
496		if (change & IFF_PROMISC)
497			dev_set_promiscuity(real_dev, dev->flags & IFF_PROMISC ? 1 : -1);
498	}
499}
500
501static void vlan_dev_set_rx_mode(struct net_device *vlan_dev)
502{
503	dev_mc_sync(vlan_dev_priv(vlan_dev)->real_dev, vlan_dev);
504	dev_uc_sync(vlan_dev_priv(vlan_dev)->real_dev, vlan_dev);
505}
506
507static __be16 vlan_parse_protocol(const struct sk_buff *skb)
508{
509	struct vlan_ethhdr *veth = (struct vlan_ethhdr *)(skb->data);
510
511	return __vlan_get_protocol(skb, veth->h_vlan_proto, NULL);
512}
513
514static const struct header_ops vlan_header_ops = {
515	.create	 = vlan_dev_hard_header,
516	.parse	 = eth_header_parse,
517	.parse_protocol = vlan_parse_protocol,
518};
519
520static int vlan_passthru_hard_header(struct sk_buff *skb, struct net_device *dev,
521				     unsigned short type,
522				     const void *daddr, const void *saddr,
523				     unsigned int len)
524{
525	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
526	struct net_device *real_dev = vlan->real_dev;
527
528	if (saddr == NULL)
529		saddr = dev->dev_addr;
530
531	return dev_hard_header(skb, real_dev, type, daddr, saddr, len);
532}
533
534static const struct header_ops vlan_passthru_header_ops = {
535	.create	 = vlan_passthru_hard_header,
536	.parse	 = eth_header_parse,
537	.parse_protocol = vlan_parse_protocol,
538};
539
540static const struct device_type vlan_type = {
541	.name	= "vlan",
542};
543
544static const struct net_device_ops vlan_netdev_ops;
545
546static int vlan_dev_init(struct net_device *dev)
547{
548	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
549	struct net_device *real_dev = vlan->real_dev;
550
551	netif_carrier_off(dev);
552
553	/* IFF_BROADCAST|IFF_MULTICAST; ??? */
554	dev->flags  = real_dev->flags & ~(IFF_UP | IFF_PROMISC | IFF_ALLMULTI |
555					  IFF_MASTER | IFF_SLAVE);
556	dev->state  = (real_dev->state & ((1<<__LINK_STATE_NOCARRIER) |
557					  (1<<__LINK_STATE_DORMANT))) |
558		      (1<<__LINK_STATE_PRESENT);
559
560	if (vlan->flags & VLAN_FLAG_BRIDGE_BINDING)
561		dev->state |= (1 << __LINK_STATE_NOCARRIER);
562
563	dev->hw_features = NETIF_F_HW_CSUM | NETIF_F_SG |
564			   NETIF_F_FRAGLIST | NETIF_F_GSO_SOFTWARE |
565			   NETIF_F_GSO_ENCAP_ALL |
566			   NETIF_F_HIGHDMA | NETIF_F_SCTP_CRC |
567			   NETIF_F_ALL_FCOE;
568
569	if (real_dev->vlan_features & NETIF_F_HW_MACSEC)
570		dev->hw_features |= NETIF_F_HW_MACSEC;
571
572	dev->features |= dev->hw_features | NETIF_F_LLTX;
573	netif_inherit_tso_max(dev, real_dev);
574	if (dev->features & NETIF_F_VLAN_FEATURES)
575		netdev_warn(real_dev, "VLAN features are set incorrectly.  Q-in-Q configurations may not work correctly.\n");
576
577	dev->vlan_features = real_dev->vlan_features & ~NETIF_F_ALL_FCOE;
578	dev->hw_enc_features = vlan_tnl_features(real_dev);
579	dev->mpls_features = real_dev->mpls_features;
580
581	/* ipv6 shared card related stuff */
582	dev->dev_id = real_dev->dev_id;
583
584	if (is_zero_ether_addr(dev->dev_addr)) {
585		eth_hw_addr_set(dev, real_dev->dev_addr);
586		dev->addr_assign_type = NET_ADDR_STOLEN;
587	}
588	if (is_zero_ether_addr(dev->broadcast))
589		memcpy(dev->broadcast, real_dev->broadcast, dev->addr_len);
590
591#if IS_ENABLED(CONFIG_FCOE)
592	dev->fcoe_ddp_xid = real_dev->fcoe_ddp_xid;
593#endif
594
595	dev->needed_headroom = real_dev->needed_headroom;
596	if (vlan_hw_offload_capable(real_dev->features, vlan->vlan_proto)) {
597		dev->header_ops      = &vlan_passthru_header_ops;
598		dev->hard_header_len = real_dev->hard_header_len;
599	} else {
600		dev->header_ops      = &vlan_header_ops;
601		dev->hard_header_len = real_dev->hard_header_len + VLAN_HLEN;
602	}
603
604	dev->netdev_ops = &vlan_netdev_ops;
605
606	SET_NETDEV_DEVTYPE(dev, &vlan_type);
607
608	netdev_lockdep_set_classes(dev);
609
610	vlan->vlan_pcpu_stats = netdev_alloc_pcpu_stats(struct vlan_pcpu_stats);
611	if (!vlan->vlan_pcpu_stats)
612		return -ENOMEM;
613
614	/* Get vlan's reference to real_dev */
615	netdev_hold(real_dev, &vlan->dev_tracker, GFP_KERNEL);
616
617	return 0;
618}
619
620/* Note: this function might be called multiple times for the same device. */
621void vlan_dev_free_egress_priority(const struct net_device *dev)
622{
623	struct vlan_priority_tci_mapping *pm;
624	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
625	int i;
626
627	for (i = 0; i < ARRAY_SIZE(vlan->egress_priority_map); i++) {
628		while ((pm = vlan->egress_priority_map[i]) != NULL) {
629			vlan->egress_priority_map[i] = pm->next;
630			kfree(pm);
631		}
632	}
633}
634
635static void vlan_dev_uninit(struct net_device *dev)
636{
637	vlan_dev_free_egress_priority(dev);
638}
639
640static netdev_features_t vlan_dev_fix_features(struct net_device *dev,
641	netdev_features_t features)
642{
643	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
644	netdev_features_t old_features = features;
645	netdev_features_t lower_features;
646
647	lower_features = netdev_intersect_features((real_dev->vlan_features |
648						    NETIF_F_RXCSUM),
649						   real_dev->features);
650
651	/* Add HW_CSUM setting to preserve user ability to control
652	 * checksum offload on the vlan device.
653	 */
654	if (lower_features & (NETIF_F_IP_CSUM|NETIF_F_IPV6_CSUM))
655		lower_features |= NETIF_F_HW_CSUM;
656	features = netdev_intersect_features(features, lower_features);
657	features |= old_features & (NETIF_F_SOFT_FEATURES | NETIF_F_GSO_SOFTWARE);
658	features |= NETIF_F_LLTX;
659
660	return features;
661}
662
663static int vlan_ethtool_get_link_ksettings(struct net_device *dev,
664					   struct ethtool_link_ksettings *cmd)
665{
666	const struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
667
668	return __ethtool_get_link_ksettings(vlan->real_dev, cmd);
669}
670
671static void vlan_ethtool_get_drvinfo(struct net_device *dev,
672				     struct ethtool_drvinfo *info)
673{
674	strscpy(info->driver, vlan_fullname, sizeof(info->driver));
675	strscpy(info->version, vlan_version, sizeof(info->version));
676	strscpy(info->fw_version, "N/A", sizeof(info->fw_version));
677}
678
679static int vlan_ethtool_get_ts_info(struct net_device *dev,
680				    struct ethtool_ts_info *info)
681{
682	const struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
683	return ethtool_get_ts_info_by_layer(vlan->real_dev, info);
684}
685
686static void vlan_dev_get_stats64(struct net_device *dev,
687				 struct rtnl_link_stats64 *stats)
688{
689	struct vlan_pcpu_stats *p;
690	u32 rx_errors = 0, tx_dropped = 0;
691	int i;
692
693	for_each_possible_cpu(i) {
694		u64 rxpackets, rxbytes, rxmulticast, txpackets, txbytes;
695		unsigned int start;
696
697		p = per_cpu_ptr(vlan_dev_priv(dev)->vlan_pcpu_stats, i);
698		do {
699			start = u64_stats_fetch_begin(&p->syncp);
700			rxpackets	= u64_stats_read(&p->rx_packets);
701			rxbytes		= u64_stats_read(&p->rx_bytes);
702			rxmulticast	= u64_stats_read(&p->rx_multicast);
703			txpackets	= u64_stats_read(&p->tx_packets);
704			txbytes		= u64_stats_read(&p->tx_bytes);
705		} while (u64_stats_fetch_retry(&p->syncp, start));
706
707		stats->rx_packets	+= rxpackets;
708		stats->rx_bytes		+= rxbytes;
709		stats->multicast	+= rxmulticast;
710		stats->tx_packets	+= txpackets;
711		stats->tx_bytes		+= txbytes;
712		/* rx_errors & tx_dropped are u32 */
713		rx_errors	+= READ_ONCE(p->rx_errors);
714		tx_dropped	+= READ_ONCE(p->tx_dropped);
715	}
716	stats->rx_errors  = rx_errors;
717	stats->tx_dropped = tx_dropped;
718}
719
720#ifdef CONFIG_NET_POLL_CONTROLLER
721static void vlan_dev_poll_controller(struct net_device *dev)
722{
723	return;
724}
725
726static int vlan_dev_netpoll_setup(struct net_device *dev, struct netpoll_info *npinfo)
727{
728	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
729	struct net_device *real_dev = vlan->real_dev;
730	struct netpoll *netpoll;
731	int err = 0;
732
733	netpoll = kzalloc(sizeof(*netpoll), GFP_KERNEL);
734	err = -ENOMEM;
735	if (!netpoll)
736		goto out;
737
738	err = __netpoll_setup(netpoll, real_dev);
739	if (err) {
740		kfree(netpoll);
741		goto out;
742	}
743
744	vlan->netpoll = netpoll;
745
746out:
747	return err;
748}
749
750static void vlan_dev_netpoll_cleanup(struct net_device *dev)
751{
752	struct vlan_dev_priv *vlan= vlan_dev_priv(dev);
753	struct netpoll *netpoll = vlan->netpoll;
754
755	if (!netpoll)
756		return;
757
758	vlan->netpoll = NULL;
759	__netpoll_free(netpoll);
760}
761#endif /* CONFIG_NET_POLL_CONTROLLER */
762
763static int vlan_dev_get_iflink(const struct net_device *dev)
764{
765	const struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
766
767	return READ_ONCE(real_dev->ifindex);
768}
769
770static int vlan_dev_fill_forward_path(struct net_device_path_ctx *ctx,
771				      struct net_device_path *path)
772{
773	struct vlan_dev_priv *vlan = vlan_dev_priv(ctx->dev);
774
775	path->type = DEV_PATH_VLAN;
776	path->encap.id = vlan->vlan_id;
777	path->encap.proto = vlan->vlan_proto;
778	path->dev = ctx->dev;
779	ctx->dev = vlan->real_dev;
780	if (ctx->num_vlans >= ARRAY_SIZE(ctx->vlan))
781		return -ENOSPC;
782
783	ctx->vlan[ctx->num_vlans].id = vlan->vlan_id;
784	ctx->vlan[ctx->num_vlans].proto = vlan->vlan_proto;
785	ctx->num_vlans++;
786
787	return 0;
788}
789
790#if IS_ENABLED(CONFIG_MACSEC)
791
792static const struct macsec_ops *vlan_get_macsec_ops(const struct macsec_context *ctx)
793{
794	return vlan_dev_priv(ctx->netdev)->real_dev->macsec_ops;
795}
796
797static int vlan_macsec_offload(int (* const func)(struct macsec_context *),
798			       struct macsec_context *ctx)
799{
800	if (unlikely(!func))
801		return 0;
802
803	return (*func)(ctx);
804}
805
806static int vlan_macsec_dev_open(struct macsec_context *ctx)
807{
808	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
809
810	if (!ops)
811		return -EOPNOTSUPP;
812
813	return vlan_macsec_offload(ops->mdo_dev_open, ctx);
814}
815
816static int vlan_macsec_dev_stop(struct macsec_context *ctx)
817{
818	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
819
820	if (!ops)
821		return -EOPNOTSUPP;
822
823	return vlan_macsec_offload(ops->mdo_dev_stop, ctx);
824}
825
826static int vlan_macsec_add_secy(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_add_secy, ctx);
834}
835
836static int vlan_macsec_upd_secy(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_upd_secy, ctx);
844}
845
846static int vlan_macsec_del_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_del_secy, ctx);
854}
855
856static int vlan_macsec_add_rxsc(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_add_rxsc, ctx);
864}
865
866static int vlan_macsec_upd_rxsc(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_upd_rxsc, ctx);
874}
875
876static int vlan_macsec_del_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_del_rxsc, ctx);
884}
885
886static int vlan_macsec_add_rxsa(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_add_rxsa, ctx);
894}
895
896static int vlan_macsec_upd_rxsa(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_upd_rxsa, ctx);
904}
905
906static int vlan_macsec_del_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_del_rxsa, ctx);
914}
915
916static int vlan_macsec_add_txsa(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_add_txsa, ctx);
924}
925
926static int vlan_macsec_upd_txsa(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_upd_txsa, ctx);
934}
935
936static int vlan_macsec_del_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_del_txsa, ctx);
944}
945
946static int vlan_macsec_get_dev_stats(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_get_dev_stats, ctx);
954}
955
956static int vlan_macsec_get_tx_sc_stats(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_get_tx_sc_stats, ctx);
964}
965
966static int vlan_macsec_get_tx_sa_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_tx_sa_stats, ctx);
974}
975
976static int vlan_macsec_get_rx_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_rx_sc_stats, ctx);
984}
985
986static int vlan_macsec_get_rx_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_rx_sa_stats, ctx);
994}
995
996static const struct macsec_ops macsec_offload_ops = {
997	/* Device wide */
998	.mdo_dev_open = vlan_macsec_dev_open,
999	.mdo_dev_stop = vlan_macsec_dev_stop,
1000	/* SecY */
1001	.mdo_add_secy = vlan_macsec_add_secy,
1002	.mdo_upd_secy = vlan_macsec_upd_secy,
1003	.mdo_del_secy = vlan_macsec_del_secy,
1004	/* Security channels */
1005	.mdo_add_rxsc = vlan_macsec_add_rxsc,
1006	.mdo_upd_rxsc = vlan_macsec_upd_rxsc,
1007	.mdo_del_rxsc = vlan_macsec_del_rxsc,
1008	/* Security associations */
1009	.mdo_add_rxsa = vlan_macsec_add_rxsa,
1010	.mdo_upd_rxsa = vlan_macsec_upd_rxsa,
1011	.mdo_del_rxsa = vlan_macsec_del_rxsa,
1012	.mdo_add_txsa = vlan_macsec_add_txsa,
1013	.mdo_upd_txsa = vlan_macsec_upd_txsa,
1014	.mdo_del_txsa = vlan_macsec_del_txsa,
1015	/* Statistics */
1016	.mdo_get_dev_stats = vlan_macsec_get_dev_stats,
1017	.mdo_get_tx_sc_stats = vlan_macsec_get_tx_sc_stats,
1018	.mdo_get_tx_sa_stats = vlan_macsec_get_tx_sa_stats,
1019	.mdo_get_rx_sc_stats = vlan_macsec_get_rx_sc_stats,
1020	.mdo_get_rx_sa_stats = vlan_macsec_get_rx_sa_stats,
1021};
1022
1023#endif
1024
1025static const struct ethtool_ops vlan_ethtool_ops = {
1026	.get_link_ksettings	= vlan_ethtool_get_link_ksettings,
1027	.get_drvinfo	        = vlan_ethtool_get_drvinfo,
1028	.get_link		= ethtool_op_get_link,
1029	.get_ts_info		= vlan_ethtool_get_ts_info,
1030};
1031
1032static const struct net_device_ops vlan_netdev_ops = {
1033	.ndo_change_mtu		= vlan_dev_change_mtu,
1034	.ndo_init		= vlan_dev_init,
1035	.ndo_uninit		= vlan_dev_uninit,
1036	.ndo_open		= vlan_dev_open,
1037	.ndo_stop		= vlan_dev_stop,
1038	.ndo_start_xmit =  vlan_dev_hard_start_xmit,
1039	.ndo_validate_addr	= eth_validate_addr,
1040	.ndo_set_mac_address	= vlan_dev_set_mac_address,
1041	.ndo_set_rx_mode	= vlan_dev_set_rx_mode,
1042	.ndo_change_rx_flags	= vlan_dev_change_rx_flags,
1043	.ndo_eth_ioctl		= vlan_dev_ioctl,
1044	.ndo_neigh_setup	= vlan_dev_neigh_setup,
1045	.ndo_get_stats64	= vlan_dev_get_stats64,
1046#if IS_ENABLED(CONFIG_FCOE)
1047	.ndo_fcoe_ddp_setup	= vlan_dev_fcoe_ddp_setup,
1048	.ndo_fcoe_ddp_done	= vlan_dev_fcoe_ddp_done,
1049	.ndo_fcoe_enable	= vlan_dev_fcoe_enable,
1050	.ndo_fcoe_disable	= vlan_dev_fcoe_disable,
1051	.ndo_fcoe_ddp_target	= vlan_dev_fcoe_ddp_target,
1052#endif
1053#ifdef NETDEV_FCOE_WWNN
1054	.ndo_fcoe_get_wwn	= vlan_dev_fcoe_get_wwn,
1055#endif
1056#ifdef CONFIG_NET_POLL_CONTROLLER
1057	.ndo_poll_controller	= vlan_dev_poll_controller,
1058	.ndo_netpoll_setup	= vlan_dev_netpoll_setup,
1059	.ndo_netpoll_cleanup	= vlan_dev_netpoll_cleanup,
1060#endif
1061	.ndo_fix_features	= vlan_dev_fix_features,
1062	.ndo_get_iflink		= vlan_dev_get_iflink,
1063	.ndo_fill_forward_path	= vlan_dev_fill_forward_path,
1064	.ndo_hwtstamp_get	= vlan_hwtstamp_get,
1065	.ndo_hwtstamp_set	= vlan_hwtstamp_set,
1066};
1067
1068static void vlan_dev_free(struct net_device *dev)
1069{
1070	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
1071
1072	free_percpu(vlan->vlan_pcpu_stats);
1073	vlan->vlan_pcpu_stats = NULL;
1074
1075	/* Get rid of the vlan's reference to real_dev */
1076	netdev_put(vlan->real_dev, &vlan->dev_tracker);
1077}
1078
1079void vlan_setup(struct net_device *dev)
1080{
1081	ether_setup(dev);
1082
1083	dev->priv_flags		|= IFF_802_1Q_VLAN | IFF_NO_QUEUE;
1084	dev->priv_flags		|= IFF_UNICAST_FLT;
1085	dev->priv_flags		&= ~IFF_TX_SKB_SHARING;
1086	netif_keep_dst(dev);
1087
1088	dev->netdev_ops		= &vlan_netdev_ops;
1089	dev->needs_free_netdev	= true;
1090	dev->priv_destructor	= vlan_dev_free;
1091	dev->ethtool_ops	= &vlan_ethtool_ops;
1092
1093#if IS_ENABLED(CONFIG_MACSEC)
1094	dev->macsec_ops		= &macsec_offload_ops;
1095#endif
1096	dev->min_mtu		= 0;
1097	dev->max_mtu		= ETH_MAX_MTU;
1098
1099	eth_zero_addr(dev->broadcast);
1100}
1101