Branch data Line data Source code
1 : : // SPDX-License-Identifier: GPL-2.0-or-later
2 : : /*
3 : : * PTP 1588 clock support
4 : : *
5 : : * Copyright (C) 2010 OMICRON electronics GmbH
6 : : */
7 : : #include <linux/idr.h>
8 : : #include <linux/device.h>
9 : : #include <linux/err.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>
19 : :
20 : : #include "ptp_private.h"
21 : :
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)
26 : :
27 : : /* private globals */
28 : :
29 : : static dev_t ptp_devt;
30 : : static struct class *ptp_class;
31 : :
32 : : static DEFINE_IDA(ptp_clocks_map);
33 : :
34 : : /* time stamp event queue operations */
35 : :
36 : : static inline int queue_free(struct timestamp_event_queue *q)
37 : : {
38 : : return PTP_MAX_TIMESTAMPS - queue_cnt(q) - 1;
39 : : }
40 : :
41 : : static void enqueue_external_timestamp(struct timestamp_event_queue *queue,
42 : : struct ptp_clock_event *src)
43 : : {
44 : : struct ptp_extts_event *dst;
45 : : unsigned long flags;
46 : : s64 seconds;
47 : : u32 remainder;
48 : :
49 : : seconds = div_u64_rem(src->timestamp, 1000000000, &remainder);
50 : :
51 : : spin_lock_irqsave(&queue->lock, flags);
52 : :
53 : : dst = &queue->buf[queue->tail];
54 : : dst->index = src->index;
55 : : dst->t.sec = seconds;
56 : : dst->t.nsec = remainder;
57 : :
58 : : if (!queue_free(queue))
59 : : queue->head = (queue->head + 1) % PTP_MAX_TIMESTAMPS;
60 : :
61 : : queue->tail = (queue->tail + 1) % PTP_MAX_TIMESTAMPS;
62 : :
63 : : spin_unlock_irqrestore(&queue->lock, flags);
64 : : }
65 : :
66 : 0 : s32 scaled_ppm_to_ppb(long ppm)
67 : : {
68 : : /*
69 : : * The 'freq' field in the 'struct timex' is in parts per
70 : : * million, but with a 16 bit binary fractional field.
71 : : *
72 : : * We want to calculate
73 : : *
74 : : * ppb = scaled_ppm * 1000 / 2^16
75 : : *
76 : : * which simplifies to
77 : : *
78 : : * ppb = scaled_ppm * 125 / 2^13
79 : : */
80 : 0 : s64 ppb = 1 + ppm;
81 : 0 : ppb *= 125;
82 : 0 : ppb >>= 13;
83 : 0 : return (s32) ppb;
84 : : }
85 : : EXPORT_SYMBOL(scaled_ppm_to_ppb);
86 : :
87 : : /* posix clock implementation */
88 : :
89 : 0 : static int ptp_clock_getres(struct posix_clock *pc, struct timespec64 *tp)
90 : : {
91 : 0 : tp->tv_sec = 0;
92 : 0 : tp->tv_nsec = 1;
93 : 0 : return 0;
94 : : }
95 : :
96 : 0 : static int ptp_clock_settime(struct posix_clock *pc, const struct timespec64 *tp)
97 : : {
98 : 0 : struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
99 : :
100 : 0 : return ptp->info->settime64(ptp->info, tp);
101 : : }
102 : :
103 : 0 : static int ptp_clock_gettime(struct posix_clock *pc, struct timespec64 *tp)
104 : : {
105 : 0 : struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
106 : 0 : int err;
107 : :
108 [ # # ]: 0 : if (ptp->info->gettimex64)
109 : 0 : err = ptp->info->gettimex64(ptp->info, tp, NULL);
110 : : else
111 : 0 : err = ptp->info->gettime64(ptp->info, tp);
112 : 0 : return err;
113 : : }
114 : :
115 : 0 : static int ptp_clock_adjtime(struct posix_clock *pc, struct __kernel_timex *tx)
116 : : {
117 : 0 : struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
118 : 0 : struct ptp_clock_info *ops;
119 : 0 : int err = -EOPNOTSUPP;
120 : :
121 : 0 : ops = ptp->info;
122 : :
123 [ # # ]: 0 : if (tx->modes & ADJ_SETOFFSET) {
124 : 0 : struct timespec64 ts;
125 : 0 : ktime_t kt;
126 : 0 : s64 delta;
127 : :
128 : 0 : ts.tv_sec = tx->time.tv_sec;
129 : 0 : ts.tv_nsec = tx->time.tv_usec;
130 : :
131 [ # # ]: 0 : if (!(tx->modes & ADJ_NANO))
132 : 0 : ts.tv_nsec *= 1000;
133 : :
134 [ # # ]: 0 : if ((unsigned long) ts.tv_nsec >= NSEC_PER_SEC)
135 : : return -EINVAL;
136 : :
137 [ # # ]: 0 : kt = timespec64_to_ktime(ts);
138 : 0 : delta = ktime_to_ns(kt);
139 : 0 : err = ops->adjtime(ops, delta);
140 [ # # ]: 0 : } else if (tx->modes & ADJ_FREQUENCY) {
141 : 0 : s32 ppb = scaled_ppm_to_ppb(tx->freq);
142 [ # # # # ]: 0 : if (ppb > ops->max_adj || ppb < -ops->max_adj)
143 : : return -ERANGE;
144 [ # # ]: 0 : if (ops->adjfine)
145 : 0 : err = ops->adjfine(ops, tx->freq);
146 : : else
147 : 0 : err = ops->adjfreq(ops, ppb);
148 : 0 : ptp->dialed_frequency = tx->freq;
149 [ # # ]: 0 : } else if (tx->modes == 0) {
150 : 0 : tx->freq = ptp->dialed_frequency;
151 : 0 : err = 0;
152 : : }
153 : :
154 : : return err;
155 : : }
156 : :
157 : : static struct posix_clock_operations ptp_clock_ops = {
158 : : .owner = THIS_MODULE,
159 : : .clock_adjtime = ptp_clock_adjtime,
160 : : .clock_gettime = ptp_clock_gettime,
161 : : .clock_getres = ptp_clock_getres,
162 : : .clock_settime = ptp_clock_settime,
163 : : .ioctl = ptp_ioctl,
164 : : .open = ptp_open,
165 : : .poll = ptp_poll,
166 : : .read = ptp_read,
167 : : };
168 : :
169 : 0 : static void ptp_clock_release(struct device *dev)
170 : : {
171 : 0 : struct ptp_clock *ptp = container_of(dev, struct ptp_clock, dev);
172 : :
173 : 0 : ptp_cleanup_pin_groups(ptp);
174 : 0 : mutex_destroy(&ptp->tsevq_mux);
175 : 0 : mutex_destroy(&ptp->pincfg_mux);
176 : 0 : ida_simple_remove(&ptp_clocks_map, ptp->index);
177 : 0 : kfree(ptp);
178 : 0 : }
179 : :
180 : 0 : static void ptp_aux_kworker(struct kthread_work *work)
181 : : {
182 : 0 : struct ptp_clock *ptp = container_of(work, struct ptp_clock,
183 : : aux_work.work);
184 : 0 : struct ptp_clock_info *info = ptp->info;
185 : 0 : long delay;
186 : :
187 : 0 : delay = info->do_aux_work(info);
188 : :
189 [ # # ]: 0 : if (delay >= 0)
190 : 0 : kthread_queue_delayed_work(ptp->kworker, &ptp->aux_work, delay);
191 : 0 : }
192 : :
193 : : /* public interface */
194 : :
195 : 30 : struct ptp_clock *ptp_clock_register(struct ptp_clock_info *info,
196 : : struct device *parent)
197 : : {
198 : 30 : struct ptp_clock *ptp;
199 : 30 : int err = 0, index, major = MAJOR(ptp_devt);
200 : :
201 [ + - ]: 30 : if (info->n_alarm > PTP_MAX_ALARMS)
202 : : return ERR_PTR(-EINVAL);
203 : :
204 : : /* Initialize a clock structure. */
205 : 30 : err = -ENOMEM;
206 : 30 : ptp = kzalloc(sizeof(struct ptp_clock), GFP_KERNEL);
207 [ - + ]: 30 : if (ptp == NULL)
208 : 0 : goto no_memory;
209 : :
210 : 30 : index = ida_simple_get(&ptp_clocks_map, 0, MINORMASK + 1, GFP_KERNEL);
211 [ - + ]: 30 : if (index < 0) {
212 : 0 : err = index;
213 : 0 : goto no_slot;
214 : : }
215 : :
216 : 30 : ptp->clock.ops = ptp_clock_ops;
217 : 30 : ptp->info = info;
218 : 30 : ptp->devid = MKDEV(major, index);
219 : 30 : ptp->index = index;
220 : 30 : spin_lock_init(&ptp->tsevq.lock);
221 : 30 : mutex_init(&ptp->tsevq_mux);
222 : 30 : mutex_init(&ptp->pincfg_mux);
223 : 30 : init_waitqueue_head(&ptp->tsev_wq);
224 : :
225 [ - + ]: 30 : if (ptp->info->do_aux_work) {
226 : 0 : kthread_init_delayed_work(&ptp->aux_work, ptp_aux_kworker);
227 : 0 : ptp->kworker = kthread_create_worker(0, "ptp%d", ptp->index);
228 [ # # ]: 0 : if (IS_ERR(ptp->kworker)) {
229 : 0 : err = PTR_ERR(ptp->kworker);
230 : 0 : pr_err("failed to create ptp aux_worker %d\n", err);
231 : 0 : goto kworker_err;
232 : : }
233 : : }
234 : :
235 : 30 : err = ptp_populate_pin_groups(ptp);
236 [ - + ]: 30 : if (err)
237 : 0 : goto no_pin_groups;
238 : :
239 : : /* Register a new PPS source. */
240 [ - + ]: 30 : if (info->pps) {
241 : 0 : struct pps_source_info pps;
242 : 0 : memset(&pps, 0, sizeof(pps));
243 : 0 : snprintf(pps.name, PPS_MAX_NAME_LEN, "ptp%d", index);
244 : 0 : pps.mode = PTP_PPS_MODE;
245 : 0 : pps.owner = info->owner;
246 : 0 : ptp->pps_source = pps_register_source(&pps, PTP_PPS_DEFAULTS);
247 [ # # ]: 0 : if (IS_ERR(ptp->pps_source)) {
248 : 0 : err = PTR_ERR(ptp->pps_source);
249 : 0 : pr_err("failed to register pps source\n");
250 : 0 : goto no_pps;
251 : : }
252 : : }
253 : :
254 : : /* Initialize a new device of our class in our clock structure. */
255 : 30 : device_initialize(&ptp->dev);
256 : 30 : ptp->dev.devt = ptp->devid;
257 : 30 : ptp->dev.class = ptp_class;
258 : 30 : ptp->dev.parent = parent;
259 : 30 : ptp->dev.groups = ptp->pin_attr_groups;
260 : 30 : ptp->dev.release = ptp_clock_release;
261 : 30 : dev_set_drvdata(&ptp->dev, ptp);
262 : 30 : dev_set_name(&ptp->dev, "ptp%d", ptp->index);
263 : :
264 : : /* Create a posix clock and link it to the device. */
265 : 30 : err = posix_clock_register(&ptp->clock, &ptp->dev);
266 [ - + ]: 30 : if (err) {
267 : 0 : pr_err("failed to create posix clock\n");
268 : 0 : goto no_clock;
269 : : }
270 : :
271 : : return ptp;
272 : :
273 : : no_clock:
274 [ # # ]: 0 : if (ptp->pps_source)
275 : 0 : pps_unregister_source(ptp->pps_source);
276 : 0 : no_pps:
277 : 0 : ptp_cleanup_pin_groups(ptp);
278 : 0 : no_pin_groups:
279 [ # # ]: 0 : if (ptp->kworker)
280 : 0 : kthread_destroy_worker(ptp->kworker);
281 : 0 : kworker_err:
282 : 0 : mutex_destroy(&ptp->tsevq_mux);
283 : 0 : mutex_destroy(&ptp->pincfg_mux);
284 : 0 : ida_simple_remove(&ptp_clocks_map, index);
285 : 0 : no_slot:
286 : 0 : kfree(ptp);
287 : 0 : no_memory:
288 : 0 : return ERR_PTR(err);
289 : : }
290 : : EXPORT_SYMBOL(ptp_clock_register);
291 : :
292 : 0 : int ptp_clock_unregister(struct ptp_clock *ptp)
293 : : {
294 : 0 : ptp->defunct = 1;
295 : 0 : wake_up_interruptible(&ptp->tsev_wq);
296 : :
297 [ # # ]: 0 : if (ptp->kworker) {
298 : 0 : kthread_cancel_delayed_work_sync(&ptp->aux_work);
299 : 0 : kthread_destroy_worker(ptp->kworker);
300 : : }
301 : :
302 : : /* Release the clock's resources. */
303 [ # # ]: 0 : if (ptp->pps_source)
304 : 0 : pps_unregister_source(ptp->pps_source);
305 : :
306 : 0 : posix_clock_unregister(&ptp->clock);
307 : :
308 : 0 : return 0;
309 : : }
310 : : EXPORT_SYMBOL(ptp_clock_unregister);
311 : :
312 : 0 : void ptp_clock_event(struct ptp_clock *ptp, struct ptp_clock_event *event)
313 : : {
314 : 0 : struct pps_event_time evt;
315 : :
316 [ # # # # ]: 0 : switch (event->type) {
317 : :
318 : : case PTP_CLOCK_ALARM:
319 : : break;
320 : :
321 : 0 : case PTP_CLOCK_EXTTS:
322 : 0 : enqueue_external_timestamp(&ptp->tsevq, event);
323 : 0 : wake_up_interruptible(&ptp->tsev_wq);
324 : 0 : break;
325 : :
326 : 0 : case PTP_CLOCK_PPS:
327 : 0 : pps_get_ts(&evt);
328 : 0 : pps_event(ptp->pps_source, &evt, PTP_PPS_EVENT, NULL);
329 : 0 : break;
330 : :
331 : 0 : case PTP_CLOCK_PPSUSR:
332 : 0 : pps_event(ptp->pps_source, &event->pps_times,
333 : : PTP_PPS_EVENT, NULL);
334 : 0 : break;
335 : : }
336 : 0 : }
337 : : EXPORT_SYMBOL(ptp_clock_event);
338 : :
339 : 0 : int ptp_clock_index(struct ptp_clock *ptp)
340 : : {
341 : 0 : return ptp->index;
342 : : }
343 : : EXPORT_SYMBOL(ptp_clock_index);
344 : :
345 : 0 : int ptp_find_pin(struct ptp_clock *ptp,
346 : : enum ptp_pin_function func, unsigned int chan)
347 : : {
348 : 0 : struct ptp_pin_desc *pin = NULL;
349 : 0 : int i;
350 : :
351 : 0 : mutex_lock(&ptp->pincfg_mux);
352 [ # # ]: 0 : for (i = 0; i < ptp->info->n_pins; i++) {
353 [ # # ]: 0 : if (ptp->info->pin_config[i].func == func &&
354 [ # # ]: 0 : ptp->info->pin_config[i].chan == chan) {
355 : : pin = &ptp->info->pin_config[i];
356 : : break;
357 : : }
358 : : }
359 : 0 : mutex_unlock(&ptp->pincfg_mux);
360 : :
361 [ # # ]: 0 : return pin ? i : -1;
362 : : }
363 : : EXPORT_SYMBOL(ptp_find_pin);
364 : :
365 : 0 : int ptp_schedule_worker(struct ptp_clock *ptp, unsigned long delay)
366 : : {
367 : 0 : return kthread_mod_delayed_work(ptp->kworker, &ptp->aux_work, delay);
368 : : }
369 : : EXPORT_SYMBOL(ptp_schedule_worker);
370 : :
371 : 0 : void ptp_cancel_worker_sync(struct ptp_clock *ptp)
372 : : {
373 : 0 : kthread_cancel_delayed_work_sync(&ptp->aux_work);
374 : 0 : }
375 : : EXPORT_SYMBOL(ptp_cancel_worker_sync);
376 : :
377 : : /* module operations */
378 : :
379 : 0 : static void __exit ptp_exit(void)
380 : : {
381 : 0 : class_destroy(ptp_class);
382 : 0 : unregister_chrdev_region(ptp_devt, MINORMASK + 1);
383 : 0 : ida_destroy(&ptp_clocks_map);
384 : 0 : }
385 : :
386 : 30 : static int __init ptp_init(void)
387 : : {
388 : 30 : int err;
389 : :
390 : 30 : ptp_class = class_create(THIS_MODULE, "ptp");
391 [ - + ]: 30 : if (IS_ERR(ptp_class)) {
392 : 0 : pr_err("ptp: failed to allocate class\n");
393 : 0 : return PTR_ERR(ptp_class);
394 : : }
395 : :
396 : 30 : err = alloc_chrdev_region(&ptp_devt, 0, MINORMASK + 1, "ptp");
397 [ - + ]: 30 : if (err < 0) {
398 : 0 : pr_err("ptp: failed to allocate device region\n");
399 : 0 : goto no_region;
400 : : }
401 : :
402 : 30 : ptp_class->dev_groups = ptp_groups;
403 : 30 : pr_info("PTP clock support registered\n");
404 : 30 : return 0;
405 : :
406 : : no_region:
407 : 0 : class_destroy(ptp_class);
408 : 0 : return err;
409 : : }
410 : :
411 : : subsys_initcall(ptp_init);
412 : : module_exit(ptp_exit);
413 : :
414 : : MODULE_AUTHOR("Richard Cochran <richardcochran@gmail.com>");
415 : : MODULE_DESCRIPTION("PTP clocks support");
416 : : MODULE_LICENSE("GPL");
|
