Commit b9a61b97 authored by Jacob Keller's avatar Jacob Keller Committed by David S. Miller

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: default avatarJacob Keller <jacob.e.keller@intel.com>
Acked-by: default avatarRichard Cochran <richardcochran@gmail.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 70479a40
...@@ -45,6 +45,8 @@ struct system_device_crosststamp; ...@@ -45,6 +45,8 @@ struct system_device_crosststamp;
/** /**
* struct ptp_system_timestamp - system time corresponding to a PHC timestamp * 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 ptp_system_timestamp {
struct timespec64 pre_ts; struct timespec64 pre_ts;
...@@ -316,6 +318,11 @@ int ptp_find_pin(struct ptp_clock *ptp, ...@@ -316,6 +318,11 @@ int ptp_find_pin(struct ptp_clock *ptp,
* should most likely call ptp_find_pin() directly from their * should most likely call ptp_find_pin() directly from their
* ptp_clock_info::enable() method. * 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, int ptp_find_pin_unlocked(struct ptp_clock *ptp,
......
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