diff options
| author | Jacob Keller <jacob.e.keller@intel.com> | 2022-10-28 14:04:12 +0300 |
|---|---|---|
| committer | David S. Miller <davem@davemloft.net> | 2022-10-31 14:14:16 +0300 |
| commit | b9a61b97798ca6d0c856a217e61e2177bd8f6eae (patch) | |
| tree | 13892ba3870feabbd6b8d5113bedc6fb0afe630d | |
| parent | 70479a40954cf353e87a486997a3477108c75aa9 (diff) | |
| download | linux-b9a61b97798ca6d0c856a217e61e2177bd8f6eae.tar.xz | |
ptp: add missing documentation for parameters
The ptp_find_pin_unlocked function and the ptp_system_timestamp structure
didn't document their parameters and fields. Fix this.
Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
Acked-by: Richard Cochran <richardcochran@gmail.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
| -rw-r--r-- | include/linux/ptp_clock_kernel.h | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/include/linux/ptp_clock_kernel.h b/include/linux/ptp_clock_kernel.h index 92b44161408e..ad4aaadc2f7a 100644 --- a/include/linux/ptp_clock_kernel.h +++ b/include/linux/ptp_clock_kernel.h @@ -45,6 +45,8 @@ struct system_device_crosststamp; /** * struct ptp_system_timestamp - system time corresponding to a PHC timestamp + * @pre_ts: system timestamp before capturing PHC + * @post_ts: system timestamp after capturing PHC */ struct ptp_system_timestamp { struct timespec64 pre_ts; @@ -316,6 +318,11 @@ int ptp_find_pin(struct ptp_clock *ptp, * should most likely call ptp_find_pin() directly from their * ptp_clock_info::enable() method. * +* @ptp: The clock obtained from ptp_clock_register(). +* @func: One of the ptp_pin_function enumerated values. +* @chan: The particular functional channel to find. +* Return: Pin index in the range of zero to ptp_clock_caps.n_pins - 1, +* or -1 if the auxiliary function cannot be found. */ int ptp_find_pin_unlocked(struct ptp_clock *ptp, |