1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * PTP 1588 clock for Freescale QorIQ 1588 timer
5 * Copyright (C) 2010 OMICRON electronics GmbH
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10 #include <linux/device.h>
11 #include <linux/hrtimer.h>
12 #include <linux/kernel.h>
13 #include <linux/module.h>
15 #include <linux/of_platform.h>
16 #include <linux/timex.h>
17 #include <linux/slab.h>
18 #include <linux/clk.h>
20 #include <linux/fsl/ptp_qoriq.h>
23 * Register access functions
26 /* Caller must hold ptp_qoriq->lock. */
27 static u64 tmr_cnt_read(struct ptp_qoriq *ptp_qoriq)
29 struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;
33 lo = ptp_qoriq->read(®s->ctrl_regs->tmr_cnt_l);
34 hi = ptp_qoriq->read(®s->ctrl_regs->tmr_cnt_h);
35 ns = ((u64) hi) << 32;
40 /* Caller must hold ptp_qoriq->lock. */
41 static void tmr_cnt_write(struct ptp_qoriq *ptp_qoriq, u64 ns)
43 struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;
45 u32 lo = ns & 0xffffffff;
47 ptp_qoriq->write(®s->ctrl_regs->tmr_cnt_l, lo);
48 ptp_qoriq->write(®s->ctrl_regs->tmr_cnt_h, hi);
51 /* Caller must hold ptp_qoriq->lock. */
52 static void set_alarm(struct ptp_qoriq *ptp_qoriq)
54 struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;
58 ns = tmr_cnt_read(ptp_qoriq) + 1500000000ULL;
59 ns = div_u64(ns, 1000000000UL) * 1000000000ULL;
60 ns -= ptp_qoriq->tclk_period;
63 ptp_qoriq->write(®s->alarm_regs->tmr_alarm1_l, lo);
64 ptp_qoriq->write(®s->alarm_regs->tmr_alarm1_h, hi);
67 /* Caller must hold ptp_qoriq->lock. */
68 static void set_fipers(struct ptp_qoriq *ptp_qoriq)
70 struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;
73 ptp_qoriq->write(®s->fiper_regs->tmr_fiper1, ptp_qoriq->tmr_fiper1);
74 ptp_qoriq->write(®s->fiper_regs->tmr_fiper2, ptp_qoriq->tmr_fiper2);
77 int extts_clean_up(struct ptp_qoriq *ptp_qoriq, int index, bool update_event)
79 struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;
80 struct ptp_clock_event event;
81 void __iomem *reg_etts_l;
82 void __iomem *reg_etts_h;
88 reg_etts_l = ®s->etts_regs->tmr_etts1_l;
89 reg_etts_h = ®s->etts_regs->tmr_etts1_h;
93 reg_etts_l = ®s->etts_regs->tmr_etts2_l;
94 reg_etts_h = ®s->etts_regs->tmr_etts2_h;
100 event.type = PTP_CLOCK_EXTTS;
103 if (ptp_qoriq->extts_fifo_support)
104 if (!(ptp_qoriq->read(®s->ctrl_regs->tmr_stat) & valid))
108 lo = ptp_qoriq->read(reg_etts_l);
109 hi = ptp_qoriq->read(reg_etts_h);
112 event.timestamp = ((u64) hi) << 32;
113 event.timestamp |= lo;
114 ptp_clock_event(ptp_qoriq->clock, &event);
117 if (!ptp_qoriq->extts_fifo_support)
119 } while (ptp_qoriq->read(®s->ctrl_regs->tmr_stat) & valid);
123 EXPORT_SYMBOL_GPL(extts_clean_up);
126 * Interrupt service routine
129 irqreturn_t ptp_qoriq_isr(int irq, void *priv)
131 struct ptp_qoriq *ptp_qoriq = priv;
132 struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;
133 struct ptp_clock_event event;
134 u32 ack = 0, mask, val, irqs;
136 spin_lock(&ptp_qoriq->lock);
138 val = ptp_qoriq->read(®s->ctrl_regs->tmr_tevent);
139 mask = ptp_qoriq->read(®s->ctrl_regs->tmr_temask);
141 spin_unlock(&ptp_qoriq->lock);
147 extts_clean_up(ptp_qoriq, 0, true);
152 extts_clean_up(ptp_qoriq, 1, true);
157 event.type = PTP_CLOCK_PPS;
158 ptp_clock_event(ptp_qoriq->clock, &event);
162 ptp_qoriq->write(®s->ctrl_regs->tmr_tevent, ack);
167 EXPORT_SYMBOL_GPL(ptp_qoriq_isr);
170 * PTP clock operations
173 int ptp_qoriq_adjfine(struct ptp_clock_info *ptp, long scaled_ppm)
178 struct ptp_qoriq *ptp_qoriq = container_of(ptp, struct ptp_qoriq, caps);
179 struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;
181 if (scaled_ppm < 0) {
183 scaled_ppm = -scaled_ppm;
185 tmr_add = ptp_qoriq->tmr_add;
188 /* calculate diff as adj*(scaled_ppm/65536)/1000000
189 * and round() to the nearest integer
192 diff = div_u64(adj, 8000000);
193 diff = (diff >> 13) + ((diff >> 12) & 1);
195 tmr_add = neg_adj ? tmr_add - diff : tmr_add + diff;
197 ptp_qoriq->write(®s->ctrl_regs->tmr_add, tmr_add);
201 EXPORT_SYMBOL_GPL(ptp_qoriq_adjfine);
203 int ptp_qoriq_adjtime(struct ptp_clock_info *ptp, s64 delta)
207 struct ptp_qoriq *ptp_qoriq = container_of(ptp, struct ptp_qoriq, caps);
209 spin_lock_irqsave(&ptp_qoriq->lock, flags);
211 now = tmr_cnt_read(ptp_qoriq);
213 tmr_cnt_write(ptp_qoriq, now);
214 set_fipers(ptp_qoriq);
216 spin_unlock_irqrestore(&ptp_qoriq->lock, flags);
220 EXPORT_SYMBOL_GPL(ptp_qoriq_adjtime);
222 int ptp_qoriq_gettime(struct ptp_clock_info *ptp, struct timespec64 *ts)
226 struct ptp_qoriq *ptp_qoriq = container_of(ptp, struct ptp_qoriq, caps);
228 spin_lock_irqsave(&ptp_qoriq->lock, flags);
230 ns = tmr_cnt_read(ptp_qoriq);
232 spin_unlock_irqrestore(&ptp_qoriq->lock, flags);
234 *ts = ns_to_timespec64(ns);
238 EXPORT_SYMBOL_GPL(ptp_qoriq_gettime);
240 int ptp_qoriq_settime(struct ptp_clock_info *ptp,
241 const struct timespec64 *ts)
245 struct ptp_qoriq *ptp_qoriq = container_of(ptp, struct ptp_qoriq, caps);
247 ns = timespec64_to_ns(ts);
249 spin_lock_irqsave(&ptp_qoriq->lock, flags);
251 tmr_cnt_write(ptp_qoriq, ns);
252 set_fipers(ptp_qoriq);
254 spin_unlock_irqrestore(&ptp_qoriq->lock, flags);
258 EXPORT_SYMBOL_GPL(ptp_qoriq_settime);
260 int ptp_qoriq_enable(struct ptp_clock_info *ptp,
261 struct ptp_clock_request *rq, int on)
263 struct ptp_qoriq *ptp_qoriq = container_of(ptp, struct ptp_qoriq, caps);
264 struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;
269 case PTP_CLK_REQ_EXTTS:
270 switch (rq->extts.index) {
282 extts_clean_up(ptp_qoriq, rq->extts.index, false);
285 case PTP_CLK_REQ_PPS:
292 spin_lock_irqsave(&ptp_qoriq->lock, flags);
294 mask = ptp_qoriq->read(®s->ctrl_regs->tmr_temask);
297 ptp_qoriq->write(®s->ctrl_regs->tmr_tevent, bit);
302 ptp_qoriq->write(®s->ctrl_regs->tmr_temask, mask);
304 spin_unlock_irqrestore(&ptp_qoriq->lock, flags);
307 EXPORT_SYMBOL_GPL(ptp_qoriq_enable);
309 static const struct ptp_clock_info ptp_qoriq_caps = {
310 .owner = THIS_MODULE,
311 .name = "qoriq ptp clock",
314 .n_ext_ts = N_EXT_TS,
318 .adjfine = ptp_qoriq_adjfine,
319 .adjtime = ptp_qoriq_adjtime,
320 .gettime64 = ptp_qoriq_gettime,
321 .settime64 = ptp_qoriq_settime,
322 .enable = ptp_qoriq_enable,
326 * ptp_qoriq_nominal_freq - calculate nominal frequency according to
327 * reference clock frequency
329 * @clk_src: reference clock frequency
331 * The nominal frequency is the desired clock frequency.
332 * It should be less than the reference clock frequency.
333 * It should be a factor of 1000MHz.
335 * Return the nominal frequency
337 static u32 ptp_qoriq_nominal_freq(u32 clk_src)
342 remainder = clk_src % 100;
344 clk_src -= remainder;
351 } while (1000 % clk_src);
353 return clk_src * 1000000;
357 * ptp_qoriq_auto_config - calculate a set of default configurations
359 * @ptp_qoriq: pointer to ptp_qoriq
360 * @node: pointer to device_node
362 * If below dts properties are not provided, this function will be
363 * called to calculate a set of default configurations for them.
371 * Return 0 if success
373 static int ptp_qoriq_auto_config(struct ptp_qoriq *ptp_qoriq,
374 struct device_node *node)
383 ptp_qoriq->cksel = DEFAULT_CKSEL;
385 clk = of_clk_get(node, 0);
387 clk_src = clk_get_rate(clk);
391 if (clk_src <= 100000000UL) {
392 pr_err("error reference clock value, or lower than 100MHz\n");
396 nominal_freq = ptp_qoriq_nominal_freq(clk_src);
400 ptp_qoriq->tclk_period = 1000000000UL / nominal_freq;
401 ptp_qoriq->tmr_prsc = DEFAULT_TMR_PRSC;
403 /* Calculate initial frequency compensation value for TMR_ADD register.
404 * freq_comp = ceil(2^32 / freq_ratio)
405 * freq_ratio = reference_clock_freq / nominal_freq
407 freq_comp = ((u64)1 << 32) * nominal_freq;
408 freq_comp = div_u64_rem(freq_comp, clk_src, &remainder);
412 ptp_qoriq->tmr_add = freq_comp;
413 ptp_qoriq->tmr_fiper1 = DEFAULT_FIPER1_PERIOD - ptp_qoriq->tclk_period;
414 ptp_qoriq->tmr_fiper2 = DEFAULT_FIPER2_PERIOD - ptp_qoriq->tclk_period;
416 /* max_adj = 1000000000 * (freq_ratio - 1.0) - 1
417 * freq_ratio = reference_clock_freq / nominal_freq
419 max_adj = 1000000000ULL * (clk_src - nominal_freq);
420 max_adj = div_u64(max_adj, nominal_freq) - 1;
421 ptp_qoriq->caps.max_adj = max_adj;
426 int ptp_qoriq_init(struct ptp_qoriq *ptp_qoriq, void __iomem *base,
427 const struct ptp_clock_info *caps)
429 struct device_node *node = ptp_qoriq->dev->of_node;
430 struct ptp_qoriq_registers *regs;
431 struct timespec64 now;
438 ptp_qoriq->base = base;
439 ptp_qoriq->caps = *caps;
441 if (of_property_read_u32(node, "fsl,cksel", &ptp_qoriq->cksel))
442 ptp_qoriq->cksel = DEFAULT_CKSEL;
444 if (of_property_read_bool(node, "fsl,extts-fifo"))
445 ptp_qoriq->extts_fifo_support = true;
447 ptp_qoriq->extts_fifo_support = false;
449 if (of_property_read_u32(node,
450 "fsl,tclk-period", &ptp_qoriq->tclk_period) ||
451 of_property_read_u32(node,
452 "fsl,tmr-prsc", &ptp_qoriq->tmr_prsc) ||
453 of_property_read_u32(node,
454 "fsl,tmr-add", &ptp_qoriq->tmr_add) ||
455 of_property_read_u32(node,
456 "fsl,tmr-fiper1", &ptp_qoriq->tmr_fiper1) ||
457 of_property_read_u32(node,
458 "fsl,tmr-fiper2", &ptp_qoriq->tmr_fiper2) ||
459 of_property_read_u32(node,
460 "fsl,max-adj", &ptp_qoriq->caps.max_adj)) {
461 pr_warn("device tree node missing required elements, try automatic configuration\n");
463 if (ptp_qoriq_auto_config(ptp_qoriq, node))
467 if (of_property_read_bool(node, "little-endian")) {
468 ptp_qoriq->read = qoriq_read_le;
469 ptp_qoriq->write = qoriq_write_le;
471 ptp_qoriq->read = qoriq_read_be;
472 ptp_qoriq->write = qoriq_write_be;
475 /* The eTSEC uses differnt memory map with DPAA/ENETC */
476 if (of_device_is_compatible(node, "fsl,etsec-ptp")) {
477 ptp_qoriq->regs.ctrl_regs = base + ETSEC_CTRL_REGS_OFFSET;
478 ptp_qoriq->regs.alarm_regs = base + ETSEC_ALARM_REGS_OFFSET;
479 ptp_qoriq->regs.fiper_regs = base + ETSEC_FIPER_REGS_OFFSET;
480 ptp_qoriq->regs.etts_regs = base + ETSEC_ETTS_REGS_OFFSET;
482 ptp_qoriq->regs.ctrl_regs = base + CTRL_REGS_OFFSET;
483 ptp_qoriq->regs.alarm_regs = base + ALARM_REGS_OFFSET;
484 ptp_qoriq->regs.fiper_regs = base + FIPER_REGS_OFFSET;
485 ptp_qoriq->regs.etts_regs = base + ETTS_REGS_OFFSET;
488 spin_lock_init(&ptp_qoriq->lock);
490 ktime_get_real_ts64(&now);
491 ptp_qoriq_settime(&ptp_qoriq->caps, &now);
494 (ptp_qoriq->tclk_period & TCLK_PERIOD_MASK) << TCLK_PERIOD_SHIFT |
495 (ptp_qoriq->cksel & CKSEL_MASK) << CKSEL_SHIFT;
497 spin_lock_irqsave(&ptp_qoriq->lock, flags);
499 regs = &ptp_qoriq->regs;
500 ptp_qoriq->write(®s->ctrl_regs->tmr_ctrl, tmr_ctrl);
501 ptp_qoriq->write(®s->ctrl_regs->tmr_add, ptp_qoriq->tmr_add);
502 ptp_qoriq->write(®s->ctrl_regs->tmr_prsc, ptp_qoriq->tmr_prsc);
503 ptp_qoriq->write(®s->fiper_regs->tmr_fiper1, ptp_qoriq->tmr_fiper1);
504 ptp_qoriq->write(®s->fiper_regs->tmr_fiper2, ptp_qoriq->tmr_fiper2);
505 set_alarm(ptp_qoriq);
506 ptp_qoriq->write(®s->ctrl_regs->tmr_ctrl,
507 tmr_ctrl|FIPERST|RTPE|TE|FRD);
509 spin_unlock_irqrestore(&ptp_qoriq->lock, flags);
511 ptp_qoriq->clock = ptp_clock_register(&ptp_qoriq->caps, ptp_qoriq->dev);
512 if (IS_ERR(ptp_qoriq->clock))
513 return PTR_ERR(ptp_qoriq->clock);
515 ptp_qoriq->phc_index = ptp_clock_index(ptp_qoriq->clock);
516 ptp_qoriq_create_debugfs(ptp_qoriq);
519 EXPORT_SYMBOL_GPL(ptp_qoriq_init);
521 void ptp_qoriq_free(struct ptp_qoriq *ptp_qoriq)
523 struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;
525 ptp_qoriq->write(®s->ctrl_regs->tmr_temask, 0);
526 ptp_qoriq->write(®s->ctrl_regs->tmr_ctrl, 0);
528 ptp_qoriq_remove_debugfs(ptp_qoriq);
529 ptp_clock_unregister(ptp_qoriq->clock);
530 iounmap(ptp_qoriq->base);
531 free_irq(ptp_qoriq->irq, ptp_qoriq);
533 EXPORT_SYMBOL_GPL(ptp_qoriq_free);
535 static int ptp_qoriq_probe(struct platform_device *dev)
537 struct ptp_qoriq *ptp_qoriq;
541 ptp_qoriq = kzalloc(sizeof(*ptp_qoriq), GFP_KERNEL);
545 ptp_qoriq->dev = &dev->dev;
549 ptp_qoriq->irq = platform_get_irq(dev, 0);
550 if (ptp_qoriq->irq < 0) {
551 pr_err("irq not in device tree\n");
554 if (request_irq(ptp_qoriq->irq, ptp_qoriq_isr, IRQF_SHARED,
555 DRIVER, ptp_qoriq)) {
556 pr_err("request_irq failed\n");
560 ptp_qoriq->rsrc = platform_get_resource(dev, IORESOURCE_MEM, 0);
561 if (!ptp_qoriq->rsrc) {
562 pr_err("no resource\n");
565 if (request_resource(&iomem_resource, ptp_qoriq->rsrc)) {
566 pr_err("resource busy\n");
570 base = ioremap(ptp_qoriq->rsrc->start,
571 resource_size(ptp_qoriq->rsrc));
573 pr_err("ioremap ptp registers failed\n");
577 err = ptp_qoriq_init(ptp_qoriq, base, &ptp_qoriq_caps);
581 platform_set_drvdata(dev, ptp_qoriq);
585 iounmap(ptp_qoriq->base);
587 release_resource(ptp_qoriq->rsrc);
589 free_irq(ptp_qoriq->irq, ptp_qoriq);
596 static int ptp_qoriq_remove(struct platform_device *dev)
598 struct ptp_qoriq *ptp_qoriq = platform_get_drvdata(dev);
600 ptp_qoriq_free(ptp_qoriq);
601 release_resource(ptp_qoriq->rsrc);
606 static const struct of_device_id match_table[] = {
607 { .compatible = "fsl,etsec-ptp" },
608 { .compatible = "fsl,fman-ptp-timer" },
611 MODULE_DEVICE_TABLE(of, match_table);
613 static struct platform_driver ptp_qoriq_driver = {
616 .of_match_table = match_table,
618 .probe = ptp_qoriq_probe,
619 .remove = ptp_qoriq_remove,
622 module_platform_driver(ptp_qoriq_driver);
624 MODULE_AUTHOR("Richard Cochran <richardcochran@gmail.com>");
625 MODULE_DESCRIPTION("PTP clock for Freescale QorIQ 1588 timer");
626 MODULE_LICENSE("GPL");