drivers/ptp/ptp_clock.c

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