2 * PTP 1588 clock support - sysfs interface.
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/capability.h>
21 #include <linux/slab.h>
23 #include "ptp_private.h"
25 static ssize_t clock_name_show(struct device *dev,
26 struct device_attribute *attr, char *page)
28 struct ptp_clock *ptp = dev_get_drvdata(dev);
29 return snprintf(page, PAGE_SIZE-1, "%s\n", ptp->info->name);
31 static DEVICE_ATTR(clock_name, 0444, clock_name_show, NULL);
33 #define PTP_SHOW_INT(name, var) \
34 static ssize_t var##_show(struct device *dev, \
35 struct device_attribute *attr, char *page) \
37 struct ptp_clock *ptp = dev_get_drvdata(dev); \
38 return snprintf(page, PAGE_SIZE-1, "%d\n", ptp->info->var); \
40 static DEVICE_ATTR(name, 0444, var##_show, NULL);
42 PTP_SHOW_INT(max_adjustment, max_adj);
43 PTP_SHOW_INT(n_alarms, n_alarm);
44 PTP_SHOW_INT(n_external_timestamps, n_ext_ts);
45 PTP_SHOW_INT(n_periodic_outputs, n_per_out);
46 PTP_SHOW_INT(n_programmable_pins, n_pins);
47 PTP_SHOW_INT(pps_available, pps);
49 static struct attribute *ptp_attrs[] = {
50 &dev_attr_clock_name.attr,
51 &dev_attr_max_adjustment.attr,
52 &dev_attr_n_alarms.attr,
53 &dev_attr_n_external_timestamps.attr,
54 &dev_attr_n_periodic_outputs.attr,
55 &dev_attr_n_programmable_pins.attr,
56 &dev_attr_pps_available.attr,
60 static const struct attribute_group ptp_group = {
64 const struct attribute_group *ptp_groups[] = {
70 static ssize_t extts_enable_store(struct device *dev,
71 struct device_attribute *attr,
72 const char *buf, size_t count)
74 struct ptp_clock *ptp = dev_get_drvdata(dev);
75 struct ptp_clock_info *ops = ptp->info;
76 struct ptp_clock_request req = { .type = PTP_CLK_REQ_EXTTS };
80 cnt = sscanf(buf, "%u %d", &req.extts.index, &enable);
83 if (req.extts.index >= ops->n_ext_ts)
86 err = ops->enable(ops, &req, enable ? 1 : 0);
95 static ssize_t extts_fifo_show(struct device *dev,
96 struct device_attribute *attr, char *page)
98 struct ptp_clock *ptp = dev_get_drvdata(dev);
99 struct timestamp_event_queue *queue = &ptp->tsevq;
100 struct ptp_extts_event event;
105 memset(&event, 0, sizeof(event));
107 if (mutex_lock_interruptible(&ptp->tsevq_mux))
110 spin_lock_irqsave(&queue->lock, flags);
111 qcnt = queue_cnt(queue);
113 event = queue->buf[queue->head];
114 queue->head = (queue->head + 1) % PTP_MAX_TIMESTAMPS;
116 spin_unlock_irqrestore(&queue->lock, flags);
121 cnt = snprintf(page, PAGE_SIZE, "%u %lld %u\n",
122 event.index, event.t.sec, event.t.nsec);
124 mutex_unlock(&ptp->tsevq_mux);
128 static ssize_t period_store(struct device *dev,
129 struct device_attribute *attr,
130 const char *buf, size_t count)
132 struct ptp_clock *ptp = dev_get_drvdata(dev);
133 struct ptp_clock_info *ops = ptp->info;
134 struct ptp_clock_request req = { .type = PTP_CLK_REQ_PEROUT };
135 int cnt, enable, err = -EINVAL;
137 cnt = sscanf(buf, "%u %lld %u %lld %u", &req.perout.index,
138 &req.perout.start.sec, &req.perout.start.nsec,
139 &req.perout.period.sec, &req.perout.period.nsec);
142 if (req.perout.index >= ops->n_per_out)
145 enable = req.perout.period.sec || req.perout.period.nsec;
146 err = ops->enable(ops, &req, enable);
155 static ssize_t pps_enable_store(struct device *dev,
156 struct device_attribute *attr,
157 const char *buf, size_t count)
159 struct ptp_clock *ptp = dev_get_drvdata(dev);
160 struct ptp_clock_info *ops = ptp->info;
161 struct ptp_clock_request req = { .type = PTP_CLK_REQ_PPS };
165 if (!capable(CAP_SYS_TIME))
168 cnt = sscanf(buf, "%d", &enable);
172 err = ops->enable(ops, &req, enable ? 1 : 0);
181 static int ptp_pin_name2index(struct ptp_clock *ptp, const char *name)
184 for (i = 0; i < ptp->info->n_pins; i++) {
185 if (!strcmp(ptp->info->pin_config[i].name, name))
191 static ssize_t ptp_pin_show(struct device *dev, struct device_attribute *attr,
194 struct ptp_clock *ptp = dev_get_drvdata(dev);
195 unsigned int func, chan;
198 index = ptp_pin_name2index(ptp, attr->attr.name);
202 if (mutex_lock_interruptible(&ptp->pincfg_mux))
205 func = ptp->info->pin_config[index].func;
206 chan = ptp->info->pin_config[index].chan;
208 mutex_unlock(&ptp->pincfg_mux);
210 return snprintf(page, PAGE_SIZE, "%u %u\n", func, chan);
213 static ssize_t ptp_pin_store(struct device *dev, struct device_attribute *attr,
214 const char *buf, size_t count)
216 struct ptp_clock *ptp = dev_get_drvdata(dev);
217 unsigned int func, chan;
220 cnt = sscanf(buf, "%u %u", &func, &chan);
224 index = ptp_pin_name2index(ptp, attr->attr.name);
228 if (mutex_lock_interruptible(&ptp->pincfg_mux))
230 err = ptp_set_pinfunc(ptp, index, func, chan);
231 mutex_unlock(&ptp->pincfg_mux);
238 static DEVICE_ATTR(extts_enable, 0220, NULL, extts_enable_store);
239 static DEVICE_ATTR(fifo, 0444, extts_fifo_show, NULL);
240 static DEVICE_ATTR(period, 0220, NULL, period_store);
241 static DEVICE_ATTR(pps_enable, 0220, NULL, pps_enable_store);
243 int ptp_cleanup_sysfs(struct ptp_clock *ptp)
245 struct device *dev = ptp->dev;
246 struct ptp_clock_info *info = ptp->info;
248 if (info->n_ext_ts) {
249 device_remove_file(dev, &dev_attr_extts_enable);
250 device_remove_file(dev, &dev_attr_fifo);
253 device_remove_file(dev, &dev_attr_period);
256 device_remove_file(dev, &dev_attr_pps_enable);
259 sysfs_remove_group(&dev->kobj, &ptp->pin_attr_group);
260 kfree(ptp->pin_attr);
261 kfree(ptp->pin_dev_attr);
266 static int ptp_populate_pins(struct ptp_clock *ptp)
268 struct device *dev = ptp->dev;
269 struct ptp_clock_info *info = ptp->info;
270 int err = -ENOMEM, i, n_pins = info->n_pins;
272 ptp->pin_dev_attr = kzalloc(n_pins * sizeof(*ptp->pin_dev_attr),
274 if (!ptp->pin_dev_attr)
277 ptp->pin_attr = kzalloc((1 + n_pins) * sizeof(struct attribute *),
282 for (i = 0; i < n_pins; i++) {
283 struct device_attribute *da = &ptp->pin_dev_attr[i];
284 sysfs_attr_init(&da->attr);
285 da->attr.name = info->pin_config[i].name;
286 da->attr.mode = 0644;
287 da->show = ptp_pin_show;
288 da->store = ptp_pin_store;
289 ptp->pin_attr[i] = &da->attr;
292 ptp->pin_attr_group.name = "pins";
293 ptp->pin_attr_group.attrs = ptp->pin_attr;
295 err = sysfs_create_group(&dev->kobj, &ptp->pin_attr_group);
301 kfree(ptp->pin_attr);
303 kfree(ptp->pin_dev_attr);
308 int ptp_populate_sysfs(struct ptp_clock *ptp)
310 struct device *dev = ptp->dev;
311 struct ptp_clock_info *info = ptp->info;
314 if (info->n_ext_ts) {
315 err = device_create_file(dev, &dev_attr_extts_enable);
318 err = device_create_file(dev, &dev_attr_fifo);
322 if (info->n_per_out) {
323 err = device_create_file(dev, &dev_attr_period);
328 err = device_create_file(dev, &dev_attr_pps_enable);
333 err = ptp_populate_pins(ptp);
340 device_remove_file(dev, &dev_attr_pps_enable);
343 device_remove_file(dev, &dev_attr_period);
346 device_remove_file(dev, &dev_attr_fifo);
349 device_remove_file(dev, &dev_attr_extts_enable);