2 * PTP 1588 clock using the EG20T PCH
4 * Copyright (C) 2010 OMICRON electronics GmbH
5 * Copyright (C) 2011-2012 LAPIS SEMICONDUCTOR Co., LTD.
7 * This code was derived from the IXP46X driver.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; version 2 of the License.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
23 #include <linux/device.h>
24 #include <linux/err.h>
25 #include <linux/init.h>
26 #include <linux/interrupt.h>
28 #include <linux/irq.h>
29 #include <linux/kernel.h>
30 #include <linux/module.h>
31 #include <linux/pci.h>
32 #include <linux/ptp_clock_kernel.h>
33 #include <linux/slab.h>
35 #define STATION_ADDR_LEN 20
36 #define PCI_DEVICE_ID_PCH_1588 0x8819
39 #define DEFAULT_ADDEND 0xA0000000
40 #define TICKS_NS_SHIFT 5
47 PCH_INTERRUPTMODEINUSE,
52 * struct pch_ts_regs - IEEE 1588 registers
91 #define PCH_TSC_RESET (1 << 0)
92 #define PCH_TSC_TTM_MASK (1 << 1)
93 #define PCH_TSC_ASMS_MASK (1 << 2)
94 #define PCH_TSC_AMMS_MASK (1 << 3)
95 #define PCH_TSC_PPSM_MASK (1 << 4)
96 #define PCH_TSE_TTIPEND (1 << 1)
97 #define PCH_TSE_SNS (1 << 2)
98 #define PCH_TSE_SNM (1 << 3)
99 #define PCH_TSE_PPS (1 << 4)
100 #define PCH_CC_MM (1 << 0)
101 #define PCH_CC_TA (1 << 1)
103 #define PCH_CC_MODE_SHIFT 16
104 #define PCH_CC_MODE_MASK 0x001F0000
105 #define PCH_CC_VERSION (1 << 31)
106 #define PCH_CE_TXS (1 << 0)
107 #define PCH_CE_RXS (1 << 1)
108 #define PCH_CE_OVR (1 << 0)
109 #define PCH_CE_VAL (1 << 1)
110 #define PCH_ECS_ETH (1 << 0)
112 #define PCH_ECS_CAN (1 << 1)
113 #define PCH_STATION_BYTES 6
115 #define PCH_IEEE1588_ETH (1 << 0)
116 #define PCH_IEEE1588_CAN (1 << 1)
118 * struct pch_dev - Driver private data
121 struct pch_ts_regs *regs;
122 struct ptp_clock *ptp_clock;
123 struct ptp_clock_info caps;
130 struct pci_dev *pdev;
131 spinlock_t register_lock;
135 * struct pch_params - 1588 module parameter
138 u8 station[STATION_ADDR_LEN];
141 /* structure to hold the module parameters */
142 static struct pch_params pch_param = {
147 * Register access functions
149 static inline void pch_eth_enable_set(struct pch_dev *chip)
152 /* SET the eth_enable bit */
153 val = ioread32(&chip->regs->ts_sel) | (PCH_ECS_ETH);
154 iowrite32(val, (&chip->regs->ts_sel));
157 static u64 pch_systime_read(struct pch_ts_regs *regs)
162 lo = ioread32(®s->systime_lo);
163 hi = ioread32(®s->systime_hi);
165 ns = ((u64) hi) << 32;
167 ns <<= TICKS_NS_SHIFT;
172 static void pch_systime_write(struct pch_ts_regs *regs, u64 ns)
176 ns >>= TICKS_NS_SHIFT;
178 lo = ns & 0xffffffff;
180 iowrite32(lo, ®s->systime_lo);
181 iowrite32(hi, ®s->systime_hi);
184 static inline void pch_block_reset(struct pch_dev *chip)
187 /* Reset Hardware Assist block */
188 val = ioread32(&chip->regs->control) | PCH_TSC_RESET;
189 iowrite32(val, (&chip->regs->control));
190 val = val & ~PCH_TSC_RESET;
191 iowrite32(val, (&chip->regs->control));
194 u32 pch_ch_control_read(struct pci_dev *pdev)
196 struct pch_dev *chip = pci_get_drvdata(pdev);
199 val = ioread32(&chip->regs->ch_control);
203 EXPORT_SYMBOL(pch_ch_control_read);
205 void pch_ch_control_write(struct pci_dev *pdev, u32 val)
207 struct pch_dev *chip = pci_get_drvdata(pdev);
209 iowrite32(val, (&chip->regs->ch_control));
211 EXPORT_SYMBOL(pch_ch_control_write);
213 u32 pch_ch_event_read(struct pci_dev *pdev)
215 struct pch_dev *chip = pci_get_drvdata(pdev);
218 val = ioread32(&chip->regs->ch_event);
222 EXPORT_SYMBOL(pch_ch_event_read);
224 void pch_ch_event_write(struct pci_dev *pdev, u32 val)
226 struct pch_dev *chip = pci_get_drvdata(pdev);
228 iowrite32(val, (&chip->regs->ch_event));
230 EXPORT_SYMBOL(pch_ch_event_write);
232 u32 pch_src_uuid_lo_read(struct pci_dev *pdev)
234 struct pch_dev *chip = pci_get_drvdata(pdev);
237 val = ioread32(&chip->regs->src_uuid_lo);
241 EXPORT_SYMBOL(pch_src_uuid_lo_read);
243 u32 pch_src_uuid_hi_read(struct pci_dev *pdev)
245 struct pch_dev *chip = pci_get_drvdata(pdev);
248 val = ioread32(&chip->regs->src_uuid_hi);
252 EXPORT_SYMBOL(pch_src_uuid_hi_read);
254 u64 pch_rx_snap_read(struct pci_dev *pdev)
256 struct pch_dev *chip = pci_get_drvdata(pdev);
260 lo = ioread32(&chip->regs->rx_snap_lo);
261 hi = ioread32(&chip->regs->rx_snap_hi);
263 ns = ((u64) hi) << 32;
268 EXPORT_SYMBOL(pch_rx_snap_read);
270 u64 pch_tx_snap_read(struct pci_dev *pdev)
272 struct pch_dev *chip = pci_get_drvdata(pdev);
276 lo = ioread32(&chip->regs->tx_snap_lo);
277 hi = ioread32(&chip->regs->tx_snap_hi);
279 ns = ((u64) hi) << 32;
284 EXPORT_SYMBOL(pch_tx_snap_read);
286 /* This function enables all 64 bits in system time registers [high & low].
287 This is a work-around for non continuous value in the SystemTime Register*/
288 static void pch_set_system_time_count(struct pch_dev *chip)
290 iowrite32(0x01, &chip->regs->stl_max_set_en);
291 iowrite32(0xFFFFFFFF, &chip->regs->stl_max_set);
292 iowrite32(0x00, &chip->regs->stl_max_set_en);
295 static void pch_reset(struct pch_dev *chip)
297 /* Reset Hardware Assist */
298 pch_block_reset(chip);
300 /* enable all 32 bits in system time registers */
301 pch_set_system_time_count(chip);
305 * pch_set_station_address() - This API sets the station address used by
306 * IEEE 1588 hardware when looking at PTP
307 * traffic on the ethernet interface
308 * @addr: dress which contain the column separated address to be used.
310 static int pch_set_station_address(u8 *addr, struct pci_dev *pdev)
313 struct pch_dev *chip = pci_get_drvdata(pdev);
315 /* Verify the parameter */
316 if ((chip->regs == 0) || addr == (u8 *)NULL) {
318 "invalid params returning PCH_INVALIDPARAM\n");
319 return PCH_INVALIDPARAM;
321 /* For all station address bytes */
322 for (i = 0; i < PCH_STATION_BYTES; i++) {
326 tmp = hex_to_bin(addr[i * 3]);
329 "invalid params returning PCH_INVALIDPARAM\n");
330 return PCH_INVALIDPARAM;
333 tmp = hex_to_bin(addr[(i * 3) + 1]);
336 "invalid params returning PCH_INVALIDPARAM\n");
337 return PCH_INVALIDPARAM;
340 /* Expects ':' separated addresses */
341 if ((i < 5) && (addr[(i * 3) + 2] != ':')) {
343 "invalid params returning PCH_INVALIDPARAM\n");
344 return PCH_INVALIDPARAM;
347 /* Ideally we should set the address only after validating
349 dev_dbg(&pdev->dev, "invoking pch_station_set\n");
350 iowrite32(val, &chip->regs->ts_st[i]);
356 * Interrupt service routine
358 static irqreturn_t isr(int irq, void *priv)
360 struct pch_dev *pch_dev = priv;
361 struct pch_ts_regs *regs = pch_dev->regs;
362 struct ptp_clock_event event;
363 u32 ack = 0, lo, hi, val;
365 val = ioread32(®s->event);
367 if (val & PCH_TSE_SNS) {
369 if (pch_dev->exts0_enabled) {
370 hi = ioread32(®s->asms_hi);
371 lo = ioread32(®s->asms_lo);
372 event.type = PTP_CLOCK_EXTTS;
374 event.timestamp = ((u64) hi) << 32;
375 event.timestamp |= lo;
376 event.timestamp <<= TICKS_NS_SHIFT;
377 ptp_clock_event(pch_dev->ptp_clock, &event);
381 if (val & PCH_TSE_SNM) {
383 if (pch_dev->exts1_enabled) {
384 hi = ioread32(®s->amms_hi);
385 lo = ioread32(®s->amms_lo);
386 event.type = PTP_CLOCK_EXTTS;
388 event.timestamp = ((u64) hi) << 32;
389 event.timestamp |= lo;
390 event.timestamp <<= TICKS_NS_SHIFT;
391 ptp_clock_event(pch_dev->ptp_clock, &event);
395 if (val & PCH_TSE_TTIPEND)
396 ack |= PCH_TSE_TTIPEND; /* this bit seems to be always set */
399 iowrite32(ack, ®s->event);
406 * PTP clock operations
409 static int ptp_pch_adjfreq(struct ptp_clock_info *ptp, s32 ppb)
414 struct pch_dev *pch_dev = container_of(ptp, struct pch_dev, caps);
415 struct pch_ts_regs *regs = pch_dev->regs;
421 addend = DEFAULT_ADDEND;
424 diff = div_u64(adj, 1000000000ULL);
426 addend = neg_adj ? addend - diff : addend + diff;
428 iowrite32(addend, ®s->addend);
433 static int ptp_pch_adjtime(struct ptp_clock_info *ptp, s64 delta)
437 struct pch_dev *pch_dev = container_of(ptp, struct pch_dev, caps);
438 struct pch_ts_regs *regs = pch_dev->regs;
440 spin_lock_irqsave(&pch_dev->register_lock, flags);
441 now = pch_systime_read(regs);
443 pch_systime_write(regs, now);
444 spin_unlock_irqrestore(&pch_dev->register_lock, flags);
449 static int ptp_pch_gettime(struct ptp_clock_info *ptp, struct timespec *ts)
454 struct pch_dev *pch_dev = container_of(ptp, struct pch_dev, caps);
455 struct pch_ts_regs *regs = pch_dev->regs;
457 spin_lock_irqsave(&pch_dev->register_lock, flags);
458 ns = pch_systime_read(regs);
459 spin_unlock_irqrestore(&pch_dev->register_lock, flags);
461 ts->tv_sec = div_u64_rem(ns, 1000000000, &remainder);
462 ts->tv_nsec = remainder;
466 static int ptp_pch_settime(struct ptp_clock_info *ptp,
467 const struct timespec *ts)
471 struct pch_dev *pch_dev = container_of(ptp, struct pch_dev, caps);
472 struct pch_ts_regs *regs = pch_dev->regs;
474 ns = ts->tv_sec * 1000000000ULL;
477 spin_lock_irqsave(&pch_dev->register_lock, flags);
478 pch_systime_write(regs, ns);
479 spin_unlock_irqrestore(&pch_dev->register_lock, flags);
484 static int ptp_pch_enable(struct ptp_clock_info *ptp,
485 struct ptp_clock_request *rq, int on)
487 struct pch_dev *pch_dev = container_of(ptp, struct pch_dev, caps);
490 case PTP_CLK_REQ_EXTTS:
491 switch (rq->extts.index) {
493 pch_dev->exts0_enabled = on ? 1 : 0;
496 pch_dev->exts1_enabled = on ? 1 : 0;
509 static struct ptp_clock_info ptp_pch_caps = {
510 .owner = THIS_MODULE,
513 .n_ext_ts = N_EXT_TS,
515 .adjfreq = ptp_pch_adjfreq,
516 .adjtime = ptp_pch_adjtime,
517 .gettime = ptp_pch_gettime,
518 .settime = ptp_pch_settime,
519 .enable = ptp_pch_enable,
524 static s32 pch_suspend(struct pci_dev *pdev, pm_message_t state)
526 pci_disable_device(pdev);
527 pci_enable_wake(pdev, PCI_D3hot, 0);
529 if (pci_save_state(pdev) != 0) {
530 dev_err(&pdev->dev, "could not save PCI config state\n");
533 pci_set_power_state(pdev, pci_choose_state(pdev, state));
538 static s32 pch_resume(struct pci_dev *pdev)
542 pci_set_power_state(pdev, PCI_D0);
543 pci_restore_state(pdev);
544 ret = pci_enable_device(pdev);
546 dev_err(&pdev->dev, "pci_enable_device failed\n");
549 pci_enable_wake(pdev, PCI_D3hot, 0);
553 #define pch_suspend NULL
554 #define pch_resume NULL
557 static void __devexit pch_remove(struct pci_dev *pdev)
559 struct pch_dev *chip = pci_get_drvdata(pdev);
561 ptp_clock_unregister(chip->ptp_clock);
562 /* free the interrupt */
564 free_irq(pdev->irq, chip);
566 /* unmap the virtual IO memory space */
567 if (chip->regs != 0) {
571 /* release the reserved IO memory space */
572 if (chip->mem_base != 0) {
573 release_mem_region(chip->mem_base, chip->mem_size);
576 pci_disable_device(pdev);
578 dev_info(&pdev->dev, "complete\n");
582 pch_probe(struct pci_dev *pdev, const struct pci_device_id *id)
586 struct pch_dev *chip;
588 chip = kzalloc(sizeof(struct pch_dev), GFP_KERNEL);
592 /* enable the 1588 pci device */
593 ret = pci_enable_device(pdev);
595 dev_err(&pdev->dev, "could not enable the pci device\n");
599 chip->mem_base = pci_resource_start(pdev, IO_MEM_BAR);
600 if (!chip->mem_base) {
601 dev_err(&pdev->dev, "could not locate IO memory address\n");
606 /* retrieve the available length of the IO memory space */
607 chip->mem_size = pci_resource_len(pdev, IO_MEM_BAR);
609 /* allocate the memory for the device registers */
610 if (!request_mem_region(chip->mem_base, chip->mem_size, "1588_regs")) {
612 "could not allocate register memory space\n");
614 goto err_req_mem_region;
617 /* get the virtual address to the 1588 registers */
618 chip->regs = ioremap(chip->mem_base, chip->mem_size);
621 dev_err(&pdev->dev, "Could not get virtual address\n");
626 chip->caps = ptp_pch_caps;
627 chip->ptp_clock = ptp_clock_register(&chip->caps);
629 if (IS_ERR(chip->ptp_clock))
630 return PTR_ERR(chip->ptp_clock);
632 spin_lock_init(&chip->register_lock);
634 ret = request_irq(pdev->irq, &isr, IRQF_SHARED, KBUILD_MODNAME, chip);
636 dev_err(&pdev->dev, "failed to get irq %d\n", pdev->irq);
640 /* indicate success */
641 chip->irq = pdev->irq;
643 pci_set_drvdata(pdev, chip);
645 spin_lock_irqsave(&chip->register_lock, flags);
646 /* reset the ieee1588 h/w */
649 iowrite32(DEFAULT_ADDEND, &chip->regs->addend);
650 iowrite32(1, &chip->regs->trgt_lo);
651 iowrite32(0, &chip->regs->trgt_hi);
652 iowrite32(PCH_TSE_TTIPEND, &chip->regs->event);
653 /* Version: IEEE1588 v1 and IEEE1588-2008, Mode: All Evwnt, Locked */
654 iowrite32(0x80020000, &chip->regs->ch_control);
656 pch_eth_enable_set(chip);
658 if (strcmp(pch_param.station, "00:00:00:00:00:00") != 0) {
659 if (pch_set_station_address(pch_param.station, pdev) != 0) {
661 "Invalid station address parameter\n"
662 "Module loaded but station address not set correctly\n"
666 spin_unlock_irqrestore(&chip->register_lock, flags);
670 ptp_clock_unregister(chip->ptp_clock);
675 release_mem_region(chip->mem_base, chip->mem_size);
681 pci_disable_device(pdev);
685 dev_err(&pdev->dev, "probe failed(ret=0x%x)\n", ret);
690 static DEFINE_PCI_DEVICE_TABLE(pch_ieee1588_pcidev_id) = {
692 .vendor = PCI_VENDOR_ID_INTEL,
693 .device = PCI_DEVICE_ID_PCH_1588
698 static struct pci_driver pch_driver = {
699 .name = KBUILD_MODNAME,
700 .id_table = pch_ieee1588_pcidev_id,
702 .remove = pch_remove,
703 .suspend = pch_suspend,
704 .resume = pch_resume,
707 static void __exit ptp_pch_exit(void)
709 pci_unregister_driver(&pch_driver);
712 static s32 __init ptp_pch_init(void)
716 /* register the driver with the pci core */
717 ret = pci_register_driver(&pch_driver);
722 module_init(ptp_pch_init);
723 module_exit(ptp_pch_exit);
725 module_param_string(station, pch_param.station, sizeof pch_param.station, 0444);
726 MODULE_PARM_DESC(station,
727 "IEEE 1588 station address to use - column separated hex values");
729 MODULE_AUTHOR("LAPIS SEMICONDUCTOR, <tshimizu818@gmail.com>");
730 MODULE_DESCRIPTION("PTP clock using the EG20T timer");
731 MODULE_LICENSE("GPL");