1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * PTP 1588 clock support - character device implementation.
5 * Copyright (C) 2010 OMICRON electronics GmbH
7 #include <linux/module.h>
8 #include <linux/posix-clock.h>
9 #include <linux/poll.h>
10 #include <linux/sched.h>
11 #include <linux/slab.h>
12 #include <linux/timekeeping.h>
14 #include <linux/nospec.h>
16 #include "ptp_private.h"
18 static int ptp_disable_pinfunc(struct ptp_clock_info *ops,
19 enum ptp_pin_function func, unsigned int chan)
21 struct ptp_clock_request rq;
24 memset(&rq, 0, sizeof(rq));
30 rq.type = PTP_CLK_REQ_EXTTS;
31 rq.extts.index = chan;
32 err = ops->enable(ops, &rq, 0);
35 rq.type = PTP_CLK_REQ_PEROUT;
36 rq.perout.index = chan;
37 err = ops->enable(ops, &rq, 0);
48 int ptp_set_pinfunc(struct ptp_clock *ptp, unsigned int pin,
49 enum ptp_pin_function func, unsigned int chan)
51 struct ptp_clock_info *info = ptp->info;
52 struct ptp_pin_desc *pin1 = NULL, *pin2 = &info->pin_config[pin];
55 /* Check to see if any other pin previously had this function. */
56 for (i = 0; i < info->n_pins; i++) {
57 if (info->pin_config[i].func == func &&
58 info->pin_config[i].chan == chan) {
59 pin1 = &info->pin_config[i];
66 /* Check the desired function and channel. */
71 if (chan >= info->n_ext_ts)
75 if (chan >= info->n_per_out)
86 if (info->verify(info, pin, func, chan)) {
87 pr_err("driver cannot use function %u on pin %u\n", func, chan);
91 /* Disable whatever function was previously assigned. */
93 ptp_disable_pinfunc(info, func, chan);
94 pin1->func = PTP_PF_NONE;
97 ptp_disable_pinfunc(info, pin2->func, pin2->chan);
104 int ptp_open(struct posix_clock *pc, fmode_t fmode)
109 long ptp_ioctl(struct posix_clock *pc, unsigned int cmd, unsigned long arg)
111 struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
112 struct ptp_sys_offset_extended *extoff = NULL;
113 struct ptp_sys_offset_precise precise_offset;
114 struct system_device_crosststamp xtstamp;
115 struct ptp_clock_info *ops = ptp->info;
116 struct ptp_sys_offset *sysoff = NULL;
117 struct ptp_system_timestamp sts;
118 struct ptp_clock_request req;
119 struct ptp_clock_caps caps;
120 struct ptp_clock_time *pct;
121 unsigned int i, pin_index;
122 struct ptp_pin_desc pd;
123 struct timespec64 ts;
128 case PTP_CLOCK_GETCAPS:
129 case PTP_CLOCK_GETCAPS2:
130 memset(&caps, 0, sizeof(caps));
132 caps.max_adj = ptp->info->max_adj;
133 caps.n_alarm = ptp->info->n_alarm;
134 caps.n_ext_ts = ptp->info->n_ext_ts;
135 caps.n_per_out = ptp->info->n_per_out;
136 caps.pps = ptp->info->pps;
137 caps.n_pins = ptp->info->n_pins;
138 caps.cross_timestamping = ptp->info->getcrosststamp != NULL;
139 if (copy_to_user((void __user *)arg, &caps, sizeof(caps)))
143 case PTP_EXTTS_REQUEST:
144 case PTP_EXTTS_REQUEST2:
145 memset(&req, 0, sizeof(req));
147 if (copy_from_user(&req.extts, (void __user *)arg,
148 sizeof(req.extts))) {
152 if (cmd == PTP_EXTTS_REQUEST2) {
153 /* Tell the drivers to check the flags carefully. */
154 req.extts.flags |= PTP_STRICT_FLAGS;
155 /* Make sure no reserved bit is set. */
156 if ((req.extts.flags & ~PTP_EXTTS_VALID_FLAGS) ||
157 req.extts.rsv[0] || req.extts.rsv[1]) {
161 /* Ensure one of the rising/falling edge bits is set. */
162 if ((req.extts.flags & PTP_ENABLE_FEATURE) &&
163 (req.extts.flags & PTP_EXTTS_EDGES) == 0) {
167 } else if (cmd == PTP_EXTTS_REQUEST) {
168 req.extts.flags &= PTP_EXTTS_V1_VALID_FLAGS;
169 req.extts.rsv[0] = 0;
170 req.extts.rsv[1] = 0;
172 if (req.extts.index >= ops->n_ext_ts) {
176 req.type = PTP_CLK_REQ_EXTTS;
177 enable = req.extts.flags & PTP_ENABLE_FEATURE ? 1 : 0;
178 err = ops->enable(ops, &req, enable);
181 case PTP_PEROUT_REQUEST:
182 case PTP_PEROUT_REQUEST2:
183 memset(&req, 0, sizeof(req));
185 if (copy_from_user(&req.perout, (void __user *)arg,
186 sizeof(req.perout))) {
190 if (((req.perout.flags & ~PTP_PEROUT_VALID_FLAGS) ||
191 req.perout.rsv[0] || req.perout.rsv[1] ||
192 req.perout.rsv[2] || req.perout.rsv[3]) &&
193 cmd == PTP_PEROUT_REQUEST2) {
196 } else if (cmd == PTP_PEROUT_REQUEST) {
197 req.perout.flags &= PTP_PEROUT_V1_VALID_FLAGS;
198 req.perout.rsv[0] = 0;
199 req.perout.rsv[1] = 0;
200 req.perout.rsv[2] = 0;
201 req.perout.rsv[3] = 0;
203 if (req.perout.index >= ops->n_per_out) {
207 req.type = PTP_CLK_REQ_PEROUT;
208 enable = req.perout.period.sec || req.perout.period.nsec;
209 err = ops->enable(ops, &req, enable);
213 case PTP_ENABLE_PPS2:
214 memset(&req, 0, sizeof(req));
216 if (!capable(CAP_SYS_TIME))
218 req.type = PTP_CLK_REQ_PPS;
219 enable = arg ? 1 : 0;
220 err = ops->enable(ops, &req, enable);
223 case PTP_SYS_OFFSET_PRECISE:
224 case PTP_SYS_OFFSET_PRECISE2:
225 if (!ptp->info->getcrosststamp) {
229 err = ptp->info->getcrosststamp(ptp->info, &xtstamp);
233 memset(&precise_offset, 0, sizeof(precise_offset));
234 ts = ktime_to_timespec64(xtstamp.device);
235 precise_offset.device.sec = ts.tv_sec;
236 precise_offset.device.nsec = ts.tv_nsec;
237 ts = ktime_to_timespec64(xtstamp.sys_realtime);
238 precise_offset.sys_realtime.sec = ts.tv_sec;
239 precise_offset.sys_realtime.nsec = ts.tv_nsec;
240 ts = ktime_to_timespec64(xtstamp.sys_monoraw);
241 precise_offset.sys_monoraw.sec = ts.tv_sec;
242 precise_offset.sys_monoraw.nsec = ts.tv_nsec;
243 if (copy_to_user((void __user *)arg, &precise_offset,
244 sizeof(precise_offset)))
248 case PTP_SYS_OFFSET_EXTENDED:
249 case PTP_SYS_OFFSET_EXTENDED2:
250 if (!ptp->info->gettimex64) {
254 extoff = memdup_user((void __user *)arg, sizeof(*extoff));
255 if (IS_ERR(extoff)) {
256 err = PTR_ERR(extoff);
260 if (extoff->n_samples > PTP_MAX_SAMPLES
261 || extoff->rsv[0] || extoff->rsv[1] || extoff->rsv[2]) {
265 for (i = 0; i < extoff->n_samples; i++) {
266 err = ptp->info->gettimex64(ptp->info, &ts, &sts);
269 extoff->ts[i][0].sec = sts.pre_ts.tv_sec;
270 extoff->ts[i][0].nsec = sts.pre_ts.tv_nsec;
271 extoff->ts[i][1].sec = ts.tv_sec;
272 extoff->ts[i][1].nsec = ts.tv_nsec;
273 extoff->ts[i][2].sec = sts.post_ts.tv_sec;
274 extoff->ts[i][2].nsec = sts.post_ts.tv_nsec;
276 if (copy_to_user((void __user *)arg, extoff, sizeof(*extoff)))
281 case PTP_SYS_OFFSET2:
282 sysoff = memdup_user((void __user *)arg, sizeof(*sysoff));
283 if (IS_ERR(sysoff)) {
284 err = PTR_ERR(sysoff);
288 if (sysoff->n_samples > PTP_MAX_SAMPLES) {
292 pct = &sysoff->ts[0];
293 for (i = 0; i < sysoff->n_samples; i++) {
294 ktime_get_real_ts64(&ts);
295 pct->sec = ts.tv_sec;
296 pct->nsec = ts.tv_nsec;
299 err = ops->gettimex64(ops, &ts, NULL);
301 err = ops->gettime64(ops, &ts);
304 pct->sec = ts.tv_sec;
305 pct->nsec = ts.tv_nsec;
308 ktime_get_real_ts64(&ts);
309 pct->sec = ts.tv_sec;
310 pct->nsec = ts.tv_nsec;
311 if (copy_to_user((void __user *)arg, sysoff, sizeof(*sysoff)))
315 case PTP_PIN_GETFUNC:
316 case PTP_PIN_GETFUNC2:
317 if (copy_from_user(&pd, (void __user *)arg, sizeof(pd))) {
321 if ((pd.rsv[0] || pd.rsv[1] || pd.rsv[2]
322 || pd.rsv[3] || pd.rsv[4])
323 && cmd == PTP_PIN_GETFUNC2) {
326 } else if (cmd == PTP_PIN_GETFUNC) {
333 pin_index = pd.index;
334 if (pin_index >= ops->n_pins) {
338 pin_index = array_index_nospec(pin_index, ops->n_pins);
339 if (mutex_lock_interruptible(&ptp->pincfg_mux))
341 pd = ops->pin_config[pin_index];
342 mutex_unlock(&ptp->pincfg_mux);
343 if (!err && copy_to_user((void __user *)arg, &pd, sizeof(pd)))
347 case PTP_PIN_SETFUNC:
348 case PTP_PIN_SETFUNC2:
349 if (copy_from_user(&pd, (void __user *)arg, sizeof(pd))) {
353 if ((pd.rsv[0] || pd.rsv[1] || pd.rsv[2]
354 || pd.rsv[3] || pd.rsv[4])
355 && cmd == PTP_PIN_SETFUNC2) {
358 } else if (cmd == PTP_PIN_SETFUNC) {
365 pin_index = pd.index;
366 if (pin_index >= ops->n_pins) {
370 pin_index = array_index_nospec(pin_index, ops->n_pins);
371 if (mutex_lock_interruptible(&ptp->pincfg_mux))
373 err = ptp_set_pinfunc(ptp, pin_index, pd.func, pd.chan);
374 mutex_unlock(&ptp->pincfg_mux);
388 __poll_t ptp_poll(struct posix_clock *pc, struct file *fp, poll_table *wait)
390 struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
392 poll_wait(fp, &ptp->tsev_wq, wait);
394 return queue_cnt(&ptp->tsevq) ? EPOLLIN : 0;
397 #define EXTTS_BUFSIZE (PTP_BUF_TIMESTAMPS * sizeof(struct ptp_extts_event))
399 ssize_t ptp_read(struct posix_clock *pc,
400 uint rdflags, char __user *buf, size_t cnt)
402 struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
403 struct timestamp_event_queue *queue = &ptp->tsevq;
404 struct ptp_extts_event *event;
409 if (cnt % sizeof(struct ptp_extts_event) != 0)
412 if (cnt > EXTTS_BUFSIZE)
415 cnt = cnt / sizeof(struct ptp_extts_event);
417 if (mutex_lock_interruptible(&ptp->tsevq_mux))
420 if (wait_event_interruptible(ptp->tsev_wq,
421 ptp->defunct || queue_cnt(queue))) {
422 mutex_unlock(&ptp->tsevq_mux);
427 mutex_unlock(&ptp->tsevq_mux);
431 event = kmalloc(EXTTS_BUFSIZE, GFP_KERNEL);
433 mutex_unlock(&ptp->tsevq_mux);
437 spin_lock_irqsave(&queue->lock, flags);
439 qcnt = queue_cnt(queue);
444 for (i = 0; i < cnt; i++) {
445 event[i] = queue->buf[queue->head];
446 queue->head = (queue->head + 1) % PTP_MAX_TIMESTAMPS;
449 spin_unlock_irqrestore(&queue->lock, flags);
451 cnt = cnt * sizeof(struct ptp_extts_event);
453 mutex_unlock(&ptp->tsevq_mux);
456 if (copy_to_user(buf, event, cnt))