Commit c7347078 authored by Vincent Mailhol's avatar Vincent Mailhol Committed by Marc Kleine-Budde
Browse files

can: etas_es58x: clean-up documentation of struct es58x_fd_tx_conf_msg 

The documentation of struct es58x_fd_tx_conf_msg explains in details
the different TDC parameters. However, those description are redundant
with the documentation of struct can_tdc.

Remove most of the description.

Also, fixes a typo in the reference to the datasheet (E701 -> E70).

Link: https://lore.kernel.org/r/20210815033248.98111-8-mailhol.vincent@wanadoo.fr


Signed-off-by: default avatarVincent Mailhol <mailhol.vincent@wanadoo.fr>
Signed-off-by: default avatarMarc Kleine-Budde <mkl@pengutronix.de>
parent 7a4573cf

drivers/net/can/usb/etas_es58x/es58x_fd.h

+7 −16
Original line number Diff line number Diff line
@@ -96,23 +96,14 @@ struct es58x_fd_bittiming { 
 * @ctrlmode: type enum es58x_fd_ctrlmode.

 * @canfd_enabled: boolean (0: Classical CAN, 1: CAN and/or CANFD).

 * @data_bittiming: Bittiming for flexible data-rate transmission.

 * @tdc_enabled: Transmitter Delay Compensation switch (0: disabled,

 *	1: enabled). On very high bitrates, the delay between when the

 *	bit is sent and received on the CANTX and CANRX pins of the

 *	transceiver start to be significant enough for errors to occur

 *	and thus need to be compensated.

 * @tdco: Transmitter Delay Compensation Offset. Offset value, in time

 *	quanta, defining the delay between the start of the bit

 *	reception on the CANRX pin of the transceiver and the SSP

 *	(Secondary Sample Point). Valid values: 0 to 127.

 * @tdcf: Transmitter Delay Compensation Filter window. Defines the

 *	minimum value for the SSP position, in time quanta. The

 *	feature is enabled when TDCF is configured to a value greater

 *	than TDCO. Valid values: 0 to 127.

 * @tdc_enabled: Transmitter Delay Compensation switch (0: TDC is

 *	disabled, 1: TDC is enabled).

 * @tdco: Transmitter Delay Compensation Offset.

 * @tdcf: Transmitter Delay Compensation Filter window.

 *

 * Please refer to the microcontroller datasheet: "SAM

 * E701/S70/V70/V71 Family" section 49 "Controller Area Network

 * (MCAN)" for additional information.

 * Please refer to the microcontroller datasheet: "SAM E70/S70/V70/V71

 * Family" section 49 "Controller Area Network (MCAN)" for additional

 * information.

 */

struct es58x_fd_tx_conf_msg {

	struct es58x_fd_bittiming nominal_bittiming;