public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Simon Horman <horms@kernel.org>
To: Vincent Mailhol <mailhol@kernel.org>
Cc: Oliver Hartkopp <socketcan@hartkopp.net>,
	Marc Kleine-Budde <mkl@pengutronix.de>,
	"David S. Miller" <davem@davemloft.net>,
	Eric Dumazet <edumazet@google.com>,
	Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
	Jonathan Corbet <corbet@lwn.net>,
	Geert Uytterhoeven <geert@linux-m68k.org>,
	linux-can@vger.kernel.org, netdev@vger.kernel.org,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 2/2] can: add Transmitter Delay Compensation (TDC) documentation
Date: Mon, 13 Oct 2025 10:41:59 +0100	[thread overview]
Message-ID: <aOzJZ1NsKxNMvIzJ@horms.kernel.org> (raw)
In-Reply-To: <20251012-can-fd-doc-v1-2-86cc7d130026@kernel.org>

On Sun, Oct 12, 2025 at 08:23:43PM +0900, Vincent Mailhol wrote:

...

> @@ -1464,6 +1464,66 @@ Example when 'fd-non-iso on' is added on this switchable CAN FD adapter::
>     can <FD,FD-NON-ISO> state ERROR-ACTIVE (berr-counter tx 0 rx 0) restart-ms 0
>  
>  
> +Transmitter Delay Compensation
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +At high bit rates, the propagation delay from the TX pin to the RX pin of
> +the transceiver might become greater than the actual bit time causing
> +measurement errors: the RX pin would still be measuring the previous bit.
> +
> +The Transmitter Delay Compensation (thereafter, TDC) resolves this problem
> +by introducing a Secondary Sample Point (SSP) equal to the distance, in
> +minimum time quantum, from the start of the bit time on the TX pin to the
> +actual measurement on the RX pin. The SSP is calculated as the sum of two
> +configurable values: the TDC Value (TDCV) and the TDC offset (TDCO).
> +
> +TDC, if supported by the device, can be configured together with CAN-FD
> +using the ip tool's "tdc-mode" argument as follow::
> +
> +- **omitted**: when no "tdc-mode" option is provided, the kernel will

Hi Vincent,

I'm unsure why, but make htmldocs reports:

.../can.rst:1484: ERROR: Unexpected indentation. [docutils]

> +  automatically decide whether TDC should be turned on, in which case it
> +  will calculate a default TDCO and use the TDCV as measured by the
> +  device. This is the recommended method to use TDC.

...

  parent reply	other threads:[~2025-10-13  9:42 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-12 11:23 [PATCH 0/2] can: add Transmitter Delay Compensation (TDC) documentation Vincent Mailhol
2025-10-12 11:23 ` [PATCH 1/2] can: remove false statement about 1:1 mapping between DLC and length Vincent Mailhol
2025-10-12 11:23 ` [PATCH 2/2] can: add Transmitter Delay Compensation (TDC) documentation Vincent Mailhol
2025-10-12 14:47   ` Andrew Lunn
2025-10-12 16:01     ` Vincent Mailhol
2025-10-12 16:04       ` Andrew Lunn
2025-10-13  9:41   ` Simon Horman [this message]
2025-10-12 14:30 ` [PATCH 0/2] " Marc Kleine-Budde

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=aOzJZ1NsKxNMvIzJ@horms.kernel.org \
    --to=horms@kernel.org \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=edumazet@google.com \
    --cc=geert@linux-m68k.org \
    --cc=kuba@kernel.org \
    --cc=linux-can@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mailhol@kernel.org \
    --cc=mkl@pengutronix.de \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=socketcan@hartkopp.net \
    /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