Commit d04a53b1 authored by Ahmad Fatoum's avatar Ahmad Fatoum Committed by Jakub Kicinski

ptp: document struct ptp_clock_request members

It's arguable most people interested in configuring a PPS signal
want it as external output, not as kernel input. PTP_CLK_REQ_PPS
is for input though. Add documentation to nudge readers into
the correct direction.
Signed-off-by: default avatarAhmad Fatoum <a.fatoum@pengutronix.de>
Acked-by: default avatarRichard Cochran <richardcochran@gmail.com>
Link: https://lore.kernel.org/r/20201117213826.18235-1-a.fatoum@pengutronix.deSigned-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent ed30aef3
...@@ -12,6 +12,19 @@ ...@@ -12,6 +12,19 @@
#include <linux/pps_kernel.h> #include <linux/pps_kernel.h>
#include <linux/ptp_clock.h> #include <linux/ptp_clock.h>
/**
* struct ptp_clock_request - request PTP clock event
*
* @type: The type of the request.
* EXTTS: Configure external trigger timestamping
* PEROUT: Configure periodic output signal (e.g. PPS)
* PPS: trigger internal PPS event for input
* into kernel PPS subsystem
* @extts: describes configuration for external trigger timestamping.
* This is only valid when event == PTP_CLK_REQ_EXTTS.
* @perout: describes configuration for periodic output.
* This is only valid when event == PTP_CLK_REQ_PEROUT.
*/
struct ptp_clock_request { struct ptp_clock_request {
enum { enum {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment