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].
This series introduces can_frame_bits(): a function-like macro that
can calculate the exact size of a CAN(-FD) frame in bits with or
without bitsuffing.
[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@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/
* Changelog *
v4 -> v5:
* In __can_cc_frame_bits() and __can_fd_frame_bits(), enclose
data_len in brackets to prevent operator precedence issues.
* Add a note in can_frame_bits() documentation to explain that
data_len shall have no side effects.
* While at it, make CAN(FD)_FRAME_LEN_MAX definition fit on a single
line.
* A few typo/grammar small fixes in the commit descriptions.
Link: https://lore.kernel.org/linux-can/20230601165625.100040-1-mailhol.vincent@xxxxxxxxxx/
v3 -> v4:
* No functional changes.
* as reported by Simon Horman, fix typo in the documentation of
can_bitstuffing_len(): "bitstream_len" -> "destuffed_len".
* as reported by Thomas Kopp, fix several other typos:
- "indicatior" -> "indicator"
- "in on the wire" -> "on the wire"
- "bitsuffing" -> "bitstuffing".
* in CAN_FRAME_LEN_MAX comment: specify that only the dynamic
bitstuffing gets ignored but that the intermission is included.
* move the Suggested-by: Thomas Kopp tag from patch 2 to patch 3.
* add Reviewed-by: Thomas Kopp tag on the full series.
* add an additional line of comment for the @intermission argument
of can_frame_bits().
Link: https://lore.kernel.org/linux-can/20230530144637.4746-1-mailhol.vincent@xxxxxxxxxx/
v2 -> v3:
* turn can_frame_bits() and can_frame_bytes() into function-like
macros. The fact that inline functions can not be used to
initialize constant struct fields was bothering me. I did my best
to make the macro look as less ugly as possible.
* as reported by Simon Horman, add missing document for the is_fd
argument of can_frame_bits().
Link: https://lore.kernel.org/linux-can/20230523065218.51227-1-mailhol.vincent@xxxxxxxxxx/
v1 -> v2:
* as suggested by Thomas Kopp, add a new patch to the series to fix
the stuff bit count and the fixed stuff bits definitions
* and another patch to fix documentation of the Remote Request
Substitution (RRS).
* refactor the length definition. Instead of using individual macro,
rely on an inline function. One reason is to minimize the number
of definitions. Another reason is that because the dynamic bit
stuff is calculated differently for CAN and CAN-FD, it is just not
possible to multiply the existing CANFD_FRAME_OVERHEAD_SFF/EFF by
the overhead ratio to get the bitsuffing: for CAN-FD, the CRC
field is already stuffed by the fixed stuff bits and is out of
scope of the dynamic bitstuffing.
Link: https://lore.kernel.org/linux-can/20230507155506.3179711-1-mailhol.vincent@xxxxxxxxxx/
Vincent Mailhol (3):
can: length: fix bitstuffing count
can: length: fix description of the RRS field
can: length: refactor frame lengths definition to add size in bits
drivers/net/can/dev/length.c | 15 +-
include/linux/can/length.h | 299 +++++++++++++++++++++++++----------
2 files changed, 216 insertions(+), 98 deletions(-)
--
2.39.3
