1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * PTP 1588 clock support - sysfs interface.
5 * Copyright (C) 2010 OMICRON electronics GmbH
8 #include <linux/capability.h>
9 #include <linux/slab.h>
11 #include "ptp_private.h"
13 static ssize_t clock_name_show(struct device *dev,
14 struct device_attribute *attr, char *page)
16 struct ptp_clock *ptp = dev_get_drvdata(dev);
17 return sysfs_emit(page, "%s\n", ptp->info->name);
19 static DEVICE_ATTR_RO(clock_name);
21 static ssize_t max_phase_adjustment_show(struct device *dev,
22 struct device_attribute *attr,
25 struct ptp_clock *ptp = dev_get_drvdata(dev);
27 return snprintf(page, PAGE_SIZE - 1, "%d\n",
28 ptp->info->getmaxphase(ptp->info));
30 static DEVICE_ATTR_RO(max_phase_adjustment);
32 #define PTP_SHOW_INT(name, var) \
33 static ssize_t var##_show(struct device *dev, \
34 struct device_attribute *attr, char *page) \
36 struct ptp_clock *ptp = dev_get_drvdata(dev); \
37 return snprintf(page, PAGE_SIZE-1, "%d\n", ptp->info->var); \
39 static DEVICE_ATTR(name, 0444, var##_show, NULL);
41 PTP_SHOW_INT(max_adjustment, max_adj);
42 PTP_SHOW_INT(n_alarms, n_alarm);
43 PTP_SHOW_INT(n_external_timestamps, n_ext_ts);
44 PTP_SHOW_INT(n_periodic_outputs, n_per_out);
45 PTP_SHOW_INT(n_programmable_pins, n_pins);
46 PTP_SHOW_INT(pps_available, pps);
48 static ssize_t extts_enable_store(struct device *dev,
49 struct device_attribute *attr,
50 const char *buf, size_t count)
52 struct ptp_clock *ptp = dev_get_drvdata(dev);
53 struct ptp_clock_info *ops = ptp->info;
54 struct ptp_clock_request req = { .type = PTP_CLK_REQ_EXTTS };
58 cnt = sscanf(buf, "%u %d", &req.extts.index, &enable);
61 if (req.extts.index >= ops->n_ext_ts)
64 err = ops->enable(ops, &req, enable ? 1 : 0);
72 static DEVICE_ATTR(extts_enable, 0220, NULL, extts_enable_store);
74 static ssize_t extts_fifo_show(struct device *dev,
75 struct device_attribute *attr, char *page)
77 struct ptp_clock *ptp = dev_get_drvdata(dev);
78 struct timestamp_event_queue *queue = &ptp->tsevq;
79 struct ptp_extts_event event;
84 memset(&event, 0, sizeof(event));
86 if (mutex_lock_interruptible(&ptp->tsevq_mux))
89 spin_lock_irqsave(&queue->lock, flags);
90 qcnt = queue_cnt(queue);
92 event = queue->buf[queue->head];
93 /* Paired with READ_ONCE() in queue_cnt() */
94 WRITE_ONCE(queue->head, (queue->head + 1) % PTP_MAX_TIMESTAMPS);
96 spin_unlock_irqrestore(&queue->lock, flags);
101 cnt = snprintf(page, PAGE_SIZE, "%u %lld %u\n",
102 event.index, event.t.sec, event.t.nsec);
104 mutex_unlock(&ptp->tsevq_mux);
107 static DEVICE_ATTR(fifo, 0444, extts_fifo_show, NULL);
109 static ssize_t period_store(struct device *dev,
110 struct device_attribute *attr,
111 const char *buf, size_t count)
113 struct ptp_clock *ptp = dev_get_drvdata(dev);
114 struct ptp_clock_info *ops = ptp->info;
115 struct ptp_clock_request req = { .type = PTP_CLK_REQ_PEROUT };
116 int cnt, enable, err = -EINVAL;
118 cnt = sscanf(buf, "%u %lld %u %lld %u", &req.perout.index,
119 &req.perout.start.sec, &req.perout.start.nsec,
120 &req.perout.period.sec, &req.perout.period.nsec);
123 if (req.perout.index >= ops->n_per_out)
126 enable = req.perout.period.sec || req.perout.period.nsec;
127 err = ops->enable(ops, &req, enable);
135 static DEVICE_ATTR(period, 0220, NULL, period_store);
137 static ssize_t pps_enable_store(struct device *dev,
138 struct device_attribute *attr,
139 const char *buf, size_t count)
141 struct ptp_clock *ptp = dev_get_drvdata(dev);
142 struct ptp_clock_info *ops = ptp->info;
143 struct ptp_clock_request req = { .type = PTP_CLK_REQ_PPS };
147 if (!capable(CAP_SYS_TIME))
150 cnt = sscanf(buf, "%d", &enable);
154 err = ops->enable(ops, &req, enable ? 1 : 0);
162 static DEVICE_ATTR(pps_enable, 0220, NULL, pps_enable_store);
164 static int unregister_vclock(struct device *dev, void *data)
166 struct ptp_clock *ptp = dev_get_drvdata(dev);
167 struct ptp_clock_info *info = ptp->info;
168 struct ptp_vclock *vclock;
171 vclock = info_to_vclock(info);
172 dev_info(dev->parent, "delete virtual clock ptp%d\n",
173 vclock->clock->index);
175 ptp_vclock_unregister(vclock);
178 /* For break. Not error. */
185 static ssize_t n_vclocks_show(struct device *dev,
186 struct device_attribute *attr, char *page)
188 struct ptp_clock *ptp = dev_get_drvdata(dev);
191 if (mutex_lock_interruptible(&ptp->n_vclocks_mux))
194 size = snprintf(page, PAGE_SIZE - 1, "%u\n", ptp->n_vclocks);
196 mutex_unlock(&ptp->n_vclocks_mux);
201 static ssize_t n_vclocks_store(struct device *dev,
202 struct device_attribute *attr,
203 const char *buf, size_t count)
205 struct ptp_clock *ptp = dev_get_drvdata(dev);
206 struct ptp_vclock *vclock;
210 if (kstrtou32(buf, 0, &num))
213 if (mutex_lock_interruptible(&ptp->n_vclocks_mux))
216 if (num > ptp->max_vclocks) {
217 dev_err(dev, "max value is %d\n", ptp->max_vclocks);
221 /* Need to create more vclocks */
222 if (num > ptp->n_vclocks) {
223 for (i = 0; i < num - ptp->n_vclocks; i++) {
224 vclock = ptp_vclock_register(ptp);
228 *(ptp->vclock_index + ptp->n_vclocks + i) =
229 vclock->clock->index;
231 dev_info(dev, "new virtual clock ptp%d\n",
232 vclock->clock->index);
236 /* Need to delete vclocks */
237 if (num < ptp->n_vclocks) {
238 i = ptp->n_vclocks - num;
239 device_for_each_child_reverse(dev, &i,
242 for (i = 1; i <= ptp->n_vclocks - num; i++)
243 *(ptp->vclock_index + ptp->n_vclocks - i) = -1;
246 /* Need to inform about changed physical clock behavior */
247 if (!ptp->has_cycles) {
249 dev_info(dev, "only physical clock in use now\n");
251 dev_info(dev, "guarantee physical clock free running\n");
254 ptp->n_vclocks = num;
255 mutex_unlock(&ptp->n_vclocks_mux);
259 mutex_unlock(&ptp->n_vclocks_mux);
262 static DEVICE_ATTR_RW(n_vclocks);
264 static ssize_t max_vclocks_show(struct device *dev,
265 struct device_attribute *attr, char *page)
267 struct ptp_clock *ptp = dev_get_drvdata(dev);
270 size = snprintf(page, PAGE_SIZE - 1, "%u\n", ptp->max_vclocks);
275 static ssize_t max_vclocks_store(struct device *dev,
276 struct device_attribute *attr,
277 const char *buf, size_t count)
279 struct ptp_clock *ptp = dev_get_drvdata(dev);
280 unsigned int *vclock_index;
285 if (kstrtou32(buf, 0, &max) || max == 0)
288 if (max == ptp->max_vclocks)
291 if (mutex_lock_interruptible(&ptp->n_vclocks_mux))
294 if (max < ptp->n_vclocks)
297 size = sizeof(int) * max;
298 vclock_index = kzalloc(size, GFP_KERNEL);
304 size = sizeof(int) * ptp->n_vclocks;
305 memcpy(vclock_index, ptp->vclock_index, size);
307 kfree(ptp->vclock_index);
308 ptp->vclock_index = vclock_index;
309 ptp->max_vclocks = max;
311 mutex_unlock(&ptp->n_vclocks_mux);
315 mutex_unlock(&ptp->n_vclocks_mux);
318 static DEVICE_ATTR_RW(max_vclocks);
320 static struct attribute *ptp_attrs[] = {
321 &dev_attr_clock_name.attr,
323 &dev_attr_max_adjustment.attr,
324 &dev_attr_max_phase_adjustment.attr,
325 &dev_attr_n_alarms.attr,
326 &dev_attr_n_external_timestamps.attr,
327 &dev_attr_n_periodic_outputs.attr,
328 &dev_attr_n_programmable_pins.attr,
329 &dev_attr_pps_available.attr,
331 &dev_attr_extts_enable.attr,
333 &dev_attr_period.attr,
334 &dev_attr_pps_enable.attr,
335 &dev_attr_n_vclocks.attr,
336 &dev_attr_max_vclocks.attr,
340 static umode_t ptp_is_attribute_visible(struct kobject *kobj,
341 struct attribute *attr, int n)
343 struct device *dev = kobj_to_dev(kobj);
344 struct ptp_clock *ptp = dev_get_drvdata(dev);
345 struct ptp_clock_info *info = ptp->info;
346 umode_t mode = attr->mode;
348 if (attr == &dev_attr_extts_enable.attr ||
349 attr == &dev_attr_fifo.attr) {
352 } else if (attr == &dev_attr_period.attr) {
353 if (!info->n_per_out)
355 } else if (attr == &dev_attr_pps_enable.attr) {
358 } else if (attr == &dev_attr_n_vclocks.attr ||
359 attr == &dev_attr_max_vclocks.attr) {
360 if (ptp->is_virtual_clock)
362 } else if (attr == &dev_attr_max_phase_adjustment.attr) {
363 if (!info->adjphase || !info->getmaxphase)
370 static const struct attribute_group ptp_group = {
371 .is_visible = ptp_is_attribute_visible,
375 const struct attribute_group *ptp_groups[] = {
380 static int ptp_pin_name2index(struct ptp_clock *ptp, const char *name)
383 for (i = 0; i < ptp->info->n_pins; i++) {
384 if (!strcmp(ptp->info->pin_config[i].name, name))
390 static ssize_t ptp_pin_show(struct device *dev, struct device_attribute *attr,
393 struct ptp_clock *ptp = dev_get_drvdata(dev);
394 unsigned int func, chan;
397 index = ptp_pin_name2index(ptp, attr->attr.name);
401 if (mutex_lock_interruptible(&ptp->pincfg_mux))
404 func = ptp->info->pin_config[index].func;
405 chan = ptp->info->pin_config[index].chan;
407 mutex_unlock(&ptp->pincfg_mux);
409 return sysfs_emit(page, "%u %u\n", func, chan);
412 static ssize_t ptp_pin_store(struct device *dev, struct device_attribute *attr,
413 const char *buf, size_t count)
415 struct ptp_clock *ptp = dev_get_drvdata(dev);
416 unsigned int func, chan;
419 cnt = sscanf(buf, "%u %u", &func, &chan);
423 index = ptp_pin_name2index(ptp, attr->attr.name);
427 if (mutex_lock_interruptible(&ptp->pincfg_mux))
429 err = ptp_set_pinfunc(ptp, index, func, chan);
430 mutex_unlock(&ptp->pincfg_mux);
437 int ptp_populate_pin_groups(struct ptp_clock *ptp)
439 struct ptp_clock_info *info = ptp->info;
440 int err = -ENOMEM, i, n_pins = info->n_pins;
445 ptp->pin_dev_attr = kcalloc(n_pins, sizeof(*ptp->pin_dev_attr),
447 if (!ptp->pin_dev_attr)
450 ptp->pin_attr = kcalloc(1 + n_pins, sizeof(*ptp->pin_attr), GFP_KERNEL);
454 for (i = 0; i < n_pins; i++) {
455 struct device_attribute *da = &ptp->pin_dev_attr[i];
456 sysfs_attr_init(&da->attr);
457 da->attr.name = info->pin_config[i].name;
458 da->attr.mode = 0644;
459 da->show = ptp_pin_show;
460 da->store = ptp_pin_store;
461 ptp->pin_attr[i] = &da->attr;
464 ptp->pin_attr_group.name = "pins";
465 ptp->pin_attr_group.attrs = ptp->pin_attr;
467 ptp->pin_attr_groups[0] = &ptp->pin_attr_group;
472 kfree(ptp->pin_dev_attr);
477 void ptp_cleanup_pin_groups(struct ptp_clock *ptp)
479 kfree(ptp->pin_attr);
480 kfree(ptp->pin_dev_attr);