mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-30 06:10:56 +00:00
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>
This commit is contained in:
parent
70479a4095
commit
b9a61b9779
1 changed files with 7 additions and 0 deletions
|
@ -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,
|
||||
|
|
Loading…
Reference in a new issue