Version:  2.0.40 2.2.26 2.4.37 3.13 3.14 3.15 3.16 3.17 3.18 3.19 4.0 4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.9 4.10

Linux/drivers/net/ethernet/freescale/gianfar_ptp.c

  1 /*
  2  * PTP 1588 clock using the eTSEC
  3  *
  4  * Copyright (C) 2010 OMICRON electronics GmbH
  5  *
  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.
 10  *
 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.
 15  *
 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.
 19  */
 20 
 21 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
 22 
 23 #include <linux/device.h>
 24 #include <linux/hrtimer.h>
 25 #include <linux/interrupt.h>
 26 #include <linux/kernel.h>
 27 #include <linux/module.h>
 28 #include <linux/of.h>
 29 #include <linux/of_platform.h>
 30 #include <linux/timex.h>
 31 #include <linux/io.h>
 32 
 33 #include <linux/ptp_clock_kernel.h>
 34 
 35 #include "gianfar.h"
 36 
 37 /*
 38  * gianfar ptp registers
 39  * Generated by regen.tcl on Thu May 13 01:38:57 PM CEST 2010
 40  */
 41 struct gianfar_ptp_registers {
 42         u32 tmr_ctrl;     /* Timer control register */
 43         u32 tmr_tevent;   /* Timestamp event register */
 44         u32 tmr_temask;   /* Timer event mask register */
 45         u32 tmr_pevent;   /* Timestamp event register */
 46         u32 tmr_pemask;   /* Timer event mask register */
 47         u32 tmr_stat;     /* Timestamp status register */
 48         u32 tmr_cnt_h;    /* Timer counter high register */
 49         u32 tmr_cnt_l;    /* Timer counter low register */
 50         u32 tmr_add;      /* Timer drift compensation addend register */
 51         u32 tmr_acc;      /* Timer accumulator register */
 52         u32 tmr_prsc;     /* Timer prescale */
 53         u8  res1[4];
 54         u32 tmroff_h;     /* Timer offset high */
 55         u32 tmroff_l;     /* Timer offset low */
 56         u8  res2[8];
 57         u32 tmr_alarm1_h; /* Timer alarm 1 high register */
 58         u32 tmr_alarm1_l; /* Timer alarm 1 high register */
 59         u32 tmr_alarm2_h; /* Timer alarm 2 high register */
 60         u32 tmr_alarm2_l; /* Timer alarm 2 high register */
 61         u8  res3[48];
 62         u32 tmr_fiper1;   /* Timer fixed period interval */
 63         u32 tmr_fiper2;   /* Timer fixed period interval */
 64         u32 tmr_fiper3;   /* Timer fixed period interval */
 65         u8  res4[20];
 66         u32 tmr_etts1_h;  /* Timestamp of general purpose external trigger */
 67         u32 tmr_etts1_l;  /* Timestamp of general purpose external trigger */
 68         u32 tmr_etts2_h;  /* Timestamp of general purpose external trigger */
 69         u32 tmr_etts2_l;  /* Timestamp of general purpose external trigger */
 70 };
 71 
 72 /* Bit definitions for the TMR_CTRL register */
 73 #define ALM1P                 (1<<31) /* Alarm1 output polarity */
 74 #define ALM2P                 (1<<30) /* Alarm2 output polarity */
 75 #define FIPERST               (1<<28) /* FIPER start indication */
 76 #define PP1L                  (1<<27) /* Fiper1 pulse loopback mode enabled. */
 77 #define PP2L                  (1<<26) /* Fiper2 pulse loopback mode enabled. */
 78 #define TCLK_PERIOD_SHIFT     (16) /* 1588 timer reference clock period. */
 79 #define TCLK_PERIOD_MASK      (0x3ff)
 80 #define RTPE                  (1<<15) /* Record Tx Timestamp to PAL Enable. */
 81 #define FRD                   (1<<14) /* FIPER Realignment Disable */
 82 #define ESFDP                 (1<<11) /* External Tx/Rx SFD Polarity. */
 83 #define ESFDE                 (1<<10) /* External Tx/Rx SFD Enable. */
 84 #define ETEP2                 (1<<9) /* External trigger 2 edge polarity */
 85 #define ETEP1                 (1<<8) /* External trigger 1 edge polarity */
 86 #define COPH                  (1<<7) /* Generated clock output phase. */
 87 #define CIPH                  (1<<6) /* External oscillator input clock phase */
 88 #define TMSR                  (1<<5) /* Timer soft reset. */
 89 #define BYP                   (1<<3) /* Bypass drift compensated clock */
 90 #define TE                    (1<<2) /* 1588 timer enable. */
 91 #define CKSEL_SHIFT           (0)    /* 1588 Timer reference clock source */
 92 #define CKSEL_MASK            (0x3)
 93 
 94 /* Bit definitions for the TMR_TEVENT register */
 95 #define ETS2                  (1<<25) /* External trigger 2 timestamp sampled */
 96 #define ETS1                  (1<<24) /* External trigger 1 timestamp sampled */
 97 #define ALM2                  (1<<17) /* Current time = alarm time register 2 */
 98 #define ALM1                  (1<<16) /* Current time = alarm time register 1 */
 99 #define PP1                   (1<<7)  /* periodic pulse generated on FIPER1 */
100 #define PP2                   (1<<6)  /* periodic pulse generated on FIPER2 */
101 #define PP3                   (1<<5)  /* periodic pulse generated on FIPER3 */
102 
103 /* Bit definitions for the TMR_TEMASK register */
104 #define ETS2EN                (1<<25) /* External trigger 2 timestamp enable */
105 #define ETS1EN                (1<<24) /* External trigger 1 timestamp enable */
106 #define ALM2EN                (1<<17) /* Timer ALM2 event enable */
107 #define ALM1EN                (1<<16) /* Timer ALM1 event enable */
108 #define PP1EN                 (1<<7) /* Periodic pulse event 1 enable */
109 #define PP2EN                 (1<<6) /* Periodic pulse event 2 enable */
110 
111 /* Bit definitions for the TMR_PEVENT register */
112 #define TXP2                  (1<<9) /* PTP transmitted timestamp im TXTS2 */
113 #define TXP1                  (1<<8) /* PTP transmitted timestamp in TXTS1 */
114 #define RXP                   (1<<0) /* PTP frame has been received */
115 
116 /* Bit definitions for the TMR_PEMASK register */
117 #define TXP2EN                (1<<9) /* Transmit PTP packet event 2 enable */
118 #define TXP1EN                (1<<8) /* Transmit PTP packet event 1 enable */
119 #define RXPEN                 (1<<0) /* Receive PTP packet event enable */
120 
121 /* Bit definitions for the TMR_STAT register */
122 #define STAT_VEC_SHIFT        (0) /* Timer general purpose status vector */
123 #define STAT_VEC_MASK         (0x3f)
124 
125 /* Bit definitions for the TMR_PRSC register */
126 #define PRSC_OCK_SHIFT        (0) /* Output clock division/prescale factor. */
127 #define PRSC_OCK_MASK         (0xffff)
128 
129 
130 #define DRIVER          "gianfar_ptp"
131 #define DEFAULT_CKSEL   1
132 #define N_EXT_TS        2
133 #define REG_SIZE        sizeof(struct gianfar_ptp_registers)
134 
135 struct etsects {
136         struct gianfar_ptp_registers __iomem *regs;
137         spinlock_t lock; /* protects regs */
138         struct ptp_clock *clock;
139         struct ptp_clock_info caps;
140         struct resource *rsrc;
141         int irq;
142         u64 alarm_interval; /* for periodic alarm */
143         u64 alarm_value;
144         u32 tclk_period;  /* nanoseconds */
145         u32 tmr_prsc;
146         u32 tmr_add;
147         u32 cksel;
148         u32 tmr_fiper1;
149         u32 tmr_fiper2;
150 };
151 
152 /*
153  * Register access functions
154  */
155 
156 /* Caller must hold etsects->lock. */
157 static u64 tmr_cnt_read(struct etsects *etsects)
158 {
159         u64 ns;
160         u32 lo, hi;
161 
162         lo = gfar_read(&etsects->regs->tmr_cnt_l);
163         hi = gfar_read(&etsects->regs->tmr_cnt_h);
164         ns = ((u64) hi) << 32;
165         ns |= lo;
166         return ns;
167 }
168 
169 /* Caller must hold etsects->lock. */
170 static void tmr_cnt_write(struct etsects *etsects, u64 ns)
171 {
172         u32 hi = ns >> 32;
173         u32 lo = ns & 0xffffffff;
174 
175         gfar_write(&etsects->regs->tmr_cnt_l, lo);
176         gfar_write(&etsects->regs->tmr_cnt_h, hi);
177 }
178 
179 /* Caller must hold etsects->lock. */
180 static void set_alarm(struct etsects *etsects)
181 {
182         u64 ns;
183         u32 lo, hi;
184 
185         ns = tmr_cnt_read(etsects) + 1500000000ULL;
186         ns = div_u64(ns, 1000000000UL) * 1000000000ULL;
187         ns -= etsects->tclk_period;
188         hi = ns >> 32;
189         lo = ns & 0xffffffff;
190         gfar_write(&etsects->regs->tmr_alarm1_l, lo);
191         gfar_write(&etsects->regs->tmr_alarm1_h, hi);
192 }
193 
194 /* Caller must hold etsects->lock. */
195 static void set_fipers(struct etsects *etsects)
196 {
197         set_alarm(etsects);
198         gfar_write(&etsects->regs->tmr_fiper1, etsects->tmr_fiper1);
199         gfar_write(&etsects->regs->tmr_fiper2, etsects->tmr_fiper2);
200 }
201 
202 /*
203  * Interrupt service routine
204  */
205 
206 static irqreturn_t isr(int irq, void *priv)
207 {
208         struct etsects *etsects = priv;
209         struct ptp_clock_event event;
210         u64 ns;
211         u32 ack = 0, lo, hi, mask, val;
212 
213         val = gfar_read(&etsects->regs->tmr_tevent);
214 
215         if (val & ETS1) {
216                 ack |= ETS1;
217                 hi = gfar_read(&etsects->regs->tmr_etts1_h);
218                 lo = gfar_read(&etsects->regs->tmr_etts1_l);
219                 event.type = PTP_CLOCK_EXTTS;
220                 event.index = 0;
221                 event.timestamp = ((u64) hi) << 32;
222                 event.timestamp |= lo;
223                 ptp_clock_event(etsects->clock, &event);
224         }
225 
226         if (val & ETS2) {
227                 ack |= ETS2;
228                 hi = gfar_read(&etsects->regs->tmr_etts2_h);
229                 lo = gfar_read(&etsects->regs->tmr_etts2_l);
230                 event.type = PTP_CLOCK_EXTTS;
231                 event.index = 1;
232                 event.timestamp = ((u64) hi) << 32;
233                 event.timestamp |= lo;
234                 ptp_clock_event(etsects->clock, &event);
235         }
236 
237         if (val & ALM2) {
238                 ack |= ALM2;
239                 if (etsects->alarm_value) {
240                         event.type = PTP_CLOCK_ALARM;
241                         event.index = 0;
242                         event.timestamp = etsects->alarm_value;
243                         ptp_clock_event(etsects->clock, &event);
244                 }
245                 if (etsects->alarm_interval) {
246                         ns = etsects->alarm_value + etsects->alarm_interval;
247                         hi = ns >> 32;
248                         lo = ns & 0xffffffff;
249                         spin_lock(&etsects->lock);
250                         gfar_write(&etsects->regs->tmr_alarm2_l, lo);
251                         gfar_write(&etsects->regs->tmr_alarm2_h, hi);
252                         spin_unlock(&etsects->lock);
253                         etsects->alarm_value = ns;
254                 } else {
255                         gfar_write(&etsects->regs->tmr_tevent, ALM2);
256                         spin_lock(&etsects->lock);
257                         mask = gfar_read(&etsects->regs->tmr_temask);
258                         mask &= ~ALM2EN;
259                         gfar_write(&etsects->regs->tmr_temask, mask);
260                         spin_unlock(&etsects->lock);
261                         etsects->alarm_value = 0;
262                         etsects->alarm_interval = 0;
263                 }
264         }
265 
266         if (val & PP1) {
267                 ack |= PP1;
268                 event.type = PTP_CLOCK_PPS;
269                 ptp_clock_event(etsects->clock, &event);
270         }
271 
272         if (ack) {
273                 gfar_write(&etsects->regs->tmr_tevent, ack);
274                 return IRQ_HANDLED;
275         } else
276                 return IRQ_NONE;
277 }
278 
279 /*
280  * PTP clock operations
281  */
282 
283 static int ptp_gianfar_adjfine(struct ptp_clock_info *ptp, long scaled_ppm)
284 {
285         u64 adj, diff;
286         u32 tmr_add;
287         int neg_adj = 0;
288         struct etsects *etsects = container_of(ptp, struct etsects, caps);
289 
290         if (scaled_ppm < 0) {
291                 neg_adj = 1;
292                 scaled_ppm = -scaled_ppm;
293         }
294         tmr_add = etsects->tmr_add;
295         adj = tmr_add;
296 
297         /* calculate diff as adj*(scaled_ppm/65536)/1000000
298          * and round() to the nearest integer
299          */
300         adj *= scaled_ppm;
301         diff = div_u64(adj, 8000000);
302         diff = (diff >> 13) + ((diff >> 12) & 1);
303 
304         tmr_add = neg_adj ? tmr_add - diff : tmr_add + diff;
305 
306         gfar_write(&etsects->regs->tmr_add, tmr_add);
307 
308         return 0;
309 }
310 
311 static int ptp_gianfar_adjtime(struct ptp_clock_info *ptp, s64 delta)
312 {
313         s64 now;
314         unsigned long flags;
315         struct etsects *etsects = container_of(ptp, struct etsects, caps);
316 
317         spin_lock_irqsave(&etsects->lock, flags);
318 
319         now = tmr_cnt_read(etsects);
320         now += delta;
321         tmr_cnt_write(etsects, now);
322 
323         spin_unlock_irqrestore(&etsects->lock, flags);
324 
325         set_fipers(etsects);
326 
327         return 0;
328 }
329 
330 static int ptp_gianfar_gettime(struct ptp_clock_info *ptp,
331                                struct timespec64 *ts)
332 {
333         u64 ns;
334         unsigned long flags;
335         struct etsects *etsects = container_of(ptp, struct etsects, caps);
336 
337         spin_lock_irqsave(&etsects->lock, flags);
338 
339         ns = tmr_cnt_read(etsects);
340 
341         spin_unlock_irqrestore(&etsects->lock, flags);
342 
343         *ts = ns_to_timespec64(ns);
344 
345         return 0;
346 }
347 
348 static int ptp_gianfar_settime(struct ptp_clock_info *ptp,
349                                const struct timespec64 *ts)
350 {
351         u64 ns;
352         unsigned long flags;
353         struct etsects *etsects = container_of(ptp, struct etsects, caps);
354 
355         ns = timespec64_to_ns(ts);
356 
357         spin_lock_irqsave(&etsects->lock, flags);
358 
359         tmr_cnt_write(etsects, ns);
360         set_fipers(etsects);
361 
362         spin_unlock_irqrestore(&etsects->lock, flags);
363 
364         return 0;
365 }
366 
367 static int ptp_gianfar_enable(struct ptp_clock_info *ptp,
368                               struct ptp_clock_request *rq, int on)
369 {
370         struct etsects *etsects = container_of(ptp, struct etsects, caps);
371         unsigned long flags;
372         u32 bit, mask;
373 
374         switch (rq->type) {
375         case PTP_CLK_REQ_EXTTS:
376                 switch (rq->extts.index) {
377                 case 0:
378                         bit = ETS1EN;
379                         break;
380                 case 1:
381                         bit = ETS2EN;
382                         break;
383                 default:
384                         return -EINVAL;
385                 }
386                 spin_lock_irqsave(&etsects->lock, flags);
387                 mask = gfar_read(&etsects->regs->tmr_temask);
388                 if (on)
389                         mask |= bit;
390                 else
391                         mask &= ~bit;
392                 gfar_write(&etsects->regs->tmr_temask, mask);
393                 spin_unlock_irqrestore(&etsects->lock, flags);
394                 return 0;
395 
396         case PTP_CLK_REQ_PPS:
397                 spin_lock_irqsave(&etsects->lock, flags);
398                 mask = gfar_read(&etsects->regs->tmr_temask);
399                 if (on)
400                         mask |= PP1EN;
401                 else
402                         mask &= ~PP1EN;
403                 gfar_write(&etsects->regs->tmr_temask, mask);
404                 spin_unlock_irqrestore(&etsects->lock, flags);
405                 return 0;
406 
407         default:
408                 break;
409         }
410 
411         return -EOPNOTSUPP;
412 }
413 
414 static struct ptp_clock_info ptp_gianfar_caps = {
415         .owner          = THIS_MODULE,
416         .name           = "gianfar clock",
417         .max_adj        = 512000,
418         .n_alarm        = 0,
419         .n_ext_ts       = N_EXT_TS,
420         .n_per_out      = 0,
421         .n_pins         = 0,
422         .pps            = 1,
423         .adjfine        = ptp_gianfar_adjfine,
424         .adjtime        = ptp_gianfar_adjtime,
425         .gettime64      = ptp_gianfar_gettime,
426         .settime64      = ptp_gianfar_settime,
427         .enable         = ptp_gianfar_enable,
428 };
429 
430 static int gianfar_ptp_probe(struct platform_device *dev)
431 {
432         struct device_node *node = dev->dev.of_node;
433         struct etsects *etsects;
434         struct timespec64 now;
435         int err = -ENOMEM;
436         u32 tmr_ctrl;
437         unsigned long flags;
438 
439         etsects = kzalloc(sizeof(*etsects), GFP_KERNEL);
440         if (!etsects)
441                 goto no_memory;
442 
443         err = -ENODEV;
444 
445         etsects->caps = ptp_gianfar_caps;
446 
447         if (of_property_read_u32(node, "fsl,cksel", &etsects->cksel))
448                 etsects->cksel = DEFAULT_CKSEL;
449 
450         if (of_property_read_u32(node,
451                                  "fsl,tclk-period", &etsects->tclk_period) ||
452             of_property_read_u32(node,
453                                  "fsl,tmr-prsc", &etsects->tmr_prsc) ||
454             of_property_read_u32(node,
455                                  "fsl,tmr-add", &etsects->tmr_add) ||
456             of_property_read_u32(node,
457                                  "fsl,tmr-fiper1", &etsects->tmr_fiper1) ||
458             of_property_read_u32(node,
459                                  "fsl,tmr-fiper2", &etsects->tmr_fiper2) ||
460             of_property_read_u32(node,
461                                  "fsl,max-adj", &etsects->caps.max_adj)) {
462                 pr_err("device tree node missing required elements\n");
463                 goto no_node;
464         }
465 
466         etsects->irq = platform_get_irq(dev, 0);
467 
468         if (etsects->irq < 0) {
469                 pr_err("irq not in device tree\n");
470                 goto no_node;
471         }
472         if (request_irq(etsects->irq, isr, 0, DRIVER, etsects)) {
473                 pr_err("request_irq failed\n");
474                 goto no_node;
475         }
476 
477         etsects->rsrc = platform_get_resource(dev, IORESOURCE_MEM, 0);
478         if (!etsects->rsrc) {
479                 pr_err("no resource\n");
480                 goto no_resource;
481         }
482         if (request_resource(&iomem_resource, etsects->rsrc)) {
483                 pr_err("resource busy\n");
484                 goto no_resource;
485         }
486 
487         spin_lock_init(&etsects->lock);
488 
489         etsects->regs = ioremap(etsects->rsrc->start,
490                                 resource_size(etsects->rsrc));
491         if (!etsects->regs) {
492                 pr_err("ioremap ptp registers failed\n");
493                 goto no_ioremap;
494         }
495         getnstimeofday64(&now);
496         ptp_gianfar_settime(&etsects->caps, &now);
497 
498         tmr_ctrl =
499           (etsects->tclk_period & TCLK_PERIOD_MASK) << TCLK_PERIOD_SHIFT |
500           (etsects->cksel & CKSEL_MASK) << CKSEL_SHIFT;
501 
502         spin_lock_irqsave(&etsects->lock, flags);
503 
504         gfar_write(&etsects->regs->tmr_ctrl,   tmr_ctrl);
505         gfar_write(&etsects->regs->tmr_add,    etsects->tmr_add);
506         gfar_write(&etsects->regs->tmr_prsc,   etsects->tmr_prsc);
507         gfar_write(&etsects->regs->tmr_fiper1, etsects->tmr_fiper1);
508         gfar_write(&etsects->regs->tmr_fiper2, etsects->tmr_fiper2);
509         set_alarm(etsects);
510         gfar_write(&etsects->regs->tmr_ctrl,   tmr_ctrl|FIPERST|RTPE|TE|FRD);
511 
512         spin_unlock_irqrestore(&etsects->lock, flags);
513 
514         etsects->clock = ptp_clock_register(&etsects->caps, &dev->dev);
515         if (IS_ERR(etsects->clock)) {
516                 err = PTR_ERR(etsects->clock);
517                 goto no_clock;
518         }
519         gfar_phc_index = ptp_clock_index(etsects->clock);
520 
521         platform_set_drvdata(dev, etsects);
522 
523         return 0;
524 
525 no_clock:
526         iounmap(etsects->regs);
527 no_ioremap:
528         release_resource(etsects->rsrc);
529 no_resource:
530         free_irq(etsects->irq, etsects);
531 no_node:
532         kfree(etsects);
533 no_memory:
534         return err;
535 }
536 
537 static int gianfar_ptp_remove(struct platform_device *dev)
538 {
539         struct etsects *etsects = platform_get_drvdata(dev);
540 
541         gfar_write(&etsects->regs->tmr_temask, 0);
542         gfar_write(&etsects->regs->tmr_ctrl,   0);
543 
544         gfar_phc_index = -1;
545         ptp_clock_unregister(etsects->clock);
546         iounmap(etsects->regs);
547         release_resource(etsects->rsrc);
548         free_irq(etsects->irq, etsects);
549         kfree(etsects);
550 
551         return 0;
552 }
553 
554 static const struct of_device_id match_table[] = {
555         { .compatible = "fsl,etsec-ptp" },
556         {},
557 };
558 MODULE_DEVICE_TABLE(of, match_table);
559 
560 static struct platform_driver gianfar_ptp_driver = {
561         .driver = {
562                 .name           = "gianfar_ptp",
563                 .of_match_table = match_table,
564         },
565         .probe       = gianfar_ptp_probe,
566         .remove      = gianfar_ptp_remove,
567 };
568 
569 module_platform_driver(gianfar_ptp_driver);
570 
571 MODULE_AUTHOR("Richard Cochran <richardcochran@gmail.com>");
572 MODULE_DESCRIPTION("PTP clock using the eTSEC");
573 MODULE_LICENSE("GPL");
574 

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us