VLAN overhaul

doc/releases/migration-guide-3.7.rst

@@ -194,6 +194,12 @@ Networking
   used to read the inner IPv4/IPv6 packets in an IP tunnel. This incoming tunnel read is now
   implemented in `recv` callback. (:github:`70549`)
 
+* Virtual LAN (VLAN) implementation is changed to use the Virtual network interfaces.
+  There are no API changes, but the type of a VLAN network interface is changed from `ETHERNET`
+  to `VIRTUAL`. This could require changes to the code that sets the VLAN tags to a network
+  interface. For example in the `net_eth_is_vlan_enabled()` API, the 2nd interface parameter
+  must point to the main Ethernet interface, and not to the VLAN interface. (:github:`70345`)
+
 * Modified the ``wifi connect`` command to use key-value format for the arguments. In the
   previous implementation, we were identifying an option using its position in the argument string.
   This made it difficult to deal with optional arguments or extending the support

drivers/ethernet/eth_e1000.c

@@ -68,22 +68,9 @@ static const char *e1000_reg_to_string(enum e1000_reg_t r)
 	return NULL;
 }
 
-static struct net_if *get_iface(struct e1000_dev *ctx, uint16_t vlan_tag)
+static struct net_if *get_iface(struct e1000_dev *ctx)
 {
-#if defined(CONFIG_NET_VLAN)
-	struct net_if *iface;
-
-	iface = net_eth_get_vlan_iface(ctx->iface, vlan_tag);
-	if (!iface) {
-		return ctx->iface;
-	}
-
-	return iface;
-#else
-	ARG_UNUSED(vlan_tag);
-
 	return ctx->iface;
-#endif
 }
 
 static enum ethernet_hw_caps e1000_caps(const struct device *dev)
@@ -187,7 +174,6 @@ static void e1000_isr(const struct device *ddev)
 {
 	struct e1000_dev *dev = ddev->data;
 	uint32_t icr = ior32(dev, ICR); /* Cleared upon read */
-	uint16_t vlan_tag = NET_VLAN_TAG_UNSPEC;
 
 	icr &= ~(ICR_TXDW | ICR_TXQE);
 
@@ -197,31 +183,9 @@ static void e1000_isr(const struct device *ddev)
 		icr &= ~ICR_RXO;
 
 		if (pkt) {
-#if defined(CONFIG_NET_VLAN)
-			struct net_eth_hdr *hdr = NET_ETH_HDR(pkt);
-
-			if (ntohs(hdr->type) == NET_ETH_PTYPE_VLAN) {
-				struct net_eth_vlan_hdr *hdr_vlan =
-					(struct net_eth_vlan_hdr *)
-					NET_ETH_HDR(pkt);
-
-				net_pkt_set_vlan_tci(
-					pkt, ntohs(hdr_vlan->vlan.tci));
-				vlan_tag = net_pkt_vlan_tag(pkt);
-
-#if CONFIG_NET_TC_RX_COUNT > 1
-				enum net_priority prio;
-
-				prio = net_vlan2priority(
-						net_pkt_vlan_priority(pkt));
-				net_pkt_set_priority(pkt, prio);
-#endif
-			}
-#endif /* CONFIG_NET_VLAN */
-
-			net_recv_data(get_iface(dev, vlan_tag), pkt);
+			net_recv_data(get_iface(dev), pkt);
 		} else {
-			eth_stats_update_errors_rx(get_iface(dev, vlan_tag));
+			eth_stats_update_errors_rx(get_iface(dev));
 		}
 	}
 
@@ -291,10 +255,6 @@ static void e1000_iface_init(struct net_if *iface)
 	struct e1000_dev *dev = net_if_get_device(iface)->data;
 	const struct e1000_config *config = net_if_get_device(iface)->config;
 
-	/* For VLAN, this value is only used to get the correct L2 driver.
-	 * The iface pointer in device context should contain the main
-	 * interface if the VLANs are enabled.
-	 */
 	if (dev->iface == NULL) {
 		dev->iface = iface;
 

drivers/ethernet/eth_enc28j60.c

@@ -457,23 +457,9 @@ static void eth_enc28j60_init_phy(const struct device *dev)
 	}
 }
 
-static struct net_if *get_iface(struct eth_enc28j60_runtime *ctx,
-				uint16_t vlan_tag)
+static struct net_if *get_iface(struct eth_enc28j60_runtime *ctx)
 {
-#if defined(CONFIG_NET_VLAN)
-	struct net_if *iface;
-
-	iface = net_eth_get_vlan_iface(ctx->iface, vlan_tag);
-	if (!iface) {
-		return ctx->iface;
-	}
-
-	return iface;
-#else
-	ARG_UNUSED(vlan_tag);
-
 	return ctx->iface;
-#endif
 }
 
 static int eth_enc28j60_tx(const struct device *dev, struct net_pkt *pkt)
@@ -549,8 +535,7 @@ static int eth_enc28j60_tx(const struct device *dev, struct net_pkt *pkt)
 	return 0;
 }
 
-static void enc28j60_read_packet(const struct device *dev, uint16_t *vlan_tag,
-				 uint16_t frm_len)
+static void enc28j60_read_packet(const struct device *dev, uint16_t frm_len)
 {
 	const struct eth_enc28j60_config *config = dev->config;
 	struct eth_enc28j60_runtime *context = dev->data;
@@ -560,11 +545,11 @@ static void enc28j60_read_packet(const struct device *dev, uint16_t *vlan_tag,
 	uint8_t dummy[4];
 
 	/* Get the frame from the buffer */
-	pkt = net_pkt_rx_alloc_with_buffer(get_iface(context, *vlan_tag), frm_len,
+	pkt = net_pkt_rx_alloc_with_buffer(get_iface(context), frm_len,
 					   AF_UNSPEC, 0, K_MSEC(config->timeout));
 	if (!pkt) {
 		LOG_ERR("%s: Could not allocate rx buffer", dev->name);
-		eth_stats_update_errors_rx(get_iface(context, *vlan_tag));
+		eth_stats_update_errors_rx(get_iface(context));
 		return;
 	}
 
@@ -606,28 +591,7 @@ static void enc28j60_read_packet(const struct device *dev, uint16_t *vlan_tag,
 		eth_enc28j60_read_mem(dev, dummy, 1);
 	}
 
-#if defined(CONFIG_NET_VLAN)
-	struct net_eth_hdr *hdr = NET_ETH_HDR(pkt);
-
-	if (ntohs(hdr->type) == NET_ETH_PTYPE_VLAN) {
-		struct net_eth_vlan_hdr *hdr_vlan =
-			(struct net_eth_vlan_hdr *)NET_ETH_HDR(pkt);
-
-		net_pkt_set_vlan_tci(pkt, ntohs(hdr_vlan->vlan.tci));
-		*vlan_tag = net_pkt_vlan_tag(pkt);
-
-#if CONFIG_NET_TC_RX_COUNT > 1
-		enum net_priority prio;
-
-		prio = net_vlan2priority(net_pkt_vlan_priority(pkt));
-		net_pkt_set_priority(pkt, prio);
-#endif
-	} else {
-		net_pkt_set_iface(pkt, context->iface);
-	}
-#else /* CONFIG_NET_VLAN */
 	net_pkt_set_iface(pkt, context->iface);
-#endif /* CONFIG_NET_VLAN */
 
 	/* Feed buffer frame to IP stack */
 	LOG_DBG("%s: Received packet of length %u", dev->name, lengthfr);
@@ -636,7 +600,7 @@ static void enc28j60_read_packet(const struct device *dev, uint16_t *vlan_tag,
 	}
 }
 
-static int eth_enc28j60_rx(const struct device *dev, uint16_t *vlan_tag)
+static int eth_enc28j60_rx(const struct device *dev)
 {
 	struct eth_enc28j60_runtime *context = dev->data;
 	uint8_t counter;
@@ -688,7 +652,7 @@ static int eth_enc28j60_rx(const struct device *dev, uint16_t *vlan_tag)
 		 */
 		frm_len = sys_get_le16(info) - 4;
 
-		enc28j60_read_packet(dev, vlan_tag, frm_len);
+		enc28j60_read_packet(dev, frm_len);
 
 		/* Free buffer memory and decrement rx counter */
 		eth_enc28j60_set_bank(dev, ENC28J60_REG_ERXRDPTL);
@@ -716,15 +680,14 @@ static void eth_enc28j60_rx_thread(void *p1, void *p2, void *p3)
 
 	const struct device *dev = p1;
 	struct eth_enc28j60_runtime *context = dev->data;
-	uint16_t vlan_tag = NET_VLAN_TAG_UNSPEC;
 	uint8_t int_stat;
 
 	while (true) {
 		k_sem_take(&context->int_sem, K_FOREVER);
 
 		eth_enc28j60_read_reg(dev, ENC28J60_REG_EIR, &int_stat);
 		if (int_stat & ENC28J60_BIT_EIR_PKTIF) {
-			eth_enc28j60_rx(dev, &vlan_tag);
+			eth_enc28j60_rx(dev);
 			/* Clear rx interruption flag */
 			eth_enc28j60_clear_eth_reg(dev, ENC28J60_REG_EIR,
 						   ENC28J60_BIT_EIR_PKTIF
@@ -769,10 +732,6 @@ static void eth_enc28j60_iface_init(struct net_if *iface)
 			     sizeof(context->mac_address),
 			     NET_LINK_ETHERNET);
 
-	/* For VLAN, this value is only used to get the correct L2 driver.
-	 * The iface pointer in context should contain the main interface
-	 * if the VLANs are enabled.
-	 */
 	if (context->iface == NULL) {
 		context->iface = iface;
 	}

drivers/ethernet/eth_mcux.c

@@ -161,10 +161,6 @@ static const char *eth_name(ENET_Type *base)
 struct eth_context {
 	ENET_Type *base;
 	void (*config_func)(void);
-	/* If VLAN is enabled, there can be multiple VLAN interfaces related to
-	 * this physical device. In that case, this pointer value is not really
-	 * used for anything.
-	 */
 	struct net_if *iface;
 #if defined(CONFIG_NET_POWER_MANAGEMENT)
 	clock_ip_name_t clock;
@@ -336,22 +332,9 @@ static void eth_mcux_decode_duplex_and_speed(uint32_t status,
 }
 #endif /* ETH_MCUX_FIXED_LINK */
 
-static inline struct net_if *get_iface(struct eth_context *ctx, uint16_t vlan_tag)
+static inline struct net_if *get_iface(struct eth_context *ctx)
 {
-#if defined(CONFIG_NET_VLAN)
-	struct net_if *iface;
-
-	iface = net_eth_get_vlan_iface(ctx->iface, vlan_tag);
-	if (!iface) {
-		return ctx->iface;
-	}
-
-	return iface;
-#else
-	ARG_UNUSED(vlan_tag);
-
 	return ctx->iface;
-#endif
 }
 
 static void eth_mcux_phy_enter_reset(struct eth_context *context)
@@ -672,31 +655,12 @@ static bool eth_get_ptp_data(struct net_if *iface, struct net_pkt *pkt)
 {
 	int eth_hlen;
 
-#if defined(CONFIG_NET_VLAN)
-	struct net_eth_vlan_hdr *hdr_vlan;
-	struct ethernet_context *eth_ctx;
-	bool vlan_enabled = false;
-
-	eth_ctx = net_if_l2_data(iface);
-	if (net_eth_is_vlan_enabled(eth_ctx, iface)) {
-		hdr_vlan = (struct net_eth_vlan_hdr *)NET_ETH_HDR(pkt);
-		vlan_enabled = true;
-
-		if (ntohs(hdr_vlan->type) != NET_ETH_PTYPE_PTP) {
-			return false;
-		}
-
-		eth_hlen = sizeof(struct net_eth_vlan_hdr);
-	} else
-#endif
-	{
-		if (ntohs(NET_ETH_HDR(pkt)->type) != NET_ETH_PTYPE_PTP) {
-			return false;
-		}
-
-		eth_hlen = sizeof(struct net_eth_hdr);
+	if (ntohs(NET_ETH_HDR(pkt)->type) != NET_ETH_PTYPE_PTP) {
+		return false;
 	}
 
+	eth_hlen = sizeof(struct net_eth_hdr);
+
 	net_pkt_set_priority(pkt, NET_PRIORITY_CA);
 
 	return true;
@@ -762,7 +726,6 @@ static int eth_tx(const struct device *dev, struct net_pkt *pkt)
 
 static int eth_rx(struct eth_context *context)
 {
-	uint16_t vlan_tag = NET_VLAN_TAG_UNSPEC;
 	uint32_t frame_length = 0U;
 	struct net_if *iface;
 	struct net_pkt *pkt;
@@ -823,36 +786,12 @@ static int eth_rx(struct eth_context *context)
 
 	k_mutex_unlock(&context->rx_frame_buf_mutex);
 
-#if defined(CONFIG_NET_VLAN)
-	{
-		struct net_eth_hdr *hdr = NET_ETH_HDR(pkt);
-
-		if (ntohs(hdr->type) == NET_ETH_PTYPE_VLAN) {
-			struct net_eth_vlan_hdr *hdr_vlan =
-				(struct net_eth_vlan_hdr *)NET_ETH_HDR(pkt);
-
-			net_pkt_set_vlan_tci(pkt, ntohs(hdr_vlan->vlan.tci));
-			vlan_tag = net_pkt_vlan_tag(pkt);
-
-#if CONFIG_NET_TC_RX_COUNT > 1
-			{
-				enum net_priority prio;
-
-				prio = net_vlan2priority(
-						net_pkt_vlan_priority(pkt));
-				net_pkt_set_priority(pkt, prio);
-			}
-#endif
-		}
-	}
-#endif /* CONFIG_NET_VLAN */
-
 	/*
 	 * Use MAC timestamp
 	 */
 #if defined(CONFIG_PTP_CLOCK_MCUX)
 	k_mutex_lock(&context->ptp_mutex, K_FOREVER);
-	if (eth_get_ptp_data(get_iface(context, vlan_tag), pkt)) {
+	if (eth_get_ptp_data(get_iface(context), pkt)) {
 		ENET_Ptp1588GetTimer(context->base, &context->enet_handle,
 					&ptpTimeData);
 		/* If latest timestamp reloads after getting from Rx BD,
@@ -873,7 +812,7 @@ static int eth_rx(struct eth_context *context)
 	k_mutex_unlock(&context->ptp_mutex);
 #endif /* CONFIG_PTP_CLOCK_MCUX */
 
-	iface = get_iface(context, vlan_tag);
+	iface = get_iface(context);
 #if defined(CONFIG_NET_DSA)
 	iface = dsa_net_recv(iface, &pkt);
 #endif
@@ -892,7 +831,7 @@ static int eth_rx(struct eth_context *context)
 					0, RING_ID, NULL);
 	__ASSERT_NO_MSG(status == kStatus_Success);
 error:
-	eth_stats_update_errors_rx(get_iface(context, vlan_tag));
+	eth_stats_update_errors_rx(get_iface(context));
 	return -EIO;
 }
 
@@ -1174,10 +1113,6 @@ static void eth_iface_init(struct net_if *iface)
 			     sizeof(context->mac_addr),
 			     NET_LINK_ETHERNET);
 
-	/* For VLAN, this value is only used to get the correct L2 driver.
-	 * The iface pointer in context should contain the main interface
-	 * if the VLANs are enabled.
-	 */
 	if (context->iface == NULL) {
 		context->iface = iface;
 	}
@@ -1195,8 +1130,11 @@ static enum ethernet_hw_caps eth_mcux_get_capabilities(const struct device *dev)
 {
 	ARG_UNUSED(dev);
 
-	return ETHERNET_HW_VLAN | ETHERNET_LINK_10BASE_T |
+	return ETHERNET_LINK_10BASE_T |
 		ETHERNET_HW_FILTERING |
+#if defined(CONFIG_NET_VLAN)
+		ETHERNET_HW_VLAN |
+#endif
 #if defined(CONFIG_PTP_CLOCK_MCUX)
 		ETHERNET_PTP |
 #endif