1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * PTP 1588 clock support - sysfs interface.
5 * Copyright (C) 2010 OMICRON electronics GmbH
7 #include <linux/capability.h>
8 #include <linux/slab.h>
10 #include "ptp_private.h"
12 static ssize_t clock_name_show(struct device *dev,
13 struct device_attribute *attr, char *page)
15 struct ptp_clock *ptp = dev_get_drvdata(dev);
16 return sysfs_emit(page, "%s\n", ptp->info->name);
18 static DEVICE_ATTR_RO(clock_name);
20 #define PTP_SHOW_INT(name, var) \
21 static ssize_t var##_show(struct device *dev, \
22 struct device_attribute *attr, char *page) \
24 struct ptp_clock *ptp = dev_get_drvdata(dev); \
25 return snprintf(page, PAGE_SIZE-1, "%d\n", ptp->info->var); \
27 static DEVICE_ATTR(name, 0444, var##_show, NULL);
29 PTP_SHOW_INT(max_adjustment, max_adj);
30 PTP_SHOW_INT(n_alarms, n_alarm);
31 PTP_SHOW_INT(n_external_timestamps, n_ext_ts);
32 PTP_SHOW_INT(n_periodic_outputs, n_per_out);
33 PTP_SHOW_INT(n_programmable_pins, n_pins);
34 PTP_SHOW_INT(pps_available, pps);
36 static ssize_t extts_enable_store(struct device *dev,
37 struct device_attribute *attr,
38 const char *buf, size_t count)
40 struct ptp_clock *ptp = dev_get_drvdata(dev);
41 struct ptp_clock_info *ops = ptp->info;
42 struct ptp_clock_request req = { .type = PTP_CLK_REQ_EXTTS };
46 cnt = sscanf(buf, "%u %d", &req.extts.index, &enable);
49 if (req.extts.index >= ops->n_ext_ts)
52 err = ops->enable(ops, &req, enable ? 1 : 0);
60 static DEVICE_ATTR(extts_enable, 0220, NULL, extts_enable_store);
62 static ssize_t extts_fifo_show(struct device *dev,
63 struct device_attribute *attr, char *page)
65 struct ptp_clock *ptp = dev_get_drvdata(dev);
66 struct timestamp_event_queue *queue = &ptp->tsevq;
67 struct ptp_extts_event event;
72 memset(&event, 0, sizeof(event));
74 if (mutex_lock_interruptible(&ptp->tsevq_mux))
77 spin_lock_irqsave(&queue->lock, flags);
78 qcnt = queue_cnt(queue);
80 event = queue->buf[queue->head];
81 /* Paired with READ_ONCE() in queue_cnt() */
82 WRITE_ONCE(queue->head, (queue->head + 1) % PTP_MAX_TIMESTAMPS);
84 spin_unlock_irqrestore(&queue->lock, flags);
89 cnt = snprintf(page, PAGE_SIZE, "%u %lld %u\n",
90 event.index, event.t.sec, event.t.nsec);
92 mutex_unlock(&ptp->tsevq_mux);
95 static DEVICE_ATTR(fifo, 0444, extts_fifo_show, NULL);
97 static ssize_t period_store(struct device *dev,
98 struct device_attribute *attr,
99 const char *buf, size_t count)
101 struct ptp_clock *ptp = dev_get_drvdata(dev);
102 struct ptp_clock_info *ops = ptp->info;
103 struct ptp_clock_request req = { .type = PTP_CLK_REQ_PEROUT };
104 int cnt, enable, err = -EINVAL;
106 cnt = sscanf(buf, "%u %lld %u %lld %u", &req.perout.index,
107 &req.perout.start.sec, &req.perout.start.nsec,
108 &req.perout.period.sec, &req.perout.period.nsec);
111 if (req.perout.index >= ops->n_per_out)
114 enable = req.perout.period.sec || req.perout.period.nsec;
115 err = ops->enable(ops, &req, enable);
123 static DEVICE_ATTR(period, 0220, NULL, period_store);
125 static ssize_t pps_enable_store(struct device *dev,
126 struct device_attribute *attr,
127 const char *buf, size_t count)
129 struct ptp_clock *ptp = dev_get_drvdata(dev);
130 struct ptp_clock_info *ops = ptp->info;
131 struct ptp_clock_request req = { .type = PTP_CLK_REQ_PPS };
135 if (!capable(CAP_SYS_TIME))
138 cnt = sscanf(buf, "%d", &enable);
142 err = ops->enable(ops, &req, enable ? 1 : 0);
150 static DEVICE_ATTR(pps_enable, 0220, NULL, pps_enable_store);
152 static struct attribute *ptp_attrs[] = {
153 &dev_attr_clock_name.attr,
155 &dev_attr_max_adjustment.attr,
156 &dev_attr_n_alarms.attr,
157 &dev_attr_n_external_timestamps.attr,
158 &dev_attr_n_periodic_outputs.attr,
159 &dev_attr_n_programmable_pins.attr,
160 &dev_attr_pps_available.attr,
162 &dev_attr_extts_enable.attr,
164 &dev_attr_period.attr,
165 &dev_attr_pps_enable.attr,
169 static umode_t ptp_is_attribute_visible(struct kobject *kobj,
170 struct attribute *attr, int n)
172 struct device *dev = kobj_to_dev(kobj);
173 struct ptp_clock *ptp = dev_get_drvdata(dev);
174 struct ptp_clock_info *info = ptp->info;
175 umode_t mode = attr->mode;
177 if (attr == &dev_attr_extts_enable.attr ||
178 attr == &dev_attr_fifo.attr) {
181 } else if (attr == &dev_attr_period.attr) {
182 if (!info->n_per_out)
184 } else if (attr == &dev_attr_pps_enable.attr) {
192 static const struct attribute_group ptp_group = {
193 .is_visible = ptp_is_attribute_visible,
197 const struct attribute_group *ptp_groups[] = {
202 static int ptp_pin_name2index(struct ptp_clock *ptp, const char *name)
205 for (i = 0; i < ptp->info->n_pins; i++) {
206 if (!strcmp(ptp->info->pin_config[i].name, name))
212 static ssize_t ptp_pin_show(struct device *dev, struct device_attribute *attr,
215 struct ptp_clock *ptp = dev_get_drvdata(dev);
216 unsigned int func, chan;
219 index = ptp_pin_name2index(ptp, attr->attr.name);
223 if (mutex_lock_interruptible(&ptp->pincfg_mux))
226 func = ptp->info->pin_config[index].func;
227 chan = ptp->info->pin_config[index].chan;
229 mutex_unlock(&ptp->pincfg_mux);
231 return sysfs_emit(page, "%u %u\n", func, chan);
234 static ssize_t ptp_pin_store(struct device *dev, struct device_attribute *attr,
235 const char *buf, size_t count)
237 struct ptp_clock *ptp = dev_get_drvdata(dev);
238 unsigned int func, chan;
241 cnt = sscanf(buf, "%u %u", &func, &chan);
245 index = ptp_pin_name2index(ptp, attr->attr.name);
249 if (mutex_lock_interruptible(&ptp->pincfg_mux))
251 err = ptp_set_pinfunc(ptp, index, func, chan);
252 mutex_unlock(&ptp->pincfg_mux);
259 int ptp_populate_pin_groups(struct ptp_clock *ptp)
261 struct ptp_clock_info *info = ptp->info;
262 int err = -ENOMEM, i, n_pins = info->n_pins;
267 ptp->pin_dev_attr = kcalloc(n_pins, sizeof(*ptp->pin_dev_attr),
269 if (!ptp->pin_dev_attr)
272 ptp->pin_attr = kcalloc(1 + n_pins, sizeof(*ptp->pin_attr), GFP_KERNEL);
276 for (i = 0; i < n_pins; i++) {
277 struct device_attribute *da = &ptp->pin_dev_attr[i];
278 sysfs_attr_init(&da->attr);
279 da->attr.name = info->pin_config[i].name;
280 da->attr.mode = 0644;
281 da->show = ptp_pin_show;
282 da->store = ptp_pin_store;
283 ptp->pin_attr[i] = &da->attr;
286 ptp->pin_attr_group.name = "pins";
287 ptp->pin_attr_group.attrs = ptp->pin_attr;
289 ptp->pin_attr_groups[0] = &ptp->pin_attr_group;
294 kfree(ptp->pin_dev_attr);
299 void ptp_cleanup_pin_groups(struct ptp_clock *ptp)
301 kfree(ptp->pin_attr);
302 kfree(ptp->pin_dev_attr);