diff mbox series

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

Message ID 20220512232706.24575-4-matej.vasilevski@seznam.cz
State New
Headers show
Series None | expand

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
 ~~~~~~~~~~~