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 mii_timestamper mii_ts;
102 struct delayed_work ts_work;
107 /* remember state of cfg0 during calibration */
109 /* remember the last event time stamp */
110 struct phy_txts edata;
111 /* list of rx timestamps */
112 struct list_head rxts;
113 struct list_head rxpool;
114 struct rxts rx_pool_data[MAX_RXTS];
115 /* protects above three fields from concurrent access */
117 /* queues of incoming and outgoing packets */
118 struct sk_buff_head rx_queue;
119 struct sk_buff_head tx_queue;
122 struct dp83640_clock {
123 /* keeps the instance in the 'phyter_clocks' list */
124 struct list_head list;
125 /* we create one clock instance per MII bus */
127 /* protects extended registers from concurrent access */
128 struct mutex extreg_lock;
129 /* remembers which page was last selected */
131 /* our advertised capabilities */
132 struct ptp_clock_info caps;
133 /* protects the three fields below from concurrent access */
134 struct mutex clock_lock;
135 /* the one phyter from which we shall read */
136 struct dp83640_private *chosen;
137 /* list of the other attached phyters, not chosen */
138 struct list_head phylist;
139 /* reference to our PTP hardware clock */
140 struct ptp_clock *ptp_clock;
157 static int chosen_phy = -1;
158 static ushort gpio_tab[GPIO_TABLE_SIZE] = {
159 1, 2, 3, 4, 8, 9, 10, 11
162 module_param(chosen_phy, int, 0444);
163 module_param_array(gpio_tab, ushort, NULL, 0444);
165 MODULE_PARM_DESC(chosen_phy, \
166 "The address of the PHY to use for the ancillary clock features");
167 MODULE_PARM_DESC(gpio_tab, \
168 "Which GPIO line to use for which purpose: cal,perout,extts1,...,extts6");
170 static void dp83640_gpio_defaults(struct ptp_pin_desc *pd)
174 for (i = 0; i < DP83640_N_PINS; i++) {
175 snprintf(pd[i].name, sizeof(pd[i].name), "GPIO%d", 1 + i);
179 for (i = 0; i < GPIO_TABLE_SIZE; i++) {
180 if (gpio_tab[i] < 1 || gpio_tab[i] > DP83640_N_PINS) {
181 pr_err("gpio_tab[%d]=%hu out of range", i, gpio_tab[i]);
186 index = gpio_tab[CALIBRATE_GPIO] - 1;
187 pd[index].func = PTP_PF_PHYSYNC;
190 index = gpio_tab[PEROUT_GPIO] - 1;
191 pd[index].func = PTP_PF_PEROUT;
194 for (i = EXTTS0_GPIO; i < GPIO_TABLE_SIZE; i++) {
195 index = gpio_tab[i] - 1;
196 pd[index].func = PTP_PF_EXTTS;
197 pd[index].chan = i - EXTTS0_GPIO;
201 /* a list of clocks and a mutex to protect it */
202 static LIST_HEAD(phyter_clocks);
203 static DEFINE_MUTEX(phyter_clocks_lock);
205 static void rx_timestamp_work(struct work_struct *work);
207 /* extended register access functions */
209 #define BROADCAST_ADDR 31
211 static inline int broadcast_write(struct phy_device *phydev, u32 regnum,
214 return mdiobus_write(phydev->mdio.bus, BROADCAST_ADDR, regnum, val);
217 /* Caller must hold extreg_lock. */
218 static int ext_read(struct phy_device *phydev, int page, u32 regnum)
220 struct dp83640_private *dp83640 = phydev->priv;
223 if (dp83640->clock->page != page) {
224 broadcast_write(phydev, PAGESEL, page);
225 dp83640->clock->page = page;
227 val = phy_read(phydev, regnum);
232 /* Caller must hold extreg_lock. */
233 static void ext_write(int broadcast, struct phy_device *phydev,
234 int page, u32 regnum, u16 val)
236 struct dp83640_private *dp83640 = phydev->priv;
238 if (dp83640->clock->page != page) {
239 broadcast_write(phydev, PAGESEL, page);
240 dp83640->clock->page = page;
243 broadcast_write(phydev, regnum, val);
245 phy_write(phydev, regnum, val);
248 /* Caller must hold extreg_lock. */
249 static int tdr_write(int bc, struct phy_device *dev,
250 const struct timespec64 *ts, u16 cmd)
252 ext_write(bc, dev, PAGE4, PTP_TDR, ts->tv_nsec & 0xffff);/* ns[15:0] */
253 ext_write(bc, dev, PAGE4, PTP_TDR, ts->tv_nsec >> 16); /* ns[31:16] */
254 ext_write(bc, dev, PAGE4, PTP_TDR, ts->tv_sec & 0xffff); /* sec[15:0] */
255 ext_write(bc, dev, PAGE4, PTP_TDR, ts->tv_sec >> 16); /* sec[31:16]*/
257 ext_write(bc, dev, PAGE4, PTP_CTL, cmd);
262 /* convert phy timestamps into driver timestamps */
264 static void phy2rxts(struct phy_rxts *p, struct rxts *rxts)
269 sec |= p->sec_hi << 16;
272 rxts->ns |= (p->ns_hi & 0x3fff) << 16;
273 rxts->ns += ((u64)sec) * 1000000000ULL;
274 rxts->seqid = p->seqid;
275 rxts->msgtype = (p->msgtype >> 12) & 0xf;
276 rxts->hash = p->msgtype & 0x0fff;
277 rxts->tmo = jiffies + SKB_TIMESTAMP_TIMEOUT;
280 static u64 phy2txts(struct phy_txts *p)
286 sec |= p->sec_hi << 16;
289 ns |= (p->ns_hi & 0x3fff) << 16;
290 ns += ((u64)sec) * 1000000000ULL;
295 static int periodic_output(struct dp83640_clock *clock,
296 struct ptp_clock_request *clkreq, bool on,
299 struct dp83640_private *dp83640 = clock->chosen;
300 struct phy_device *phydev = dp83640->phydev;
301 u32 sec, nsec, pwidth;
302 u16 gpio, ptp_trig, val;
305 gpio = 1 + ptp_find_pin(clock->ptp_clock, PTP_PF_PEROUT,
314 (trigger & TRIG_CSEL_MASK) << TRIG_CSEL_SHIFT |
315 (gpio & TRIG_GPIO_MASK) << TRIG_GPIO_SHIFT |
319 val = (trigger & TRIG_SEL_MASK) << TRIG_SEL_SHIFT;
323 mutex_lock(&clock->extreg_lock);
324 ext_write(0, phydev, PAGE5, PTP_TRIG, ptp_trig);
325 ext_write(0, phydev, PAGE4, PTP_CTL, val);
326 mutex_unlock(&clock->extreg_lock);
330 sec = clkreq->perout.start.sec;
331 nsec = clkreq->perout.start.nsec;
332 pwidth = clkreq->perout.period.sec * 1000000000UL;
333 pwidth += clkreq->perout.period.nsec;
336 mutex_lock(&clock->extreg_lock);
338 ext_write(0, phydev, PAGE5, PTP_TRIG, ptp_trig);
342 ext_write(0, phydev, PAGE4, PTP_CTL, val);
343 ext_write(0, phydev, PAGE4, PTP_TDR, nsec & 0xffff); /* ns[15:0] */
344 ext_write(0, phydev, PAGE4, PTP_TDR, nsec >> 16); /* ns[31:16] */
345 ext_write(0, phydev, PAGE4, PTP_TDR, sec & 0xffff); /* sec[15:0] */
346 ext_write(0, phydev, PAGE4, PTP_TDR, sec >> 16); /* sec[31:16] */
347 ext_write(0, phydev, PAGE4, PTP_TDR, pwidth & 0xffff); /* ns[15:0] */
348 ext_write(0, phydev, PAGE4, PTP_TDR, pwidth >> 16); /* ns[31:16] */
349 /* Triggers 0 and 1 has programmable pulsewidth2 */
351 ext_write(0, phydev, PAGE4, PTP_TDR, pwidth & 0xffff);
352 ext_write(0, phydev, PAGE4, PTP_TDR, pwidth >> 16);
358 ext_write(0, phydev, PAGE4, PTP_CTL, val);
360 mutex_unlock(&clock->extreg_lock);
364 /* ptp clock methods */
366 static int ptp_dp83640_adjfine(struct ptp_clock_info *ptp, long scaled_ppm)
368 struct dp83640_clock *clock =
369 container_of(ptp, struct dp83640_clock, caps);
370 struct phy_device *phydev = clock->chosen->phydev;
375 if (scaled_ppm < 0) {
377 scaled_ppm = -scaled_ppm;
381 rate = div_u64(rate, 15625);
383 hi = (rate >> 16) & PTP_RATE_HI_MASK;
389 mutex_lock(&clock->extreg_lock);
391 ext_write(1, phydev, PAGE4, PTP_RATEH, hi);
392 ext_write(1, phydev, PAGE4, PTP_RATEL, lo);
394 mutex_unlock(&clock->extreg_lock);
399 static int ptp_dp83640_adjtime(struct ptp_clock_info *ptp, s64 delta)
401 struct dp83640_clock *clock =
402 container_of(ptp, struct dp83640_clock, caps);
403 struct phy_device *phydev = clock->chosen->phydev;
404 struct timespec64 ts;
407 delta += ADJTIME_FIX;
409 ts = ns_to_timespec64(delta);
411 mutex_lock(&clock->extreg_lock);
413 err = tdr_write(1, phydev, &ts, PTP_STEP_CLK);
415 mutex_unlock(&clock->extreg_lock);
420 static int ptp_dp83640_gettime(struct ptp_clock_info *ptp,
421 struct timespec64 *ts)
423 struct dp83640_clock *clock =
424 container_of(ptp, struct dp83640_clock, caps);
425 struct phy_device *phydev = clock->chosen->phydev;
428 mutex_lock(&clock->extreg_lock);
430 ext_write(0, phydev, PAGE4, PTP_CTL, PTP_RD_CLK);
432 val[0] = ext_read(phydev, PAGE4, PTP_TDR); /* ns[15:0] */
433 val[1] = ext_read(phydev, PAGE4, PTP_TDR); /* ns[31:16] */
434 val[2] = ext_read(phydev, PAGE4, PTP_TDR); /* sec[15:0] */
435 val[3] = ext_read(phydev, PAGE4, PTP_TDR); /* sec[31:16] */
437 mutex_unlock(&clock->extreg_lock);
439 ts->tv_nsec = val[0] | (val[1] << 16);
440 ts->tv_sec = val[2] | (val[3] << 16);
445 static int ptp_dp83640_settime(struct ptp_clock_info *ptp,
446 const struct timespec64 *ts)
448 struct dp83640_clock *clock =
449 container_of(ptp, struct dp83640_clock, caps);
450 struct phy_device *phydev = clock->chosen->phydev;
453 mutex_lock(&clock->extreg_lock);
455 err = tdr_write(1, phydev, ts, PTP_LOAD_CLK);
457 mutex_unlock(&clock->extreg_lock);
462 static int ptp_dp83640_enable(struct ptp_clock_info *ptp,
463 struct ptp_clock_request *rq, int on)
465 struct dp83640_clock *clock =
466 container_of(ptp, struct dp83640_clock, caps);
467 struct phy_device *phydev = clock->chosen->phydev;
469 u16 evnt, event_num, gpio_num;
472 case PTP_CLK_REQ_EXTTS:
473 /* Reject requests with unsupported flags */
474 if (rq->extts.flags & ~(PTP_ENABLE_FEATURE |
480 /* Reject requests to enable time stamping on both edges. */
481 if ((rq->extts.flags & PTP_STRICT_FLAGS) &&
482 (rq->extts.flags & PTP_ENABLE_FEATURE) &&
483 (rq->extts.flags & PTP_EXTTS_EDGES) == PTP_EXTTS_EDGES)
486 index = rq->extts.index;
487 if (index >= N_EXT_TS)
489 event_num = EXT_EVENT + index;
490 evnt = EVNT_WR | (event_num & EVNT_SEL_MASK) << EVNT_SEL_SHIFT;
492 gpio_num = 1 + ptp_find_pin(clock->ptp_clock,
493 PTP_PF_EXTTS, index);
496 evnt |= (gpio_num & EVNT_GPIO_MASK) << EVNT_GPIO_SHIFT;
497 if (rq->extts.flags & PTP_FALLING_EDGE)
502 mutex_lock(&clock->extreg_lock);
503 ext_write(0, phydev, PAGE5, PTP_EVNT, evnt);
504 mutex_unlock(&clock->extreg_lock);
507 case PTP_CLK_REQ_PEROUT:
508 /* Reject requests with unsupported flags */
509 if (rq->perout.flags)
511 if (rq->perout.index >= N_PER_OUT)
513 return periodic_output(clock, rq, on, rq->perout.index);
522 static int ptp_dp83640_verify(struct ptp_clock_info *ptp, unsigned int pin,
523 enum ptp_pin_function func, unsigned int chan)
525 struct dp83640_clock *clock =
526 container_of(ptp, struct dp83640_clock, caps);
528 if (clock->caps.pin_config[pin].func == PTP_PF_PHYSYNC &&
529 !list_empty(&clock->phylist))
532 if (func == PTP_PF_PHYSYNC)
538 static u8 status_frame_dst[6] = { 0x01, 0x1B, 0x19, 0x00, 0x00, 0x00 };
539 static u8 status_frame_src[6] = { 0x08, 0x00, 0x17, 0x0B, 0x6B, 0x0F };
541 static void enable_status_frames(struct phy_device *phydev, bool on)
543 struct dp83640_private *dp83640 = phydev->priv;
544 struct dp83640_clock *clock = dp83640->clock;
548 cfg0 = PSF_EVNT_EN | PSF_RXTS_EN | PSF_TXTS_EN | ENDIAN_FLAG;
550 ver = (PSF_PTPVER & VERSIONPTP_MASK) << VERSIONPTP_SHIFT;
552 mutex_lock(&clock->extreg_lock);
554 ext_write(0, phydev, PAGE5, PSF_CFG0, cfg0);
555 ext_write(0, phydev, PAGE6, PSF_CFG1, ver);
557 mutex_unlock(&clock->extreg_lock);
559 if (!phydev->attached_dev) {
561 "expected to find an attached netdevice\n");
566 if (dev_mc_add(phydev->attached_dev, status_frame_dst))
567 phydev_warn(phydev, "failed to add mc address\n");
569 if (dev_mc_del(phydev->attached_dev, status_frame_dst))
570 phydev_warn(phydev, "failed to delete mc address\n");
574 static bool is_status_frame(struct sk_buff *skb, int type)
576 struct ethhdr *h = eth_hdr(skb);
578 if (PTP_CLASS_V2_L2 == type &&
579 !memcmp(h->h_source, status_frame_src, sizeof(status_frame_src)))
585 static int expired(struct rxts *rxts)
587 return time_after(jiffies, rxts->tmo);
590 /* Caller must hold rx_lock. */
591 static void prune_rx_ts(struct dp83640_private *dp83640)
593 struct list_head *this, *next;
596 list_for_each_safe(this, next, &dp83640->rxts) {
597 rxts = list_entry(this, struct rxts, list);
599 list_del_init(&rxts->list);
600 list_add(&rxts->list, &dp83640->rxpool);
605 /* synchronize the phyters so they act as one clock */
607 static void enable_broadcast(struct phy_device *phydev, int init_page, int on)
610 phy_write(phydev, PAGESEL, 0);
611 val = phy_read(phydev, PHYCR2);
616 phy_write(phydev, PHYCR2, val);
617 phy_write(phydev, PAGESEL, init_page);
620 static void recalibrate(struct dp83640_clock *clock)
623 struct phy_txts event_ts;
624 struct timespec64 ts;
625 struct list_head *this;
626 struct dp83640_private *tmp;
627 struct phy_device *master = clock->chosen->phydev;
628 u16 cal_gpio, cfg0, evnt, ptp_trig, trigger, val;
630 trigger = CAL_TRIGGER;
631 cal_gpio = 1 + ptp_find_pin_unlocked(clock->ptp_clock, PTP_PF_PHYSYNC, 0);
633 pr_err("PHY calibration pin not available - PHY is not calibrated.");
637 mutex_lock(&clock->extreg_lock);
640 * enable broadcast, disable status frames, enable ptp clock
642 list_for_each(this, &clock->phylist) {
643 tmp = list_entry(this, struct dp83640_private, list);
644 enable_broadcast(tmp->phydev, clock->page, 1);
645 tmp->cfg0 = ext_read(tmp->phydev, PAGE5, PSF_CFG0);
646 ext_write(0, tmp->phydev, PAGE5, PSF_CFG0, 0);
647 ext_write(0, tmp->phydev, PAGE4, PTP_CTL, PTP_ENABLE);
649 enable_broadcast(master, clock->page, 1);
650 cfg0 = ext_read(master, PAGE5, PSF_CFG0);
651 ext_write(0, master, PAGE5, PSF_CFG0, 0);
652 ext_write(0, master, PAGE4, PTP_CTL, PTP_ENABLE);
655 * enable an event timestamp
657 evnt = EVNT_WR | EVNT_RISE | EVNT_SINGLE;
658 evnt |= (CAL_EVENT & EVNT_SEL_MASK) << EVNT_SEL_SHIFT;
659 evnt |= (cal_gpio & EVNT_GPIO_MASK) << EVNT_GPIO_SHIFT;
661 list_for_each(this, &clock->phylist) {
662 tmp = list_entry(this, struct dp83640_private, list);
663 ext_write(0, tmp->phydev, PAGE5, PTP_EVNT, evnt);
665 ext_write(0, master, PAGE5, PTP_EVNT, evnt);
668 * configure a trigger
670 ptp_trig = TRIG_WR | TRIG_IF_LATE | TRIG_PULSE;
671 ptp_trig |= (trigger & TRIG_CSEL_MASK) << TRIG_CSEL_SHIFT;
672 ptp_trig |= (cal_gpio & TRIG_GPIO_MASK) << TRIG_GPIO_SHIFT;
673 ext_write(0, master, PAGE5, PTP_TRIG, ptp_trig);
676 val = (trigger & TRIG_SEL_MASK) << TRIG_SEL_SHIFT;
678 ext_write(0, master, PAGE4, PTP_CTL, val);
683 ext_write(0, master, PAGE4, PTP_CTL, val);
685 /* disable trigger */
686 val = (trigger & TRIG_SEL_MASK) << TRIG_SEL_SHIFT;
688 ext_write(0, master, PAGE4, PTP_CTL, val);
691 * read out and correct offsets
693 val = ext_read(master, PAGE4, PTP_STS);
694 phydev_info(master, "master PTP_STS 0x%04hx\n", val);
695 val = ext_read(master, PAGE4, PTP_ESTS);
696 phydev_info(master, "master PTP_ESTS 0x%04hx\n", val);
697 event_ts.ns_lo = ext_read(master, PAGE4, PTP_EDATA);
698 event_ts.ns_hi = ext_read(master, PAGE4, PTP_EDATA);
699 event_ts.sec_lo = ext_read(master, PAGE4, PTP_EDATA);
700 event_ts.sec_hi = ext_read(master, PAGE4, PTP_EDATA);
701 now = phy2txts(&event_ts);
703 list_for_each(this, &clock->phylist) {
704 tmp = list_entry(this, struct dp83640_private, list);
705 val = ext_read(tmp->phydev, PAGE4, PTP_STS);
706 phydev_info(tmp->phydev, "slave PTP_STS 0x%04hx\n", val);
707 val = ext_read(tmp->phydev, PAGE4, PTP_ESTS);
708 phydev_info(tmp->phydev, "slave PTP_ESTS 0x%04hx\n", val);
709 event_ts.ns_lo = ext_read(tmp->phydev, PAGE4, PTP_EDATA);
710 event_ts.ns_hi = ext_read(tmp->phydev, PAGE4, PTP_EDATA);
711 event_ts.sec_lo = ext_read(tmp->phydev, PAGE4, PTP_EDATA);
712 event_ts.sec_hi = ext_read(tmp->phydev, PAGE4, PTP_EDATA);
713 diff = now - (s64) phy2txts(&event_ts);
714 phydev_info(tmp->phydev, "slave offset %lld nanoseconds\n",
717 ts = ns_to_timespec64(diff);
718 tdr_write(0, tmp->phydev, &ts, PTP_STEP_CLK);
722 * restore status frames
724 list_for_each(this, &clock->phylist) {
725 tmp = list_entry(this, struct dp83640_private, list);
726 ext_write(0, tmp->phydev, PAGE5, PSF_CFG0, tmp->cfg0);
728 ext_write(0, master, PAGE5, PSF_CFG0, cfg0);
730 mutex_unlock(&clock->extreg_lock);
733 /* time stamping methods */
735 static inline u16 exts_chan_to_edata(int ch)
737 return 1 << ((ch + EXT_EVENT) * 2);
740 static int decode_evnt(struct dp83640_private *dp83640,
741 void *data, int len, u16 ests)
743 struct phy_txts *phy_txts;
744 struct ptp_clock_event event;
746 int words = (ests >> EVNT_TS_LEN_SHIFT) & EVNT_TS_LEN_MASK;
749 /* calculate length of the event timestamp status message */
750 if (ests & MULT_EVNT)
751 parsed = (words + 2) * sizeof(u16);
753 parsed = (words + 1) * sizeof(u16);
755 /* check if enough data is available */
759 if (ests & MULT_EVNT) {
760 ext_status = *(u16 *) data;
761 data += sizeof(ext_status);
768 dp83640->edata.sec_hi = phy_txts->sec_hi;
771 dp83640->edata.sec_lo = phy_txts->sec_lo;
774 dp83640->edata.ns_hi = phy_txts->ns_hi;
777 dp83640->edata.ns_lo = phy_txts->ns_lo;
781 i = ((ests >> EVNT_NUM_SHIFT) & EVNT_NUM_MASK) - EXT_EVENT;
782 ext_status = exts_chan_to_edata(i);
785 event.type = PTP_CLOCK_EXTTS;
786 event.timestamp = phy2txts(&dp83640->edata);
788 /* Compensate for input path and synchronization delays */
789 event.timestamp -= 35;
791 for (i = 0; i < N_EXT_TS; i++) {
792 if (ext_status & exts_chan_to_edata(i)) {
794 ptp_clock_event(dp83640->clock->ptp_clock, &event);
801 #define DP83640_PACKET_HASH_OFFSET 20
802 #define DP83640_PACKET_HASH_LEN 10
804 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);
811 /* check sequenceID, messageType, 12 bit hash of offset 20-29 */
813 if (type & PTP_CLASS_VLAN)
816 switch (type & PTP_CLASS_PMASK) {
818 offset += ETH_HLEN + IPV4_HLEN(data + offset) + UDP_HLEN;
821 offset += ETH_HLEN + IP6_HLEN + UDP_HLEN;
830 if (skb->len + ETH_HLEN < offset + OFF_PTP_SEQUENCE_ID + sizeof(*seqid))
833 if (unlikely(type & PTP_CLASS_V1))
834 msgtype = data + offset + OFF_PTP_CONTROL;
836 msgtype = data + offset;
837 if (rxts->msgtype != (*msgtype & 0xf))
840 seqid = (__be16 *)(data + offset + OFF_PTP_SEQUENCE_ID);
841 if (rxts->seqid != ntohs(*seqid))
844 hash = ether_crc(DP83640_PACKET_HASH_LEN,
845 data + offset + DP83640_PACKET_HASH_OFFSET) >> 20;
846 if (rxts->hash != hash)
852 static void decode_rxts(struct dp83640_private *dp83640,
853 struct phy_rxts *phy_rxts)
856 struct skb_shared_hwtstamps *shhwtstamps = NULL;
861 overflow = (phy_rxts->ns_hi >> 14) & 0x3;
863 pr_debug("rx timestamp queue overflow, count %d\n", overflow);
865 spin_lock_irqsave(&dp83640->rx_lock, flags);
867 prune_rx_ts(dp83640);
869 if (list_empty(&dp83640->rxpool)) {
870 pr_debug("rx timestamp pool is empty\n");
873 rxts = list_first_entry(&dp83640->rxpool, struct rxts, list);
874 list_del_init(&rxts->list);
875 phy2rxts(phy_rxts, rxts);
877 spin_lock(&dp83640->rx_queue.lock);
878 skb_queue_walk(&dp83640->rx_queue, skb) {
879 struct dp83640_skb_info *skb_info;
881 skb_info = (struct dp83640_skb_info *)skb->cb;
882 if (match(skb, skb_info->ptp_type, rxts)) {
883 __skb_unlink(skb, &dp83640->rx_queue);
884 shhwtstamps = skb_hwtstamps(skb);
885 memset(shhwtstamps, 0, sizeof(*shhwtstamps));
886 shhwtstamps->hwtstamp = ns_to_ktime(rxts->ns);
887 list_add(&rxts->list, &dp83640->rxpool);
891 spin_unlock(&dp83640->rx_queue.lock);
894 list_add_tail(&rxts->list, &dp83640->rxts);
896 spin_unlock_irqrestore(&dp83640->rx_lock, flags);
902 static void decode_txts(struct dp83640_private *dp83640,
903 struct phy_txts *phy_txts)
905 struct skb_shared_hwtstamps shhwtstamps;
906 struct dp83640_skb_info *skb_info;
911 /* We must already have the skb that triggered this. */
913 skb = skb_dequeue(&dp83640->tx_queue);
915 pr_debug("have timestamp but tx_queue empty\n");
919 overflow = (phy_txts->ns_hi >> 14) & 0x3;
921 pr_debug("tx timestamp queue overflow, count %d\n", overflow);
924 skb = skb_dequeue(&dp83640->tx_queue);
928 skb_info = (struct dp83640_skb_info *)skb->cb;
929 if (time_after(jiffies, skb_info->tmo)) {
934 ns = phy2txts(phy_txts);
935 memset(&shhwtstamps, 0, sizeof(shhwtstamps));
936 shhwtstamps.hwtstamp = ns_to_ktime(ns);
937 skb_complete_tx_timestamp(skb, &shhwtstamps);
940 static void decode_status_frame(struct dp83640_private *dp83640,
943 struct phy_rxts *phy_rxts;
944 struct phy_txts *phy_txts;
951 for (len = skb_headlen(skb) - 2; len > sizeof(type); len -= size) {
954 ests = type & 0x0fff;
955 type = type & 0xf000;
959 if (PSF_RX == type && len >= sizeof(*phy_rxts)) {
961 phy_rxts = (struct phy_rxts *) ptr;
962 decode_rxts(dp83640, phy_rxts);
963 size = sizeof(*phy_rxts);
965 } else if (PSF_TX == type && len >= sizeof(*phy_txts)) {
967 phy_txts = (struct phy_txts *) ptr;
968 decode_txts(dp83640, phy_txts);
969 size = sizeof(*phy_txts);
971 } else if (PSF_EVNT == type) {
973 size = decode_evnt(dp83640, ptr, len, ests);
983 static int is_sync(struct sk_buff *skb, int type)
985 u8 *data = skb->data, *msgtype;
986 unsigned int offset = 0;
988 if (type & PTP_CLASS_VLAN)
991 switch (type & PTP_CLASS_PMASK) {
993 offset += ETH_HLEN + IPV4_HLEN(data + offset) + UDP_HLEN;
996 offset += ETH_HLEN + IP6_HLEN + UDP_HLEN;
1005 if (type & PTP_CLASS_V1)
1006 offset += OFF_PTP_CONTROL;
1008 if (skb->len < offset + 1)
1011 msgtype = data + offset;
1013 return (*msgtype & 0xf) == 0;
1016 static void dp83640_free_clocks(void)
1018 struct dp83640_clock *clock;
1019 struct list_head *this, *next;
1021 mutex_lock(&phyter_clocks_lock);
1023 list_for_each_safe(this, next, &phyter_clocks) {
1024 clock = list_entry(this, struct dp83640_clock, list);
1025 if (!list_empty(&clock->phylist)) {
1026 pr_warn("phy list non-empty while unloading\n");
1029 list_del(&clock->list);
1030 mutex_destroy(&clock->extreg_lock);
1031 mutex_destroy(&clock->clock_lock);
1032 put_device(&clock->bus->dev);
1033 kfree(clock->caps.pin_config);
1037 mutex_unlock(&phyter_clocks_lock);
1040 static void dp83640_clock_init(struct dp83640_clock *clock, struct mii_bus *bus)
1042 INIT_LIST_HEAD(&clock->list);
1044 mutex_init(&clock->extreg_lock);
1045 mutex_init(&clock->clock_lock);
1046 INIT_LIST_HEAD(&clock->phylist);
1047 clock->caps.owner = THIS_MODULE;
1048 sprintf(clock->caps.name, "dp83640 timer");
1049 clock->caps.max_adj = 1953124;
1050 clock->caps.n_alarm = 0;
1051 clock->caps.n_ext_ts = N_EXT_TS;
1052 clock->caps.n_per_out = N_PER_OUT;
1053 clock->caps.n_pins = DP83640_N_PINS;
1054 clock->caps.pps = 0;
1055 clock->caps.adjfine = ptp_dp83640_adjfine;
1056 clock->caps.adjtime = ptp_dp83640_adjtime;
1057 clock->caps.gettime64 = ptp_dp83640_gettime;
1058 clock->caps.settime64 = ptp_dp83640_settime;
1059 clock->caps.enable = ptp_dp83640_enable;
1060 clock->caps.verify = ptp_dp83640_verify;
1062 * Convert the module param defaults into a dynamic pin configuration.
1064 dp83640_gpio_defaults(clock->caps.pin_config);
1066 * Get a reference to this bus instance.
1068 get_device(&bus->dev);
1071 static int choose_this_phy(struct dp83640_clock *clock,
1072 struct phy_device *phydev)
1074 if (chosen_phy == -1 && !clock->chosen)
1077 if (chosen_phy == phydev->mdio.addr)
1083 static struct dp83640_clock *dp83640_clock_get(struct dp83640_clock *clock)
1086 mutex_lock(&clock->clock_lock);
1091 * Look up and lock a clock by bus instance.
1092 * If there is no clock for this bus, then create it first.
1094 static struct dp83640_clock *dp83640_clock_get_bus(struct mii_bus *bus)
1096 struct dp83640_clock *clock = NULL, *tmp;
1097 struct list_head *this;
1099 mutex_lock(&phyter_clocks_lock);
1101 list_for_each(this, &phyter_clocks) {
1102 tmp = list_entry(this, struct dp83640_clock, list);
1103 if (tmp->bus == bus) {
1111 clock = kzalloc(sizeof(struct dp83640_clock), GFP_KERNEL);
1115 clock->caps.pin_config = kcalloc(DP83640_N_PINS,
1116 sizeof(struct ptp_pin_desc),
1118 if (!clock->caps.pin_config) {
1123 dp83640_clock_init(clock, bus);
1124 list_add_tail(&clock->list, &phyter_clocks);
1126 mutex_unlock(&phyter_clocks_lock);
1128 return dp83640_clock_get(clock);
1131 static void dp83640_clock_put(struct dp83640_clock *clock)
1133 mutex_unlock(&clock->clock_lock);
1136 static int dp83640_soft_reset(struct phy_device *phydev)
1140 ret = genphy_soft_reset(phydev);
1144 /* From DP83640 datasheet: "Software driver code must wait 3 us
1145 * following a software reset before allowing further serial MII
1146 * operations with the DP83640."
1148 udelay(10); /* Taking udelay inaccuracy into account */
1153 static int dp83640_config_init(struct phy_device *phydev)
1155 struct dp83640_private *dp83640 = phydev->priv;
1156 struct dp83640_clock *clock = dp83640->clock;
1158 if (clock->chosen && !list_empty(&clock->phylist))
1161 mutex_lock(&clock->extreg_lock);
1162 enable_broadcast(phydev, clock->page, 1);
1163 mutex_unlock(&clock->extreg_lock);
1166 enable_status_frames(phydev, true);
1168 mutex_lock(&clock->extreg_lock);
1169 ext_write(0, phydev, PAGE4, PTP_CTL, PTP_ENABLE);
1170 mutex_unlock(&clock->extreg_lock);
1175 static int dp83640_ack_interrupt(struct phy_device *phydev)
1177 int err = phy_read(phydev, MII_DP83640_MISR);
1185 static int dp83640_config_intr(struct phy_device *phydev)
1191 if (phydev->interrupts == PHY_INTERRUPT_ENABLED) {
1192 misr = phy_read(phydev, MII_DP83640_MISR);
1196 (MII_DP83640_MISR_ANC_INT_EN |
1197 MII_DP83640_MISR_DUP_INT_EN |
1198 MII_DP83640_MISR_SPD_INT_EN |
1199 MII_DP83640_MISR_LINK_INT_EN);
1200 err = phy_write(phydev, MII_DP83640_MISR, misr);
1204 micr = phy_read(phydev, MII_DP83640_MICR);
1208 (MII_DP83640_MICR_OE |
1209 MII_DP83640_MICR_IE);
1210 return phy_write(phydev, MII_DP83640_MICR, micr);
1212 micr = phy_read(phydev, MII_DP83640_MICR);
1216 ~(MII_DP83640_MICR_OE |
1217 MII_DP83640_MICR_IE);
1218 err = phy_write(phydev, MII_DP83640_MICR, micr);
1222 misr = phy_read(phydev, MII_DP83640_MISR);
1226 ~(MII_DP83640_MISR_ANC_INT_EN |
1227 MII_DP83640_MISR_DUP_INT_EN |
1228 MII_DP83640_MISR_SPD_INT_EN |
1229 MII_DP83640_MISR_LINK_INT_EN);
1230 return phy_write(phydev, MII_DP83640_MISR, misr);
1234 static int dp83640_hwtstamp(struct mii_timestamper *mii_ts, struct ifreq *ifr)
1236 struct dp83640_private *dp83640 =
1237 container_of(mii_ts, struct dp83640_private, mii_ts);
1238 struct hwtstamp_config cfg;
1241 if (copy_from_user(&cfg, ifr->ifr_data, sizeof(cfg)))
1244 if (cfg.flags) /* reserved for future extensions */
1247 if (cfg.tx_type < 0 || cfg.tx_type > HWTSTAMP_TX_ONESTEP_SYNC)
1250 dp83640->hwts_tx_en = cfg.tx_type;
1252 switch (cfg.rx_filter) {
1253 case HWTSTAMP_FILTER_NONE:
1254 dp83640->hwts_rx_en = 0;
1256 dp83640->version = 0;
1258 case HWTSTAMP_FILTER_PTP_V1_L4_EVENT:
1259 case HWTSTAMP_FILTER_PTP_V1_L4_SYNC:
1260 case HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ:
1261 dp83640->hwts_rx_en = 1;
1262 dp83640->layer = PTP_CLASS_L4;
1263 dp83640->version = PTP_CLASS_V1;
1264 cfg.rx_filter = HWTSTAMP_FILTER_PTP_V1_L4_EVENT;
1266 case HWTSTAMP_FILTER_PTP_V2_L4_EVENT:
1267 case HWTSTAMP_FILTER_PTP_V2_L4_SYNC:
1268 case HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ:
1269 dp83640->hwts_rx_en = 1;
1270 dp83640->layer = PTP_CLASS_L4;
1271 dp83640->version = PTP_CLASS_V2;
1272 cfg.rx_filter = HWTSTAMP_FILTER_PTP_V2_L4_EVENT;
1274 case HWTSTAMP_FILTER_PTP_V2_L2_EVENT:
1275 case HWTSTAMP_FILTER_PTP_V2_L2_SYNC:
1276 case HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ:
1277 dp83640->hwts_rx_en = 1;
1278 dp83640->layer = PTP_CLASS_L2;
1279 dp83640->version = PTP_CLASS_V2;
1280 cfg.rx_filter = HWTSTAMP_FILTER_PTP_V2_L2_EVENT;
1282 case HWTSTAMP_FILTER_PTP_V2_EVENT:
1283 case HWTSTAMP_FILTER_PTP_V2_SYNC:
1284 case HWTSTAMP_FILTER_PTP_V2_DELAY_REQ:
1285 dp83640->hwts_rx_en = 1;
1286 dp83640->layer = PTP_CLASS_L4 | PTP_CLASS_L2;
1287 dp83640->version = PTP_CLASS_V2;
1288 cfg.rx_filter = HWTSTAMP_FILTER_PTP_V2_EVENT;
1294 txcfg0 = (dp83640->version & TX_PTP_VER_MASK) << TX_PTP_VER_SHIFT;
1295 rxcfg0 = (dp83640->version & TX_PTP_VER_MASK) << TX_PTP_VER_SHIFT;
1297 if (dp83640->layer & PTP_CLASS_L2) {
1301 if (dp83640->layer & PTP_CLASS_L4) {
1302 txcfg0 |= TX_IPV6_EN | TX_IPV4_EN;
1303 rxcfg0 |= RX_IPV6_EN | RX_IPV4_EN;
1306 if (dp83640->hwts_tx_en)
1309 if (dp83640->hwts_tx_en == HWTSTAMP_TX_ONESTEP_SYNC)
1310 txcfg0 |= SYNC_1STEP | CHK_1STEP;
1312 if (dp83640->hwts_rx_en)
1315 mutex_lock(&dp83640->clock->extreg_lock);
1317 ext_write(0, dp83640->phydev, PAGE5, PTP_TXCFG0, txcfg0);
1318 ext_write(0, dp83640->phydev, PAGE5, PTP_RXCFG0, rxcfg0);
1320 mutex_unlock(&dp83640->clock->extreg_lock);
1322 return copy_to_user(ifr->ifr_data, &cfg, sizeof(cfg)) ? -EFAULT : 0;
1325 static void rx_timestamp_work(struct work_struct *work)
1327 struct dp83640_private *dp83640 =
1328 container_of(work, struct dp83640_private, ts_work.work);
1329 struct sk_buff *skb;
1331 /* Deliver expired packets. */
1332 while ((skb = skb_dequeue(&dp83640->rx_queue))) {
1333 struct dp83640_skb_info *skb_info;
1335 skb_info = (struct dp83640_skb_info *)skb->cb;
1336 if (!time_after(jiffies, skb_info->tmo)) {
1337 skb_queue_head(&dp83640->rx_queue, skb);
1344 if (!skb_queue_empty(&dp83640->rx_queue))
1345 schedule_delayed_work(&dp83640->ts_work, SKB_TIMESTAMP_TIMEOUT);
1348 static bool dp83640_rxtstamp(struct mii_timestamper *mii_ts,
1349 struct sk_buff *skb, int type)
1351 struct dp83640_private *dp83640 =
1352 container_of(mii_ts, struct dp83640_private, mii_ts);
1353 struct dp83640_skb_info *skb_info = (struct dp83640_skb_info *)skb->cb;
1354 struct list_head *this, *next;
1356 struct skb_shared_hwtstamps *shhwtstamps = NULL;
1357 unsigned long flags;
1359 if (is_status_frame(skb, type)) {
1360 decode_status_frame(dp83640, skb);
1365 if (!dp83640->hwts_rx_en)
1368 if ((type & dp83640->version) == 0 || (type & dp83640->layer) == 0)
1371 spin_lock_irqsave(&dp83640->rx_lock, flags);
1372 prune_rx_ts(dp83640);
1373 list_for_each_safe(this, next, &dp83640->rxts) {
1374 rxts = list_entry(this, struct rxts, list);
1375 if (match(skb, type, rxts)) {
1376 shhwtstamps = skb_hwtstamps(skb);
1377 memset(shhwtstamps, 0, sizeof(*shhwtstamps));
1378 shhwtstamps->hwtstamp = ns_to_ktime(rxts->ns);
1379 list_del_init(&rxts->list);
1380 list_add(&rxts->list, &dp83640->rxpool);
1384 spin_unlock_irqrestore(&dp83640->rx_lock, flags);
1387 skb_info->ptp_type = type;
1388 skb_info->tmo = jiffies + SKB_TIMESTAMP_TIMEOUT;
1389 skb_queue_tail(&dp83640->rx_queue, skb);
1390 schedule_delayed_work(&dp83640->ts_work, SKB_TIMESTAMP_TIMEOUT);
1398 static void dp83640_txtstamp(struct mii_timestamper *mii_ts,
1399 struct sk_buff *skb, int type)
1401 struct dp83640_skb_info *skb_info = (struct dp83640_skb_info *)skb->cb;
1402 struct dp83640_private *dp83640 =
1403 container_of(mii_ts, struct dp83640_private, mii_ts);
1405 switch (dp83640->hwts_tx_en) {
1407 case HWTSTAMP_TX_ONESTEP_SYNC:
1408 if (is_sync(skb, type)) {
1413 case HWTSTAMP_TX_ON:
1414 skb_shinfo(skb)->tx_flags |= SKBTX_IN_PROGRESS;
1415 skb_info->tmo = jiffies + SKB_TIMESTAMP_TIMEOUT;
1416 skb_queue_tail(&dp83640->tx_queue, skb);
1419 case HWTSTAMP_TX_OFF:
1426 static int dp83640_ts_info(struct mii_timestamper *mii_ts,
1427 struct ethtool_ts_info *info)
1429 struct dp83640_private *dp83640 =
1430 container_of(mii_ts, struct dp83640_private, mii_ts);
1432 info->so_timestamping =
1433 SOF_TIMESTAMPING_TX_HARDWARE |
1434 SOF_TIMESTAMPING_RX_HARDWARE |
1435 SOF_TIMESTAMPING_RAW_HARDWARE;
1436 info->phc_index = ptp_clock_index(dp83640->clock->ptp_clock);
1438 (1 << HWTSTAMP_TX_OFF) |
1439 (1 << HWTSTAMP_TX_ON) |
1440 (1 << HWTSTAMP_TX_ONESTEP_SYNC);
1442 (1 << HWTSTAMP_FILTER_NONE) |
1443 (1 << HWTSTAMP_FILTER_PTP_V1_L4_EVENT) |
1444 (1 << HWTSTAMP_FILTER_PTP_V2_L4_EVENT) |
1445 (1 << HWTSTAMP_FILTER_PTP_V2_L2_EVENT) |
1446 (1 << HWTSTAMP_FILTER_PTP_V2_EVENT);
1450 static int dp83640_probe(struct phy_device *phydev)
1452 struct dp83640_clock *clock;
1453 struct dp83640_private *dp83640;
1454 int err = -ENOMEM, i;
1456 if (phydev->mdio.addr == BROADCAST_ADDR)
1459 clock = dp83640_clock_get_bus(phydev->mdio.bus);
1463 dp83640 = kzalloc(sizeof(struct dp83640_private), GFP_KERNEL);
1467 dp83640->phydev = phydev;
1468 dp83640->mii_ts.rxtstamp = dp83640_rxtstamp;
1469 dp83640->mii_ts.txtstamp = dp83640_txtstamp;
1470 dp83640->mii_ts.hwtstamp = dp83640_hwtstamp;
1471 dp83640->mii_ts.ts_info = dp83640_ts_info;
1473 INIT_DELAYED_WORK(&dp83640->ts_work, rx_timestamp_work);
1474 INIT_LIST_HEAD(&dp83640->rxts);
1475 INIT_LIST_HEAD(&dp83640->rxpool);
1476 for (i = 0; i < MAX_RXTS; i++)
1477 list_add(&dp83640->rx_pool_data[i].list, &dp83640->rxpool);
1479 phydev->mii_ts = &dp83640->mii_ts;
1480 phydev->priv = dp83640;
1482 spin_lock_init(&dp83640->rx_lock);
1483 skb_queue_head_init(&dp83640->rx_queue);
1484 skb_queue_head_init(&dp83640->tx_queue);
1486 dp83640->clock = clock;
1488 if (choose_this_phy(clock, phydev)) {
1489 clock->chosen = dp83640;
1490 clock->ptp_clock = ptp_clock_register(&clock->caps,
1492 if (IS_ERR(clock->ptp_clock)) {
1493 err = PTR_ERR(clock->ptp_clock);
1497 list_add_tail(&dp83640->list, &clock->phylist);
1499 dp83640_clock_put(clock);
1503 clock->chosen = NULL;
1506 dp83640_clock_put(clock);
1511 static void dp83640_remove(struct phy_device *phydev)
1513 struct dp83640_clock *clock;
1514 struct list_head *this, *next;
1515 struct dp83640_private *tmp, *dp83640 = phydev->priv;
1517 if (phydev->mdio.addr == BROADCAST_ADDR)
1520 phydev->mii_ts = NULL;
1522 enable_status_frames(phydev, false);
1523 cancel_delayed_work_sync(&dp83640->ts_work);
1525 skb_queue_purge(&dp83640->rx_queue);
1526 skb_queue_purge(&dp83640->tx_queue);
1528 clock = dp83640_clock_get(dp83640->clock);
1530 if (dp83640 == clock->chosen) {
1531 ptp_clock_unregister(clock->ptp_clock);
1532 clock->chosen = NULL;
1534 list_for_each_safe(this, next, &clock->phylist) {
1535 tmp = list_entry(this, struct dp83640_private, list);
1536 if (tmp == dp83640) {
1537 list_del_init(&tmp->list);
1543 dp83640_clock_put(clock);
1547 static struct phy_driver dp83640_driver = {
1548 .phy_id = DP83640_PHY_ID,
1549 .phy_id_mask = 0xfffffff0,
1550 .name = "NatSemi DP83640",
1551 /* PHY_BASIC_FEATURES */
1552 .probe = dp83640_probe,
1553 .remove = dp83640_remove,
1554 .soft_reset = dp83640_soft_reset,
1555 .config_init = dp83640_config_init,
1556 .ack_interrupt = dp83640_ack_interrupt,
1557 .config_intr = dp83640_config_intr,
1560 static int __init dp83640_init(void)
1562 return phy_driver_register(&dp83640_driver, THIS_MODULE);
1565 static void __exit dp83640_exit(void)
1567 dp83640_free_clocks();
1568 phy_driver_unregister(&dp83640_driver);
1571 MODULE_DESCRIPTION("National Semiconductor DP83640 PHY driver");
1573 MODULE_LICENSE("GPL");
1575 module_init(dp83640_init);
1576 module_exit(dp83640_exit);
1578 static struct mdio_device_id __maybe_unused dp83640_tbl[] = {
1579 { DP83640_PHY_ID, 0xfffffff0 },
1583 MODULE_DEVICE_TABLE(mdio, dp83640_tbl);