All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH net v4] net: bgmac: fix RX frame length check
@ 2026-11-21  0:50 Rosen Penev
  0 siblings, 0 replies; only message in thread
From: Rosen Penev @ 2026-11-21  0:50 UTC (permalink / raw)
  To: Rafał Miłecki, Andrew Lunn, David S. Miller,
	Eric Dumazet, Jakub Kicinski, Paolo Abeni, Felix Fietkau,
	Simon Horman, Florian Fainelli
  Cc: Broadcom internal kernel review list, Rafał Miłecki,
	netdev

While reviewing commit 77dac783f113
("net: bgmac: rate limit RX error messages"), Florian spotted that the RX
length sanity check compares the length reported in the RX header against
BGMAC_RX_ALLOC_SIZE. That is the size of the whole fragment, including the
space reserved for struct skb_shared_info. The data area handed to the
hardware is only BGMAC_RX_BUF_SIZE bytes, and the frame starts
BGMAC_RX_FRAME_OFFSET bytes into it, so at most BGMAC_RX_MAX_FRAME_SIZE
(1536) bytes of a frame fit in one RX buffer.

A corrupted length well beyond that limit passes the check, and the
following skb_put() runs past the skb tailroom and calls skb_over_panic()
instead of dropping the frame. Lengths only slightly above the limit fit
in the alignment padding at the end of the buffer and were delivered,
with the data past the buffer end being stale memory.

The check has no lower bound either. A length below ETH_FCS_LEN wraps
when the FCS is subtracted, so skb_put() asks for almost 64 KiB and hits
the same skb_over_panic(). A length that leaves less than an Ethernet
header makes eth_type_trans() parse bytes the hardware never wrote.

The other limits in the driver do not agree with the buffer size either.
The MAC is programmed to accept up to 32 + ETHER_MAX_LEN = 1550 bytes in
bgmac_chip_init(), and up to 32 + mtu = 1564 bytes after
bgmac_change_mtu(). max_mtu is BGMAC_RX_MAX_FRAME_SIZE - ETH_FCS_LEN,
which leaves out the Ethernet header and any VLAN tag.

Such frames do not fit in one RX buffer. The DMA engine is the same dma64
engine used by b43 and brcmsmac, and with BGMAC_DMA_RX_OVERFLOW_CONT set it
continues the frame into the next descriptor's buffer. bgmac_dma_rx_read()
consumes only the first descriptor and parses the continuation buffer as
a new frame, taking its RX header from frame data the sender controls. A
bounds check on the length cannot catch that, and the stale memory in the
rest of that buffer is passed up the stack.

Fix all of this:

- Program UMAC_MAX_FRAME_LEN from the MTU plus a VLAN tagged Ethernet
  header and the FCS, and limit max_mtu so that the resulting frame fits
  in one RX buffer. At the default MTU of 1500 this gives 1522 bytes. A
  DSA conduit carrying a 4 byte Broadcom tag (MTU 1504) gives 1526 bytes.
  max_mtu drops from 1532 to 1514. bgmac_chip_init() runs on every
  ndo_open and used to reset the limit to the fixed default, so use the
  current MTU there. bgmac_change_mtu() also never updated net_dev->mtu,
  so the MTU seen by the stack never changed. Set it.

- Check the RX header flags. The MAC is not set up to discard errored
  frames (CMD_RX_ERR_DISC is cleared), so frames above the programmed
  maximum still reach the host. The layout of the flags is taken from
  bcmgmacrxh.h in the Broadcom SDK: bits 11:8 hold the descriptor count
  minus one, bit 7 flags an RX FIFO overflow, bit 4 a frame longer than
  the maximum frame length and bit 3 a CRC error. Drop frames that have
  any of the error flags set and count them in the matching statistics.
  Drop frames that span more than one descriptor and recycle their
  continuation buffers without parsing them. The skip count is kept in
  the ring so that it carries over into the next poll. The poison check
  stays first, since its 0xbeef pattern has descriptor count bits set.

- Reject lengths below ETH_HLEN + ETH_FCS_LEN or above
  BGMAC_RX_MAX_FRAME_SIZE, and print the bad length.

Only compile tested. Not tested on hardware.

Fixes: dd4544f05469 ("bgmac: driver for GBit MAC core on BCMA bus")
Fixes: 6a6c708469c9 ("bgmac: add check for oversized packets")
Fixes: 752e5fcc2e77 ("bgmac: reduce max frame size to support just MTU 1500")
Signed-off-by: Rosen Penev <rosenp@gmail.com>
---
v4:
- program UMAC_MAX_FRAME_LEN from the MTU plus a VLAN Ethernet header
  and FCS, and limit max_mtu to 1514, so every frame the MAC accepts by
  its programmed limit fits in one RX buffer
- check the RX header flags: drop errored frames and recycle the
  continuation buffers of frames that span more than one descriptor
  instead of parsing them as frames
- correct the commit message: lengths just above the limit fit in the
  SKB_DATA_ALIGN padding and were delivered, not panicked on
- AI coding assistant (Claude) used to help analyse the review and
  prepare this version; I have reviewed the result
v3: add a lower bound
v2: replace Suggested-by with description.

 drivers/net/ethernet/broadcom/bgmac.c | 55 +++++++++++++++++++++++----
 drivers/net/ethernet/broadcom/bgmac.h | 15 +++++++-
 2 files changed, 61 insertions(+), 9 deletions(-)

diff --git a/drivers/net/ethernet/broadcom/bgmac.c b/drivers/net/ethernet/broadcom/bgmac.c
index 9ef7307edd41..d72e9c8577c4 100644
--- a/drivers/net/ethernet/broadcom/bgmac.c
+++ b/drivers/net/ethernet/broadcom/bgmac.c
@@ -10,6 +10,7 @@
 #define pr_fmt(fmt)		KBUILD_MODNAME ": " fmt

 #include <linux/bcma/bcma.h>
+#include <linux/bitfield.h>
 #include <linux/etherdevice.h>
 #include <linux/interrupt.h>
 #include <linux/bcm47xx_nvram.h>
@@ -435,6 +436,13 @@ static int bgmac_dma_rx_read(struct bgmac *bgmac, struct bgmac_dma_ring *ring,
 		dma_addr_t dma_addr = slot->dma_addr;
 		u16 len, flags;

+		/* The rest of a multi descriptor frame that was dropped */
+		if (ring->rx_skip) {
+			ring->rx_skip--;
+			bgmac_dma_rx_poison_buf(dma_dev, slot);
+			goto next;
+		}
+
 		do {
 			/* Prepare new skb as replacement */
 			if (bgmac_dma_rx_skb_for_slot(bgmac, slot)) {
@@ -460,10 +468,34 @@ static int bgmac_dma_rx_read(struct bgmac *bgmac, struct bgmac_dma_ring *ring,
 				break;
 			}

-			if (len > BGMAC_RX_ALLOC_SIZE) {
+			/* The frame did not fit in one buffer. The following
+			 * buffers hold the rest of its data, not RX headers.
+			 */
+			if (flags & BGMAC_RXF_DC_MASK) {
+				ring->rx_skip = FIELD_GET(BGMAC_RXF_DC_MASK, flags);
+				put_page(virt_to_head_page(buf));
+				bgmac->net_dev->stats.rx_length_errors++;
+				bgmac->net_dev->stats.rx_errors++;
+				break;
+			}
+
+			if (flags & BGMAC_RXF_ERR) {
+				put_page(virt_to_head_page(buf));
+				if (flags & BGMAC_RXF_OVF)
+					bgmac->net_dev->stats.rx_fifo_errors++;
+				if (flags & BGMAC_RXF_OVERSIZE)
+					bgmac->net_dev->stats.rx_length_errors++;
+				if (flags & BGMAC_RXF_CRC)
+					bgmac->net_dev->stats.rx_crc_errors++;
+				bgmac->net_dev->stats.rx_errors++;
+				break;
+			}
+
+			if (len < ETH_HLEN + ETH_FCS_LEN ||
+			    len > BGMAC_RX_MAX_FRAME_SIZE) {
 				if (net_ratelimit())
-					netdev_err(bgmac->net_dev, "Found oversized packet at slot %d, DMA issue!\n",
-						   ring->start);
+					netdev_err(bgmac->net_dev, "Found packet with invalid length %u at slot %d, DMA issue!\n",
+						   len, ring->start);
 				put_page(virt_to_head_page(buf));
 				bgmac->net_dev->stats.rx_length_errors++;
 				bgmac->net_dev->stats.rx_errors++;
@@ -493,6 +525,7 @@ static int bgmac_dma_rx_read(struct bgmac *bgmac, struct bgmac_dma_ring *ring,
 			handled++;
 		} while (0);

+next:
 		bgmac_dma_rx_setup_desc(bgmac, ring, ring->start);

 		if (++ring->start >= BGMAC_RX_RING_SLOTS)
@@ -735,6 +768,7 @@ static int bgmac_dma_init(struct bgmac *bgmac)

 		ring->start = 0;
 		ring->end = 0;
+		ring->rx_skip = 0;
 		for (j = 0; j < BGMAC_RX_RING_SLOTS; j++) {
 			err = bgmac_dma_rx_skb_for_slot(bgmac, &ring->slots[j]);
 			if (err)
@@ -1110,6 +1144,13 @@ static void bgmac_enable(struct bgmac *bgmac)
 	}
 }

+/* The MAC counts the FCS in the maximum frame length. */
+static void bgmac_set_max_frame_len(struct bgmac *bgmac, int mtu)
+{
+	bgmac_umac_write(bgmac, UMAC_MAX_FRAME_LEN,
+			 mtu + VLAN_ETH_HLEN + ETH_FCS_LEN);
+}
+
 /* http://bcm-v4.sipsolutions.net/mac-gbit/gmac/chipinit */
 static void bgmac_chip_init(struct bgmac *bgmac)
 {
@@ -1131,7 +1172,7 @@ static void bgmac_chip_init(struct bgmac *bgmac)
 	else
 		bgmac_umac_cmd_maskset(bgmac, ~CMD_LCL_LOOP_EN, 0, false);

-	bgmac_umac_write(bgmac, UMAC_MAX_FRAME_LEN, 32 + ETHER_MAX_LEN);
+	bgmac_set_max_frame_len(bgmac, bgmac->net_dev->mtu);

 	bgmac_chip_intrs_on(bgmac);

@@ -1267,7 +1308,8 @@ static int bgmac_change_mtu(struct net_device *net_dev, int mtu)
 {
 	struct bgmac *bgmac = netdev_priv(net_dev);

-	bgmac_umac_write(bgmac, UMAC_MAX_FRAME_LEN, 32 + mtu);
+	bgmac_set_max_frame_len(bgmac, mtu);
+	WRITE_ONCE(net_dev->mtu, mtu);
 	return 0;
 }

@@ -1559,8 +1601,7 @@ int bgmac_enet_probe(struct bgmac *bgmac)
 	net_dev->hw_features = net_dev->features;
 	net_dev->vlan_features = net_dev->features;

-	/* Omit FCS from max MTU size */
-	net_dev->max_mtu = BGMAC_RX_MAX_FRAME_SIZE - ETH_FCS_LEN;
+	net_dev->max_mtu = BGMAC_RX_MAX_MTU;

 	bgmac->in_init = false;

diff --git a/drivers/net/ethernet/broadcom/bgmac.h b/drivers/net/ethernet/broadcom/bgmac.h
index 6fee9a41839c..7697c673c4d2 100644
--- a/drivers/net/ethernet/broadcom/bgmac.h
+++ b/drivers/net/ethernet/broadcom/bgmac.h
@@ -2,6 +2,7 @@
 #ifndef _BGMAC_H
 #define _BGMAC_H

+#include <linux/if_vlan.h>
 #include <linux/netdevice.h>

 #include "unimac.h"
@@ -330,6 +331,9 @@
 						 BGMAC_RX_FRAME_OFFSET)
 #define BGMAC_RX_MAX_FRAME_SIZE			1536
 #define BGMAC_RX_BUF_SIZE			(BGMAC_RX_FRAME_OFFSET + BGMAC_RX_MAX_FRAME_SIZE)
+/* Largest MTU whose VLAN tagged frames, FCS included, fit in one RX buffer */
+#define BGMAC_RX_MAX_MTU			(BGMAC_RX_MAX_FRAME_SIZE - VLAN_ETH_HLEN - \
+						 ETH_FCS_LEN)
 #define BGMAC_RX_ALLOC_SIZE			(SKB_DATA_ALIGN(BGMAC_RX_BUF_SIZE + BGMAC_RX_BUF_OFFSET) + \
 						 SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))

@@ -363,8 +367,6 @@
 #define BGMAC_CHIPCTL_7_IF_TYPE_MII		0x00000040
 #define BGMAC_CHIPCTL_7_IF_TYPE_RGMII		0x00000080

-#define ETHER_MAX_LEN	(ETH_FRAME_LEN + ETH_FCS_LEN)
-
 /* Feature Flags */
 #define BGMAC_FEAT_TX_MASK_SETUP	BIT(0)
 #define BGMAC_FEAT_RX_MASK_SETUP	BIT(1)
@@ -426,6 +428,7 @@ struct bgmac_dma_ring {
 	u32 index_base; /* Used for unaligned rings only, otherwise 0 */
 	u16 mmio_base;
 	bool unaligned;
+	u8 rx_skip; /* Continuation slots of a dropped RX frame */

 	struct bgmac_slot_info slots[BGMAC_RX_RING_SLOTS];
 };
@@ -436,6 +439,14 @@ struct bgmac_rx_header {
 	__le16 pad[12];
 };

+/* bgmac_rx_header::flags */
+#define BGMAC_RXF_DC_MASK			0x0f00	/* Descriptors used - 1 */
+#define BGMAC_RXF_OVF				0x0080	/* RX FIFO overflow */
+#define BGMAC_RXF_OVERSIZE			0x0010	/* Frame > max frame length */
+#define BGMAC_RXF_CRC				0x0008	/* CRC error */
+#define BGMAC_RXF_ERR				(BGMAC_RXF_OVF | BGMAC_RXF_OVERSIZE | \
+						 BGMAC_RXF_CRC)
+
 struct bgmac {
 	union {
 		struct {

base-commit: fdb6fcabdbb8247f1647d54fb1b9dc3575d7fcc8
--
2.56.1


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2026-11-21  0:50 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-11-21  0:50 [PATCH net v4] net: bgmac: fix RX frame length check Rosen Penev

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.