2 * PTP 1588 clock support - character device implementation.
4 * Copyright (C) 2010 OMICRON electronics GmbH
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #include <linux/module.h>
21 #include <linux/posix-clock.h>
22 #include <linux/poll.h>
23 #include <linux/sched.h>
24 #include <linux/slab.h>
25 #include <linux/timekeeping.h>
27 #include <linux/nospec.h>
29 #include "ptp_private.h"
31 static int ptp_disable_pinfunc(struct ptp_clock_info *ops,
32 enum ptp_pin_function func, unsigned int chan)
34 struct ptp_clock_request rq;
37 memset(&rq, 0, sizeof(rq));
43 rq.type = PTP_CLK_REQ_EXTTS;
44 rq.extts.index = chan;
45 err = ops->enable(ops, &rq, 0);
48 rq.type = PTP_CLK_REQ_PEROUT;
49 rq.perout.index = chan;
50 err = ops->enable(ops, &rq, 0);
61 int ptp_set_pinfunc(struct ptp_clock *ptp, unsigned int pin,
62 enum ptp_pin_function func, unsigned int chan)
64 struct ptp_clock_info *info = ptp->info;
65 struct ptp_pin_desc *pin1 = NULL, *pin2 = &info->pin_config[pin];
68 /* Check to see if any other pin previously had this function. */
69 for (i = 0; i < info->n_pins; i++) {
70 if (info->pin_config[i].func == func &&
71 info->pin_config[i].chan == chan) {
72 pin1 = &info->pin_config[i];
79 /* Check the desired function and channel. */
84 if (chan >= info->n_ext_ts)
88 if (chan >= info->n_per_out)
99 if (info->verify(info, pin, func, chan)) {
100 pr_err("driver cannot use function %u on pin %u\n", func, chan);
104 /* Disable whatever function was previously assigned. */
106 ptp_disable_pinfunc(info, func, chan);
107 pin1->func = PTP_PF_NONE;
110 ptp_disable_pinfunc(info, pin2->func, pin2->chan);
117 int ptp_open(struct posix_clock *pc, fmode_t fmode)
122 long ptp_ioctl(struct posix_clock *pc, unsigned int cmd, unsigned long arg)
124 struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
125 struct ptp_sys_offset_extended *extoff = NULL;
126 struct ptp_sys_offset_precise precise_offset;
127 struct system_device_crosststamp xtstamp;
128 struct ptp_clock_info *ops = ptp->info;
129 struct ptp_sys_offset *sysoff = NULL;
130 struct ptp_system_timestamp sts;
131 struct ptp_clock_request req;
132 struct ptp_clock_caps caps;
133 struct ptp_clock_time *pct;
134 unsigned int i, pin_index;
135 struct ptp_pin_desc pd;
136 struct timespec64 ts;
141 case PTP_CLOCK_GETCAPS:
142 memset(&caps, 0, sizeof(caps));
143 caps.max_adj = ptp->info->max_adj;
144 caps.n_alarm = ptp->info->n_alarm;
145 caps.n_ext_ts = ptp->info->n_ext_ts;
146 caps.n_per_out = ptp->info->n_per_out;
147 caps.pps = ptp->info->pps;
148 caps.n_pins = ptp->info->n_pins;
149 caps.cross_timestamping = ptp->info->getcrosststamp != NULL;
150 if (copy_to_user((void __user *)arg, &caps, sizeof(caps)))
154 case PTP_EXTTS_REQUEST:
155 if (copy_from_user(&req.extts, (void __user *)arg,
156 sizeof(req.extts))) {
160 if (req.extts.index >= ops->n_ext_ts) {
164 req.type = PTP_CLK_REQ_EXTTS;
165 enable = req.extts.flags & PTP_ENABLE_FEATURE ? 1 : 0;
166 err = ops->enable(ops, &req, enable);
169 case PTP_PEROUT_REQUEST:
170 if (copy_from_user(&req.perout, (void __user *)arg,
171 sizeof(req.perout))) {
175 if (req.perout.index >= ops->n_per_out) {
179 req.type = PTP_CLK_REQ_PEROUT;
180 enable = req.perout.period.sec || req.perout.period.nsec;
181 err = ops->enable(ops, &req, enable);
185 if (!capable(CAP_SYS_TIME))
187 req.type = PTP_CLK_REQ_PPS;
188 enable = arg ? 1 : 0;
189 err = ops->enable(ops, &req, enable);
192 case PTP_SYS_OFFSET_PRECISE:
193 if (!ptp->info->getcrosststamp) {
197 err = ptp->info->getcrosststamp(ptp->info, &xtstamp);
201 memset(&precise_offset, 0, sizeof(precise_offset));
202 ts = ktime_to_timespec64(xtstamp.device);
203 precise_offset.device.sec = ts.tv_sec;
204 precise_offset.device.nsec = ts.tv_nsec;
205 ts = ktime_to_timespec64(xtstamp.sys_realtime);
206 precise_offset.sys_realtime.sec = ts.tv_sec;
207 precise_offset.sys_realtime.nsec = ts.tv_nsec;
208 ts = ktime_to_timespec64(xtstamp.sys_monoraw);
209 precise_offset.sys_monoraw.sec = ts.tv_sec;
210 precise_offset.sys_monoraw.nsec = ts.tv_nsec;
211 if (copy_to_user((void __user *)arg, &precise_offset,
212 sizeof(precise_offset)))
216 case PTP_SYS_OFFSET_EXTENDED:
217 if (!ptp->info->gettimex64) {
221 extoff = memdup_user((void __user *)arg, sizeof(*extoff));
222 if (IS_ERR(extoff)) {
223 err = PTR_ERR(extoff);
227 if (extoff->n_samples > PTP_MAX_SAMPLES
228 || extoff->rsv[0] || extoff->rsv[1] || extoff->rsv[2]) {
232 for (i = 0; i < extoff->n_samples; i++) {
233 err = ptp->info->gettimex64(ptp->info, &ts, &sts);
236 extoff->ts[i][0].sec = sts.pre_ts.tv_sec;
237 extoff->ts[i][0].nsec = sts.pre_ts.tv_nsec;
238 extoff->ts[i][1].sec = ts.tv_sec;
239 extoff->ts[i][1].nsec = ts.tv_nsec;
240 extoff->ts[i][2].sec = sts.post_ts.tv_sec;
241 extoff->ts[i][2].nsec = sts.post_ts.tv_nsec;
243 if (copy_to_user((void __user *)arg, extoff, sizeof(*extoff)))
248 sysoff = memdup_user((void __user *)arg, sizeof(*sysoff));
249 if (IS_ERR(sysoff)) {
250 err = PTR_ERR(sysoff);
254 if (sysoff->n_samples > PTP_MAX_SAMPLES) {
258 pct = &sysoff->ts[0];
259 for (i = 0; i < sysoff->n_samples; i++) {
260 ktime_get_real_ts64(&ts);
261 pct->sec = ts.tv_sec;
262 pct->nsec = ts.tv_nsec;
265 err = ops->gettimex64(ops, &ts, NULL);
267 err = ops->gettime64(ops, &ts);
270 pct->sec = ts.tv_sec;
271 pct->nsec = ts.tv_nsec;
274 ktime_get_real_ts64(&ts);
275 pct->sec = ts.tv_sec;
276 pct->nsec = ts.tv_nsec;
277 if (copy_to_user((void __user *)arg, sysoff, sizeof(*sysoff)))
281 case PTP_PIN_GETFUNC:
282 if (copy_from_user(&pd, (void __user *)arg, sizeof(pd))) {
286 pin_index = pd.index;
287 if (pin_index >= ops->n_pins) {
291 pin_index = array_index_nospec(pin_index, ops->n_pins);
292 if (mutex_lock_interruptible(&ptp->pincfg_mux))
294 pd = ops->pin_config[pin_index];
295 mutex_unlock(&ptp->pincfg_mux);
296 if (!err && copy_to_user((void __user *)arg, &pd, sizeof(pd)))
300 case PTP_PIN_SETFUNC:
301 if (copy_from_user(&pd, (void __user *)arg, sizeof(pd))) {
305 pin_index = pd.index;
306 if (pin_index >= ops->n_pins) {
310 pin_index = array_index_nospec(pin_index, ops->n_pins);
311 if (mutex_lock_interruptible(&ptp->pincfg_mux))
313 err = ptp_set_pinfunc(ptp, pin_index, pd.func, pd.chan);
314 mutex_unlock(&ptp->pincfg_mux);
328 __poll_t ptp_poll(struct posix_clock *pc, struct file *fp, poll_table *wait)
330 struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
332 poll_wait(fp, &ptp->tsev_wq, wait);
334 return queue_cnt(&ptp->tsevq) ? EPOLLIN : 0;
337 #define EXTTS_BUFSIZE (PTP_BUF_TIMESTAMPS * sizeof(struct ptp_extts_event))
339 ssize_t ptp_read(struct posix_clock *pc,
340 uint rdflags, char __user *buf, size_t cnt)
342 struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
343 struct timestamp_event_queue *queue = &ptp->tsevq;
344 struct ptp_extts_event *event;
349 if (cnt % sizeof(struct ptp_extts_event) != 0)
352 if (cnt > EXTTS_BUFSIZE)
355 cnt = cnt / sizeof(struct ptp_extts_event);
357 if (mutex_lock_interruptible(&ptp->tsevq_mux))
360 if (wait_event_interruptible(ptp->tsev_wq,
361 ptp->defunct || queue_cnt(queue))) {
362 mutex_unlock(&ptp->tsevq_mux);
367 mutex_unlock(&ptp->tsevq_mux);
371 event = kmalloc(EXTTS_BUFSIZE, GFP_KERNEL);
373 mutex_unlock(&ptp->tsevq_mux);
377 spin_lock_irqsave(&queue->lock, flags);
379 qcnt = queue_cnt(queue);
384 for (i = 0; i < cnt; i++) {
385 event[i] = queue->buf[queue->head];
386 queue->head = (queue->head + 1) % PTP_MAX_TIMESTAMPS;
389 spin_unlock_irqrestore(&queue->lock, flags);
391 cnt = cnt * sizeof(struct ptp_extts_event);
393 mutex_unlock(&ptp->tsevq_mux);
396 if (copy_to_user(buf, event, cnt))