include/linux/ptp_clock_kernel.h

1 /* SPDX-License-Identifier: GPL-2.0-or-later */
19  * struct ptp_clock_request - request PTP clock event
47  * struct ptp_system_timestamp - system time corresponding to a PHC timestamp
57  * struct ptp_clock_info - describes a PTP hardware clock
81  *             algorithm to correct the provided phase offset.
82  *             parameter delta: PHC servo phase adjustment target
86  *                to the hardware clock's phase control functionality
157  *                scheduling time (>=0) or negative value in case further
163  * The callbacks must all return zero on success, non-zero otherwise.
177 	int (*adjphase)(struct ptp_clock_info *ptp, s32 phase);
208  * struct ptp_clock_event - decribes a PTP hardware clock event
226  * scaled_ppm_to_ppb() - convert scaled ppm to ppb
252  * diff_by_scaled_ppm - Calculate difference using scaled ppm
263  * Returns: true if scaled_ppm is negative, false otherwise
267 	bool negative = false;  in diff_by_scaled_ppm()  local
270 		negative = true;  in diff_by_scaled_ppm()
271 		scaled_ppm = -scaled_ppm;  in diff_by_scaled_ppm()
276 	return negative;  in diff_by_scaled_ppm()
280  * adjust_by_scaled_ppm - Adjust a base increment by scaled parts per million
292 		return base - diff;  in adjust_by_scaled_ppm()
300  * ptp_clock_register() - register a PTP hardware clock driver
315  * ptp_clock_unregister() - unregister a PTP hardware clock driver
323  * ptp_clock_event() - notify the PTP layer about an event
333  * ptp_clock_index() - obtain the device index of a PTP clock
341  * ptp_find_pin() - obtain the pin index of a given auxiliary function
352  * Return:  Pin index in the range of zero to ptp_clock_caps.n_pins - 1,
353  *          or -1 if the auxiliary function cannot be found.
360  * ptp_find_pin_unlocked() - wrapper for ptp_find_pin()
370 * Return:  Pin index in the range of zero to ptp_clock_caps.n_pins - 1,
371 *          or -1 if the auxiliary function cannot be found.
378  * ptp_schedule_worker() - schedule ptp auxiliary work
388  * ptp_cancel_worker_sync() - cancel ptp auxiliary clock
404 { return -1; }  in ptp_clock_index()
407 { return -1; }  in ptp_find_pin()
411 { return -1; }  in ptp_find_pin_unlocked()
414 { return -EOPNOTSUPP; }  in ptp_schedule_worker()
426  * ptp_get_vclocks_index() - get all vclocks index on pclock, and
438  * ptp_convert_timestamp() - convert timestamp to a ptp vclock time
458 		ktime_get_real_ts64(&sts->pre_ts);  in ptp_read_system_prets()
464 		ktime_get_real_ts64(&sts->post_ts);  in ptp_read_system_postts()