Commit 8345a330 authored Jun 16, 2021 by Marc Kleine-Budde

can: bittiming: fix documentation for struct can_tdc

This patch fixes a typo in the documentation for struct can_tdc::tdcv.
The number "0" refers to automatic mode not the letter "O".

Further two grammar errors in the documentation for struct can_tdc are
fixed.

First grammar error: add a missing third person 's'.

Second grammar error: replace "such as" by "such that". The intent is
to give a condition, not an example.

Fixes: 289ea9e4 ("can: add new CAN FD bittiming parameters: Transmitter Delay Compensation (TDC)")
Link: https://lore.kernel.org/r/20210616095922.2430415-1-mkl@pengutronix.de
Link: https://lore.kernel.org/r/20210616124057.60723-1-mailhol.vincent@wanadoo.fr


Co-developed-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
Acked-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
Signed-off-by: Marc Kleine-Budde <mkl@pengutronix.de>

parent 30bfec4f

include/linux/can/bittiming.h

+2 −2

Original line number	Diff line number	Diff line
		@@ -37,7 +37,7 @@
		* quanta, from when the bit is sent on the TX pin to when it is
		* received on the RX pin of the transmitter. Possible options:
		*
		* O: automatic mode. The controller dynamically measure @tdcv
		* 0: automatic mode. The controller dynamically measures @tdcv
		* for each transmitted CAN FD frame.
		*
		* Other values: manual mode. Use the fixed provided value.
		@@ -45,7 +45,7 @@
		* @tdco: Transmitter Delay Compensation Offset. Offset value, in time
		* quanta, defining the distance between the start of the bit
		* reception on the RX pin of the transceiver and the SSP
		* position such as SSP = @tdcv + @tdco.
		* position such that SSP = @tdcv + @tdco.
		*
		* If @tdco is zero, then TDC is disabled and both @tdcv and
		* @tdcf should be ignored.