Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Tue, 30 May 2023 17:51:05 +0200
From:   Simon Horman <simon.horman@corigine.com>
To:     Vincent Mailhol <mailhol.vincent@wanadoo.fr>
Cc:     Marc Kleine-Budde <mkl@pengutronix.de>, linux-can@vger.kernel.org,
        Thomas.Kopp@microchip.com,
        Oliver Hartkopp <socketcan@hartkopp.net>,
        netdev@vger.kernel.org, marex@denx.de, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3 3/3] can: length: refactor frame lengths definition to
 add size in bits
Message-ID: <ZHYbaYWeIaDcUhhw@corigine.com>
References: <20230507155506.3179711-1-mailhol.vincent@wanadoo.fr>
 <20230530144637.4746-1-mailhol.vincent@wanadoo.fr>
 <20230530144637.4746-4-mailhol.vincent@wanadoo.fr>
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20230530144637.4746-4-mailhol.vincent@wanadoo.fr>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?eBHw3gzkYvWy5cWbiXLSCOaCWso3bQc0VO4JgdNSgzD4BckLNxQY95aQaVxC?=
 =?us-ascii?Q?WBFksaoBedpHYr0fOeAojS/YXWkclefEZtmKEzGnxWAYbL62C4Bk4boftaAK?=
 =?us-ascii?Q?Ns6f6+Ybd0J8jI6md1wY/w5pIBgF2QSSdkywbzzYubVAqeXy2Z6ckmKfuva8?=
 =?us-ascii?Q?GyYo8ovDaNCr1kloiGAx70XQkGOYDfUwc/wAZP3fo/JRCutDwKYIk1FF0l++?=
 =?us-ascii?Q?wHSAGZEfpEY8NxLTVB9srOIkAWJFwRKAOTn4ZSzfQIRquV4ALMEYpX94WKEf?=
 =?us-ascii?Q?MB3Vnb9hYFEK9y0lifsMG6FPqE6B0NCCMoNk/Eek8FDc6YsMQCHdmdpSZdDF?=
 =?us-ascii?Q?Exl4FTET1GnYa4dCC8ee3HnOedR0SjksRNhdjHDFKZxYkVdnaO67bCimO7p7?=
 =?us-ascii?Q?ahcNgq7iUwqLGQcFCJB0GWeoZn61rv162eoQWtdofDxEB2CqKA5bkERepRE2?=
 =?us-ascii?Q?HiYUCud0OW87F/6gFMsUILAan94drcZzTBfrYxpbPdFX4aE82ccNImxUIexD?=
 =?us-ascii?Q?QmSMXFalGhuxr2z5Z76QlS/NzVIoy7pUMT6ti0iffiEMW5dmMXgeuHUvKgNm?=
 =?us-ascii?Q?gftH/WbIP66ENHAiqkm5AOzipSUbvCiYIWdP7wT6r9bYrKbyglHZ1LyLUo9o?=
 =?us-ascii?Q?7enbezVkHHyw5CWiptevd9NC+HKVDbdSkBikyuTsaWCiKKBfD4KVvhBLzEsh?=
 =?us-ascii?Q?FilXe1fRj6nL7lSwY08415brLK7FXpDG3JdDbzsoepFf3A4DL+AVhQO0l4Ng?=
 =?us-ascii?Q?X6enLA+rZWQLz9uNLArt0UPvL/gmvO286wcxw5TpnHUSSY6kWMczB/5lJ18n?=
 =?us-ascii?Q?1LwKpI2Xc+oTrxpYutNcf/F0egXqNvBuUzp7HWtyoP+J8BtkhVyaoc0Hoihq?=
 =?us-ascii?Q?/taO0j5+/qhm4MaN69+ow+jYnSFnZE92fozsp85civv0j5gORxCq2xGH0F6t?=
 =?us-ascii?Q?4Uh9FK0RM1VPT7Uu0RgHlUtJ3VtxNXEFKqa+q+5XfubZCmHMTgHC6GLl5oFe?=
 =?us-ascii?Q?x1KoS6dGMyVLL4LZ3qy39s0lzCpCXX22jgNAYEP5Uqg/rSRpXfy1vyRYKEUy?=
 =?us-ascii?Q?VBcJNYPmb8+cKycGrWwXyJzmY8mJvJGl856b6uJDzpllzly8bMwPyUaHk+uy?=
 =?us-ascii?Q?GWtWLhUt1eUMi8+f8PcvnHmFVXJM6KmnVt5ibVQ7aQvDRtdoPfHYQEFlNgOe?=
 =?us-ascii?Q?2hmNPrTxzDydT+SsnQdxwhPhqEi+PEXUpcC1gQMJKxmEp7Y3SCfpSaF/H0M4?=
 =?us-ascii?Q?TWkcoBnBI61U0AoYlsqLLoka7VDvY8bPkrDJ6Grae/QNPB4Wkn2hpjDCHrL4?=
 =?us-ascii?Q?wAH7T42jJpO7xLoW022njHtGbeTksjaGezVU2Gid3hR3d0BOk0CU9TNQvENm?=
 =?us-ascii?Q?ZAyQGBl9MTw1/kTVAYK2XhRvFe/dNlv9GXdWQ77Mq8e3XIgDMOOHSF9+5UJO?=
 =?us-ascii?Q?CLtRhp+eAdaSG10sXmvww39jvofjLaLa7BQ4m3tQt98Wsdehb8nGcxTzmVo7?=
 =?us-ascii?Q?CAo7RCRBWYQ65XFSRrlBlpDY2Yz37nSsoe2LiJQnNpING9Jh/GK2+TUfH/P/?=
 =?us-ascii?Q?67RdRxIJdVOow28O0FFUqL7ELExKCXGujNhVfvWDB1oLD43IO0lGlOFo0+Nv?=
 =?us-ascii?Q?+4jtOwJLOfCkEyl8veeBtccLtim483elrqexIMJ3ckK1m7JVKGX4kEbE/1Zf?=
 =?us-ascii?Q?o7EDTg=3D=3D?=
X-OriginatorOrg: corigine.com
X-MS-Exchange-CrossTenant-Network-Message-Id: a99aa63a-1a13-40cf-d6cc-08db6125b225
X-MS-Exchange-CrossTenant-AuthSource: PH0PR13MB4842.namprd13.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 30 May 2023 15:51:13.4983
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: fe128f2c-073b-4c20-818e-7246a585940c
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 4oVp0uSfKcDXpVEg9iAuan/xzgMQn6PeZfpO5IpwZf4SWbxPsHwHMeFzucyeDT/wQJ5FnWLqPSRB0gWSHayDtf7WiS20X/flpKPMpaSrt68=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR13MB3872
X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,SPF_HELO_PASS,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On Tue, May 30, 2023 at 11:46:37PM +0900, Vincent Mailhol wrote:
> Introduce a method to calculate the exact size in bits of a CAN(-FD)
> frame with or without dynamic bitsuffing.
> 
> These are all the possible combinations taken into account:
> 
>   - Classical CAN or CAN-FD
>   - Standard or Extended frame format
>   - CAN-FD CRC17 or CRC21
>   - Include or not intermission
> 
> Instead of doing several individual macro definitions, declare the
> can_frame_bits() function-like macro. To this extent, do a full
> refactoring of the length definitions.
> 
> In addition add the can_frame_bytes(). This function-like macro
> replaces the existing macro:
> 
>   - CAN_FRAME_OVERHEAD_SFF: can_frame_bytes(false, false, 0)
>   - CAN_FRAME_OVERHEAD_EFF: can_frame_bytes(false, true, 0)
>   - CANFD_FRAME_OVERHEAD_SFF: can_frame_bytes(true, false, 0)
>   - CANFD_FRAME_OVERHEAD_EFF: can_frame_bytes(true, true, 0)
> 
> The different maximum frame lengths (maximum data length, including
> intermission) are as follow:
> 
>    Frame type				bits	bytes
>   -------------------------------------------------------
>    Classic CAN SFF no-bitstuffing	111	14
>    Classic CAN EFF no-bitstuffing	131	17
>    Classic CAN SFF bitstuffing		135	17
>    Classic CAN EFF bitstuffing		160	20
>    CAN-FD SFF no-bitstuffing		579	73
>    CAN-FD EFF no-bitstuffing		598	75
>    CAN-FD SFF bitstuffing		712	89
>    CAN-FD EFF bitstuffing		736	92
> 
> The macro CAN_FRAME_LEN_MAX and CANFD_FRAME_LEN_MAX are kept as an
> alias to, respectively, can_frame_bytes(false, true, CAN_MAX_DLEN) and
> can_frame_bytes(true, true, CANFD_MAX_DLEN).
> 
> In addition to the above:
> 
>  - Use ISO 11898-1:2015 definitions for the name of the CAN frame
>    fields.
>  - Include linux/bits.h for use of BITS_PER_BYTE.
>  - Include linux/math.h for use of mult_frac() and
>    DIV_ROUND_UP(). N.B: the use of DIV_ROUND_UP() is not new to this
>    patch, but the include was previously omitted.
>  - Add copyright 2023 for myself.
> 
> Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>

...

> +/**
> + * can_bitstuffing_len() - Calculate the maximum length with bitsuffing
> + * @bitstream_len: length of a destuffed bit stream

Hi Vincent,

it looks like an editing error has crept in here:

	s/bitstream_len/destuffed_len/

> + *
> + * The worst bit stuffing case is a sequence in which dominant and
> + * recessive bits alternate every four bits:
> + *
> + *   Destuffed: 1 1111  0000  1111  0000  1111
> + *   Stuffed:   1 1111o 0000i 1111o 0000i 1111o
> + *
> + * Nomenclature
> + *
> + *  - "0": dominant bit
> + *  - "o": dominant stuff bit
> + *  - "1": recessive bit
> + *  - "i": recessive stuff bit
> + *
> + * Aside of the first bit, one stuff bit is added every four bits.
> + *
> + * Return: length of the stuffed bit stream in the worst case scenario.
> + */
> +#define can_bitstuffing_len(destuffed_len)			\
> +	(destuffed_len + (destuffed_len - 1) / 4)