1 // SPDX-License-Identifier: GPL-2.0-or-later
3  * PTP 1588 clock for Freescale QorIQ 1588 timer
26 /* Caller must hold ptp_qoriq->lock. */
29 	struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;  in tmr_cnt_read()
33 	lo = ptp_qoriq->read(&regs->ctrl_regs->tmr_cnt_l);  in tmr_cnt_read()
34 	hi = ptp_qoriq->read(&regs->ctrl_regs->tmr_cnt_h);  in tmr_cnt_read()
40 /* Caller must hold ptp_qoriq->lock. */
43 	struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;  in tmr_cnt_write()
47 	ptp_qoriq->write(&regs->ctrl_regs->tmr_cnt_l, lo);  in tmr_cnt_write()
48 	ptp_qoriq->write(&regs->ctrl_regs->tmr_cnt_h, hi);  in tmr_cnt_write()
53 	struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;  in tmr_offset_read()
57 	lo = ptp_qoriq->read(&regs->ctrl_regs->tmroff_l);  in tmr_offset_read()
58 	hi = ptp_qoriq->read(&regs->ctrl_regs->tmroff_h);  in tmr_offset_read()
66 	struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;  in tmr_offset_write()
70 	ptp_qoriq->write(&regs->ctrl_regs->tmroff_l, lo);  in tmr_offset_write()
71 	ptp_qoriq->write(&regs->ctrl_regs->tmroff_h, hi);  in tmr_offset_write()
74 /* Caller must hold ptp_qoriq->lock. */
77 	struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;  in set_alarm()
85 	ns -= ptp_qoriq->tclk_period;  in set_alarm()
88 	ptp_qoriq->write(&regs->alarm_regs->tmr_alarm1_l, lo);  in set_alarm()
89 	ptp_qoriq->write(&regs->alarm_regs->tmr_alarm1_h, hi);  in set_alarm()
92 /* Caller must hold ptp_qoriq->lock. */
95 	struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;  in set_fipers()
98 	ptp_qoriq->write(&regs->fiper_regs->tmr_fiper1, ptp_qoriq->tmr_fiper1);  in set_fipers()
99 	ptp_qoriq->write(&regs->fiper_regs->tmr_fiper2, ptp_qoriq->tmr_fiper2);  in set_fipers()
101 	if (ptp_qoriq->fiper3_support)  in set_fipers()
102 		ptp_qoriq->write(&regs->fiper_regs->tmr_fiper3,  in set_fipers()
103 				 ptp_qoriq->tmr_fiper3);  in set_fipers()
108 	struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;  in extts_clean_up()
117 		reg_etts_l = &regs->etts_regs->tmr_etts1_l;  in extts_clean_up()
118 		reg_etts_h = &regs->etts_regs->tmr_etts1_h;  in extts_clean_up()
122 		reg_etts_l = &regs->etts_regs->tmr_etts2_l;  in extts_clean_up()
123 		reg_etts_h = &regs->etts_regs->tmr_etts2_h;  in extts_clean_up()
126 		return -EINVAL;  in extts_clean_up()
132 	if (ptp_qoriq->extts_fifo_support)  in extts_clean_up()
133 		if (!(ptp_qoriq->read(&regs->ctrl_regs->tmr_stat) & valid))  in extts_clean_up()
137 		lo = ptp_qoriq->read(reg_etts_l);  in extts_clean_up()
138 		hi = ptp_qoriq->read(reg_etts_h);  in extts_clean_up()
143 			ptp_clock_event(ptp_qoriq->clock, &event);  in extts_clean_up()
146 		if (!ptp_qoriq->extts_fifo_support)  in extts_clean_up()
148 	} while (ptp_qoriq->read(&regs->ctrl_regs->tmr_stat) & valid);  in extts_clean_up()
161 	struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;  in ptp_qoriq_isr()
165 	spin_lock(&ptp_qoriq->lock);  in ptp_qoriq_isr()
167 	val = ptp_qoriq->read(&regs->ctrl_regs->tmr_tevent);  in ptp_qoriq_isr()
168 	mask = ptp_qoriq->read(&regs->ctrl_regs->tmr_temask);  in ptp_qoriq_isr()
170 	spin_unlock(&ptp_qoriq->lock);  in ptp_qoriq_isr()
187 		ptp_clock_event(ptp_qoriq->clock, &event);  in ptp_qoriq_isr()
191 		ptp_qoriq->write(&regs->ctrl_regs->tmr_tevent, ack);  in ptp_qoriq_isr()
199  * PTP clock operations
202 int ptp_qoriq_adjfine(struct ptp_clock_info *ptp, long scaled_ppm)  in ptp_qoriq_adjfine()  argument
207 	struct ptp_qoriq *ptp_qoriq = container_of(ptp, struct ptp_qoriq, caps);  in ptp_qoriq_adjfine()
208 	struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;  in ptp_qoriq_adjfine()
212 		scaled_ppm = -scaled_ppm;  in ptp_qoriq_adjfine()
214 	tmr_add = ptp_qoriq->tmr_add;  in ptp_qoriq_adjfine()
226 	tmr_add = neg_adj ? tmr_add - diff : tmr_add + diff;  in ptp_qoriq_adjfine()
227 	ptp_qoriq->write(&regs->ctrl_regs->tmr_add, tmr_add);  in ptp_qoriq_adjfine()
233 int ptp_qoriq_adjtime(struct ptp_clock_info *ptp, s64 delta)  in ptp_qoriq_adjtime()  argument
235 	struct ptp_qoriq *ptp_qoriq = container_of(ptp, struct ptp_qoriq, caps);  in ptp_qoriq_adjtime()
239 	spin_lock_irqsave(&ptp_qoriq->lock, flags);  in ptp_qoriq_adjtime()
244 	if (ptp_qoriq->etsec) {  in ptp_qoriq_adjtime()
255 	spin_unlock_irqrestore(&ptp_qoriq->lock, flags);  in ptp_qoriq_adjtime()
261 int ptp_qoriq_gettime(struct ptp_clock_info *ptp, struct timespec64 *ts)  in ptp_qoriq_gettime()  argument
265 	struct ptp_qoriq *ptp_qoriq = container_of(ptp, struct ptp_qoriq, caps);  in ptp_qoriq_gettime()
267 	spin_lock_irqsave(&ptp_qoriq->lock, flags);  in ptp_qoriq_gettime()
271 	spin_unlock_irqrestore(&ptp_qoriq->lock, flags);  in ptp_qoriq_gettime()
279 int ptp_qoriq_settime(struct ptp_clock_info *ptp,  in ptp_qoriq_settime()  argument
284 	struct ptp_qoriq *ptp_qoriq = container_of(ptp, struct ptp_qoriq, caps);  in ptp_qoriq_settime()
288 	spin_lock_irqsave(&ptp_qoriq->lock, flags);  in ptp_qoriq_settime()
294 	spin_unlock_irqrestore(&ptp_qoriq->lock, flags);  in ptp_qoriq_settime()
300 int ptp_qoriq_enable(struct ptp_clock_info *ptp,  in ptp_qoriq_enable()  argument
303 	struct ptp_qoriq *ptp_qoriq = container_of(ptp, struct ptp_qoriq, caps);  in ptp_qoriq_enable()
304 	struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;  in ptp_qoriq_enable()
308 	switch (rq->type) {  in ptp_qoriq_enable()
310 		switch (rq->extts.index) {  in ptp_qoriq_enable()
318 			return -EINVAL;  in ptp_qoriq_enable()
322 			extts_clean_up(ptp_qoriq, rq->extts.index, false);  in ptp_qoriq_enable()
329 		return -EOPNOTSUPP;  in ptp_qoriq_enable()
332 	spin_lock_irqsave(&ptp_qoriq->lock, flags);  in ptp_qoriq_enable()
334 	mask = ptp_qoriq->read(&regs->ctrl_regs->tmr_temask);  in ptp_qoriq_enable()
337 		ptp_qoriq->write(&regs->ctrl_regs->tmr_tevent, bit);  in ptp_qoriq_enable()
342 	ptp_qoriq->write(&regs->ctrl_regs->tmr_temask, mask);  in ptp_qoriq_enable()
344 	spin_unlock_irqrestore(&ptp_qoriq->lock, flags);  in ptp_qoriq_enable()
351 	.name		= "qoriq ptp clock",
366  * ptp_qoriq_nominal_freq - calculate nominal frequency according to
384 		clk_src -= remainder;  in ptp_qoriq_nominal_freq()
389 		clk_src -= 100;  in ptp_qoriq_nominal_freq()
397  * ptp_qoriq_auto_config - calculate a set of default configurations
404  *   "fsl,tclk-period"
405  *   "fsl,tmr-prsc"
406  *   "fsl,tmr-add"
407  *   "fsl,tmr-fiper1"
408  *   "fsl,tmr-fiper2"
409  *   "fsl,tmr-fiper3" (required only for DPAA2 and ENETC hardware)
410  *   "fsl,max-adj"
424 	ptp_qoriq->cksel = DEFAULT_CKSEL;  in ptp_qoriq_auto_config()
434 		return -EINVAL;  in ptp_qoriq_auto_config()
439 		return -EINVAL;  in ptp_qoriq_auto_config()
441 	ptp_qoriq->tclk_period = 1000000000UL / nominal_freq;  in ptp_qoriq_auto_config()
442 	ptp_qoriq->tmr_prsc = DEFAULT_TMR_PRSC;  in ptp_qoriq_auto_config()
453 	ptp_qoriq->tmr_add = freq_comp;  in ptp_qoriq_auto_config()
454 	ptp_qoriq->tmr_fiper1 = DEFAULT_FIPER1_PERIOD - ptp_qoriq->tclk_period;  in ptp_qoriq_auto_config()
455 	ptp_qoriq->tmr_fiper2 = DEFAULT_FIPER2_PERIOD - ptp_qoriq->tclk_period;  in ptp_qoriq_auto_config()
456 	ptp_qoriq->tmr_fiper3 = DEFAULT_FIPER3_PERIOD - ptp_qoriq->tclk_period;  in ptp_qoriq_auto_config()
458 	/* max_adj = 1000000000 * (freq_ratio - 1.0) - 1  in ptp_qoriq_auto_config()
461 	max_adj = 1000000000ULL * (clk_src - nominal_freq);  in ptp_qoriq_auto_config()
462 	max_adj = div_u64(max_adj, nominal_freq) - 1;  in ptp_qoriq_auto_config()
463 	ptp_qoriq->caps.max_adj = max_adj;  in ptp_qoriq_auto_config()
471 	struct device_node *node = ptp_qoriq->dev->of_node;  in ptp_qoriq_init()
478 		return -ENODEV;  in ptp_qoriq_init()
480 	ptp_qoriq->base = base;  in ptp_qoriq_init()
481 	ptp_qoriq->caps = *caps;  in ptp_qoriq_init()
483 	if (of_property_read_u32(node, "fsl,cksel", &ptp_qoriq->cksel))  in ptp_qoriq_init()
484 		ptp_qoriq->cksel = DEFAULT_CKSEL;  in ptp_qoriq_init()
486 	if (of_property_read_bool(node, "fsl,extts-fifo"))  in ptp_qoriq_init()
487 		ptp_qoriq->extts_fifo_support = true;  in ptp_qoriq_init()
489 		ptp_qoriq->extts_fifo_support = false;  in ptp_qoriq_init()
491 	if (of_device_is_compatible(node, "fsl,dpaa2-ptp") ||  in ptp_qoriq_init()
492 	    of_device_is_compatible(node, "fsl,enetc-ptp"))  in ptp_qoriq_init()
493 		ptp_qoriq->fiper3_support = true;  in ptp_qoriq_init()
496 				 "fsl,tclk-period", &ptp_qoriq->tclk_period) ||  in ptp_qoriq_init()
498 				 "fsl,tmr-prsc", &ptp_qoriq->tmr_prsc) ||  in ptp_qoriq_init()
500 				 "fsl,tmr-add", &ptp_qoriq->tmr_add) ||  in ptp_qoriq_init()
502 				 "fsl,tmr-fiper1", &ptp_qoriq->tmr_fiper1) ||  in ptp_qoriq_init()
504 				 "fsl,tmr-fiper2", &ptp_qoriq->tmr_fiper2) ||  in ptp_qoriq_init()
506 				 "fsl,max-adj", &ptp_qoriq->caps.max_adj) ||  in ptp_qoriq_init()
507 	    (ptp_qoriq->fiper3_support &&  in ptp_qoriq_init()
508 	     of_property_read_u32(node, "fsl,tmr-fiper3",  in ptp_qoriq_init()
509 				  &ptp_qoriq->tmr_fiper3))) {  in ptp_qoriq_init()
513 			return -ENODEV;  in ptp_qoriq_init()
516 	if (of_property_read_bool(node, "little-endian")) {  in ptp_qoriq_init()
517 		ptp_qoriq->read = qoriq_read_le;  in ptp_qoriq_init()
518 		ptp_qoriq->write = qoriq_write_le;  in ptp_qoriq_init()
520 		ptp_qoriq->read = qoriq_read_be;  in ptp_qoriq_init()
521 		ptp_qoriq->write = qoriq_write_be;  in ptp_qoriq_init()
525 	if (of_device_is_compatible(node, "fsl,etsec-ptp")) {  in ptp_qoriq_init()
526 		ptp_qoriq->etsec = true;  in ptp_qoriq_init()
527 		ptp_qoriq->regs.ctrl_regs = base + ETSEC_CTRL_REGS_OFFSET;  in ptp_qoriq_init()
528 		ptp_qoriq->regs.alarm_regs = base + ETSEC_ALARM_REGS_OFFSET;  in ptp_qoriq_init()
529 		ptp_qoriq->regs.fiper_regs = base + ETSEC_FIPER_REGS_OFFSET;  in ptp_qoriq_init()
530 		ptp_qoriq->regs.etts_regs = base + ETSEC_ETTS_REGS_OFFSET;  in ptp_qoriq_init()
532 		ptp_qoriq->regs.ctrl_regs = base + CTRL_REGS_OFFSET;  in ptp_qoriq_init()
533 		ptp_qoriq->regs.alarm_regs = base + ALARM_REGS_OFFSET;  in ptp_qoriq_init()
534 		ptp_qoriq->regs.fiper_regs = base + FIPER_REGS_OFFSET;  in ptp_qoriq_init()
535 		ptp_qoriq->regs.etts_regs = base + ETTS_REGS_OFFSET;  in ptp_qoriq_init()
538 	spin_lock_init(&ptp_qoriq->lock);  in ptp_qoriq_init()
541 	ptp_qoriq_settime(&ptp_qoriq->caps, &now);  in ptp_qoriq_init()
544 	  (ptp_qoriq->tclk_period & TCLK_PERIOD_MASK) << TCLK_PERIOD_SHIFT |  in ptp_qoriq_init()
545 	  (ptp_qoriq->cksel & CKSEL_MASK) << CKSEL_SHIFT;  in ptp_qoriq_init()
547 	spin_lock_irqsave(&ptp_qoriq->lock, flags);  in ptp_qoriq_init()
549 	regs = &ptp_qoriq->regs;  in ptp_qoriq_init()
550 	ptp_qoriq->write(&regs->ctrl_regs->tmr_ctrl, tmr_ctrl);  in ptp_qoriq_init()
551 	ptp_qoriq->write(&regs->ctrl_regs->tmr_add, ptp_qoriq->tmr_add);  in ptp_qoriq_init()
552 	ptp_qoriq->write(&regs->ctrl_regs->tmr_prsc, ptp_qoriq->tmr_prsc);  in ptp_qoriq_init()
553 	ptp_qoriq->write(&regs->fiper_regs->tmr_fiper1, ptp_qoriq->tmr_fiper1);  in ptp_qoriq_init()
554 	ptp_qoriq->write(&regs->fiper_regs->tmr_fiper2, ptp_qoriq->tmr_fiper2);  in ptp_qoriq_init()
556 	if (ptp_qoriq->fiper3_support)  in ptp_qoriq_init()
557 		ptp_qoriq->write(&regs->fiper_regs->tmr_fiper3,  in ptp_qoriq_init()
558 				 ptp_qoriq->tmr_fiper3);  in ptp_qoriq_init()
561 	ptp_qoriq->write(&regs->ctrl_regs->tmr_ctrl,  in ptp_qoriq_init()
564 	spin_unlock_irqrestore(&ptp_qoriq->lock, flags);  in ptp_qoriq_init()
566 	ptp_qoriq->clock = ptp_clock_register(&ptp_qoriq->caps, ptp_qoriq->dev);  in ptp_qoriq_init()
567 	if (IS_ERR(ptp_qoriq->clock))  in ptp_qoriq_init()
568 		return PTR_ERR(ptp_qoriq->clock);  in ptp_qoriq_init()
570 	ptp_qoriq->phc_index = ptp_clock_index(ptp_qoriq->clock);  in ptp_qoriq_init()
578 	struct ptp_qoriq_registers *regs = &ptp_qoriq->regs;  in ptp_qoriq_free()
580 	ptp_qoriq->write(&regs->ctrl_regs->tmr_temask, 0);  in ptp_qoriq_free()
581 	ptp_qoriq->write(&regs->ctrl_regs->tmr_ctrl,   0);  in ptp_qoriq_free()
584 	ptp_clock_unregister(ptp_qoriq->clock);  in ptp_qoriq_free()
585 	iounmap(ptp_qoriq->base);  in ptp_qoriq_free()
586 	free_irq(ptp_qoriq->irq, ptp_qoriq);  in ptp_qoriq_free()
593 	int err = -ENOMEM;  in ptp_qoriq_probe()
600 	ptp_qoriq->dev = &dev->dev;  in ptp_qoriq_probe()
602 	err = -ENODEV;  in ptp_qoriq_probe()
604 	ptp_qoriq->irq = platform_get_irq(dev, 0);  in ptp_qoriq_probe()
605 	if (ptp_qoriq->irq < 0) {  in ptp_qoriq_probe()
609 	if (request_irq(ptp_qoriq->irq, ptp_qoriq_isr, IRQF_SHARED,  in ptp_qoriq_probe()
615 	ptp_qoriq->rsrc = platform_get_resource(dev, IORESOURCE_MEM, 0);  in ptp_qoriq_probe()
616 	if (!ptp_qoriq->rsrc) {  in ptp_qoriq_probe()
620 	if (request_resource(&iomem_resource, ptp_qoriq->rsrc)) {  in ptp_qoriq_probe()
625 	base = ioremap(ptp_qoriq->rsrc->start,  in ptp_qoriq_probe()
626 		       resource_size(ptp_qoriq->rsrc));  in ptp_qoriq_probe()
628 		pr_err("ioremap ptp registers failed\n");  in ptp_qoriq_probe()
642 	release_resource(ptp_qoriq->rsrc);  in ptp_qoriq_probe()
644 	free_irq(ptp_qoriq->irq, ptp_qoriq);  in ptp_qoriq_probe()
656 	release_resource(ptp_qoriq->rsrc);  in ptp_qoriq_remove()
661 	{ .compatible = "fsl,etsec-ptp" },
662 	{ .compatible = "fsl,fman-ptp-timer" },
679 MODULE_DESCRIPTION("PTP clock for Freescale QorIQ 1588 timer");