|
|
Log in / Subscribe / Register

can: add Transmitter Delay Compensation (TDC) documentation

From:  Vincent Mailhol <mailhol-AT-kernel.org>
To:  Oliver Hartkopp <socketcan-AT-hartkopp.net>, Marc Kleine-Budde <mkl-AT-pengutronix.de>
Subject:  [PATCH v2 0/2] can: add Transmitter Delay Compensation (TDC) documentation
Date:  Mon, 13 Oct 2025 19:10:21 +0900
Message-ID:  <20251013-can-fd-doc-v2-0-5d53bdc8f2ad@kernel.org>
Cc:  Simon Horman <horms-AT-kernel.org>, Paolo Abeni <pabeni-AT-redhat.com>, "David S. Miller" <davem-AT-davemloft.net>, Eric Dumazet <edumazet-AT-google.com>, Jakub Kicinski <kuba-AT-kernel.org>, Paolo Abeni <pabeni-AT-redhat.com>, Simon Horman <horms-AT-kernel.org>, Jonathan Corbet <corbet-AT-lwn.net>, Geert Uytterhoeven <geert-AT-linux-m68k.org>, linux-can-AT-vger.kernel.org, netdev-AT-vger.kernel.org, linux-doc-AT-vger.kernel.org, linux-kernel-AT-vger.kernel.org, Vincent Mailhol <mailhol-AT-kernel.org>
Archive-link:  Article

TDC was added to the kernel in 2021 but I never took time to update
the documentation. The year is now 2025... As we say: "better late
than never"!

The first patch is a small clean up which fixes an incorrect statement
concerning the CAN DLC, the second patch is the real thing and adds
the documentation of how to use the ip tool to configure the TDC.

Signed-off-by: Vincent Mailhol <mailhol@kernel.org>
---
Changes in v2:

  - Fix below "make htmldocs" error:

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

  - Change from "Bullet lists" to "Definition lists" format.

Link to v1: https://lore.kernel.org/r/20251012-can-fd-doc-v1-0-86cc7d...

---
Vincent Mailhol (2):
      can: remove false statement about 1:1 mapping between DLC and length
      can: add Transmitter Delay Compensation (TDC) documentation

 Documentation/networking/can.rst | 71 +++++++++++++++++++++++++++++++++++++---
 1 file changed, 67 insertions(+), 4 deletions(-)
---
base-commit: cb6649f6217c0331b885cf787f1d175963e2a1d2
change-id: 20251012-can-fd-doc-692e7bdd6369

Best regards,
-- 
Vincent Mailhol <mailhol@kernel.org>




Copyright © 2025, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds