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.
20 #include <linux/device.h>
21 #include <linux/hrtimer.h>
22 #include <linux/init.h>
23 #include <linux/interrupt.h>
24 #include <linux/kernel.h>
25 #include <linux/module.h>
27 #include <linux/of_platform.h>
28 #include <linux/timex.h>
31 #include <linux/ptp_clock_kernel.h>
36 * gianfar ptp registers
37 * Generated by regen.tcl on Thu May 13 01:38:57 PM CEST 2010
39 struct gianfar_ptp_registers
{
40 u32 tmr_ctrl
; /* Timer control register */
41 u32 tmr_tevent
; /* Timestamp event register */
42 u32 tmr_temask
; /* Timer event mask register */
43 u32 tmr_pevent
; /* Timestamp event register */
44 u32 tmr_pemask
; /* Timer event mask register */
45 u32 tmr_stat
; /* Timestamp status register */
46 u32 tmr_cnt_h
; /* Timer counter high register */
47 u32 tmr_cnt_l
; /* Timer counter low register */
48 u32 tmr_add
; /* Timer drift compensation addend register */
49 u32 tmr_acc
; /* Timer accumulator register */
50 u32 tmr_prsc
; /* Timer prescale */
52 u32 tmroff_h
; /* Timer offset high */
53 u32 tmroff_l
; /* Timer offset low */
55 u32 tmr_alarm1_h
; /* Timer alarm 1 high register */
56 u32 tmr_alarm1_l
; /* Timer alarm 1 high register */
57 u32 tmr_alarm2_h
; /* Timer alarm 2 high register */
58 u32 tmr_alarm2_l
; /* Timer alarm 2 high register */
60 u32 tmr_fiper1
; /* Timer fixed period interval */
61 u32 tmr_fiper2
; /* Timer fixed period interval */
62 u32 tmr_fiper3
; /* Timer fixed period interval */
64 u32 tmr_etts1_h
; /* Timestamp of general purpose external trigger */
65 u32 tmr_etts1_l
; /* Timestamp of general purpose external trigger */
66 u32 tmr_etts2_h
; /* Timestamp of general purpose external trigger */
67 u32 tmr_etts2_l
; /* Timestamp of general purpose external trigger */
70 /* Bit definitions for the TMR_CTRL register */
71 #define ALM1P (1<<31) /* Alarm1 output polarity */
72 #define ALM2P (1<<30) /* Alarm2 output polarity */
73 #define FS (1<<28) /* FIPER start indication */
74 #define PP1L (1<<27) /* Fiper1 pulse loopback mode enabled. */
75 #define PP2L (1<<26) /* Fiper2 pulse loopback mode enabled. */
76 #define TCLK_PERIOD_SHIFT (16) /* 1588 timer reference clock period. */
77 #define TCLK_PERIOD_MASK (0x3ff)
78 #define RTPE (1<<15) /* Record Tx Timestamp to PAL Enable. */
79 #define FRD (1<<14) /* FIPER Realignment Disable */
80 #define ESFDP (1<<11) /* External Tx/Rx SFD Polarity. */
81 #define ESFDE (1<<10) /* External Tx/Rx SFD Enable. */
82 #define ETEP2 (1<<9) /* External trigger 2 edge polarity */
83 #define ETEP1 (1<<8) /* External trigger 1 edge polarity */
84 #define COPH (1<<7) /* Generated clock output phase. */
85 #define CIPH (1<<6) /* External oscillator input clock phase */
86 #define TMSR (1<<5) /* Timer soft reset. */
87 #define BYP (1<<3) /* Bypass drift compensated clock */
88 #define TE (1<<2) /* 1588 timer enable. */
89 #define CKSEL_SHIFT (0) /* 1588 Timer reference clock source */
90 #define CKSEL_MASK (0x3)
92 /* Bit definitions for the TMR_TEVENT register */
93 #define ETS2 (1<<25) /* External trigger 2 timestamp sampled */
94 #define ETS1 (1<<24) /* External trigger 1 timestamp sampled */
95 #define ALM2 (1<<17) /* Current time = alarm time register 2 */
96 #define ALM1 (1<<16) /* Current time = alarm time register 1 */
97 #define PP1 (1<<7) /* periodic pulse generated on FIPER1 */
98 #define PP2 (1<<6) /* periodic pulse generated on FIPER2 */
99 #define PP3 (1<<5) /* periodic pulse generated on FIPER3 */
101 /* Bit definitions for the TMR_TEMASK register */
102 #define ETS2EN (1<<25) /* External trigger 2 timestamp enable */
103 #define ETS1EN (1<<24) /* External trigger 1 timestamp enable */
104 #define ALM2EN (1<<17) /* Timer ALM2 event enable */
105 #define ALM1EN (1<<16) /* Timer ALM1 event enable */
106 #define PP1EN (1<<7) /* Periodic pulse event 1 enable */
107 #define PP2EN (1<<6) /* Periodic pulse event 2 enable */
109 /* Bit definitions for the TMR_PEVENT register */
110 #define TXP2 (1<<9) /* PTP transmitted timestamp im TXTS2 */
111 #define TXP1 (1<<8) /* PTP transmitted timestamp in TXTS1 */
112 #define RXP (1<<0) /* PTP frame has been received */
114 /* Bit definitions for the TMR_PEMASK register */
115 #define TXP2EN (1<<9) /* Transmit PTP packet event 2 enable */
116 #define TXP1EN (1<<8) /* Transmit PTP packet event 1 enable */
117 #define RXPEN (1<<0) /* Receive PTP packet event enable */
119 /* Bit definitions for the TMR_STAT register */
120 #define STAT_VEC_SHIFT (0) /* Timer general purpose status vector */
121 #define STAT_VEC_MASK (0x3f)
123 /* Bit definitions for the TMR_PRSC register */
124 #define PRSC_OCK_SHIFT (0) /* Output clock division/prescale factor. */
125 #define PRSC_OCK_MASK (0xffff)
128 #define DRIVER "gianfar_ptp"
129 #define DEFAULT_CKSEL 1
130 #define N_ALARM 1 /* first alarm is used internally to reset fipers */
132 #define REG_SIZE sizeof(struct gianfar_ptp_registers)
135 struct gianfar_ptp_registers
*regs
;
136 spinlock_t lock
; /* protects regs */
137 struct ptp_clock
*clock
;
138 struct ptp_clock_info caps
;
139 struct resource
*rsrc
;
141 u64 alarm_interval
; /* for periodic alarm */
143 u32 tclk_period
; /* nanoseconds */
152 * Register access functions
155 /* Caller must hold etsects->lock. */
156 static u64
tmr_cnt_read(struct etsects
*etsects
)
161 lo
= gfar_read(&etsects
->regs
->tmr_cnt_l
);
162 hi
= gfar_read(&etsects
->regs
->tmr_cnt_h
);
163 ns
= ((u64
) hi
) << 32;
168 /* Caller must hold etsects->lock. */
169 static void tmr_cnt_write(struct etsects
*etsects
, u64 ns
)
172 u32 lo
= ns
& 0xffffffff;
174 gfar_write(&etsects
->regs
->tmr_cnt_l
, lo
);
175 gfar_write(&etsects
->regs
->tmr_cnt_h
, hi
);
178 /* Caller must hold etsects->lock. */
179 static void set_alarm(struct etsects
*etsects
)
184 ns
= tmr_cnt_read(etsects
) + 1500000000ULL;
185 ns
= div_u64(ns
, 1000000000UL) * 1000000000ULL;
186 ns
-= etsects
->tclk_period
;
188 lo
= ns
& 0xffffffff;
189 gfar_write(&etsects
->regs
->tmr_alarm1_l
, lo
);
190 gfar_write(&etsects
->regs
->tmr_alarm1_h
, hi
);
193 /* Caller must hold etsects->lock. */
194 static void set_fipers(struct etsects
*etsects
)
196 u32 tmr_ctrl
= gfar_read(&etsects
->regs
->tmr_ctrl
);
198 gfar_write(&etsects
->regs
->tmr_ctrl
, tmr_ctrl
& (~TE
));
199 gfar_write(&etsects
->regs
->tmr_prsc
, etsects
->tmr_prsc
);
200 gfar_write(&etsects
->regs
->tmr_fiper1
, etsects
->tmr_fiper1
);
201 gfar_write(&etsects
->regs
->tmr_fiper2
, etsects
->tmr_fiper2
);
203 gfar_write(&etsects
->regs
->tmr_ctrl
, tmr_ctrl
|TE
);
207 * Interrupt service routine
210 static irqreturn_t
isr(int irq
, void *priv
)
212 struct etsects
*etsects
= priv
;
213 struct ptp_clock_event event
;
215 u32 ack
= 0, lo
, hi
, mask
, val
;
217 val
= gfar_read(&etsects
->regs
->tmr_tevent
);
221 hi
= gfar_read(&etsects
->regs
->tmr_etts1_h
);
222 lo
= gfar_read(&etsects
->regs
->tmr_etts1_l
);
223 event
.type
= PTP_CLOCK_EXTTS
;
225 event
.timestamp
= ((u64
) hi
) << 32;
226 event
.timestamp
|= lo
;
227 ptp_clock_event(etsects
->clock
, &event
);
232 hi
= gfar_read(&etsects
->regs
->tmr_etts2_h
);
233 lo
= gfar_read(&etsects
->regs
->tmr_etts2_l
);
234 event
.type
= PTP_CLOCK_EXTTS
;
236 event
.timestamp
= ((u64
) hi
) << 32;
237 event
.timestamp
|= lo
;
238 ptp_clock_event(etsects
->clock
, &event
);
243 if (etsects
->alarm_value
) {
244 event
.type
= PTP_CLOCK_ALARM
;
246 event
.timestamp
= etsects
->alarm_value
;
247 ptp_clock_event(etsects
->clock
, &event
);
249 if (etsects
->alarm_interval
) {
250 ns
= etsects
->alarm_value
+ etsects
->alarm_interval
;
252 lo
= ns
& 0xffffffff;
253 spin_lock(&etsects
->lock
);
254 gfar_write(&etsects
->regs
->tmr_alarm2_l
, lo
);
255 gfar_write(&etsects
->regs
->tmr_alarm2_h
, hi
);
256 spin_unlock(&etsects
->lock
);
257 etsects
->alarm_value
= ns
;
259 gfar_write(&etsects
->regs
->tmr_tevent
, ALM2
);
260 spin_lock(&etsects
->lock
);
261 mask
= gfar_read(&etsects
->regs
->tmr_temask
);
263 gfar_write(&etsects
->regs
->tmr_temask
, mask
);
264 spin_unlock(&etsects
->lock
);
265 etsects
->alarm_value
= 0;
266 etsects
->alarm_interval
= 0;
272 event
.type
= PTP_CLOCK_PPS
;
273 ptp_clock_event(etsects
->clock
, &event
);
277 gfar_write(&etsects
->regs
->tmr_tevent
, ack
);
284 * PTP clock operations
287 static int ptp_gianfar_adjfreq(struct ptp_clock_info
*ptp
, s32 ppb
)
292 struct etsects
*etsects
= container_of(ptp
, struct etsects
, caps
);
298 tmr_add
= etsects
->tmr_add
;
301 diff
= div_u64(adj
, 1000000000ULL);
303 tmr_add
= neg_adj
? tmr_add
- diff
: tmr_add
+ diff
;
305 gfar_write(&etsects
->regs
->tmr_add
, tmr_add
);
310 static int ptp_gianfar_adjtime(struct ptp_clock_info
*ptp
, s64 delta
)
314 struct etsects
*etsects
= container_of(ptp
, struct etsects
, caps
);
316 spin_lock_irqsave(&etsects
->lock
, flags
);
318 now
= tmr_cnt_read(etsects
);
320 tmr_cnt_write(etsects
, now
);
322 spin_unlock_irqrestore(&etsects
->lock
, flags
);
329 static int ptp_gianfar_gettime(struct ptp_clock_info
*ptp
, struct timespec
*ts
)
334 struct etsects
*etsects
= container_of(ptp
, struct etsects
, caps
);
336 spin_lock_irqsave(&etsects
->lock
, flags
);
338 ns
= tmr_cnt_read(etsects
);
340 spin_unlock_irqrestore(&etsects
->lock
, flags
);
342 ts
->tv_sec
= div_u64_rem(ns
, 1000000000, &remainder
);
343 ts
->tv_nsec
= remainder
;
347 static int ptp_gianfar_settime(struct ptp_clock_info
*ptp
,
348 const struct timespec
*ts
)
352 struct etsects
*etsects
= container_of(ptp
, struct etsects
, caps
);
354 ns
= ts
->tv_sec
* 1000000000ULL;
357 spin_lock_irqsave(&etsects
->lock
, flags
);
359 tmr_cnt_write(etsects
, ns
);
362 spin_unlock_irqrestore(&etsects
->lock
, flags
);
367 static int ptp_gianfar_enable(struct ptp_clock_info
*ptp
,
368 struct ptp_clock_request
*rq
, int on
)
370 struct etsects
*etsects
= container_of(ptp
, struct etsects
, caps
);
375 case PTP_CLK_REQ_EXTTS
:
376 switch (rq
->extts
.index
) {
386 spin_lock_irqsave(&etsects
->lock
, flags
);
387 mask
= gfar_read(&etsects
->regs
->tmr_temask
);
392 gfar_write(&etsects
->regs
->tmr_temask
, mask
);
393 spin_unlock_irqrestore(&etsects
->lock
, flags
);
396 case PTP_CLK_REQ_PPS
:
397 spin_lock_irqsave(&etsects
->lock
, flags
);
398 mask
= gfar_read(&etsects
->regs
->tmr_temask
);
403 gfar_write(&etsects
->regs
->tmr_temask
, mask
);
404 spin_unlock_irqrestore(&etsects
->lock
, flags
);
414 static struct ptp_clock_info ptp_gianfar_caps
= {
415 .owner
= THIS_MODULE
,
416 .name
= "gianfar clock",
419 .n_ext_ts
= N_EXT_TS
,
422 .adjfreq
= ptp_gianfar_adjfreq
,
423 .adjtime
= ptp_gianfar_adjtime
,
424 .gettime
= ptp_gianfar_gettime
,
425 .settime
= ptp_gianfar_settime
,
426 .enable
= ptp_gianfar_enable
,
431 static int get_of_u32(struct device_node
*node
, char *str
, u32
*val
)
434 const u32
*prop
= of_get_property(node
, str
, &plen
);
436 if (!prop
|| plen
!= sizeof(*prop
))
442 static int gianfar_ptp_probe(struct platform_device
*dev
)
444 struct device_node
*node
= dev
->dev
.of_node
;
445 struct etsects
*etsects
;
451 etsects
= kzalloc(sizeof(*etsects
), GFP_KERNEL
);
457 etsects
->caps
= ptp_gianfar_caps
;
458 etsects
->cksel
= DEFAULT_CKSEL
;
460 if (get_of_u32(node
, "fsl,tclk-period", &etsects
->tclk_period
) ||
461 get_of_u32(node
, "fsl,tmr-prsc", &etsects
->tmr_prsc
) ||
462 get_of_u32(node
, "fsl,tmr-add", &etsects
->tmr_add
) ||
463 get_of_u32(node
, "fsl,tmr-fiper1", &etsects
->tmr_fiper1
) ||
464 get_of_u32(node
, "fsl,tmr-fiper2", &etsects
->tmr_fiper2
) ||
465 get_of_u32(node
, "fsl,max-adj", &etsects
->caps
.max_adj
)) {
466 pr_err("device tree node missing required elements\n");
470 etsects
->irq
= platform_get_irq(dev
, 0);
472 if (etsects
->irq
== NO_IRQ
) {
473 pr_err("irq not in device tree\n");
476 if (request_irq(etsects
->irq
, isr
, 0, DRIVER
, etsects
)) {
477 pr_err("request_irq failed\n");
481 etsects
->rsrc
= platform_get_resource(dev
, IORESOURCE_MEM
, 0);
482 if (!etsects
->rsrc
) {
483 pr_err("no resource\n");
486 if (request_resource(&ioport_resource
, etsects
->rsrc
)) {
487 pr_err("resource busy\n");
491 spin_lock_init(&etsects
->lock
);
493 etsects
->regs
= ioremap(etsects
->rsrc
->start
,
494 1 + etsects
->rsrc
->end
- etsects
->rsrc
->start
);
495 if (!etsects
->regs
) {
496 pr_err("ioremap ptp registers failed\n");
499 getnstimeofday(&now
);
500 ptp_gianfar_settime(&etsects
->caps
, &now
);
503 (etsects
->tclk_period
& TCLK_PERIOD_MASK
) << TCLK_PERIOD_SHIFT
|
504 (etsects
->cksel
& CKSEL_MASK
) << CKSEL_SHIFT
;
506 spin_lock_irqsave(&etsects
->lock
, flags
);
508 gfar_write(&etsects
->regs
->tmr_ctrl
, tmr_ctrl
);
509 gfar_write(&etsects
->regs
->tmr_add
, etsects
->tmr_add
);
510 gfar_write(&etsects
->regs
->tmr_prsc
, etsects
->tmr_prsc
);
511 gfar_write(&etsects
->regs
->tmr_fiper1
, etsects
->tmr_fiper1
);
512 gfar_write(&etsects
->regs
->tmr_fiper2
, etsects
->tmr_fiper2
);
514 gfar_write(&etsects
->regs
->tmr_ctrl
, tmr_ctrl
|FS
|RTPE
|TE
);
516 spin_unlock_irqrestore(&etsects
->lock
, flags
);
518 etsects
->clock
= ptp_clock_register(&etsects
->caps
);
519 if (IS_ERR(etsects
->clock
)) {
520 err
= PTR_ERR(etsects
->clock
);
524 dev_set_drvdata(&dev
->dev
, etsects
);
530 release_resource(etsects
->rsrc
);
532 free_irq(etsects
->irq
, etsects
);
539 static int gianfar_ptp_remove(struct platform_device
*dev
)
541 struct etsects
*etsects
= dev_get_drvdata(&dev
->dev
);
543 gfar_write(&etsects
->regs
->tmr_temask
, 0);
544 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 operations */
572 static int __init
ptp_gianfar_init(void)
574 return platform_driver_register(&gianfar_ptp_driver
);
577 module_init(ptp_gianfar_init
);
579 static void __exit
ptp_gianfar_exit(void)
581 platform_driver_unregister(&gianfar_ptp_driver
);
584 module_exit(ptp_gianfar_exit
);
586 MODULE_AUTHOR("Richard Cochran <richard.cochran@omicron.at>");
587 MODULE_DESCRIPTION("PTP clock using the eTSEC");
588 MODULE_LICENSE("GPL");