From: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
To: Marc Kleine-Budde <mkl@pengutronix.de>,
linux-can@vger.kernel.org, Marek Vasut <marex@denx.de>
Cc: linux-kernel@vger.kernel.org,
Vincent Mailhol <mailhol.vincent@wanadoo.fr>
Subject: [PATCH] can: length: add definitions for frame lengths in bits
Date: Mon, 8 May 2023 00:55:06 +0900 [thread overview]
Message-ID: <20230507155506.3179711-1-mailhol.vincent@wanadoo.fr> (raw)
When created in [1], frames length definitions were added to implement
byte queue limits (bql). Because bql expects lengths in bytes, bit
length definitions were not considered back then.
Recently, a need to refer to the exact frame length in bits, with CAN
bit stuffing, appeared in [2].
Add 9 frames length definitions:
- CAN_FRAME_OVERHEAD_SFF_BITS:
- CAN_FRAME_OVERHEAD_EFF_BITS
- CANFD_FRAME_OVERHEAD_SFF_BITS
- CANFD_FRAME_OVERHEAD_EFF_BITS
- CAN_BIT_STUFFING_OVERHEAD
- CAN_FRAME_LEN_MAX_BITS_NO_STUFFING
- CAN_FRAME_LEN_MAX_BITS_STUFFING
- CANFD_FRAME_LEN_MAX_BITS_NO_STUFFING
- CANFD_FRAME_LEN_MAX_BITS_STUFFING
CAN_FRAME_LEN_MAX_BITS_STUFFING and CANFD_FRAME_LEN_MAX_BITS_STUFFING
define respectively the maximum number of bits in a classical CAN and
CAN-FD frame including bit stuffing. The other definitions are
intermediate values.
In addition to the above:
- Include linux/bits.h and then replace the value 8 by BITS_PER_BYTE
whenever relevant.
- Include linux/math.h because of DIV_ROUND_UP(). N.B: the use of
DIV_ROUND_UP() is not new to this patch, but the include was
previously omitted.
- Update the existing length definitions to use the newly defined values.
- Add myself as copyright owner for 2020 (as coauthor of the initial
version, c.f. [1]) and for 2023 (this patch).
[1] commit 85d99c3e2a13 ("can: length: can_skb_get_frame_len(): introduce
function to get data length of frame in data link layer")
Link: https://git.kernel.org/torvalds/c/85d99c3e2a13
[2] RE: [PATCH] can: mcp251xfd: Increase poll timeout
Link: https://lore.kernel.org/linux-can/BL3PR11MB64846C83ACD04E9330B0FE66FB729@BL3PR11MB6484.namprd11.prod.outlook.com/
Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
---
As always, let me know if you have better inspiration than me for the
naming.
---
include/linux/can/length.h | 84 ++++++++++++++++++++++++++++++++------
1 file changed, 72 insertions(+), 12 deletions(-)
diff --git a/include/linux/can/length.h b/include/linux/can/length.h
index 6995092b774e..60492fcbe34d 100644
--- a/include/linux/can/length.h
+++ b/include/linux/can/length.h
@@ -1,13 +1,17 @@
/* SPDX-License-Identifier: GPL-2.0 */
/* Copyright (C) 2020 Oliver Hartkopp <socketcan@hartkopp.net>
* Copyright (C) 2020 Marc Kleine-Budde <kernel@pengutronix.de>
+ * Copyright (C) 2020, 2023 Vincent Mailhol <mailhol.vincent@wanadoo.fr>
*/
#ifndef _CAN_LENGTH_H
#define _CAN_LENGTH_H
+#include <linux/bits.h>
+#include <linux/math.h>
+
/*
- * Size of a Classical CAN Standard Frame
+ * Size of a Classical CAN Standard Frame in bits
*
* Name of Field Bits
* ---------------------------------------------------------
@@ -25,12 +29,19 @@
* End-of-frame (EOF) 7
* Inter frame spacing 3
*
- * rounded up and ignoring bitstuffing
+ * ignoring bitstuffing
*/
-#define CAN_FRAME_OVERHEAD_SFF DIV_ROUND_UP(47, 8)
+#define CAN_FRAME_OVERHEAD_SFF_BITS 47
/*
- * Size of a Classical CAN Extended Frame
+ * Size of a Classical CAN Standard Frame
+ * (rounded up and ignoring bitstuffing)
+ */
+#define CAN_FRAME_OVERHEAD_SFF \
+ DIV_ROUND_UP(CAN_FRAME_OVERHEAD_SFF_BITS, BITS_PER_BYTE)
+
+/*
+ * Size of a Classical CAN Extended Frame in bits
*
* Name of Field Bits
* ---------------------------------------------------------
@@ -50,12 +61,19 @@
* End-of-frame (EOF) 7
* Inter frame spacing 3
*
- * rounded up and ignoring bitstuffing
+ * ignoring bitstuffing
*/
-#define CAN_FRAME_OVERHEAD_EFF DIV_ROUND_UP(67, 8)
+#define CAN_FRAME_OVERHEAD_EFF_BITS 67
/*
- * Size of a CAN-FD Standard Frame
+ * Size of a Classical CAN Extended Frame
+ * (rounded up and ignoring bitstuffing)
+ */
+#define CAN_FRAME_OVERHEAD_EFF \
+ DIV_ROUND_UP(CAN_FRAME_OVERHEAD_EFF_BITS, BITS_PER_BYTE)
+
+/*
+ * Size of a CAN-FD Standard Frame in bits
*
* Name of Field Bits
* ---------------------------------------------------------
@@ -77,12 +95,19 @@
* End-of-frame (EOF) 7
* Inter frame spacing 3
*
- * assuming CRC21, rounded up and ignoring bitstuffing
+ * assuming CRC21 and ignoring bitstuffing
*/
-#define CANFD_FRAME_OVERHEAD_SFF DIV_ROUND_UP(61, 8)
+#define CANFD_FRAME_OVERHEAD_SFF_BITS 61
/*
- * Size of a CAN-FD Extended Frame
+ * Size of a CAN-FD Standard Frame
+ * (assuming CRC21, rounded up and ignoring bitstuffing)
+ */
+#define CANFD_FRAME_OVERHEAD_SFF \
+ DIV_ROUND_UP(CANFD_FRAME_OVERHEAD_SFF_BITS, BITS_PER_BYTE)
+
+/*
+ * Size of a CAN-FD Extended Frame in bits
*
* Name of Field Bits
* ---------------------------------------------------------
@@ -106,9 +131,32 @@
* End-of-frame (EOF) 7
* Inter frame spacing 3
*
- * assuming CRC21, rounded up and ignoring bitstuffing
+ * assuming CRC21 and ignoring bitstuffing
+ */
+#define CANFD_FRAME_OVERHEAD_EFF_BITS 80
+
+/*
+ * Size of a CAN-FD Extended Frame
+ * (assuming CRC21, rounded up and ignoring bitstuffing)
+ */
+#define CANFD_FRAME_OVERHEAD_EFF \
+ DIV_ROUND_UP(CANFD_FRAME_OVERHEAD_EFF_BITS, BITS_PER_BYTE)
+
+/* CAN bit stuffing overhead multiplication factor */
+#define CAN_BIT_STUFFING_OVERHEAD 1.2
+
+/*
+ * Maximum size of a Classical CAN frame in bits, ignoring bitstuffing
*/
-#define CANFD_FRAME_OVERHEAD_EFF DIV_ROUND_UP(80, 8)
+#define CAN_FRAME_LEN_MAX_BITS_NO_STUFFING \
+ (CAN_FRAME_OVERHEAD_EFF_BITS + CAN_MAX_DLEN * BITS_PER_BYTE)
+
+/*
+ * Maximum size of a Classical CAN frame in bits, including bitstuffing
+ */
+#define CAN_FRAME_LEN_MAX_BITS_STUFFING \
+ ((unsigned int)(CAN_FRAME_LEN_MAX_BITS_NO_STUFFING * \
+ CAN_BIT_STUFFING_OVERHEAD))
/*
* Maximum size of a Classical CAN frame
@@ -116,6 +164,18 @@
*/
#define CAN_FRAME_LEN_MAX (CAN_FRAME_OVERHEAD_EFF + CAN_MAX_DLEN)
+/*
+ * Maximum size of a CAN-FD frame in bits, ignoring bitstuffing
+ */
+#define CANFD_FRAME_LEN_MAX_BITS_NO_STUFFING \
+ (CANFD_FRAME_OVERHEAD_EFF_BITS + CANFD_MAX_DLEN * BITS_PER_BYTE)
+
+/*
+ * Maximum size of a CAN-FD frame in bits, ignoring bitstuffing
+ */
+#define CANFD_FRAME_LEN_MAX_BITS_STUFFING \
+ ((unsigned int)(CANFD_FRAME_LEN_MAX_BITS_NO_STUFFING * \
+ CAN_BIT_STUFFING_OVERHEAD))
/*
* Maximum size of a CAN-FD frame
* (rounded up and ignoring bitstuffing)
--
2.39.3
next reply other threads:[~2023-05-07 15:55 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-07 15:55 Vincent Mailhol [this message]
2023-05-08 8:54 ` [PATCH] can: length: add definitions for frame lengths in bits Thomas.Kopp
2023-05-08 12:14 ` Marc Kleine-Budde
2023-05-09 4:16 ` Vincent MAILHOL
2023-05-09 6:43 ` Marc Kleine-Budde
2023-05-09 8:14 ` Vincent MAILHOL
2023-05-09 6:19 ` Thomas.Kopp
2023-05-08 12:20 ` Marc Kleine-Budde
2023-05-09 4:58 ` Vincent MAILHOL
2023-05-09 7:12 ` Thomas.Kopp
2023-05-09 8:06 ` Vincent MAILHOL
2023-05-23 6:52 ` [PATCH v2 0/3] can: length: fix definitions and add bit length calculation Vincent Mailhol
2023-05-23 6:52 ` [PATCH v2 1/3] can: length: fix bitstuffing count Vincent Mailhol
2023-05-23 6:52 ` [PATCH v2 2/3] can: length: fix description of the RRS field Vincent Mailhol
2023-05-23 6:52 ` [PATCH v2 3/3] can: length: refactor frame lengths definition to add size in bits Vincent Mailhol
2023-05-23 7:13 ` Vincent MAILHOL
2023-05-23 11:14 ` Simon Horman
2023-05-30 14:46 ` [PATCH v3 0/3] can: length: fix definitions and add bit length calculation Vincent Mailhol
2023-05-30 14:46 ` [PATCH v3 1/3] can: length: fix bitstuffing count Vincent Mailhol
2023-05-30 14:46 ` [PATCH v3 2/3] can: length: fix description of the RRS field Vincent Mailhol
2023-05-30 14:46 ` [PATCH v3 3/3] can: length: refactor frame lengths definition to add size in bits Vincent Mailhol
2023-05-30 15:51 ` Simon Horman
2023-05-30 17:29 ` Vincent MAILHOL
2023-05-30 19:49 ` Simon Horman
2023-05-31 9:45 ` Vincent MAILHOL
2023-06-01 10:31 ` Thomas.Kopp
2023-06-01 11:00 ` Vincent MAILHOL
2023-06-01 11:26 ` Thomas.Kopp
2023-06-01 16:56 ` [PATCH v4 0/3] can: length: fix definitions and add bit length calculation Vincent Mailhol
2023-06-01 16:56 ` [PATCH v4 1/3] can: length: fix bitstuffing count Vincent Mailhol
2023-06-01 16:56 ` [PATCH v4 2/3] can: length: fix description of the RRS field Vincent Mailhol
2023-06-01 16:56 ` [PATCH v4 3/3] can: length: refactor frame lengths definition to add size in bits Vincent Mailhol
2023-06-11 2:57 ` [PATCH v5 0/3] can: length: fix definitions and add bit length calculation Vincent Mailhol
2023-06-11 2:57 ` [PATCH v5 1/3] can: length: fix bitstuffing count Vincent Mailhol
2023-06-11 2:57 ` [PATCH v5 2/3] can: length: fix description of the RRS field Vincent Mailhol
2023-06-11 2:57 ` [PATCH v5 3/3] can: length: refactor frame lengths definition to add size in bits Vincent Mailhol
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230507155506.3179711-1-mailhol.vincent@wanadoo.fr \
--to=mailhol.vincent@wanadoo.fr \
--cc=linux-can@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=marex@denx.de \
--cc=mkl@pengutronix.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).