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