diff mbox series

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

Message ID 20220801184656.702930-4-matej.vasilevski@seznam.cz (mailing list archive)
State Awaiting Upstream
Delegated to: Netdev Maintainers
Headers show
Series can: ctucanfd: hardware rx timestamps reporting | expand

Checks

Context Check Description
netdev/tree_selection success Series ignored based on subject, async

Commit Message

Matej Vasilevski Aug. 1, 2022, 6:46 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>
---
 .../device_drivers/can/ctu/ctucanfd-driver.rst      | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

Comments

Pavel Pisa Aug. 1, 2022, 7:12 p.m. UTC | #1
Dear Matej Vasilevski,

thanks much for the work

On Monday 01 of August 2022 20:46:56 Matej Vasilevski wrote:
> Update the section about timestamping RX frames with instructions
> how to enable it.
>
> Signed-off-by: Matej Vasilevski <matej.vasilevski@seznam.cz>
Acked-by: Pavel Pisa <pisa@cmp.felk.cvut.cz>
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 40c92ea272af..05a7ce0c3d9e 100644
--- a/Documentation/networking/device_drivers/can/ctu/ctucanfd-driver.rst
+++ b/Documentation/networking/device_drivers/can/ctu/ctucanfd-driver.rst
@@ -386,8 +386,17 @@  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.
+
+Both platform and PCI devices can report the timestamp.
+For platform devices, add another clock phandle for timestamping clock
+in device tree bindings. If you don't add another clock, the driver
+will assume the primary clock's frequency for timestamping.
+For PCI devices, the timestamping frequency is assumed to be equal to
+the bus frequency.
+
+Timestamp reporting is disabled by default, you have to enable it with
+SIOCSHWTSTAMP ioctl call first.
 
 Handling TX
 ~~~~~~~~~~~