Skip to contentSkip to conversation

can: Fix data length code handling in rx path

PATCH Applied Oliver Hartkopp 4 participants 7 messages Dec 12, 2009 – Dec 14, 2009 1 message not in the archive

Subsystems (4)
lore
Share & tools
lore
#2 lore raw
In reply to a message not in the archive

Hi Oliver,

Quoted 8 lines · Oliver Hartkopp

A valid CAN dataframe can have a data length code (DLC) of 0 .. 8 data bytes.

When reading the CAN controllers register the 4-bit value may contain values from 0 .. 15 which may exceed the reserved space in the socket buffer!

The ISO 11898-1 Chapter 8.4.2.3 (DLC field) says that register values > 8 should be reduced to 8 without any error reporting or frame drop.

Quoted 6 lines

This patch introduces a new helper macro to cast a given 4-bit data length code (dlc) to __u8 and ensure the DLC value to be max. 8 bytes.

The different handlings in the rx path of the CAN netdevice drivers are fixed.

Please send you patches inline next time please. For the bfin_can and the ems_usb driver your patch now masks the dlc with 0xf. Are you sure this is needed or even correct? Also, s/__u8/u8/, please.

Thanks,

Wolfgang.

#6 lore raw
In reply to a message not in the archive
Quoted 8 lines · Oliver Hartkopp

A valid CAN dataframe can have a data length code (DLC) of 0 .. 8 data bytes.

When reading the CAN controllers register the 4-bit value may contain values from 0 .. 15 which may exceed the reserved space in the socket buffer!

The ISO 11898-1 Chapter 8.4.2.3 (DLC field) says that register values > 8 should be reduced to 8 without any error reporting or frame drop.

Quoted 6 lines

This patch introduces a new helper macro to cast a given 4-bit data length code (dlc) to __u8 and ensure the DLC value to be max. 8 bytes.

The different handlings in the rx path of the CAN netdevice drivers are fixed.

Thanks,

Wolfgang.

#4 lore raw
In reply to Oliver Hartkopp
Quoted 17 lines · Oliver Hartkopp
Quoted 16 lines · Wolfgang Grandegger

Hi Oliver,

Quoted 13 lines · Oliver Hartkopp

A valid CAN dataframe can have a data length code (DLC) of 0 .. 8 data bytes.

When reading the CAN controllers register the 4-bit value may contain values from 0 .. 15 which may exceed the reserved space in the socket buffer!

The ISO 11898-1 Chapter 8.4.2.3 (DLC field) says that register values > 8 should be reduced to 8 without any error reporting or frame drop.

This patch introduces a new helper macro to cast a given 4-bit data length code (dlc) to __u8 and ensure the DLC value to be max. 8 bytes.

The different handlings in the rx path of the CAN netdevice drivers are fixed.

Quoted 8 lines
Quoted 4 lines
Quoted 1 line

Please send you patches inline next time please. For the bfin_can and the ems_usb driver your patch now masks the dlc with 0xf. Are you sure this is needed or even correct?

Yes. Both needed to be fixed.

The bfin_can has an u16 value which is not reduced to 4-bits before.

The relevant bits are hardware specific.

Quoted 8 lines

The ems_usb driver gets a u8 value via USB urb, which comes from a SJA1000 and needs the same handling as in the sja1000 driver. There's no guarantee that the USB adapter handles the values correctly - so masking is appropriate here.

Quoted 1 line

Also, s/__u8/u8/, please.

can_frame.can_dlc is the target and it is defined as '__u8' in include/linux/can.h.

OK.

Quoted 2 lines

As discussed on SocketCAN-ML we agreed the at91_can.c to be the 'correct' implementation - and that's what i posted here on your request ... :-)

The spoke about how to handle "dlc > 8". The additional masking is hardware specific and you need to check the manual to understand if it's really required.

Quoted 1 line

IMO the patch remains 100% correct.

I just checked the bfin manual. The DLC value uses a 4 bit field and there is also written:

"Any DLC value greater than 8 is treated the same as a value of 8."

That's exactly what this patch fixes. I didn't figure out though, if the masking is really required or if the higher bits are undefined (or "0"). At least it does not harm.

Wolfgang.

#5 lore raw
Quoted 14 lines · Wolfgang Grandegger
Quoted 8 lines · Oliver Hartkopp
Quoted 3 lines · Wolfgang Grandegger

Please send you patches inline next time please. For the bfin_can and the ems_usb driver your patch now masks the dlc with 0xf. Are you sure this is needed or even correct?

Yes. Both needed to be fixed.

The bfin_can has an u16 value which is not reduced to 4-bits before.

The relevant bits are hardware specific.

Quoted 8 lines

I just checked the bfin manual. The DLC value uses a 4 bit field and there is also written:

"Any DLC value greater than 8 is treated the same as a value of 8."

That's exactly what this patch fixes. I didn't figure out though, if the masking is really required or if the higher bits are undefined (or "0"). At least it does not harm.

The other 12 bits in the u16 dlc value of the blackfin CAN controller are 'shaded' == marked as 'reserved'. Therefore it's not really specified that they are always '0' and the masking is indeed needed here.

Tnx for your sign-off.

Regards,
Oliver

#0 lore raw

PATCH 1/1 can: Fix data length code handling in rx path

A valid CAN dataframe can have a data length code (DLC) of 0 .. 8 data bytes.

When reading the CAN controllers register the 4-bit value may contain values from 0 .. 15 which may exceed the reserved space in the socket buffer!

The ISO 11898-1 Chapter 8.4.2.3 (DLC field) says that register values > 8 should be reduced to 8 without any error reporting or frame drop.

This patch introduces a new helper macro to cast a given 4-bit data length code (dlc) to __u8 and ensure the DLC value to be max. 8 bytes.

The different handlings in the rx path of the CAN netdevice drivers are fixed.

---

drivers/net/can/at91_can.c +1 -1
index cbe3fce..d0ec178 100644
@@ -474,7 +474,7 @@ static void at91_read_mb(struct net_device *dev, unsigned int mb,
 	reg_msr = at91_read(priv, AT91_MSR(mb));
 	if (reg_msr & AT91_MSR_MRTR)
 		cf->can_id |= CAN_RTR_FLAG;
-	cf->can_dlc = min_t(__u8, (reg_msr >> 16) & 0xf, 8);
+	cf->can_dlc = get_can_dlc((reg_msr >> 16) & 0xf);
 
 	*(u32 *)(cf->data + 0) = at91_read(priv, AT91_MDL(mb));
 	*(u32 *)(cf->data + 4) = at91_read(priv, AT91_MDH(mb));
drivers/net/can/bfin_can.c +1 -1
index c7fc1de..0ec1524 100644
@@ -392,7 +392,7 @@ static void bfin_can_rx(struct net_device *dev, u16 isrc)
 		cf->can_id |= CAN_RTR_FLAG;
 
 	/* get data length code */
-	cf->can_dlc = bfin_read16(&reg->chl[obj].dlc);
+	cf->can_dlc = get_can_dlc(bfin_read16(&reg->chl[obj].dlc) & 0xF);
 
 	/* get payload */
 	for (i = 0; i < 8; i += 2) {
drivers/net/can/mcp251x.c +3 -10
index 78b1b69..9c5a153 100644
@@ -403,9 +403,8 @@ static void mcp251x_hw_rx_frame(struct spi_device *spi, u8 *buf,
 
 		for (i = 1; i < RXBDAT_OFF; i++)
 			buf[i] = mcp251x_read_reg(spi, RXBCTRL(buf_idx) + i);
-		len = buf[RXBDLC_OFF] & RXBDLC_LEN_MASK;
-		if (len > 8)
-			len = 8;
+
+		len = get_can_dlc(buf[RXBDLC_OFF] & RXBDLC_LEN_MASK);
 		for (; i < (RXBDAT_OFF + len); i++)
 			buf[i] = mcp251x_read_reg(spi, RXBCTRL(buf_idx) + i);
 	} else {
@@ -455,13 +454,7 @@ static void mcp251x_hw_rx(struct spi_device *spi, int buf_idx)
 			(buf[RXBSIDL_OFF] >> RXBSIDL_SHIFT);
 	}
 	/* Data length */
-	frame->can_dlc = buf[RXBDLC_OFF] & RXBDLC_LEN_MASK;
-	if (frame->can_dlc > 8) {
-		dev_warn(&spi->dev, "invalid frame recevied\n");
-		priv->net->stats.rx_errors++;
-		dev_kfree_skb(skb);
-		return;
-	}
+	frame->can_dlc = get_can_dlc(buf[RXBDLC_OFF] & RXBDLC_LEN_MASK);
 	memcpy(frame->data, buf + RXBDAT_OFF, frame->can_dlc);
 
 	priv->net->stats.rx_packets++;
drivers/net/can/mscan/mscan.c +2 -1
index bb06dfb..07346f8 100644
@@ -297,7 +297,8 @@ static void mscan_get_rx_frame(struct net_device *dev, struct can_frame *frame)
 	frame->can_id |= can_id >> 1;
 	if (can_id & 1)
 		frame->can_id |= CAN_RTR_FLAG;
-	frame->can_dlc = in_8(&regs->rx.dlr) & 0xf;
+
+	frame->can_dlc = get_can_dlc(in_8(&regs->rx.dlr) & 0xf);
 
 	if (!(frame->can_id & CAN_RTR_FLAG)) {
 		void __iomem *data = &regs->rx.dsr1_0;
drivers/net/can/sja1000/sja1000.c +8 -10
index b4ba88a..542a4f7 100644
@@ -293,15 +293,14 @@ static void sja1000_rx(struct net_device *dev)
 	uint8_t fi;
 	uint8_t dreg;
 	canid_t id;
-	uint8_t dlc;
 	int i;
 
+	/* create zero'ed CAN frame buffer */
 	skb = alloc_can_skb(dev, &cf);
 	if (skb == NULL)
 		return;
 
 	fi = priv->read_reg(priv, REG_FI);
-	dlc = fi & 0x0F;
 
 	if (fi & FI_FF) {
 		/* extended frame format (EFF) */
@@ -318,16 +317,15 @@ static void sja1000_rx(struct net_device *dev)
 		    | (priv->read_reg(priv, REG_ID2) >> 5);
 	}
 
-	if (fi & FI_RTR)
+	if (fi & FI_RTR) {
 		id |= CAN_RTR_FLAG;
+	} else {
+		cf->can_dlc = get_can_dlc(fi & 0x0F);
+		for (i = 0; i < cf->can_dlc; i++)
+			cf->data[i] = priv->read_reg(priv, dreg++);
+	}
 
 	cf->can_id = id;
-	cf->can_dlc = dlc;
-	for (i = 0; i < dlc; i++)
-		cf->data[i] = priv->read_reg(priv, dreg++);
-
-	while (i < 8)
-		cf->data[i++] = 0;
 
 	/* release receive buffer */
 	priv->write_reg(priv, REG_CMR, CMD_RRB);
@@ -335,7 +333,7 @@ static void sja1000_rx(struct net_device *dev)
 	netif_rx(skb);
 
 	stats->rx_packets++;
-	stats->rx_bytes += dlc;
+	stats->rx_bytes += cf->can_dlc;
 }
 
 static int sja1000_err(struct net_device *dev, uint8_t isrc, uint8_t status)
drivers/net/can/ti_hecc.c +1 -1
index 07e8016..5c993c2 100644
@@ -552,7 +552,7 @@ static int ti_hecc_rx_pkt(struct ti_hecc_priv *priv, int mbxno)
 	data = hecc_read_mbx(priv, mbxno, HECC_CANMCF);
 	if (data & HECC_CANMCF_RTR)
 		cf->can_id |= CAN_RTR_FLAG;
-	cf->can_dlc = data & 0xF;
+	cf->can_dlc = get_can_dlc(data & 0xF);
 	data = hecc_read_mbx(priv, mbxno, HECC_CANMDL);
 	*(u32 *)(cf->data) = cpu_to_be32(data);
 	if (cf->can_dlc > 4) {
drivers/net/can/usb/ems_usb.c +1 -1
index 591eb0e..efbb05c 100644
@@ -316,7 +316,7 @@ static void ems_usb_rx_can_msg(struct ems_usb *dev, struct ems_cpc_msg *msg)
 		return;
 
 	cf->can_id = le32_to_cpu(msg->msg.can_msg.id);
-	cf->can_dlc = min_t(u8, msg->msg.can_msg.length, 8);
+	cf->can_dlc = get_can_dlc(msg->msg.can_msg.length & 0xF);
 
 	if (msg->type == CPC_MSG_TYPE_EXT_CAN_FRAME ||
 	    msg->type == CPC_MSG_TYPE_EXT_RTR_FRAME)
include/linux/can/dev.h +9 -0
index 1ed2a5c..3db7767 100644
@@ -51,6 +51,15 @@ struct can_priv {
 	struct sk_buff **echo_skb;
 };
 
+/*
+ * get_can_dlc(value) - helper macro to cast a given data length code (dlc)
+ * to __u8 and ensure the dlc value to be max. 8 bytes.
+ *
+ * To be used in the CAN netdriver receive path to ensure conformance with
+ * ISO 11898-1 Chapter 8.4.2.3 (DLC field)
+ */
+#define get_can_dlc(i)	(min_t(__u8, (i), 8))
+
 struct net_device *alloc_candev(int sizeof_priv, unsigned int echo_skb_max);
 void free_candev(struct net_device *dev);
 
#3 lore raw
In reply to Wolfgang Grandegger
Quoted 14 lines · Wolfgang Grandegger

Hi Oliver,

Quoted 11 lines · Oliver Hartkopp

A valid CAN dataframe can have a data length code (DLC) of 0 .. 8 data bytes.

When reading the CAN controllers register the 4-bit value may contain values from 0 .. 15 which may exceed the reserved space in the socket buffer!

The ISO 11898-1 Chapter 8.4.2.3 (DLC field) says that register values > 8 should be reduced to 8 without any error reporting or frame drop.

This patch introduces a new helper macro to cast a given 4-bit data length code (dlc) to __u8 and ensure the DLC value to be max. 8 bytes.

Quoted 7 lines
Quoted 3 lines

The different handlings in the rx path of the CAN netdevice drivers are fixed.

Please send you patches inline next time please. For the bfin_can and the ems_usb driver your patch now masks the dlc with 0xf. Are you sure this is needed or even correct?

Yes. Both needed to be fixed.

The bfin_can has an u16 value which is not reduced to 4-bits before. The ems_usb driver gets a u8 value via USB urb, which comes from a SJA1000 and needs the same handling as in the sja1000 driver. There's no guarantee that the USB adapter handles the values correctly - so masking is appropriate here.

Quoted 1 line

Also, s/__u8/u8/, please.

can_frame.can_dlc is the target and it is defined as '__u8' in include/linux/can.h.

As discussed on SocketCAN-ML we agreed the at91_can.c to be the 'correct' implementation - and that's what i posted here on your request ... :-)

IMO the patch remains 100% correct.

Best regards,
Oliver

maintainer Applied
#7 lore raw
In reply to Wolfgang Grandegger

From: Wolfgang Grandegger <[email protected]>
Date: Sat, 12 Dec 2009 19:09:54 +0100

Quoted 9 lines
Quoted 8 lines · Oliver Hartkopp

A valid CAN dataframe can have a data length code (DLC) of 0 .. 8 data bytes.

When reading the CAN controllers register the 4-bit value may contain values from 0 .. 15 which may exceed the reserved space in the socket buffer!

The ISO 11898-1 Chapter 8.4.2.3 (DLC field) says that register values > 8 should be reduced to 8 without any error reporting or frame drop.

Quoted 8 lines
Quoted 6 lines

This patch introduces a new helper macro to cast a given 4-bit data length code (dlc) to __u8 and ensure the DLC value to be max. 8 bytes.

The different handlings in the rx path of the CAN netdevice drivers are fixed.

Applied, thanks everyone.