2 * PTP 1588 clock using the eTSEC
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.
21 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
23 #include <linux/device.h>
24 #include <linux/hrtimer.h>
25 #include <linux/init.h>
26 #include <linux/interrupt.h>
27 #include <linux/kernel.h>
28 #include <linux/module.h>
30 #include <linux/of_platform.h>
31 #include <linux/timex.h>
34 #include <linux/ptp_clock_kernel.h>
39 * gianfar ptp registers
40 * Generated by regen.tcl on Thu May 13 01:38:57 PM CEST 2010
42 struct gianfar_ptp_registers {
43 u32 tmr_ctrl; /* Timer control register */
44 u32 tmr_tevent; /* Timestamp event register */
45 u32 tmr_temask; /* Timer event mask register */
46 u32 tmr_pevent; /* Timestamp event register */
47 u32 tmr_pemask; /* Timer event mask register */
48 u32 tmr_stat; /* Timestamp status register */
49 u32 tmr_cnt_h; /* Timer counter high register */
50 u32 tmr_cnt_l; /* Timer counter low register */
51 u32 tmr_add; /* Timer drift compensation addend register */
52 u32 tmr_acc; /* Timer accumulator register */
53 u32 tmr_prsc; /* Timer prescale */
55 u32 tmroff_h; /* Timer offset high */
56 u32 tmroff_l; /* Timer offset low */
58 u32 tmr_alarm1_h; /* Timer alarm 1 high register */
59 u32 tmr_alarm1_l; /* Timer alarm 1 high register */
60 u32 tmr_alarm2_h; /* Timer alarm 2 high register */
61 u32 tmr_alarm2_l; /* Timer alarm 2 high register */
63 u32 tmr_fiper1; /* Timer fixed period interval */
64 u32 tmr_fiper2; /* Timer fixed period interval */
65 u32 tmr_fiper3; /* Timer fixed period interval */
67 u32 tmr_etts1_h; /* Timestamp of general purpose external trigger */
68 u32 tmr_etts1_l; /* Timestamp of general purpose external trigger */
69 u32 tmr_etts2_h; /* Timestamp of general purpose external trigger */
70 u32 tmr_etts2_l; /* Timestamp of general purpose external trigger */
73 /* Bit definitions for the TMR_CTRL register */
74 #define ALM1P (1<<31) /* Alarm1 output polarity */
75 #define ALM2P (1<<30) /* Alarm2 output polarity */
76 #define FS (1<<28) /* FIPER start indication */
77 #define PP1L (1<<27) /* Fiper1 pulse loopback mode enabled. */
78 #define PP2L (1<<26) /* Fiper2 pulse loopback mode enabled. */
79 #define TCLK_PERIOD_SHIFT (16) /* 1588 timer reference clock period. */
80 #define TCLK_PERIOD_MASK (0x3ff)
81 #define RTPE (1<<15) /* Record Tx Timestamp to PAL Enable. */
82 #define FRD (1<<14) /* FIPER Realignment Disable */
83 #define ESFDP (1<<11) /* External Tx/Rx SFD Polarity. */
84 #define ESFDE (1<<10) /* External Tx/Rx SFD Enable. */
85 #define ETEP2 (1<<9) /* External trigger 2 edge polarity */
86 #define ETEP1 (1<<8) /* External trigger 1 edge polarity */
87 #define COPH (1<<7) /* Generated clock output phase. */
88 #define CIPH (1<<6) /* External oscillator input clock phase */
89 #define TMSR (1<<5) /* Timer soft reset. */
90 #define BYP (1<<3) /* Bypass drift compensated clock */
91 #define TE (1<<2) /* 1588 timer enable. */
92 #define CKSEL_SHIFT (0) /* 1588 Timer reference clock source */
93 #define CKSEL_MASK (0x3)
95 /* Bit definitions for the TMR_TEVENT register */
96 #define ETS2 (1<<25) /* External trigger 2 timestamp sampled */
97 #define ETS1 (1<<24) /* External trigger 1 timestamp sampled */
98 #define ALM2 (1<<17) /* Current time = alarm time register 2 */
99 #define ALM1 (1<<16) /* Current time = alarm time register 1 */
100 #define PP1 (1<<7) /* periodic pulse generated on FIPER1 */
101 #define PP2 (1<<6) /* periodic pulse generated on FIPER2 */
102 #define PP3 (1<<5) /* periodic pulse generated on FIPER3 */
104 /* Bit definitions for the TMR_TEMASK register */
105 #define ETS2EN (1<<25) /* External trigger 2 timestamp enable */
106 #define ETS1EN (1<<24) /* External trigger 1 timestamp enable */
107 #define ALM2EN (1<<17) /* Timer ALM2 event enable */
108 #define ALM1EN (1<<16) /* Timer ALM1 event enable */
109 #define PP1EN (1<<7) /* Periodic pulse event 1 enable */
110 #define PP2EN (1<<6) /* Periodic pulse event 2 enable */
112 /* Bit definitions for the TMR_PEVENT register */
113 #define TXP2 (1<<9) /* PTP transmitted timestamp im TXTS2 */
114 #define TXP1 (1<<8) /* PTP transmitted timestamp in TXTS1 */
115 #define RXP (1<<0) /* PTP frame has been received */
117 /* Bit definitions for the TMR_PEMASK register */
118 #define TXP2EN (1<<9) /* Transmit PTP packet event 2 enable */
119 #define TXP1EN (1<<8) /* Transmit PTP packet event 1 enable */
120 #define RXPEN (1<<0) /* Receive PTP packet event enable */
122 /* Bit definitions for the TMR_STAT register */
123 #define STAT_VEC_SHIFT (0) /* Timer general purpose status vector */
124 #define STAT_VEC_MASK (0x3f)
126 /* Bit definitions for the TMR_PRSC register */
127 #define PRSC_OCK_SHIFT (0) /* Output clock division/prescale factor. */
128 #define PRSC_OCK_MASK (0xffff)
131 #define DRIVER "gianfar_ptp"
132 #define DEFAULT_CKSEL 1
133 #define N_ALARM 1 /* first alarm is used internally to reset fipers */
135 #define REG_SIZE sizeof(struct gianfar_ptp_registers)
138 struct gianfar_ptp_registers *regs;
139 spinlock_t lock; /* protects regs */
140 struct ptp_clock *clock;
141 struct ptp_clock_info caps;
142 struct resource *rsrc;
144 u64 alarm_interval; /* for periodic alarm */
146 u32 tclk_period; /* nanoseconds */
155 * Register access functions
158 /* Caller must hold etsects->lock. */
159 static u64 tmr_cnt_read(struct etsects *etsects)
164 lo = gfar_read(&etsects->regs->tmr_cnt_l);
165 hi = gfar_read(&etsects->regs->tmr_cnt_h);
166 ns = ((u64) hi) << 32;
171 /* Caller must hold etsects->lock. */
172 static void tmr_cnt_write(struct etsects *etsects, u64 ns)
175 u32 lo = ns & 0xffffffff;
177 gfar_write(&etsects->regs->tmr_cnt_l, lo);
178 gfar_write(&etsects->regs->tmr_cnt_h, hi);
181 /* Caller must hold etsects->lock. */
182 static void set_alarm(struct etsects *etsects)
187 ns = tmr_cnt_read(etsects) + 1500000000ULL;
188 ns = div_u64(ns, 1000000000UL) * 1000000000ULL;
189 ns -= etsects->tclk_period;
191 lo = ns & 0xffffffff;
192 gfar_write(&etsects->regs->tmr_alarm1_l, lo);
193 gfar_write(&etsects->regs->tmr_alarm1_h, hi);
196 /* Caller must hold etsects->lock. */
197 static void set_fipers(struct etsects *etsects)
200 gfar_write(&etsects->regs->tmr_fiper1, etsects->tmr_fiper1);
201 gfar_write(&etsects->regs->tmr_fiper2, etsects->tmr_fiper2);
205 * Interrupt service routine
208 static irqreturn_t isr(int irq, void *priv)
210 struct etsects *etsects = priv;
211 struct ptp_clock_event event;
213 u32 ack = 0, lo, hi, mask, val;
215 val = gfar_read(&etsects->regs->tmr_tevent);
219 hi = gfar_read(&etsects->regs->tmr_etts1_h);
220 lo = gfar_read(&etsects->regs->tmr_etts1_l);
221 event.type = PTP_CLOCK_EXTTS;
223 event.timestamp = ((u64) hi) << 32;
224 event.timestamp |= lo;
225 ptp_clock_event(etsects->clock, &event);
230 hi = gfar_read(&etsects->regs->tmr_etts2_h);
231 lo = gfar_read(&etsects->regs->tmr_etts2_l);
232 event.type = PTP_CLOCK_EXTTS;
234 event.timestamp = ((u64) hi) << 32;
235 event.timestamp |= lo;
236 ptp_clock_event(etsects->clock, &event);
241 if (etsects->alarm_value) {
242 event.type = PTP_CLOCK_ALARM;
244 event.timestamp = etsects->alarm_value;
245 ptp_clock_event(etsects->clock, &event);
247 if (etsects->alarm_interval) {
248 ns = etsects->alarm_value + etsects->alarm_interval;
250 lo = ns & 0xffffffff;
251 spin_lock(&etsects->lock);
252 gfar_write(&etsects->regs->tmr_alarm2_l, lo);
253 gfar_write(&etsects->regs->tmr_alarm2_h, hi);
254 spin_unlock(&etsects->lock);
255 etsects->alarm_value = ns;
257 gfar_write(&etsects->regs->tmr_tevent, ALM2);
258 spin_lock(&etsects->lock);
259 mask = gfar_read(&etsects->regs->tmr_temask);
261 gfar_write(&etsects->regs->tmr_temask, mask);
262 spin_unlock(&etsects->lock);
263 etsects->alarm_value = 0;
264 etsects->alarm_interval = 0;
270 event.type = PTP_CLOCK_PPS;
271 ptp_clock_event(etsects->clock, &event);
275 gfar_write(&etsects->regs->tmr_tevent, ack);
282 * PTP clock operations
285 static int ptp_gianfar_adjfreq(struct ptp_clock_info *ptp, s32 ppb)
290 struct etsects *etsects = container_of(ptp, struct etsects, caps);
296 tmr_add = etsects->tmr_add;
299 diff = div_u64(adj, 1000000000ULL);
301 tmr_add = neg_adj ? tmr_add - diff : tmr_add + diff;
303 gfar_write(&etsects->regs->tmr_add, tmr_add);
308 static int ptp_gianfar_adjtime(struct ptp_clock_info *ptp, s64 delta)
312 struct etsects *etsects = container_of(ptp, struct etsects, caps);
314 spin_lock_irqsave(&etsects->lock, flags);
316 now = tmr_cnt_read(etsects);
318 tmr_cnt_write(etsects, now);
320 spin_unlock_irqrestore(&etsects->lock, flags);
327 static int ptp_gianfar_gettime(struct ptp_clock_info *ptp, struct timespec *ts)
332 struct etsects *etsects = container_of(ptp, struct etsects, caps);
334 spin_lock_irqsave(&etsects->lock, flags);
336 ns = tmr_cnt_read(etsects);
338 spin_unlock_irqrestore(&etsects->lock, flags);
340 ts->tv_sec = div_u64_rem(ns, 1000000000, &remainder);
341 ts->tv_nsec = remainder;
345 static int ptp_gianfar_settime(struct ptp_clock_info *ptp,
346 const struct timespec *ts)
350 struct etsects *etsects = container_of(ptp, struct etsects, caps);
352 ns = ts->tv_sec * 1000000000ULL;
355 spin_lock_irqsave(&etsects->lock, flags);
357 tmr_cnt_write(etsects, ns);
360 spin_unlock_irqrestore(&etsects->lock, flags);
365 static int ptp_gianfar_enable(struct ptp_clock_info *ptp,
366 struct ptp_clock_request *rq, int on)
368 struct etsects *etsects = container_of(ptp, struct etsects, caps);
373 case PTP_CLK_REQ_EXTTS:
374 switch (rq->extts.index) {
384 spin_lock_irqsave(&etsects->lock, flags);
385 mask = gfar_read(&etsects->regs->tmr_temask);
390 gfar_write(&etsects->regs->tmr_temask, mask);
391 spin_unlock_irqrestore(&etsects->lock, flags);
394 case PTP_CLK_REQ_PPS:
395 spin_lock_irqsave(&etsects->lock, flags);
396 mask = gfar_read(&etsects->regs->tmr_temask);
401 gfar_write(&etsects->regs->tmr_temask, mask);
402 spin_unlock_irqrestore(&etsects->lock, flags);
412 static struct ptp_clock_info ptp_gianfar_caps = {
413 .owner = THIS_MODULE,
414 .name = "gianfar clock",
417 .n_ext_ts = N_EXT_TS,
420 .adjfreq = ptp_gianfar_adjfreq,
421 .adjtime = ptp_gianfar_adjtime,
422 .gettime = ptp_gianfar_gettime,
423 .settime = ptp_gianfar_settime,
424 .enable = ptp_gianfar_enable,
429 static int get_of_u32(struct device_node *node, char *str, u32 *val)
432 const u32 *prop = of_get_property(node, str, &plen);
434 if (!prop || plen != sizeof(*prop))
440 static int gianfar_ptp_probe(struct platform_device *dev)
442 struct device_node *node = dev->dev.of_node;
443 struct etsects *etsects;
449 etsects = kzalloc(sizeof(*etsects), GFP_KERNEL);
455 etsects->caps = ptp_gianfar_caps;
456 etsects->cksel = DEFAULT_CKSEL;
458 if (get_of_u32(node, "fsl,tclk-period", &etsects->tclk_period) ||
459 get_of_u32(node, "fsl,tmr-prsc", &etsects->tmr_prsc) ||
460 get_of_u32(node, "fsl,tmr-add", &etsects->tmr_add) ||
461 get_of_u32(node, "fsl,tmr-fiper1", &etsects->tmr_fiper1) ||
462 get_of_u32(node, "fsl,tmr-fiper2", &etsects->tmr_fiper2) ||
463 get_of_u32(node, "fsl,max-adj", &etsects->caps.max_adj)) {
464 pr_err("device tree node missing required elements\n");
468 etsects->irq = platform_get_irq(dev, 0);
470 if (etsects->irq == NO_IRQ) {
471 pr_err("irq not in device tree\n");
474 if (request_irq(etsects->irq, isr, 0, DRIVER, etsects)) {
475 pr_err("request_irq failed\n");
479 etsects->rsrc = platform_get_resource(dev, IORESOURCE_MEM, 0);
480 if (!etsects->rsrc) {
481 pr_err("no resource\n");
484 if (request_resource(&iomem_resource, etsects->rsrc)) {
485 pr_err("resource busy\n");
489 spin_lock_init(&etsects->lock);
491 etsects->regs = ioremap(etsects->rsrc->start,
492 resource_size(etsects->rsrc));
493 if (!etsects->regs) {
494 pr_err("ioremap ptp registers failed\n");
497 getnstimeofday(&now);
498 ptp_gianfar_settime(&etsects->caps, &now);
501 (etsects->tclk_period & TCLK_PERIOD_MASK) << TCLK_PERIOD_SHIFT |
502 (etsects->cksel & CKSEL_MASK) << CKSEL_SHIFT;
504 spin_lock_irqsave(&etsects->lock, flags);
506 gfar_write(&etsects->regs->tmr_ctrl, tmr_ctrl);
507 gfar_write(&etsects->regs->tmr_add, etsects->tmr_add);
508 gfar_write(&etsects->regs->tmr_prsc, etsects->tmr_prsc);
509 gfar_write(&etsects->regs->tmr_fiper1, etsects->tmr_fiper1);
510 gfar_write(&etsects->regs->tmr_fiper2, etsects->tmr_fiper2);
512 gfar_write(&etsects->regs->tmr_ctrl, tmr_ctrl|FS|RTPE|TE|FRD);
514 spin_unlock_irqrestore(&etsects->lock, flags);
516 etsects->clock = ptp_clock_register(&etsects->caps, &dev->dev);
517 if (IS_ERR(etsects->clock)) {
518 err = PTR_ERR(etsects->clock);
521 gfar_phc_index = ptp_clock_index(etsects->clock);
523 dev_set_drvdata(&dev->dev, etsects);
529 release_resource(etsects->rsrc);
531 free_irq(etsects->irq, etsects);
538 static int gianfar_ptp_remove(struct platform_device *dev)
540 struct etsects *etsects = dev_get_drvdata(&dev->dev);
542 gfar_write(&etsects->regs->tmr_temask, 0);
543 gfar_write(&etsects->regs->tmr_ctrl, 0);
546 ptp_clock_unregister(etsects->clock);
547 iounmap(etsects->regs);
548 release_resource(etsects->rsrc);
549 free_irq(etsects->irq, etsects);
555 static struct of_device_id match_table[] = {
556 { .compatible = "fsl,etsec-ptp" },
560 static struct platform_driver gianfar_ptp_driver = {
562 .name = "gianfar_ptp",
563 .of_match_table = match_table,
564 .owner = THIS_MODULE,
566 .probe = gianfar_ptp_probe,
567 .remove = gianfar_ptp_remove,
570 module_platform_driver(gianfar_ptp_driver);
572 MODULE_AUTHOR("Richard Cochran <richardcochran@gmail.com>");
573 MODULE_DESCRIPTION("PTP clock using the eTSEC");
574 MODULE_LICENSE("GPL");