diff mbox series

[RFC,3/3] doc: ctucanfd: RX frames timestamping for platform devices

Message ID 20220512232706.24575-4-matej.vasilevski@seznam.cz (mailing list archive)
State RFC
Delegated to: Netdev Maintainers
Headers show
Series [RFC,1/3] can: ctucanfd: add HW timestamps to RX and error CAN frames | expand

Checks

Context Check Description
netdev/fixes_present success Fixes tag not required for -next series
netdev/subject_prefix success Link
netdev/cover_letter warning Series does not have a cover letter
netdev/patch_count success Link
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit fail Errors and warnings before: 9 this patch: 9
netdev/cc_maintainers warning 6 maintainers not CCed: corbet@lwn.net edumazet@google.com linux-doc@vger.kernel.org pabeni@redhat.com kuba@kernel.org davem@davemloft.net
netdev/build_clang fail Errors and warnings before: 9 this patch: 9
netdev/module_param success Was 0 now: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn fail Errors and warnings before: 9 this patch: 9
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 14 lines checked
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0
netdev/tree_selection success Guessing tree name failed - patch did not apply, async

Commit Message

Matej Vasilevski May 12, 2022, 11:27 p.m. UTC
Update the section about timestamping RX frames with instructions
how to enable it.

Signed-off-by: Matej Vasilevski <matej.vasilevski@seznam.cz>
---
 .../networking/device_drivers/can/ctu/ctucanfd-driver.rst | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/Documentation/networking/device_drivers/can/ctu/ctucanfd-driver.rst b/Documentation/networking/device_drivers/can/ctu/ctucanfd-driver.rst
index 2fde5551e756..53ebdde3fffe 100644
--- a/Documentation/networking/device_drivers/can/ctu/ctucanfd-driver.rst
+++ b/Documentation/networking/device_drivers/can/ctu/ctucanfd-driver.rst
@@ -386,8 +386,12 @@  The CTU CAN FD core reports the exact timestamp when the frame has been
 received. The timestamp is by default captured at the sample point of
 the last bit of EOF but is configurable to be captured at the SOF bit.
 The timestamp source is external to the core and may be up to 64 bits
-wide. At the time of writing, passing the timestamp from kernel to
-userspace is not yet implemented, but is planned in the future.
+wide. Currently only timestamps from platform devices are supported,
+no support for PCI devices yet. To enable timestamping, recompile the
+kernel with CAN_CTUCANFD_PLATFORM_ENABLE_HW_TIMESTAMPS set to yes. You
+will also have to provide the timestamping counter frequency and bit
+width in the device tree, see the dt-bindings documentation for more
+details.
 
 Handling TX
 ~~~~~~~~~~~