include/linux/ptp_clock_kernel.h

1 /* SPDX-License-Identifier: GPL-2.0-or-later */
19  * struct ptp_clock_request - request PTP clock event
23  *	    PEROUT: Configure periodic output signal (e.g. PPS)
24  *	    PPS:    trigger internal PPS event for input
25  *	            into kernel PPS subsystem
47  * struct ptp_system_timestamp - system time corresponding to a PHC timestamp
50  * @clockid: clock-base used for capturing the system timestamps
59  * struct ptp_clock_info - describes a PTP hardware clock
70  * @pps:       Indicates whether the clock supports a PPS callback.
155  *            parameter chan: the function channel index to use.
165  * The callbacks must all return zero on success, non-zero otherwise.
176 	int pps;  member
211  * struct ptp_clock_event - decribes a PTP hardware clock event
231  * scaled_ppm_to_ppb() - convert scaled ppm to ppb
257  * diff_by_scaled_ppm - Calculate difference using scaled ppm
276 		scaled_ppm = -scaled_ppm;  in diff_by_scaled_ppm()
285  * adjust_by_scaled_ppm - Adjust a base increment by scaled parts per million
297 		return base - diff;  in adjust_by_scaled_ppm()
305  * ptp_clock_register() - register a PTP hardware clock driver
320  * ptp_clock_unregister() - unregister a PTP hardware clock driver
328  * ptp_clock_event() - notify the PTP layer about an event
338  * ptp_clock_index() - obtain the device index of a PTP clock
346  * ptp_find_pin() - obtain the pin index of a given auxiliary function
356  * @chan:   The particular functional channel to find.
357  * Return:  Pin index in the range of zero to ptp_clock_caps.n_pins - 1,
358  *          or -1 if the auxiliary function cannot be found.
365  * ptp_find_pin_unlocked() - wrapper for ptp_find_pin()
374 * @chan:   The particular functional channel to find.
375 * Return:  Pin index in the range of zero to ptp_clock_caps.n_pins - 1,
376 *          or -1 if the auxiliary function cannot be found.
383  * ptp_schedule_worker() - schedule ptp auxiliary work
393  * ptp_cancel_worker_sync() - cancel ptp auxiliary clock
409 { return -1; }  in ptp_clock_index()
412 { return -1; }  in ptp_find_pin()
416 { return -1; }  in ptp_find_pin_unlocked()
419 { return -EOPNOTSUPP; }  in ptp_schedule_worker()
431  * ptp_get_vclocks_index() - get all vclocks index on pclock, and
443  * ptp_convert_timestamp() - convert timestamp to a ptp vclock time
463 		switch (sts->clockid) {  in ptp_read_system_prets()
465 			ktime_get_real_ts64(&sts->pre_ts);  in ptp_read_system_prets()
468 			ktime_get_ts64(&sts->pre_ts);  in ptp_read_system_prets()
471 			ktime_get_raw_ts64(&sts->pre_ts);  in ptp_read_system_prets()
482 		switch (sts->clockid) {  in ptp_read_system_postts()
484 			ktime_get_real_ts64(&sts->post_ts);  in ptp_read_system_postts()
487 			ktime_get_ts64(&sts->post_ts);  in ptp_read_system_postts()
490 			ktime_get_raw_ts64(&sts->post_ts);  in ptp_read_system_postts()