1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * PTP 1588 clock support
5 * Copyright (C) 2010 OMICRON electronics GmbH
8 #include <linux/device.h>
10 #include <linux/init.h>
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/posix-clock.h>
14 #include <linux/pps_kernel.h>
15 #include <linux/slab.h>
16 #include <linux/syscalls.h>
17 #include <linux/uaccess.h>
18 #include <uapi/linux/sched/types.h>
20 #include "ptp_private.h"
22 #define PTP_MAX_ALARMS 4
23 #define PTP_PPS_DEFAULTS (PPS_CAPTUREASSERT | PPS_OFFSETASSERT)
24 #define PTP_PPS_EVENT PPS_CAPTUREASSERT
25 #define PTP_PPS_MODE (PTP_PPS_DEFAULTS | PPS_CANWAIT | PPS_TSFMT_TSPEC)
29 static dev_t ptp_devt;
30 static struct class *ptp_class;
32 static DEFINE_IDA(ptp_clocks_map);
34 /* time stamp event queue operations */
36 static inline int queue_free(struct timestamp_event_queue *q)
38 return PTP_MAX_TIMESTAMPS - queue_cnt(q) - 1;
41 static void enqueue_external_timestamp(struct timestamp_event_queue *queue,
42 struct ptp_clock_event *src)
44 struct ptp_extts_event *dst;
49 seconds = div_u64_rem(src->timestamp, 1000000000, &remainder);
51 spin_lock_irqsave(&queue->lock, flags);
53 dst = &queue->buf[queue->tail];
54 dst->index = src->index;
56 dst->t.nsec = remainder;
58 /* Both WRITE_ONCE() are paired with READ_ONCE() in queue_cnt() */
59 if (!queue_free(queue))
60 WRITE_ONCE(queue->head, (queue->head + 1) % PTP_MAX_TIMESTAMPS);
62 WRITE_ONCE(queue->tail, (queue->tail + 1) % PTP_MAX_TIMESTAMPS);
64 spin_unlock_irqrestore(&queue->lock, flags);
67 long scaled_ppm_to_ppb(long ppm)
70 * The 'freq' field in the 'struct timex' is in parts per
71 * million, but with a 16 bit binary fractional field.
73 * We want to calculate
75 * ppb = scaled_ppm * 1000 / 2^16
79 * ppb = scaled_ppm * 125 / 2^13
86 EXPORT_SYMBOL(scaled_ppm_to_ppb);
88 /* posix clock implementation */
90 static int ptp_clock_getres(struct posix_clock *pc, struct timespec64 *tp)
97 static int ptp_clock_settime(struct posix_clock *pc, const struct timespec64 *tp)
99 struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
101 return ptp->info->settime64(ptp->info, tp);
104 static int ptp_clock_gettime(struct posix_clock *pc, struct timespec64 *tp)
106 struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
109 if (ptp->info->gettimex64)
110 err = ptp->info->gettimex64(ptp->info, tp, NULL);
112 err = ptp->info->gettime64(ptp->info, tp);
116 static int ptp_clock_adjtime(struct posix_clock *pc, struct __kernel_timex *tx)
118 struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
119 struct ptp_clock_info *ops;
120 int err = -EOPNOTSUPP;
124 if (tx->modes & ADJ_SETOFFSET) {
125 struct timespec64 ts;
129 ts.tv_sec = tx->time.tv_sec;
130 ts.tv_nsec = tx->time.tv_usec;
132 if (!(tx->modes & ADJ_NANO))
135 if ((unsigned long) ts.tv_nsec >= NSEC_PER_SEC)
138 kt = timespec64_to_ktime(ts);
139 delta = ktime_to_ns(kt);
140 err = ops->adjtime(ops, delta);
141 } else if (tx->modes & ADJ_FREQUENCY) {
142 long ppb = scaled_ppm_to_ppb(tx->freq);
143 if (ppb > ops->max_adj || ppb < -ops->max_adj)
146 err = ops->adjfine(ops, tx->freq);
148 err = ops->adjfreq(ops, ppb);
149 ptp->dialed_frequency = tx->freq;
150 } else if (tx->modes & ADJ_OFFSET) {
152 s32 offset = tx->offset;
154 if (!(tx->modes & ADJ_NANO))
155 offset *= NSEC_PER_USEC;
157 err = ops->adjphase(ops, offset);
159 } else if (tx->modes == 0) {
160 tx->freq = ptp->dialed_frequency;
167 static struct posix_clock_operations ptp_clock_ops = {
168 .owner = THIS_MODULE,
169 .clock_adjtime = ptp_clock_adjtime,
170 .clock_gettime = ptp_clock_gettime,
171 .clock_getres = ptp_clock_getres,
172 .clock_settime = ptp_clock_settime,
179 static void ptp_clock_release(struct device *dev)
181 struct ptp_clock *ptp = container_of(dev, struct ptp_clock, dev);
183 ptp_cleanup_pin_groups(ptp);
184 mutex_destroy(&ptp->tsevq_mux);
185 mutex_destroy(&ptp->pincfg_mux);
186 ida_simple_remove(&ptp_clocks_map, ptp->index);
190 static void ptp_aux_kworker(struct kthread_work *work)
192 struct ptp_clock *ptp = container_of(work, struct ptp_clock,
194 struct ptp_clock_info *info = ptp->info;
197 delay = info->do_aux_work(info);
200 kthread_queue_delayed_work(ptp->kworker, &ptp->aux_work, delay);
203 /* public interface */
205 struct ptp_clock *ptp_clock_register(struct ptp_clock_info *info,
206 struct device *parent)
208 struct ptp_clock *ptp;
209 int err = 0, index, major = MAJOR(ptp_devt);
211 if (info->n_alarm > PTP_MAX_ALARMS)
212 return ERR_PTR(-EINVAL);
214 /* Initialize a clock structure. */
216 ptp = kzalloc(sizeof(struct ptp_clock), GFP_KERNEL);
220 index = ida_simple_get(&ptp_clocks_map, 0, MINORMASK + 1, GFP_KERNEL);
226 ptp->clock.ops = ptp_clock_ops;
228 ptp->devid = MKDEV(major, index);
230 spin_lock_init(&ptp->tsevq.lock);
231 mutex_init(&ptp->tsevq_mux);
232 mutex_init(&ptp->pincfg_mux);
233 init_waitqueue_head(&ptp->tsev_wq);
235 if (ptp->info->do_aux_work) {
236 kthread_init_delayed_work(&ptp->aux_work, ptp_aux_kworker);
237 ptp->kworker = kthread_create_worker(0, "ptp%d", ptp->index);
238 if (IS_ERR(ptp->kworker)) {
239 err = PTR_ERR(ptp->kworker);
240 pr_err("failed to create ptp aux_worker %d\n", err);
245 err = ptp_populate_pin_groups(ptp);
249 /* Register a new PPS source. */
251 struct pps_source_info pps;
252 memset(&pps, 0, sizeof(pps));
253 snprintf(pps.name, PPS_MAX_NAME_LEN, "ptp%d", index);
254 pps.mode = PTP_PPS_MODE;
255 pps.owner = info->owner;
256 ptp->pps_source = pps_register_source(&pps, PTP_PPS_DEFAULTS);
257 if (IS_ERR(ptp->pps_source)) {
258 err = PTR_ERR(ptp->pps_source);
259 pr_err("failed to register pps source\n");
264 /* Initialize a new device of our class in our clock structure. */
265 device_initialize(&ptp->dev);
266 ptp->dev.devt = ptp->devid;
267 ptp->dev.class = ptp_class;
268 ptp->dev.parent = parent;
269 ptp->dev.groups = ptp->pin_attr_groups;
270 ptp->dev.release = ptp_clock_release;
271 dev_set_drvdata(&ptp->dev, ptp);
272 dev_set_name(&ptp->dev, "ptp%d", ptp->index);
274 /* Create a posix clock and link it to the device. */
275 err = posix_clock_register(&ptp->clock, &ptp->dev);
277 pr_err("failed to create posix clock\n");
285 pps_unregister_source(ptp->pps_source);
287 ptp_cleanup_pin_groups(ptp);
290 kthread_destroy_worker(ptp->kworker);
292 mutex_destroy(&ptp->tsevq_mux);
293 mutex_destroy(&ptp->pincfg_mux);
294 ida_simple_remove(&ptp_clocks_map, index);
300 EXPORT_SYMBOL(ptp_clock_register);
302 int ptp_clock_unregister(struct ptp_clock *ptp)
305 wake_up_interruptible(&ptp->tsev_wq);
308 kthread_cancel_delayed_work_sync(&ptp->aux_work);
309 kthread_destroy_worker(ptp->kworker);
312 /* Release the clock's resources. */
314 pps_unregister_source(ptp->pps_source);
316 posix_clock_unregister(&ptp->clock);
320 EXPORT_SYMBOL(ptp_clock_unregister);
322 void ptp_clock_event(struct ptp_clock *ptp, struct ptp_clock_event *event)
324 struct pps_event_time evt;
326 switch (event->type) {
328 case PTP_CLOCK_ALARM:
331 case PTP_CLOCK_EXTTS:
332 enqueue_external_timestamp(&ptp->tsevq, event);
333 wake_up_interruptible(&ptp->tsev_wq);
338 pps_event(ptp->pps_source, &evt, PTP_PPS_EVENT, NULL);
341 case PTP_CLOCK_PPSUSR:
342 pps_event(ptp->pps_source, &event->pps_times,
343 PTP_PPS_EVENT, NULL);
347 EXPORT_SYMBOL(ptp_clock_event);
349 int ptp_clock_index(struct ptp_clock *ptp)
353 EXPORT_SYMBOL(ptp_clock_index);
355 int ptp_find_pin(struct ptp_clock *ptp,
356 enum ptp_pin_function func, unsigned int chan)
358 struct ptp_pin_desc *pin = NULL;
361 for (i = 0; i < ptp->info->n_pins; i++) {
362 if (ptp->info->pin_config[i].func == func &&
363 ptp->info->pin_config[i].chan == chan) {
364 pin = &ptp->info->pin_config[i];
371 EXPORT_SYMBOL(ptp_find_pin);
373 int ptp_find_pin_unlocked(struct ptp_clock *ptp,
374 enum ptp_pin_function func, unsigned int chan)
378 mutex_lock(&ptp->pincfg_mux);
380 result = ptp_find_pin(ptp, func, chan);
382 mutex_unlock(&ptp->pincfg_mux);
386 EXPORT_SYMBOL(ptp_find_pin_unlocked);
388 int ptp_schedule_worker(struct ptp_clock *ptp, unsigned long delay)
390 return kthread_mod_delayed_work(ptp->kworker, &ptp->aux_work, delay);
392 EXPORT_SYMBOL(ptp_schedule_worker);
394 void ptp_cancel_worker_sync(struct ptp_clock *ptp)
396 kthread_cancel_delayed_work_sync(&ptp->aux_work);
398 EXPORT_SYMBOL(ptp_cancel_worker_sync);
400 /* module operations */
402 static void __exit ptp_exit(void)
404 class_destroy(ptp_class);
405 unregister_chrdev_region(ptp_devt, MINORMASK + 1);
406 ida_destroy(&ptp_clocks_map);
409 static int __init ptp_init(void)
413 ptp_class = class_create(THIS_MODULE, "ptp");
414 if (IS_ERR(ptp_class)) {
415 pr_err("ptp: failed to allocate class\n");
416 return PTR_ERR(ptp_class);
419 err = alloc_chrdev_region(&ptp_devt, 0, MINORMASK + 1, "ptp");
421 pr_err("ptp: failed to allocate device region\n");
425 ptp_class->dev_groups = ptp_groups;
426 pr_info("PTP clock support registered\n");
430 class_destroy(ptp_class);
434 subsys_initcall(ptp_init);
435 module_exit(ptp_exit);
437 MODULE_AUTHOR("Richard Cochran <richardcochran@gmail.com>");
438 MODULE_DESCRIPTION("PTP clocks support");
439 MODULE_LICENSE("GPL");