1 // SPDX-License-Identifier: GPL-2.0+
3 * Driver for the National Semiconductor DP83640 PHYTER
5 * Copyright (C) 2010 OMICRON electronics GmbH
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10 #include <linux/crc32.h>
11 #include <linux/ethtool.h>
12 #include <linux/kernel.h>
13 #include <linux/list.h>
14 #include <linux/mii.h>
15 #include <linux/module.h>
16 #include <linux/net_tstamp.h>
17 #include <linux/netdevice.h>
18 #include <linux/if_vlan.h>
19 #include <linux/phy.h>
20 #include <linux/ptp_classify.h>
21 #include <linux/ptp_clock_kernel.h>
23 #include "dp83640_reg.h"
25 #define DP83640_PHY_ID 0x20005ce1
31 #define PSF_EVNT 0x4000
37 #define DP83640_N_PINS 12
39 #define MII_DP83640_MICR 0x11
40 #define MII_DP83640_MISR 0x12
42 #define MII_DP83640_MICR_OE 0x1
43 #define MII_DP83640_MICR_IE 0x2
45 #define MII_DP83640_MISR_RHF_INT_EN 0x01
46 #define MII_DP83640_MISR_FHF_INT_EN 0x02
47 #define MII_DP83640_MISR_ANC_INT_EN 0x04
48 #define MII_DP83640_MISR_DUP_INT_EN 0x08
49 #define MII_DP83640_MISR_SPD_INT_EN 0x10
50 #define MII_DP83640_MISR_LINK_INT_EN 0x20
51 #define MII_DP83640_MISR_ED_INT_EN 0x40
52 #define MII_DP83640_MISR_LQ_INT_EN 0x80
54 /* phyter seems to miss the mark by 16 ns */
55 #define ADJTIME_FIX 16
57 #define SKB_TIMESTAMP_TIMEOUT 2 /* jiffies */
59 #if defined(__BIG_ENDIAN)
61 #elif defined(__LITTLE_ENDIAN)
62 #define ENDIAN_FLAG PSF_ENDIAN
65 struct dp83640_skb_info {
71 u16 ns_lo; /* ns[15:0] */
72 u16 ns_hi; /* overflow[1:0], ns[29:16] */
73 u16 sec_lo; /* sec[15:0] */
74 u16 sec_hi; /* sec[31:16] */
75 u16 seqid; /* sequenceId[15:0] */
76 u16 msgtype; /* messageType[3:0], hash[11:0] */
80 u16 ns_lo; /* ns[15:0] */
81 u16 ns_hi; /* overflow[1:0], ns[29:16] */
82 u16 sec_lo; /* sec[15:0] */
83 u16 sec_hi; /* sec[31:16] */
87 struct list_head list;
97 struct dp83640_private {
98 struct list_head list;
99 struct dp83640_clock *clock;
100 struct phy_device *phydev;
101 struct delayed_work ts_work;
106 /* remember state of cfg0 during calibration */
108 /* remember the last event time stamp */
109 struct phy_txts edata;
110 /* list of rx timestamps */
111 struct list_head rxts;
112 struct list_head rxpool;
113 struct rxts rx_pool_data[MAX_RXTS];
114 /* protects above three fields from concurrent access */
116 /* queues of incoming and outgoing packets */
117 struct sk_buff_head rx_queue;
118 struct sk_buff_head tx_queue;
121 struct dp83640_clock {
122 /* keeps the instance in the 'phyter_clocks' list */
123 struct list_head list;
124 /* we create one clock instance per MII bus */
126 /* protects extended registers from concurrent access */
127 struct mutex extreg_lock;
128 /* remembers which page was last selected */
130 /* our advertised capabilities */
131 struct ptp_clock_info caps;
132 /* protects the three fields below from concurrent access */
133 struct mutex clock_lock;
134 /* the one phyter from which we shall read */
135 struct dp83640_private *chosen;
136 /* list of the other attached phyters, not chosen */
137 struct list_head phylist;
138 /* reference to our PTP hardware clock */
139 struct ptp_clock *ptp_clock;
156 static int chosen_phy = -1;
157 static ushort gpio_tab[GPIO_TABLE_SIZE] = {
158 1, 2, 3, 4, 8, 9, 10, 11
161 module_param(chosen_phy, int, 0444);
162 module_param_array(gpio_tab, ushort, NULL, 0444);
164 MODULE_PARM_DESC(chosen_phy, \
165 "The address of the PHY to use for the ancillary clock features");
166 MODULE_PARM_DESC(gpio_tab, \
167 "Which GPIO line to use for which purpose: cal,perout,extts1,...,extts6");
169 static void dp83640_gpio_defaults(struct ptp_pin_desc *pd)
173 for (i = 0; i < DP83640_N_PINS; i++) {
174 snprintf(pd[i].name, sizeof(pd[i].name), "GPIO%d", 1 + i);
178 for (i = 0; i < GPIO_TABLE_SIZE; i++) {
179 if (gpio_tab[i] < 1 || gpio_tab[i] > DP83640_N_PINS) {
180 pr_err("gpio_tab[%d]=%hu out of range", i, gpio_tab[i]);
185 index = gpio_tab[CALIBRATE_GPIO] - 1;
186 pd[index].func = PTP_PF_PHYSYNC;
189 index = gpio_tab[PEROUT_GPIO] - 1;
190 pd[index].func = PTP_PF_PEROUT;
193 for (i = EXTTS0_GPIO; i < GPIO_TABLE_SIZE; i++) {
194 index = gpio_tab[i] - 1;
195 pd[index].func = PTP_PF_EXTTS;
196 pd[index].chan = i - EXTTS0_GPIO;
200 /* a list of clocks and a mutex to protect it */
201 static LIST_HEAD(phyter_clocks);
202 static DEFINE_MUTEX(phyter_clocks_lock);
204 static void rx_timestamp_work(struct work_struct *work);
206 /* extended register access functions */
208 #define BROADCAST_ADDR 31
210 static inline int broadcast_write(struct phy_device *phydev, u32 regnum,
213 return mdiobus_write(phydev->mdio.bus, BROADCAST_ADDR, regnum, val);
216 /* Caller must hold extreg_lock. */
217 static int ext_read(struct phy_device *phydev, int page, u32 regnum)
219 struct dp83640_private *dp83640 = phydev->priv;
222 if (dp83640->clock->page != page) {
223 broadcast_write(phydev, PAGESEL, page);
224 dp83640->clock->page = page;
226 val = phy_read(phydev, regnum);
231 /* Caller must hold extreg_lock. */
232 static void ext_write(int broadcast, struct phy_device *phydev,
233 int page, u32 regnum, u16 val)
235 struct dp83640_private *dp83640 = phydev->priv;
237 if (dp83640->clock->page != page) {
238 broadcast_write(phydev, PAGESEL, page);
239 dp83640->clock->page = page;
242 broadcast_write(phydev, regnum, val);
244 phy_write(phydev, regnum, val);
247 /* Caller must hold extreg_lock. */
248 static int tdr_write(int bc, struct phy_device *dev,
249 const struct timespec64 *ts, u16 cmd)
251 ext_write(bc, dev, PAGE4, PTP_TDR, ts->tv_nsec & 0xffff);/* ns[15:0] */
252 ext_write(bc, dev, PAGE4, PTP_TDR, ts->tv_nsec >> 16); /* ns[31:16] */
253 ext_write(bc, dev, PAGE4, PTP_TDR, ts->tv_sec & 0xffff); /* sec[15:0] */
254 ext_write(bc, dev, PAGE4, PTP_TDR, ts->tv_sec >> 16); /* sec[31:16]*/
256 ext_write(bc, dev, PAGE4, PTP_CTL, cmd);
261 /* convert phy timestamps into driver timestamps */
263 static void phy2rxts(struct phy_rxts *p, struct rxts *rxts)
268 sec |= p->sec_hi << 16;
271 rxts->ns |= (p->ns_hi & 0x3fff) << 16;
272 rxts->ns += ((u64)sec) * 1000000000ULL;
273 rxts->seqid = p->seqid;
274 rxts->msgtype = (p->msgtype >> 12) & 0xf;
275 rxts->hash = p->msgtype & 0x0fff;
276 rxts->tmo = jiffies + SKB_TIMESTAMP_TIMEOUT;
279 static u64 phy2txts(struct phy_txts *p)
285 sec |= p->sec_hi << 16;
288 ns |= (p->ns_hi & 0x3fff) << 16;
289 ns += ((u64)sec) * 1000000000ULL;
294 static int periodic_output(struct dp83640_clock *clock,
295 struct ptp_clock_request *clkreq, bool on,
298 struct dp83640_private *dp83640 = clock->chosen;
299 struct phy_device *phydev = dp83640->phydev;
300 u32 sec, nsec, pwidth;
301 u16 gpio, ptp_trig, val;
304 gpio = 1 + ptp_find_pin(clock->ptp_clock, PTP_PF_PEROUT,
313 (trigger & TRIG_CSEL_MASK) << TRIG_CSEL_SHIFT |
314 (gpio & TRIG_GPIO_MASK) << TRIG_GPIO_SHIFT |
318 val = (trigger & TRIG_SEL_MASK) << TRIG_SEL_SHIFT;
322 mutex_lock(&clock->extreg_lock);
323 ext_write(0, phydev, PAGE5, PTP_TRIG, ptp_trig);
324 ext_write(0, phydev, PAGE4, PTP_CTL, val);
325 mutex_unlock(&clock->extreg_lock);
329 sec = clkreq->perout.start.sec;
330 nsec = clkreq->perout.start.nsec;
331 pwidth = clkreq->perout.period.sec * 1000000000UL;
332 pwidth += clkreq->perout.period.nsec;
335 mutex_lock(&clock->extreg_lock);
337 ext_write(0, phydev, PAGE5, PTP_TRIG, ptp_trig);
341 ext_write(0, phydev, PAGE4, PTP_CTL, val);
342 ext_write(0, phydev, PAGE4, PTP_TDR, nsec & 0xffff); /* ns[15:0] */
343 ext_write(0, phydev, PAGE4, PTP_TDR, nsec >> 16); /* ns[31:16] */
344 ext_write(0, phydev, PAGE4, PTP_TDR, sec & 0xffff); /* sec[15:0] */
345 ext_write(0, phydev, PAGE4, PTP_TDR, sec >> 16); /* sec[31:16] */
346 ext_write(0, phydev, PAGE4, PTP_TDR, pwidth & 0xffff); /* ns[15:0] */
347 ext_write(0, phydev, PAGE4, PTP_TDR, pwidth >> 16); /* ns[31:16] */
348 /* Triggers 0 and 1 has programmable pulsewidth2 */
350 ext_write(0, phydev, PAGE4, PTP_TDR, pwidth & 0xffff);
351 ext_write(0, phydev, PAGE4, PTP_TDR, pwidth >> 16);
357 ext_write(0, phydev, PAGE4, PTP_CTL, val);
359 mutex_unlock(&clock->extreg_lock);
363 /* ptp clock methods */
365 static int ptp_dp83640_adjfine(struct ptp_clock_info *ptp, long scaled_ppm)
367 struct dp83640_clock *clock =
368 container_of(ptp, struct dp83640_clock, caps);
369 struct phy_device *phydev = clock->chosen->phydev;
374 if (scaled_ppm < 0) {
376 scaled_ppm = -scaled_ppm;
380 rate = div_u64(rate, 15625);
382 hi = (rate >> 16) & PTP_RATE_HI_MASK;
388 mutex_lock(&clock->extreg_lock);
390 ext_write(1, phydev, PAGE4, PTP_RATEH, hi);
391 ext_write(1, phydev, PAGE4, PTP_RATEL, lo);
393 mutex_unlock(&clock->extreg_lock);
398 static int ptp_dp83640_adjtime(struct ptp_clock_info *ptp, s64 delta)
400 struct dp83640_clock *clock =
401 container_of(ptp, struct dp83640_clock, caps);
402 struct phy_device *phydev = clock->chosen->phydev;
403 struct timespec64 ts;
406 delta += ADJTIME_FIX;
408 ts = ns_to_timespec64(delta);
410 mutex_lock(&clock->extreg_lock);
412 err = tdr_write(1, phydev, &ts, PTP_STEP_CLK);
414 mutex_unlock(&clock->extreg_lock);
419 static int ptp_dp83640_gettime(struct ptp_clock_info *ptp,
420 struct timespec64 *ts)
422 struct dp83640_clock *clock =
423 container_of(ptp, struct dp83640_clock, caps);
424 struct phy_device *phydev = clock->chosen->phydev;
427 mutex_lock(&clock->extreg_lock);
429 ext_write(0, phydev, PAGE4, PTP_CTL, PTP_RD_CLK);
431 val[0] = ext_read(phydev, PAGE4, PTP_TDR); /* ns[15:0] */
432 val[1] = ext_read(phydev, PAGE4, PTP_TDR); /* ns[31:16] */
433 val[2] = ext_read(phydev, PAGE4, PTP_TDR); /* sec[15:0] */
434 val[3] = ext_read(phydev, PAGE4, PTP_TDR); /* sec[31:16] */
436 mutex_unlock(&clock->extreg_lock);
438 ts->tv_nsec = val[0] | (val[1] << 16);
439 ts->tv_sec = val[2] | (val[3] << 16);
444 static int ptp_dp83640_settime(struct ptp_clock_info *ptp,
445 const struct timespec64 *ts)
447 struct dp83640_clock *clock =
448 container_of(ptp, struct dp83640_clock, caps);
449 struct phy_device *phydev = clock->chosen->phydev;
452 mutex_lock(&clock->extreg_lock);
454 err = tdr_write(1, phydev, ts, PTP_LOAD_CLK);
456 mutex_unlock(&clock->extreg_lock);
461 static int ptp_dp83640_enable(struct ptp_clock_info *ptp,
462 struct ptp_clock_request *rq, int on)
464 struct dp83640_clock *clock =
465 container_of(ptp, struct dp83640_clock, caps);
466 struct phy_device *phydev = clock->chosen->phydev;
468 u16 evnt, event_num, gpio_num;
471 case PTP_CLK_REQ_EXTTS:
472 /* Reject requests with unsupported flags */
473 if (rq->extts.flags & ~(PTP_ENABLE_FEATURE |
479 /* Reject requests to enable time stamping on both edges. */
480 if ((rq->extts.flags & PTP_STRICT_FLAGS) &&
481 (rq->extts.flags & PTP_ENABLE_FEATURE) &&
482 (rq->extts.flags & PTP_EXTTS_EDGES) == PTP_EXTTS_EDGES)
485 index = rq->extts.index;
486 if (index >= N_EXT_TS)
488 event_num = EXT_EVENT + index;
489 evnt = EVNT_WR | (event_num & EVNT_SEL_MASK) << EVNT_SEL_SHIFT;
491 gpio_num = 1 + ptp_find_pin(clock->ptp_clock,
492 PTP_PF_EXTTS, index);
495 evnt |= (gpio_num & EVNT_GPIO_MASK) << EVNT_GPIO_SHIFT;
496 if (rq->extts.flags & PTP_FALLING_EDGE)
501 mutex_lock(&clock->extreg_lock);
502 ext_write(0, phydev, PAGE5, PTP_EVNT, evnt);
503 mutex_unlock(&clock->extreg_lock);
506 case PTP_CLK_REQ_PEROUT:
507 /* Reject requests with unsupported flags */
508 if (rq->perout.flags)
510 if (rq->perout.index >= N_PER_OUT)
512 return periodic_output(clock, rq, on, rq->perout.index);
521 static int ptp_dp83640_verify(struct ptp_clock_info *ptp, unsigned int pin,
522 enum ptp_pin_function func, unsigned int chan)
524 struct dp83640_clock *clock =
525 container_of(ptp, struct dp83640_clock, caps);
527 if (clock->caps.pin_config[pin].func == PTP_PF_PHYSYNC &&
528 !list_empty(&clock->phylist))
531 if (func == PTP_PF_PHYSYNC)
537 static u8 status_frame_dst[6] = { 0x01, 0x1B, 0x19, 0x00, 0x00, 0x00 };
538 static u8 status_frame_src[6] = { 0x08, 0x00, 0x17, 0x0B, 0x6B, 0x0F };
540 static void enable_status_frames(struct phy_device *phydev, bool on)
542 struct dp83640_private *dp83640 = phydev->priv;
543 struct dp83640_clock *clock = dp83640->clock;
547 cfg0 = PSF_EVNT_EN | PSF_RXTS_EN | PSF_TXTS_EN | ENDIAN_FLAG;
549 ver = (PSF_PTPVER & VERSIONPTP_MASK) << VERSIONPTP_SHIFT;
551 mutex_lock(&clock->extreg_lock);
553 ext_write(0, phydev, PAGE5, PSF_CFG0, cfg0);
554 ext_write(0, phydev, PAGE6, PSF_CFG1, ver);
556 mutex_unlock(&clock->extreg_lock);
558 if (!phydev->attached_dev) {
560 "expected to find an attached netdevice\n");
565 if (dev_mc_add(phydev->attached_dev, status_frame_dst))
566 phydev_warn(phydev, "failed to add mc address\n");
568 if (dev_mc_del(phydev->attached_dev, status_frame_dst))
569 phydev_warn(phydev, "failed to delete mc address\n");
573 static bool is_status_frame(struct sk_buff *skb, int type)
575 struct ethhdr *h = eth_hdr(skb);
577 if (PTP_CLASS_V2_L2 == type &&
578 !memcmp(h->h_source, status_frame_src, sizeof(status_frame_src)))
584 static int expired(struct rxts *rxts)
586 return time_after(jiffies, rxts->tmo);
589 /* Caller must hold rx_lock. */
590 static void prune_rx_ts(struct dp83640_private *dp83640)
592 struct list_head *this, *next;
595 list_for_each_safe(this, next, &dp83640->rxts) {
596 rxts = list_entry(this, struct rxts, list);
598 list_del_init(&rxts->list);
599 list_add(&rxts->list, &dp83640->rxpool);
604 /* synchronize the phyters so they act as one clock */
606 static void enable_broadcast(struct phy_device *phydev, int init_page, int on)
609 phy_write(phydev, PAGESEL, 0);
610 val = phy_read(phydev, PHYCR2);
615 phy_write(phydev, PHYCR2, val);
616 phy_write(phydev, PAGESEL, init_page);
619 static void recalibrate(struct dp83640_clock *clock)
622 struct phy_txts event_ts;
623 struct timespec64 ts;
624 struct list_head *this;
625 struct dp83640_private *tmp;
626 struct phy_device *master = clock->chosen->phydev;
627 u16 cal_gpio, cfg0, evnt, ptp_trig, trigger, val;
629 trigger = CAL_TRIGGER;
630 cal_gpio = 1 + ptp_find_pin(clock->ptp_clock, PTP_PF_PHYSYNC, 0);
632 pr_err("PHY calibration pin not available - PHY is not calibrated.");
636 mutex_lock(&clock->extreg_lock);
639 * enable broadcast, disable status frames, enable ptp clock
641 list_for_each(this, &clock->phylist) {
642 tmp = list_entry(this, struct dp83640_private, list);
643 enable_broadcast(tmp->phydev, clock->page, 1);
644 tmp->cfg0 = ext_read(tmp->phydev, PAGE5, PSF_CFG0);
645 ext_write(0, tmp->phydev, PAGE5, PSF_CFG0, 0);
646 ext_write(0, tmp->phydev, PAGE4, PTP_CTL, PTP_ENABLE);
648 enable_broadcast(master, clock->page, 1);
649 cfg0 = ext_read(master, PAGE5, PSF_CFG0);
650 ext_write(0, master, PAGE5, PSF_CFG0, 0);
651 ext_write(0, master, PAGE4, PTP_CTL, PTP_ENABLE);
654 * enable an event timestamp
656 evnt = EVNT_WR | EVNT_RISE | EVNT_SINGLE;
657 evnt |= (CAL_EVENT & EVNT_SEL_MASK) << EVNT_SEL_SHIFT;
658 evnt |= (cal_gpio & EVNT_GPIO_MASK) << EVNT_GPIO_SHIFT;
660 list_for_each(this, &clock->phylist) {
661 tmp = list_entry(this, struct dp83640_private, list);
662 ext_write(0, tmp->phydev, PAGE5, PTP_EVNT, evnt);
664 ext_write(0, master, PAGE5, PTP_EVNT, evnt);
667 * configure a trigger
669 ptp_trig = TRIG_WR | TRIG_IF_LATE | TRIG_PULSE;
670 ptp_trig |= (trigger & TRIG_CSEL_MASK) << TRIG_CSEL_SHIFT;
671 ptp_trig |= (cal_gpio & TRIG_GPIO_MASK) << TRIG_GPIO_SHIFT;
672 ext_write(0, master, PAGE5, PTP_TRIG, ptp_trig);
675 val = (trigger & TRIG_SEL_MASK) << TRIG_SEL_SHIFT;
677 ext_write(0, master, PAGE4, PTP_CTL, val);
682 ext_write(0, master, PAGE4, PTP_CTL, val);
684 /* disable trigger */
685 val = (trigger & TRIG_SEL_MASK) << TRIG_SEL_SHIFT;
687 ext_write(0, master, PAGE4, PTP_CTL, val);
690 * read out and correct offsets
692 val = ext_read(master, PAGE4, PTP_STS);
693 phydev_info(master, "master PTP_STS 0x%04hx\n", val);
694 val = ext_read(master, PAGE4, PTP_ESTS);
695 phydev_info(master, "master PTP_ESTS 0x%04hx\n", val);
696 event_ts.ns_lo = ext_read(master, PAGE4, PTP_EDATA);
697 event_ts.ns_hi = ext_read(master, PAGE4, PTP_EDATA);
698 event_ts.sec_lo = ext_read(master, PAGE4, PTP_EDATA);
699 event_ts.sec_hi = ext_read(master, PAGE4, PTP_EDATA);
700 now = phy2txts(&event_ts);
702 list_for_each(this, &clock->phylist) {
703 tmp = list_entry(this, struct dp83640_private, list);
704 val = ext_read(tmp->phydev, PAGE4, PTP_STS);
705 phydev_info(tmp->phydev, "slave PTP_STS 0x%04hx\n", val);
706 val = ext_read(tmp->phydev, PAGE4, PTP_ESTS);
707 phydev_info(tmp->phydev, "slave PTP_ESTS 0x%04hx\n", val);
708 event_ts.ns_lo = ext_read(tmp->phydev, PAGE4, PTP_EDATA);
709 event_ts.ns_hi = ext_read(tmp->phydev, PAGE4, PTP_EDATA);
710 event_ts.sec_lo = ext_read(tmp->phydev, PAGE4, PTP_EDATA);
711 event_ts.sec_hi = ext_read(tmp->phydev, PAGE4, PTP_EDATA);
712 diff = now - (s64) phy2txts(&event_ts);
713 phydev_info(tmp->phydev, "slave offset %lld nanoseconds\n",
716 ts = ns_to_timespec64(diff);
717 tdr_write(0, tmp->phydev, &ts, PTP_STEP_CLK);
721 * restore status frames
723 list_for_each(this, &clock->phylist) {
724 tmp = list_entry(this, struct dp83640_private, list);
725 ext_write(0, tmp->phydev, PAGE5, PSF_CFG0, tmp->cfg0);
727 ext_write(0, master, PAGE5, PSF_CFG0, cfg0);
729 mutex_unlock(&clock->extreg_lock);
732 /* time stamping methods */
734 static inline u16 exts_chan_to_edata(int ch)
736 return 1 << ((ch + EXT_EVENT) * 2);
739 static int decode_evnt(struct dp83640_private *dp83640,
740 void *data, int len, u16 ests)
742 struct phy_txts *phy_txts;
743 struct ptp_clock_event event;
745 int words = (ests >> EVNT_TS_LEN_SHIFT) & EVNT_TS_LEN_MASK;
748 /* calculate length of the event timestamp status message */
749 if (ests & MULT_EVNT)
750 parsed = (words + 2) * sizeof(u16);
752 parsed = (words + 1) * sizeof(u16);
754 /* check if enough data is available */
758 if (ests & MULT_EVNT) {
759 ext_status = *(u16 *) data;
760 data += sizeof(ext_status);
767 dp83640->edata.sec_hi = phy_txts->sec_hi;
770 dp83640->edata.sec_lo = phy_txts->sec_lo;
773 dp83640->edata.ns_hi = phy_txts->ns_hi;
776 dp83640->edata.ns_lo = phy_txts->ns_lo;
780 i = ((ests >> EVNT_NUM_SHIFT) & EVNT_NUM_MASK) - EXT_EVENT;
781 ext_status = exts_chan_to_edata(i);
784 event.type = PTP_CLOCK_EXTTS;
785 event.timestamp = phy2txts(&dp83640->edata);
787 /* Compensate for input path and synchronization delays */
788 event.timestamp -= 35;
790 for (i = 0; i < N_EXT_TS; i++) {
791 if (ext_status & exts_chan_to_edata(i)) {
793 ptp_clock_event(dp83640->clock->ptp_clock, &event);
800 #define DP83640_PACKET_HASH_OFFSET 20
801 #define DP83640_PACKET_HASH_LEN 10
803 static int match(struct sk_buff *skb, unsigned int type, struct rxts *rxts)
806 unsigned int offset = 0;
807 u8 *msgtype, *data = skb_mac_header(skb);
809 /* check sequenceID, messageType, 12 bit hash of offset 20-29 */
811 if (type & PTP_CLASS_VLAN)
814 switch (type & PTP_CLASS_PMASK) {
816 offset += ETH_HLEN + IPV4_HLEN(data + offset) + UDP_HLEN;
819 offset += ETH_HLEN + IP6_HLEN + UDP_HLEN;
828 if (skb->len + ETH_HLEN < offset + OFF_PTP_SEQUENCE_ID + sizeof(*seqid))
831 if (unlikely(type & PTP_CLASS_V1))
832 msgtype = data + offset + OFF_PTP_CONTROL;
834 msgtype = data + offset;
835 if (rxts->msgtype != (*msgtype & 0xf))
838 seqid = (u16 *)(data + offset + OFF_PTP_SEQUENCE_ID);
839 if (rxts->seqid != ntohs(*seqid))
842 hash = ether_crc(DP83640_PACKET_HASH_LEN,
843 data + offset + DP83640_PACKET_HASH_OFFSET) >> 20;
844 if (rxts->hash != hash)
850 static void decode_rxts(struct dp83640_private *dp83640,
851 struct phy_rxts *phy_rxts)
854 struct skb_shared_hwtstamps *shhwtstamps = NULL;
859 overflow = (phy_rxts->ns_hi >> 14) & 0x3;
861 pr_debug("rx timestamp queue overflow, count %d\n", overflow);
863 spin_lock_irqsave(&dp83640->rx_lock, flags);
865 prune_rx_ts(dp83640);
867 if (list_empty(&dp83640->rxpool)) {
868 pr_debug("rx timestamp pool is empty\n");
871 rxts = list_first_entry(&dp83640->rxpool, struct rxts, list);
872 list_del_init(&rxts->list);
873 phy2rxts(phy_rxts, rxts);
875 spin_lock(&dp83640->rx_queue.lock);
876 skb_queue_walk(&dp83640->rx_queue, skb) {
877 struct dp83640_skb_info *skb_info;
879 skb_info = (struct dp83640_skb_info *)skb->cb;
880 if (match(skb, skb_info->ptp_type, rxts)) {
881 __skb_unlink(skb, &dp83640->rx_queue);
882 shhwtstamps = skb_hwtstamps(skb);
883 memset(shhwtstamps, 0, sizeof(*shhwtstamps));
884 shhwtstamps->hwtstamp = ns_to_ktime(rxts->ns);
885 list_add(&rxts->list, &dp83640->rxpool);
889 spin_unlock(&dp83640->rx_queue.lock);
892 list_add_tail(&rxts->list, &dp83640->rxts);
894 spin_unlock_irqrestore(&dp83640->rx_lock, flags);
900 static void decode_txts(struct dp83640_private *dp83640,
901 struct phy_txts *phy_txts)
903 struct skb_shared_hwtstamps shhwtstamps;
904 struct dp83640_skb_info *skb_info;
909 /* We must already have the skb that triggered this. */
911 skb = skb_dequeue(&dp83640->tx_queue);
913 pr_debug("have timestamp but tx_queue empty\n");
917 overflow = (phy_txts->ns_hi >> 14) & 0x3;
919 pr_debug("tx timestamp queue overflow, count %d\n", overflow);
922 skb = skb_dequeue(&dp83640->tx_queue);
926 skb_info = (struct dp83640_skb_info *)skb->cb;
927 if (time_after(jiffies, skb_info->tmo)) {
932 ns = phy2txts(phy_txts);
933 memset(&shhwtstamps, 0, sizeof(shhwtstamps));
934 shhwtstamps.hwtstamp = ns_to_ktime(ns);
935 skb_complete_tx_timestamp(skb, &shhwtstamps);
938 static void decode_status_frame(struct dp83640_private *dp83640,
941 struct phy_rxts *phy_rxts;
942 struct phy_txts *phy_txts;
949 for (len = skb_headlen(skb) - 2; len > sizeof(type); len -= size) {
952 ests = type & 0x0fff;
953 type = type & 0xf000;
957 if (PSF_RX == type && len >= sizeof(*phy_rxts)) {
959 phy_rxts = (struct phy_rxts *) ptr;
960 decode_rxts(dp83640, phy_rxts);
961 size = sizeof(*phy_rxts);
963 } else if (PSF_TX == type && len >= sizeof(*phy_txts)) {
965 phy_txts = (struct phy_txts *) ptr;
966 decode_txts(dp83640, phy_txts);
967 size = sizeof(*phy_txts);
969 } else if (PSF_EVNT == type) {
971 size = decode_evnt(dp83640, ptr, len, ests);
981 static int is_sync(struct sk_buff *skb, int type)
983 u8 *data = skb->data, *msgtype;
984 unsigned int offset = 0;
986 if (type & PTP_CLASS_VLAN)
989 switch (type & PTP_CLASS_PMASK) {
991 offset += ETH_HLEN + IPV4_HLEN(data + offset) + UDP_HLEN;
994 offset += ETH_HLEN + IP6_HLEN + UDP_HLEN;
1003 if (type & PTP_CLASS_V1)
1004 offset += OFF_PTP_CONTROL;
1006 if (skb->len < offset + 1)
1009 msgtype = data + offset;
1011 return (*msgtype & 0xf) == 0;
1014 static void dp83640_free_clocks(void)
1016 struct dp83640_clock *clock;
1017 struct list_head *this, *next;
1019 mutex_lock(&phyter_clocks_lock);
1021 list_for_each_safe(this, next, &phyter_clocks) {
1022 clock = list_entry(this, struct dp83640_clock, list);
1023 if (!list_empty(&clock->phylist)) {
1024 pr_warn("phy list non-empty while unloading\n");
1027 list_del(&clock->list);
1028 mutex_destroy(&clock->extreg_lock);
1029 mutex_destroy(&clock->clock_lock);
1030 put_device(&clock->bus->dev);
1031 kfree(clock->caps.pin_config);
1035 mutex_unlock(&phyter_clocks_lock);
1038 static void dp83640_clock_init(struct dp83640_clock *clock, struct mii_bus *bus)
1040 INIT_LIST_HEAD(&clock->list);
1042 mutex_init(&clock->extreg_lock);
1043 mutex_init(&clock->clock_lock);
1044 INIT_LIST_HEAD(&clock->phylist);
1045 clock->caps.owner = THIS_MODULE;
1046 sprintf(clock->caps.name, "dp83640 timer");
1047 clock->caps.max_adj = 1953124;
1048 clock->caps.n_alarm = 0;
1049 clock->caps.n_ext_ts = N_EXT_TS;
1050 clock->caps.n_per_out = N_PER_OUT;
1051 clock->caps.n_pins = DP83640_N_PINS;
1052 clock->caps.pps = 0;
1053 clock->caps.adjfine = ptp_dp83640_adjfine;
1054 clock->caps.adjtime = ptp_dp83640_adjtime;
1055 clock->caps.gettime64 = ptp_dp83640_gettime;
1056 clock->caps.settime64 = ptp_dp83640_settime;
1057 clock->caps.enable = ptp_dp83640_enable;
1058 clock->caps.verify = ptp_dp83640_verify;
1060 * Convert the module param defaults into a dynamic pin configuration.
1062 dp83640_gpio_defaults(clock->caps.pin_config);
1064 * Get a reference to this bus instance.
1066 get_device(&bus->dev);
1069 static int choose_this_phy(struct dp83640_clock *clock,
1070 struct phy_device *phydev)
1072 if (chosen_phy == -1 && !clock->chosen)
1075 if (chosen_phy == phydev->mdio.addr)
1081 static struct dp83640_clock *dp83640_clock_get(struct dp83640_clock *clock)
1084 mutex_lock(&clock->clock_lock);
1089 * Look up and lock a clock by bus instance.
1090 * If there is no clock for this bus, then create it first.
1092 static struct dp83640_clock *dp83640_clock_get_bus(struct mii_bus *bus)
1094 struct dp83640_clock *clock = NULL, *tmp;
1095 struct list_head *this;
1097 mutex_lock(&phyter_clocks_lock);
1099 list_for_each(this, &phyter_clocks) {
1100 tmp = list_entry(this, struct dp83640_clock, list);
1101 if (tmp->bus == bus) {
1109 clock = kzalloc(sizeof(struct dp83640_clock), GFP_KERNEL);
1113 clock->caps.pin_config = kcalloc(DP83640_N_PINS,
1114 sizeof(struct ptp_pin_desc),
1116 if (!clock->caps.pin_config) {
1121 dp83640_clock_init(clock, bus);
1122 list_add_tail(&phyter_clocks, &clock->list);
1124 mutex_unlock(&phyter_clocks_lock);
1126 return dp83640_clock_get(clock);
1129 static void dp83640_clock_put(struct dp83640_clock *clock)
1131 mutex_unlock(&clock->clock_lock);
1134 static int dp83640_probe(struct phy_device *phydev)
1136 struct dp83640_clock *clock;
1137 struct dp83640_private *dp83640;
1138 int err = -ENOMEM, i;
1140 if (phydev->mdio.addr == BROADCAST_ADDR)
1143 clock = dp83640_clock_get_bus(phydev->mdio.bus);
1147 dp83640 = kzalloc(sizeof(struct dp83640_private), GFP_KERNEL);
1151 dp83640->phydev = phydev;
1152 INIT_DELAYED_WORK(&dp83640->ts_work, rx_timestamp_work);
1154 INIT_LIST_HEAD(&dp83640->rxts);
1155 INIT_LIST_HEAD(&dp83640->rxpool);
1156 for (i = 0; i < MAX_RXTS; i++)
1157 list_add(&dp83640->rx_pool_data[i].list, &dp83640->rxpool);
1159 phydev->priv = dp83640;
1161 spin_lock_init(&dp83640->rx_lock);
1162 skb_queue_head_init(&dp83640->rx_queue);
1163 skb_queue_head_init(&dp83640->tx_queue);
1165 dp83640->clock = clock;
1167 if (choose_this_phy(clock, phydev)) {
1168 clock->chosen = dp83640;
1169 clock->ptp_clock = ptp_clock_register(&clock->caps,
1171 if (IS_ERR(clock->ptp_clock)) {
1172 err = PTR_ERR(clock->ptp_clock);
1176 list_add_tail(&dp83640->list, &clock->phylist);
1178 dp83640_clock_put(clock);
1182 clock->chosen = NULL;
1185 dp83640_clock_put(clock);
1190 static void dp83640_remove(struct phy_device *phydev)
1192 struct dp83640_clock *clock;
1193 struct list_head *this, *next;
1194 struct dp83640_private *tmp, *dp83640 = phydev->priv;
1196 if (phydev->mdio.addr == BROADCAST_ADDR)
1199 enable_status_frames(phydev, false);
1200 cancel_delayed_work_sync(&dp83640->ts_work);
1202 skb_queue_purge(&dp83640->rx_queue);
1203 skb_queue_purge(&dp83640->tx_queue);
1205 clock = dp83640_clock_get(dp83640->clock);
1207 if (dp83640 == clock->chosen) {
1208 ptp_clock_unregister(clock->ptp_clock);
1209 clock->chosen = NULL;
1211 list_for_each_safe(this, next, &clock->phylist) {
1212 tmp = list_entry(this, struct dp83640_private, list);
1213 if (tmp == dp83640) {
1214 list_del_init(&tmp->list);
1220 dp83640_clock_put(clock);
1224 static int dp83640_soft_reset(struct phy_device *phydev)
1228 ret = genphy_soft_reset(phydev);
1232 /* From DP83640 datasheet: "Software driver code must wait 3 us
1233 * following a software reset before allowing further serial MII
1234 * operations with the DP83640."
1236 udelay(10); /* Taking udelay inaccuracy into account */
1241 static int dp83640_config_init(struct phy_device *phydev)
1243 struct dp83640_private *dp83640 = phydev->priv;
1244 struct dp83640_clock *clock = dp83640->clock;
1246 if (clock->chosen && !list_empty(&clock->phylist))
1249 mutex_lock(&clock->extreg_lock);
1250 enable_broadcast(phydev, clock->page, 1);
1251 mutex_unlock(&clock->extreg_lock);
1254 enable_status_frames(phydev, true);
1256 mutex_lock(&clock->extreg_lock);
1257 ext_write(0, phydev, PAGE4, PTP_CTL, PTP_ENABLE);
1258 mutex_unlock(&clock->extreg_lock);
1263 static int dp83640_ack_interrupt(struct phy_device *phydev)
1265 int err = phy_read(phydev, MII_DP83640_MISR);
1273 static int dp83640_config_intr(struct phy_device *phydev)
1279 if (phydev->interrupts == PHY_INTERRUPT_ENABLED) {
1280 misr = phy_read(phydev, MII_DP83640_MISR);
1284 (MII_DP83640_MISR_ANC_INT_EN |
1285 MII_DP83640_MISR_DUP_INT_EN |
1286 MII_DP83640_MISR_SPD_INT_EN |
1287 MII_DP83640_MISR_LINK_INT_EN);
1288 err = phy_write(phydev, MII_DP83640_MISR, misr);
1292 micr = phy_read(phydev, MII_DP83640_MICR);
1296 (MII_DP83640_MICR_OE |
1297 MII_DP83640_MICR_IE);
1298 return phy_write(phydev, MII_DP83640_MICR, micr);
1300 micr = phy_read(phydev, MII_DP83640_MICR);
1304 ~(MII_DP83640_MICR_OE |
1305 MII_DP83640_MICR_IE);
1306 err = phy_write(phydev, MII_DP83640_MICR, micr);
1310 misr = phy_read(phydev, MII_DP83640_MISR);
1314 ~(MII_DP83640_MISR_ANC_INT_EN |
1315 MII_DP83640_MISR_DUP_INT_EN |
1316 MII_DP83640_MISR_SPD_INT_EN |
1317 MII_DP83640_MISR_LINK_INT_EN);
1318 return phy_write(phydev, MII_DP83640_MISR, misr);
1322 static int dp83640_hwtstamp(struct phy_device *phydev, struct ifreq *ifr)
1324 struct dp83640_private *dp83640 = phydev->priv;
1325 struct hwtstamp_config cfg;
1328 if (copy_from_user(&cfg, ifr->ifr_data, sizeof(cfg)))
1331 if (cfg.flags) /* reserved for future extensions */
1334 if (cfg.tx_type < 0 || cfg.tx_type > HWTSTAMP_TX_ONESTEP_SYNC)
1337 dp83640->hwts_tx_en = cfg.tx_type;
1339 switch (cfg.rx_filter) {
1340 case HWTSTAMP_FILTER_NONE:
1341 dp83640->hwts_rx_en = 0;
1343 dp83640->version = 0;
1345 case HWTSTAMP_FILTER_PTP_V1_L4_EVENT:
1346 case HWTSTAMP_FILTER_PTP_V1_L4_SYNC:
1347 case HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ:
1348 dp83640->hwts_rx_en = 1;
1349 dp83640->layer = PTP_CLASS_L4;
1350 dp83640->version = PTP_CLASS_V1;
1352 case HWTSTAMP_FILTER_PTP_V2_L4_EVENT:
1353 case HWTSTAMP_FILTER_PTP_V2_L4_SYNC:
1354 case HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ:
1355 dp83640->hwts_rx_en = 1;
1356 dp83640->layer = PTP_CLASS_L4;
1357 dp83640->version = PTP_CLASS_V2;
1359 case HWTSTAMP_FILTER_PTP_V2_L2_EVENT:
1360 case HWTSTAMP_FILTER_PTP_V2_L2_SYNC:
1361 case HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ:
1362 dp83640->hwts_rx_en = 1;
1363 dp83640->layer = PTP_CLASS_L2;
1364 dp83640->version = PTP_CLASS_V2;
1366 case HWTSTAMP_FILTER_PTP_V2_EVENT:
1367 case HWTSTAMP_FILTER_PTP_V2_SYNC:
1368 case HWTSTAMP_FILTER_PTP_V2_DELAY_REQ:
1369 dp83640->hwts_rx_en = 1;
1370 dp83640->layer = PTP_CLASS_L4 | PTP_CLASS_L2;
1371 dp83640->version = PTP_CLASS_V2;
1377 txcfg0 = (dp83640->version & TX_PTP_VER_MASK) << TX_PTP_VER_SHIFT;
1378 rxcfg0 = (dp83640->version & TX_PTP_VER_MASK) << TX_PTP_VER_SHIFT;
1380 if (dp83640->layer & PTP_CLASS_L2) {
1384 if (dp83640->layer & PTP_CLASS_L4) {
1385 txcfg0 |= TX_IPV6_EN | TX_IPV4_EN;
1386 rxcfg0 |= RX_IPV6_EN | RX_IPV4_EN;
1389 if (dp83640->hwts_tx_en)
1392 if (dp83640->hwts_tx_en == HWTSTAMP_TX_ONESTEP_SYNC)
1393 txcfg0 |= SYNC_1STEP | CHK_1STEP;
1395 if (dp83640->hwts_rx_en)
1398 mutex_lock(&dp83640->clock->extreg_lock);
1400 ext_write(0, phydev, PAGE5, PTP_TXCFG0, txcfg0);
1401 ext_write(0, phydev, PAGE5, PTP_RXCFG0, rxcfg0);
1403 mutex_unlock(&dp83640->clock->extreg_lock);
1405 return copy_to_user(ifr->ifr_data, &cfg, sizeof(cfg)) ? -EFAULT : 0;
1408 static void rx_timestamp_work(struct work_struct *work)
1410 struct dp83640_private *dp83640 =
1411 container_of(work, struct dp83640_private, ts_work.work);
1412 struct sk_buff *skb;
1414 /* Deliver expired packets. */
1415 while ((skb = skb_dequeue(&dp83640->rx_queue))) {
1416 struct dp83640_skb_info *skb_info;
1418 skb_info = (struct dp83640_skb_info *)skb->cb;
1419 if (!time_after(jiffies, skb_info->tmo)) {
1420 skb_queue_head(&dp83640->rx_queue, skb);
1427 if (!skb_queue_empty(&dp83640->rx_queue))
1428 schedule_delayed_work(&dp83640->ts_work, SKB_TIMESTAMP_TIMEOUT);
1431 static bool dp83640_rxtstamp(struct phy_device *phydev,
1432 struct sk_buff *skb, int type)
1434 struct dp83640_private *dp83640 = phydev->priv;
1435 struct dp83640_skb_info *skb_info = (struct dp83640_skb_info *)skb->cb;
1436 struct list_head *this, *next;
1438 struct skb_shared_hwtstamps *shhwtstamps = NULL;
1439 unsigned long flags;
1441 if (is_status_frame(skb, type)) {
1442 decode_status_frame(dp83640, skb);
1447 if (!dp83640->hwts_rx_en)
1450 if ((type & dp83640->version) == 0 || (type & dp83640->layer) == 0)
1453 spin_lock_irqsave(&dp83640->rx_lock, flags);
1454 prune_rx_ts(dp83640);
1455 list_for_each_safe(this, next, &dp83640->rxts) {
1456 rxts = list_entry(this, struct rxts, list);
1457 if (match(skb, type, rxts)) {
1458 shhwtstamps = skb_hwtstamps(skb);
1459 memset(shhwtstamps, 0, sizeof(*shhwtstamps));
1460 shhwtstamps->hwtstamp = ns_to_ktime(rxts->ns);
1461 list_del_init(&rxts->list);
1462 list_add(&rxts->list, &dp83640->rxpool);
1466 spin_unlock_irqrestore(&dp83640->rx_lock, flags);
1469 skb_info->ptp_type = type;
1470 skb_info->tmo = jiffies + SKB_TIMESTAMP_TIMEOUT;
1471 skb_queue_tail(&dp83640->rx_queue, skb);
1472 schedule_delayed_work(&dp83640->ts_work, SKB_TIMESTAMP_TIMEOUT);
1480 static void dp83640_txtstamp(struct phy_device *phydev,
1481 struct sk_buff *skb, int type)
1483 struct dp83640_skb_info *skb_info = (struct dp83640_skb_info *)skb->cb;
1484 struct dp83640_private *dp83640 = phydev->priv;
1486 switch (dp83640->hwts_tx_en) {
1488 case HWTSTAMP_TX_ONESTEP_SYNC:
1489 if (is_sync(skb, type)) {
1494 case HWTSTAMP_TX_ON:
1495 skb_shinfo(skb)->tx_flags |= SKBTX_IN_PROGRESS;
1496 skb_info->tmo = jiffies + SKB_TIMESTAMP_TIMEOUT;
1497 skb_queue_tail(&dp83640->tx_queue, skb);
1500 case HWTSTAMP_TX_OFF:
1507 static int dp83640_ts_info(struct phy_device *dev, struct ethtool_ts_info *info)
1509 struct dp83640_private *dp83640 = dev->priv;
1511 info->so_timestamping =
1512 SOF_TIMESTAMPING_TX_HARDWARE |
1513 SOF_TIMESTAMPING_RX_HARDWARE |
1514 SOF_TIMESTAMPING_RAW_HARDWARE;
1515 info->phc_index = ptp_clock_index(dp83640->clock->ptp_clock);
1517 (1 << HWTSTAMP_TX_OFF) |
1518 (1 << HWTSTAMP_TX_ON) |
1519 (1 << HWTSTAMP_TX_ONESTEP_SYNC);
1521 (1 << HWTSTAMP_FILTER_NONE) |
1522 (1 << HWTSTAMP_FILTER_PTP_V1_L4_EVENT) |
1523 (1 << HWTSTAMP_FILTER_PTP_V2_L4_EVENT) |
1524 (1 << HWTSTAMP_FILTER_PTP_V2_L2_EVENT) |
1525 (1 << HWTSTAMP_FILTER_PTP_V2_EVENT);
1529 static struct phy_driver dp83640_driver = {
1530 .phy_id = DP83640_PHY_ID,
1531 .phy_id_mask = 0xfffffff0,
1532 .name = "NatSemi DP83640",
1533 /* PHY_BASIC_FEATURES */
1534 .probe = dp83640_probe,
1535 .remove = dp83640_remove,
1536 .soft_reset = dp83640_soft_reset,
1537 .config_init = dp83640_config_init,
1538 .ack_interrupt = dp83640_ack_interrupt,
1539 .config_intr = dp83640_config_intr,
1540 .ts_info = dp83640_ts_info,
1541 .hwtstamp = dp83640_hwtstamp,
1542 .rxtstamp = dp83640_rxtstamp,
1543 .txtstamp = dp83640_txtstamp,
1546 static int __init dp83640_init(void)
1548 return phy_driver_register(&dp83640_driver, THIS_MODULE);
1551 static void __exit dp83640_exit(void)
1553 dp83640_free_clocks();
1554 phy_driver_unregister(&dp83640_driver);
1557 MODULE_DESCRIPTION("National Semiconductor DP83640 PHY driver");
1558 MODULE_AUTHOR("Richard Cochran <richardcochran@gmail.com>");
1559 MODULE_LICENSE("GPL");
1561 module_init(dp83640_init);
1562 module_exit(dp83640_exit);
1564 static struct mdio_device_id __maybe_unused dp83640_tbl[] = {
1565 { DP83640_PHY_ID, 0xfffffff0 },
1569 MODULE_DEVICE_TABLE(mdio, dp83640_tbl);