2 * Driver for the National Semiconductor DP83640 PHYTER
4 * Copyright (C) 2010 OMICRON electronics GmbH
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
23 #include <linux/ethtool.h>
24 #include <linux/kernel.h>
25 #include <linux/list.h>
26 #include <linux/mii.h>
27 #include <linux/module.h>
28 #include <linux/net_tstamp.h>
29 #include <linux/netdevice.h>
30 #include <linux/if_vlan.h>
31 #include <linux/phy.h>
32 #include <linux/ptp_classify.h>
33 #include <linux/ptp_clock_kernel.h>
35 #include "dp83640_reg.h"
37 #define DP83640_PHY_ID 0x20005ce1
44 #define PSF_EVNT 0x4000
51 #define DP83640_N_PINS 12
53 #define MII_DP83640_MICR 0x11
54 #define MII_DP83640_MISR 0x12
56 #define MII_DP83640_MICR_OE 0x1
57 #define MII_DP83640_MICR_IE 0x2
59 #define MII_DP83640_MISR_RHF_INT_EN 0x01
60 #define MII_DP83640_MISR_FHF_INT_EN 0x02
61 #define MII_DP83640_MISR_ANC_INT_EN 0x04
62 #define MII_DP83640_MISR_DUP_INT_EN 0x08
63 #define MII_DP83640_MISR_SPD_INT_EN 0x10
64 #define MII_DP83640_MISR_LINK_INT_EN 0x20
65 #define MII_DP83640_MISR_ED_INT_EN 0x40
66 #define MII_DP83640_MISR_LQ_INT_EN 0x80
68 /* phyter seems to miss the mark by 16 ns */
69 #define ADJTIME_FIX 16
71 #if defined(__BIG_ENDIAN)
73 #elif defined(__LITTLE_ENDIAN)
74 #define ENDIAN_FLAG PSF_ENDIAN
77 #define SKB_PTP_TYPE(__skb) (*(unsigned int *)((__skb)->cb))
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] */
84 u16 seqid; /* sequenceId[15:0] */
85 u16 msgtype; /* messageType[3:0], hash[11:0] */
89 u16 ns_lo; /* ns[15:0] */
90 u16 ns_hi; /* overflow[1:0], ns[29:16] */
91 u16 sec_lo; /* sec[15:0] */
92 u16 sec_hi; /* sec[31:16] */
96 struct list_head list;
104 struct dp83640_clock;
106 struct dp83640_private {
107 struct list_head list;
108 struct dp83640_clock *clock;
109 struct phy_device *phydev;
110 struct work_struct ts_work;
115 /* remember state of cfg0 during calibration */
117 /* remember the last event time stamp */
118 struct phy_txts edata;
119 /* list of rx timestamps */
120 struct list_head rxts;
121 struct list_head rxpool;
122 struct rxts rx_pool_data[MAX_RXTS];
123 /* protects above three fields from concurrent access */
125 /* queues of incoming and outgoing packets */
126 struct sk_buff_head rx_queue;
127 struct sk_buff_head tx_queue;
130 struct dp83640_clock {
131 /* keeps the instance in the 'phyter_clocks' list */
132 struct list_head list;
133 /* we create one clock instance per MII bus */
135 /* protects extended registers from concurrent access */
136 struct mutex extreg_lock;
137 /* remembers which page was last selected */
139 /* our advertised capabilities */
140 struct ptp_clock_info caps;
141 /* protects the three fields below from concurrent access */
142 struct mutex clock_lock;
143 /* the one phyter from which we shall read */
144 struct dp83640_private *chosen;
145 /* list of the other attached phyters, not chosen */
146 struct list_head phylist;
147 /* reference to our PTP hardware clock */
148 struct ptp_clock *ptp_clock;
165 static int chosen_phy = -1;
166 static ushort gpio_tab[GPIO_TABLE_SIZE] = {
167 1, 2, 3, 4, 8, 9, 10, 11
170 module_param(chosen_phy, int, 0444);
171 module_param_array(gpio_tab, ushort, NULL, 0444);
173 MODULE_PARM_DESC(chosen_phy, \
174 "The address of the PHY to use for the ancillary clock features");
175 MODULE_PARM_DESC(gpio_tab, \
176 "Which GPIO line to use for which purpose: cal,perout,extts1,...,extts6");
178 static void dp83640_gpio_defaults(struct ptp_pin_desc *pd)
182 for (i = 0; i < DP83640_N_PINS; i++) {
183 snprintf(pd[i].name, sizeof(pd[i].name), "GPIO%d", 1 + i);
187 for (i = 0; i < GPIO_TABLE_SIZE; i++) {
188 if (gpio_tab[i] < 1 || gpio_tab[i] > DP83640_N_PINS) {
189 pr_err("gpio_tab[%d]=%hu out of range", i, gpio_tab[i]);
194 index = gpio_tab[CALIBRATE_GPIO] - 1;
195 pd[index].func = PTP_PF_PHYSYNC;
198 index = gpio_tab[PEROUT_GPIO] - 1;
199 pd[index].func = PTP_PF_PEROUT;
202 for (i = EXTTS0_GPIO; i < GPIO_TABLE_SIZE; i++) {
203 index = gpio_tab[i] - 1;
204 pd[index].func = PTP_PF_EXTTS;
205 pd[index].chan = i - EXTTS0_GPIO;
209 /* a list of clocks and a mutex to protect it */
210 static LIST_HEAD(phyter_clocks);
211 static DEFINE_MUTEX(phyter_clocks_lock);
213 static void rx_timestamp_work(struct work_struct *work);
215 /* extended register access functions */
217 #define BROADCAST_ADDR 31
219 static inline int broadcast_write(struct mii_bus *bus, u32 regnum, u16 val)
221 return mdiobus_write(bus, BROADCAST_ADDR, regnum, val);
224 /* Caller must hold extreg_lock. */
225 static int ext_read(struct phy_device *phydev, int page, u32 regnum)
227 struct dp83640_private *dp83640 = phydev->priv;
230 if (dp83640->clock->page != page) {
231 broadcast_write(phydev->bus, PAGESEL, page);
232 dp83640->clock->page = page;
234 val = phy_read(phydev, regnum);
239 /* Caller must hold extreg_lock. */
240 static void ext_write(int broadcast, struct phy_device *phydev,
241 int page, u32 regnum, u16 val)
243 struct dp83640_private *dp83640 = phydev->priv;
245 if (dp83640->clock->page != page) {
246 broadcast_write(phydev->bus, PAGESEL, page);
247 dp83640->clock->page = page;
250 broadcast_write(phydev->bus, regnum, val);
252 phy_write(phydev, regnum, val);
255 /* Caller must hold extreg_lock. */
256 static int tdr_write(int bc, struct phy_device *dev,
257 const struct timespec *ts, u16 cmd)
259 ext_write(bc, dev, PAGE4, PTP_TDR, ts->tv_nsec & 0xffff);/* ns[15:0] */
260 ext_write(bc, dev, PAGE4, PTP_TDR, ts->tv_nsec >> 16); /* ns[31:16] */
261 ext_write(bc, dev, PAGE4, PTP_TDR, ts->tv_sec & 0xffff); /* sec[15:0] */
262 ext_write(bc, dev, PAGE4, PTP_TDR, ts->tv_sec >> 16); /* sec[31:16]*/
264 ext_write(bc, dev, PAGE4, PTP_CTL, cmd);
269 /* convert phy timestamps into driver timestamps */
271 static void phy2rxts(struct phy_rxts *p, struct rxts *rxts)
276 sec |= p->sec_hi << 16;
279 rxts->ns |= (p->ns_hi & 0x3fff) << 16;
280 rxts->ns += ((u64)sec) * 1000000000ULL;
281 rxts->seqid = p->seqid;
282 rxts->msgtype = (p->msgtype >> 12) & 0xf;
283 rxts->hash = p->msgtype & 0x0fff;
284 rxts->tmo = jiffies + 2;
287 static u64 phy2txts(struct phy_txts *p)
293 sec |= p->sec_hi << 16;
296 ns |= (p->ns_hi & 0x3fff) << 16;
297 ns += ((u64)sec) * 1000000000ULL;
302 static int periodic_output(struct dp83640_clock *clock,
303 struct ptp_clock_request *clkreq, bool on)
305 struct dp83640_private *dp83640 = clock->chosen;
306 struct phy_device *phydev = dp83640->phydev;
307 u32 sec, nsec, pwidth;
308 u16 gpio, ptp_trig, trigger, val;
311 gpio = 1 + ptp_find_pin(clock->ptp_clock, PTP_PF_PEROUT, 0);
318 trigger = PER_TRIGGER;
321 (trigger & TRIG_CSEL_MASK) << TRIG_CSEL_SHIFT |
322 (gpio & TRIG_GPIO_MASK) << TRIG_GPIO_SHIFT |
326 val = (trigger & TRIG_SEL_MASK) << TRIG_SEL_SHIFT;
330 mutex_lock(&clock->extreg_lock);
331 ext_write(0, phydev, PAGE5, PTP_TRIG, ptp_trig);
332 ext_write(0, phydev, PAGE4, PTP_CTL, val);
333 mutex_unlock(&clock->extreg_lock);
337 sec = clkreq->perout.start.sec;
338 nsec = clkreq->perout.start.nsec;
339 pwidth = clkreq->perout.period.sec * 1000000000UL;
340 pwidth += clkreq->perout.period.nsec;
343 mutex_lock(&clock->extreg_lock);
345 ext_write(0, phydev, PAGE5, PTP_TRIG, ptp_trig);
349 ext_write(0, phydev, PAGE4, PTP_CTL, val);
350 ext_write(0, phydev, PAGE4, PTP_TDR, nsec & 0xffff); /* ns[15:0] */
351 ext_write(0, phydev, PAGE4, PTP_TDR, nsec >> 16); /* ns[31:16] */
352 ext_write(0, phydev, PAGE4, PTP_TDR, sec & 0xffff); /* sec[15:0] */
353 ext_write(0, phydev, PAGE4, PTP_TDR, sec >> 16); /* sec[31:16] */
354 ext_write(0, phydev, PAGE4, PTP_TDR, pwidth & 0xffff); /* ns[15:0] */
355 ext_write(0, phydev, PAGE4, PTP_TDR, pwidth >> 16); /* ns[31:16] */
360 ext_write(0, phydev, PAGE4, PTP_CTL, val);
362 mutex_unlock(&clock->extreg_lock);
366 /* ptp clock methods */
368 static int ptp_dp83640_adjfreq(struct ptp_clock_info *ptp, s32 ppb)
370 struct dp83640_clock *clock =
371 container_of(ptp, struct dp83640_clock, caps);
372 struct phy_device *phydev = clock->chosen->phydev;
383 rate = div_u64(rate, 1953125);
385 hi = (rate >> 16) & PTP_RATE_HI_MASK;
391 mutex_lock(&clock->extreg_lock);
393 ext_write(1, phydev, PAGE4, PTP_RATEH, hi);
394 ext_write(1, phydev, PAGE4, PTP_RATEL, lo);
396 mutex_unlock(&clock->extreg_lock);
401 static int ptp_dp83640_adjtime(struct ptp_clock_info *ptp, s64 delta)
403 struct dp83640_clock *clock =
404 container_of(ptp, struct dp83640_clock, caps);
405 struct phy_device *phydev = clock->chosen->phydev;
409 delta += ADJTIME_FIX;
411 ts = ns_to_timespec(delta);
413 mutex_lock(&clock->extreg_lock);
415 err = tdr_write(1, phydev, &ts, PTP_STEP_CLK);
417 mutex_unlock(&clock->extreg_lock);
422 static int ptp_dp83640_gettime(struct ptp_clock_info *ptp, struct timespec *ts)
424 struct dp83640_clock *clock =
425 container_of(ptp, struct dp83640_clock, caps);
426 struct phy_device *phydev = clock->chosen->phydev;
429 mutex_lock(&clock->extreg_lock);
431 ext_write(0, phydev, PAGE4, PTP_CTL, PTP_RD_CLK);
433 val[0] = ext_read(phydev, PAGE4, PTP_TDR); /* ns[15:0] */
434 val[1] = ext_read(phydev, PAGE4, PTP_TDR); /* ns[31:16] */
435 val[2] = ext_read(phydev, PAGE4, PTP_TDR); /* sec[15:0] */
436 val[3] = ext_read(phydev, PAGE4, PTP_TDR); /* sec[31:16] */
438 mutex_unlock(&clock->extreg_lock);
440 ts->tv_nsec = val[0] | (val[1] << 16);
441 ts->tv_sec = val[2] | (val[3] << 16);
446 static int ptp_dp83640_settime(struct ptp_clock_info *ptp,
447 const struct timespec *ts)
449 struct dp83640_clock *clock =
450 container_of(ptp, struct dp83640_clock, caps);
451 struct phy_device *phydev = clock->chosen->phydev;
454 mutex_lock(&clock->extreg_lock);
456 err = tdr_write(1, phydev, ts, PTP_LOAD_CLK);
458 mutex_unlock(&clock->extreg_lock);
463 static int ptp_dp83640_enable(struct ptp_clock_info *ptp,
464 struct ptp_clock_request *rq, int on)
466 struct dp83640_clock *clock =
467 container_of(ptp, struct dp83640_clock, caps);
468 struct phy_device *phydev = clock->chosen->phydev;
470 u16 evnt, event_num, gpio_num;
473 case PTP_CLK_REQ_EXTTS:
474 index = rq->extts.index;
475 if (index >= N_EXT_TS)
477 event_num = EXT_EVENT + index;
478 evnt = EVNT_WR | (event_num & EVNT_SEL_MASK) << EVNT_SEL_SHIFT;
480 gpio_num = 1 + ptp_find_pin(clock->ptp_clock,
481 PTP_PF_EXTTS, index);
484 evnt |= (gpio_num & EVNT_GPIO_MASK) << EVNT_GPIO_SHIFT;
485 if (rq->extts.flags & PTP_FALLING_EDGE)
490 ext_write(0, phydev, PAGE5, PTP_EVNT, evnt);
493 case PTP_CLK_REQ_PEROUT:
494 if (rq->perout.index != 0)
496 return periodic_output(clock, rq, on);
505 static int ptp_dp83640_verify(struct ptp_clock_info *ptp, unsigned int pin,
506 enum ptp_pin_function func, unsigned int chan)
511 static u8 status_frame_dst[6] = { 0x01, 0x1B, 0x19, 0x00, 0x00, 0x00 };
512 static u8 status_frame_src[6] = { 0x08, 0x00, 0x17, 0x0B, 0x6B, 0x0F };
514 static void enable_status_frames(struct phy_device *phydev, bool on)
519 cfg0 = PSF_EVNT_EN | PSF_RXTS_EN | PSF_TXTS_EN | ENDIAN_FLAG;
521 ver = (PSF_PTPVER & VERSIONPTP_MASK) << VERSIONPTP_SHIFT;
523 ext_write(0, phydev, PAGE5, PSF_CFG0, cfg0);
524 ext_write(0, phydev, PAGE6, PSF_CFG1, ver);
526 if (!phydev->attached_dev) {
527 pr_warn("expected to find an attached netdevice\n");
532 if (dev_mc_add(phydev->attached_dev, status_frame_dst))
533 pr_warn("failed to add mc address\n");
535 if (dev_mc_del(phydev->attached_dev, status_frame_dst))
536 pr_warn("failed to delete mc address\n");
540 static bool is_status_frame(struct sk_buff *skb, int type)
542 struct ethhdr *h = eth_hdr(skb);
544 if (PTP_CLASS_V2_L2 == type &&
545 !memcmp(h->h_source, status_frame_src, sizeof(status_frame_src)))
551 static int expired(struct rxts *rxts)
553 return time_after(jiffies, rxts->tmo);
556 /* Caller must hold rx_lock. */
557 static void prune_rx_ts(struct dp83640_private *dp83640)
559 struct list_head *this, *next;
562 list_for_each_safe(this, next, &dp83640->rxts) {
563 rxts = list_entry(this, struct rxts, list);
565 list_del_init(&rxts->list);
566 list_add(&rxts->list, &dp83640->rxpool);
571 /* synchronize the phyters so they act as one clock */
573 static void enable_broadcast(struct phy_device *phydev, int init_page, int on)
576 phy_write(phydev, PAGESEL, 0);
577 val = phy_read(phydev, PHYCR2);
582 phy_write(phydev, PHYCR2, val);
583 phy_write(phydev, PAGESEL, init_page);
586 static void recalibrate(struct dp83640_clock *clock)
589 struct phy_txts event_ts;
591 struct list_head *this;
592 struct dp83640_private *tmp;
593 struct phy_device *master = clock->chosen->phydev;
594 u16 cal_gpio, cfg0, evnt, ptp_trig, trigger, val;
596 trigger = CAL_TRIGGER;
597 cal_gpio = gpio_tab[CALIBRATE_GPIO];
599 mutex_lock(&clock->extreg_lock);
602 * enable broadcast, disable status frames, enable ptp clock
604 list_for_each(this, &clock->phylist) {
605 tmp = list_entry(this, struct dp83640_private, list);
606 enable_broadcast(tmp->phydev, clock->page, 1);
607 tmp->cfg0 = ext_read(tmp->phydev, PAGE5, PSF_CFG0);
608 ext_write(0, tmp->phydev, PAGE5, PSF_CFG0, 0);
609 ext_write(0, tmp->phydev, PAGE4, PTP_CTL, PTP_ENABLE);
611 enable_broadcast(master, clock->page, 1);
612 cfg0 = ext_read(master, PAGE5, PSF_CFG0);
613 ext_write(0, master, PAGE5, PSF_CFG0, 0);
614 ext_write(0, master, PAGE4, PTP_CTL, PTP_ENABLE);
617 * enable an event timestamp
619 evnt = EVNT_WR | EVNT_RISE | EVNT_SINGLE;
620 evnt |= (CAL_EVENT & EVNT_SEL_MASK) << EVNT_SEL_SHIFT;
621 evnt |= (cal_gpio & EVNT_GPIO_MASK) << EVNT_GPIO_SHIFT;
623 list_for_each(this, &clock->phylist) {
624 tmp = list_entry(this, struct dp83640_private, list);
625 ext_write(0, tmp->phydev, PAGE5, PTP_EVNT, evnt);
627 ext_write(0, master, PAGE5, PTP_EVNT, evnt);
630 * configure a trigger
632 ptp_trig = TRIG_WR | TRIG_IF_LATE | TRIG_PULSE;
633 ptp_trig |= (trigger & TRIG_CSEL_MASK) << TRIG_CSEL_SHIFT;
634 ptp_trig |= (cal_gpio & TRIG_GPIO_MASK) << TRIG_GPIO_SHIFT;
635 ext_write(0, master, PAGE5, PTP_TRIG, ptp_trig);
638 val = (trigger & TRIG_SEL_MASK) << TRIG_SEL_SHIFT;
640 ext_write(0, master, PAGE4, PTP_CTL, val);
645 ext_write(0, master, PAGE4, PTP_CTL, val);
647 /* disable trigger */
648 val = (trigger & TRIG_SEL_MASK) << TRIG_SEL_SHIFT;
650 ext_write(0, master, PAGE4, PTP_CTL, val);
653 * read out and correct offsets
655 val = ext_read(master, PAGE4, PTP_STS);
656 pr_info("master PTP_STS 0x%04hx\n", val);
657 val = ext_read(master, PAGE4, PTP_ESTS);
658 pr_info("master PTP_ESTS 0x%04hx\n", val);
659 event_ts.ns_lo = ext_read(master, PAGE4, PTP_EDATA);
660 event_ts.ns_hi = ext_read(master, PAGE4, PTP_EDATA);
661 event_ts.sec_lo = ext_read(master, PAGE4, PTP_EDATA);
662 event_ts.sec_hi = ext_read(master, PAGE4, PTP_EDATA);
663 now = phy2txts(&event_ts);
665 list_for_each(this, &clock->phylist) {
666 tmp = list_entry(this, struct dp83640_private, list);
667 val = ext_read(tmp->phydev, PAGE4, PTP_STS);
668 pr_info("slave PTP_STS 0x%04hx\n", val);
669 val = ext_read(tmp->phydev, PAGE4, PTP_ESTS);
670 pr_info("slave PTP_ESTS 0x%04hx\n", val);
671 event_ts.ns_lo = ext_read(tmp->phydev, PAGE4, PTP_EDATA);
672 event_ts.ns_hi = ext_read(tmp->phydev, PAGE4, PTP_EDATA);
673 event_ts.sec_lo = ext_read(tmp->phydev, PAGE4, PTP_EDATA);
674 event_ts.sec_hi = ext_read(tmp->phydev, PAGE4, PTP_EDATA);
675 diff = now - (s64) phy2txts(&event_ts);
676 pr_info("slave offset %lld nanoseconds\n", diff);
678 ts = ns_to_timespec(diff);
679 tdr_write(0, tmp->phydev, &ts, PTP_STEP_CLK);
683 * restore status frames
685 list_for_each(this, &clock->phylist) {
686 tmp = list_entry(this, struct dp83640_private, list);
687 ext_write(0, tmp->phydev, PAGE5, PSF_CFG0, tmp->cfg0);
689 ext_write(0, master, PAGE5, PSF_CFG0, cfg0);
691 mutex_unlock(&clock->extreg_lock);
694 /* time stamping methods */
696 static inline u16 exts_chan_to_edata(int ch)
698 return 1 << ((ch + EXT_EVENT) * 2);
701 static int decode_evnt(struct dp83640_private *dp83640,
702 void *data, u16 ests)
704 struct phy_txts *phy_txts;
705 struct ptp_clock_event event;
707 int words = (ests >> EVNT_TS_LEN_SHIFT) & EVNT_TS_LEN_MASK;
710 if (ests & MULT_EVNT) {
711 ext_status = *(u16 *) data;
712 data += sizeof(ext_status);
717 switch (words) { /* fall through in every case */
719 dp83640->edata.sec_hi = phy_txts->sec_hi;
721 dp83640->edata.sec_lo = phy_txts->sec_lo;
723 dp83640->edata.ns_hi = phy_txts->ns_hi;
725 dp83640->edata.ns_lo = phy_txts->ns_lo;
732 i = ((ests >> EVNT_NUM_SHIFT) & EVNT_NUM_MASK) - EXT_EVENT;
733 ext_status = exts_chan_to_edata(i);
736 event.type = PTP_CLOCK_EXTTS;
737 event.timestamp = phy2txts(&dp83640->edata);
739 for (i = 0; i < N_EXT_TS; i++) {
740 if (ext_status & exts_chan_to_edata(i)) {
742 ptp_clock_event(dp83640->clock->ptp_clock, &event);
746 return parsed * sizeof(u16);
749 static void decode_rxts(struct dp83640_private *dp83640,
750 struct phy_rxts *phy_rxts)
755 spin_lock_irqsave(&dp83640->rx_lock, flags);
757 prune_rx_ts(dp83640);
759 if (list_empty(&dp83640->rxpool)) {
760 pr_debug("rx timestamp pool is empty\n");
763 rxts = list_first_entry(&dp83640->rxpool, struct rxts, list);
764 list_del_init(&rxts->list);
765 phy2rxts(phy_rxts, rxts);
766 list_add_tail(&rxts->list, &dp83640->rxts);
768 spin_unlock_irqrestore(&dp83640->rx_lock, flags);
771 static void decode_txts(struct dp83640_private *dp83640,
772 struct phy_txts *phy_txts)
774 struct skb_shared_hwtstamps shhwtstamps;
778 /* We must already have the skb that triggered this. */
780 skb = skb_dequeue(&dp83640->tx_queue);
783 pr_debug("have timestamp but tx_queue empty\n");
786 ns = phy2txts(phy_txts);
787 memset(&shhwtstamps, 0, sizeof(shhwtstamps));
788 shhwtstamps.hwtstamp = ns_to_ktime(ns);
789 skb_complete_tx_timestamp(skb, &shhwtstamps);
792 static void decode_status_frame(struct dp83640_private *dp83640,
795 struct phy_rxts *phy_rxts;
796 struct phy_txts *phy_txts;
803 for (len = skb_headlen(skb) - 2; len > sizeof(type); len -= size) {
806 ests = type & 0x0fff;
807 type = type & 0xf000;
811 if (PSF_RX == type && len >= sizeof(*phy_rxts)) {
813 phy_rxts = (struct phy_rxts *) ptr;
814 decode_rxts(dp83640, phy_rxts);
815 size = sizeof(*phy_rxts);
817 } else if (PSF_TX == type && len >= sizeof(*phy_txts)) {
819 phy_txts = (struct phy_txts *) ptr;
820 decode_txts(dp83640, phy_txts);
821 size = sizeof(*phy_txts);
823 } else if (PSF_EVNT == type && len >= sizeof(*phy_txts)) {
825 size = decode_evnt(dp83640, ptr, ests);
835 static int is_sync(struct sk_buff *skb, int type)
837 u8 *data = skb->data, *msgtype;
838 unsigned int offset = 0;
841 case PTP_CLASS_V1_IPV4:
842 case PTP_CLASS_V2_IPV4:
843 offset = ETH_HLEN + IPV4_HLEN(data) + UDP_HLEN;
845 case PTP_CLASS_V1_IPV6:
846 case PTP_CLASS_V2_IPV6:
849 case PTP_CLASS_V2_L2:
852 case PTP_CLASS_V2_VLAN:
853 offset = ETH_HLEN + VLAN_HLEN;
859 if (type & PTP_CLASS_V1)
860 offset += OFF_PTP_CONTROL;
862 if (skb->len < offset + 1)
865 msgtype = data + offset;
867 return (*msgtype & 0xf) == 0;
870 static int match(struct sk_buff *skb, unsigned int type, struct rxts *rxts)
874 u8 *msgtype, *data = skb_mac_header(skb);
876 /* check sequenceID, messageType, 12 bit hash of offset 20-29 */
879 case PTP_CLASS_V1_IPV4:
880 case PTP_CLASS_V2_IPV4:
881 offset = ETH_HLEN + IPV4_HLEN(data) + UDP_HLEN;
883 case PTP_CLASS_V1_IPV6:
884 case PTP_CLASS_V2_IPV6:
887 case PTP_CLASS_V2_L2:
890 case PTP_CLASS_V2_VLAN:
891 offset = ETH_HLEN + VLAN_HLEN;
897 if (skb->len + ETH_HLEN < offset + OFF_PTP_SEQUENCE_ID + sizeof(*seqid))
900 if (unlikely(type & PTP_CLASS_V1))
901 msgtype = data + offset + OFF_PTP_CONTROL;
903 msgtype = data + offset;
905 seqid = (u16 *)(data + offset + OFF_PTP_SEQUENCE_ID);
907 return rxts->msgtype == (*msgtype & 0xf) &&
908 rxts->seqid == ntohs(*seqid);
911 static void dp83640_free_clocks(void)
913 struct dp83640_clock *clock;
914 struct list_head *this, *next;
916 mutex_lock(&phyter_clocks_lock);
918 list_for_each_safe(this, next, &phyter_clocks) {
919 clock = list_entry(this, struct dp83640_clock, list);
920 if (!list_empty(&clock->phylist)) {
921 pr_warn("phy list non-empty while unloading\n");
924 list_del(&clock->list);
925 mutex_destroy(&clock->extreg_lock);
926 mutex_destroy(&clock->clock_lock);
927 put_device(&clock->bus->dev);
928 kfree(clock->caps.pin_config);
932 mutex_unlock(&phyter_clocks_lock);
935 static void dp83640_clock_init(struct dp83640_clock *clock, struct mii_bus *bus)
937 INIT_LIST_HEAD(&clock->list);
939 mutex_init(&clock->extreg_lock);
940 mutex_init(&clock->clock_lock);
941 INIT_LIST_HEAD(&clock->phylist);
942 clock->caps.owner = THIS_MODULE;
943 sprintf(clock->caps.name, "dp83640 timer");
944 clock->caps.max_adj = 1953124;
945 clock->caps.n_alarm = 0;
946 clock->caps.n_ext_ts = N_EXT_TS;
947 clock->caps.n_per_out = 1;
948 clock->caps.n_pins = DP83640_N_PINS;
950 clock->caps.adjfreq = ptp_dp83640_adjfreq;
951 clock->caps.adjtime = ptp_dp83640_adjtime;
952 clock->caps.gettime = ptp_dp83640_gettime;
953 clock->caps.settime = ptp_dp83640_settime;
954 clock->caps.enable = ptp_dp83640_enable;
955 clock->caps.verify = ptp_dp83640_verify;
957 * Convert the module param defaults into a dynamic pin configuration.
959 dp83640_gpio_defaults(clock->caps.pin_config);
961 * Get a reference to this bus instance.
963 get_device(&bus->dev);
966 static int choose_this_phy(struct dp83640_clock *clock,
967 struct phy_device *phydev)
969 if (chosen_phy == -1 && !clock->chosen)
972 if (chosen_phy == phydev->addr)
978 static struct dp83640_clock *dp83640_clock_get(struct dp83640_clock *clock)
981 mutex_lock(&clock->clock_lock);
986 * Look up and lock a clock by bus instance.
987 * If there is no clock for this bus, then create it first.
989 static struct dp83640_clock *dp83640_clock_get_bus(struct mii_bus *bus)
991 struct dp83640_clock *clock = NULL, *tmp;
992 struct list_head *this;
994 mutex_lock(&phyter_clocks_lock);
996 list_for_each(this, &phyter_clocks) {
997 tmp = list_entry(this, struct dp83640_clock, list);
998 if (tmp->bus == bus) {
1006 clock = kzalloc(sizeof(struct dp83640_clock), GFP_KERNEL);
1010 clock->caps.pin_config = kzalloc(sizeof(struct ptp_pin_desc) *
1011 DP83640_N_PINS, GFP_KERNEL);
1012 if (!clock->caps.pin_config) {
1017 dp83640_clock_init(clock, bus);
1018 list_add_tail(&phyter_clocks, &clock->list);
1020 mutex_unlock(&phyter_clocks_lock);
1022 return dp83640_clock_get(clock);
1025 static void dp83640_clock_put(struct dp83640_clock *clock)
1027 mutex_unlock(&clock->clock_lock);
1030 static int dp83640_probe(struct phy_device *phydev)
1032 struct dp83640_clock *clock;
1033 struct dp83640_private *dp83640;
1034 int err = -ENOMEM, i;
1036 if (phydev->addr == BROADCAST_ADDR)
1039 clock = dp83640_clock_get_bus(phydev->bus);
1043 dp83640 = kzalloc(sizeof(struct dp83640_private), GFP_KERNEL);
1047 dp83640->phydev = phydev;
1048 INIT_WORK(&dp83640->ts_work, rx_timestamp_work);
1050 INIT_LIST_HEAD(&dp83640->rxts);
1051 INIT_LIST_HEAD(&dp83640->rxpool);
1052 for (i = 0; i < MAX_RXTS; i++)
1053 list_add(&dp83640->rx_pool_data[i].list, &dp83640->rxpool);
1055 phydev->priv = dp83640;
1057 spin_lock_init(&dp83640->rx_lock);
1058 skb_queue_head_init(&dp83640->rx_queue);
1059 skb_queue_head_init(&dp83640->tx_queue);
1061 dp83640->clock = clock;
1063 if (choose_this_phy(clock, phydev)) {
1064 clock->chosen = dp83640;
1065 clock->ptp_clock = ptp_clock_register(&clock->caps, &phydev->dev);
1066 if (IS_ERR(clock->ptp_clock)) {
1067 err = PTR_ERR(clock->ptp_clock);
1071 list_add_tail(&dp83640->list, &clock->phylist);
1073 dp83640_clock_put(clock);
1077 clock->chosen = NULL;
1080 dp83640_clock_put(clock);
1085 static void dp83640_remove(struct phy_device *phydev)
1087 struct dp83640_clock *clock;
1088 struct list_head *this, *next;
1089 struct dp83640_private *tmp, *dp83640 = phydev->priv;
1090 struct sk_buff *skb;
1092 if (phydev->addr == BROADCAST_ADDR)
1095 enable_status_frames(phydev, false);
1096 cancel_work_sync(&dp83640->ts_work);
1098 while ((skb = skb_dequeue(&dp83640->rx_queue)) != NULL)
1101 while ((skb = skb_dequeue(&dp83640->tx_queue)) != NULL)
1102 skb_complete_tx_timestamp(skb, NULL);
1104 clock = dp83640_clock_get(dp83640->clock);
1106 if (dp83640 == clock->chosen) {
1107 ptp_clock_unregister(clock->ptp_clock);
1108 clock->chosen = NULL;
1110 list_for_each_safe(this, next, &clock->phylist) {
1111 tmp = list_entry(this, struct dp83640_private, list);
1112 if (tmp == dp83640) {
1113 list_del_init(&tmp->list);
1119 dp83640_clock_put(clock);
1123 static int dp83640_config_init(struct phy_device *phydev)
1125 struct dp83640_private *dp83640 = phydev->priv;
1126 struct dp83640_clock *clock = dp83640->clock;
1128 if (clock->chosen && !list_empty(&clock->phylist))
1131 enable_broadcast(phydev, clock->page, 1);
1133 enable_status_frames(phydev, true);
1134 ext_write(0, phydev, PAGE4, PTP_CTL, PTP_ENABLE);
1138 static int dp83640_ack_interrupt(struct phy_device *phydev)
1140 int err = phy_read(phydev, MII_DP83640_MISR);
1148 static int dp83640_config_intr(struct phy_device *phydev)
1154 if (phydev->interrupts == PHY_INTERRUPT_ENABLED) {
1155 misr = phy_read(phydev, MII_DP83640_MISR);
1159 (MII_DP83640_MISR_ANC_INT_EN |
1160 MII_DP83640_MISR_DUP_INT_EN |
1161 MII_DP83640_MISR_SPD_INT_EN |
1162 MII_DP83640_MISR_LINK_INT_EN);
1163 err = phy_write(phydev, MII_DP83640_MISR, misr);
1167 micr = phy_read(phydev, MII_DP83640_MICR);
1171 (MII_DP83640_MICR_OE |
1172 MII_DP83640_MICR_IE);
1173 return phy_write(phydev, MII_DP83640_MICR, micr);
1175 micr = phy_read(phydev, MII_DP83640_MICR);
1179 ~(MII_DP83640_MICR_OE |
1180 MII_DP83640_MICR_IE);
1181 err = phy_write(phydev, MII_DP83640_MICR, micr);
1185 misr = phy_read(phydev, MII_DP83640_MISR);
1189 ~(MII_DP83640_MISR_ANC_INT_EN |
1190 MII_DP83640_MISR_DUP_INT_EN |
1191 MII_DP83640_MISR_SPD_INT_EN |
1192 MII_DP83640_MISR_LINK_INT_EN);
1193 return phy_write(phydev, MII_DP83640_MISR, misr);
1197 static int dp83640_hwtstamp(struct phy_device *phydev, struct ifreq *ifr)
1199 struct dp83640_private *dp83640 = phydev->priv;
1200 struct hwtstamp_config cfg;
1203 if (copy_from_user(&cfg, ifr->ifr_data, sizeof(cfg)))
1206 if (cfg.flags) /* reserved for future extensions */
1209 if (cfg.tx_type < 0 || cfg.tx_type > HWTSTAMP_TX_ONESTEP_SYNC)
1212 dp83640->hwts_tx_en = cfg.tx_type;
1214 switch (cfg.rx_filter) {
1215 case HWTSTAMP_FILTER_NONE:
1216 dp83640->hwts_rx_en = 0;
1218 dp83640->version = 0;
1220 case HWTSTAMP_FILTER_PTP_V1_L4_EVENT:
1221 case HWTSTAMP_FILTER_PTP_V1_L4_SYNC:
1222 case HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ:
1223 dp83640->hwts_rx_en = 1;
1224 dp83640->layer = LAYER4;
1225 dp83640->version = 1;
1227 case HWTSTAMP_FILTER_PTP_V2_L4_EVENT:
1228 case HWTSTAMP_FILTER_PTP_V2_L4_SYNC:
1229 case HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ:
1230 dp83640->hwts_rx_en = 1;
1231 dp83640->layer = LAYER4;
1232 dp83640->version = 2;
1234 case HWTSTAMP_FILTER_PTP_V2_L2_EVENT:
1235 case HWTSTAMP_FILTER_PTP_V2_L2_SYNC:
1236 case HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ:
1237 dp83640->hwts_rx_en = 1;
1238 dp83640->layer = LAYER2;
1239 dp83640->version = 2;
1241 case HWTSTAMP_FILTER_PTP_V2_EVENT:
1242 case HWTSTAMP_FILTER_PTP_V2_SYNC:
1243 case HWTSTAMP_FILTER_PTP_V2_DELAY_REQ:
1244 dp83640->hwts_rx_en = 1;
1245 dp83640->layer = LAYER4|LAYER2;
1246 dp83640->version = 2;
1252 txcfg0 = (dp83640->version & TX_PTP_VER_MASK) << TX_PTP_VER_SHIFT;
1253 rxcfg0 = (dp83640->version & TX_PTP_VER_MASK) << TX_PTP_VER_SHIFT;
1255 if (dp83640->layer & LAYER2) {
1259 if (dp83640->layer & LAYER4) {
1260 txcfg0 |= TX_IPV6_EN | TX_IPV4_EN;
1261 rxcfg0 |= RX_IPV6_EN | RX_IPV4_EN;
1264 if (dp83640->hwts_tx_en)
1267 if (dp83640->hwts_tx_en == HWTSTAMP_TX_ONESTEP_SYNC)
1268 txcfg0 |= SYNC_1STEP | CHK_1STEP;
1270 if (dp83640->hwts_rx_en)
1273 mutex_lock(&dp83640->clock->extreg_lock);
1275 ext_write(0, phydev, PAGE5, PTP_TXCFG0, txcfg0);
1276 ext_write(0, phydev, PAGE5, PTP_RXCFG0, rxcfg0);
1278 mutex_unlock(&dp83640->clock->extreg_lock);
1280 return copy_to_user(ifr->ifr_data, &cfg, sizeof(cfg)) ? -EFAULT : 0;
1283 static void rx_timestamp_work(struct work_struct *work)
1285 struct dp83640_private *dp83640 =
1286 container_of(work, struct dp83640_private, ts_work);
1287 struct list_head *this, *next;
1289 struct skb_shared_hwtstamps *shhwtstamps;
1290 struct sk_buff *skb;
1292 unsigned long flags;
1294 /* Deliver each deferred packet, with or without a time stamp. */
1296 while ((skb = skb_dequeue(&dp83640->rx_queue)) != NULL) {
1297 type = SKB_PTP_TYPE(skb);
1298 spin_lock_irqsave(&dp83640->rx_lock, flags);
1299 list_for_each_safe(this, next, &dp83640->rxts) {
1300 rxts = list_entry(this, struct rxts, list);
1301 if (match(skb, type, rxts)) {
1302 shhwtstamps = skb_hwtstamps(skb);
1303 memset(shhwtstamps, 0, sizeof(*shhwtstamps));
1304 shhwtstamps->hwtstamp = ns_to_ktime(rxts->ns);
1305 list_del_init(&rxts->list);
1306 list_add(&rxts->list, &dp83640->rxpool);
1310 spin_unlock_irqrestore(&dp83640->rx_lock, flags);
1314 /* Clear out expired time stamps. */
1316 spin_lock_irqsave(&dp83640->rx_lock, flags);
1317 prune_rx_ts(dp83640);
1318 spin_unlock_irqrestore(&dp83640->rx_lock, flags);
1321 static bool dp83640_rxtstamp(struct phy_device *phydev,
1322 struct sk_buff *skb, int type)
1324 struct dp83640_private *dp83640 = phydev->priv;
1326 if (!dp83640->hwts_rx_en)
1329 if (is_status_frame(skb, type)) {
1330 decode_status_frame(dp83640, skb);
1335 SKB_PTP_TYPE(skb) = type;
1336 skb_queue_tail(&dp83640->rx_queue, skb);
1337 schedule_work(&dp83640->ts_work);
1342 static void dp83640_txtstamp(struct phy_device *phydev,
1343 struct sk_buff *skb, int type)
1345 struct dp83640_private *dp83640 = phydev->priv;
1347 switch (dp83640->hwts_tx_en) {
1349 case HWTSTAMP_TX_ONESTEP_SYNC:
1350 if (is_sync(skb, type)) {
1351 skb_complete_tx_timestamp(skb, NULL);
1355 case HWTSTAMP_TX_ON:
1356 skb_shinfo(skb)->tx_flags |= SKBTX_IN_PROGRESS;
1357 skb_queue_tail(&dp83640->tx_queue, skb);
1358 schedule_work(&dp83640->ts_work);
1361 case HWTSTAMP_TX_OFF:
1363 skb_complete_tx_timestamp(skb, NULL);
1368 static int dp83640_ts_info(struct phy_device *dev, struct ethtool_ts_info *info)
1370 struct dp83640_private *dp83640 = dev->priv;
1372 info->so_timestamping =
1373 SOF_TIMESTAMPING_TX_HARDWARE |
1374 SOF_TIMESTAMPING_RX_HARDWARE |
1375 SOF_TIMESTAMPING_RAW_HARDWARE;
1376 info->phc_index = ptp_clock_index(dp83640->clock->ptp_clock);
1378 (1 << HWTSTAMP_TX_OFF) |
1379 (1 << HWTSTAMP_TX_ON) |
1380 (1 << HWTSTAMP_TX_ONESTEP_SYNC);
1382 (1 << HWTSTAMP_FILTER_NONE) |
1383 (1 << HWTSTAMP_FILTER_PTP_V1_L4_EVENT) |
1384 (1 << HWTSTAMP_FILTER_PTP_V1_L4_SYNC) |
1385 (1 << HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ) |
1386 (1 << HWTSTAMP_FILTER_PTP_V2_L4_EVENT) |
1387 (1 << HWTSTAMP_FILTER_PTP_V2_L4_SYNC) |
1388 (1 << HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ) |
1389 (1 << HWTSTAMP_FILTER_PTP_V2_L2_EVENT) |
1390 (1 << HWTSTAMP_FILTER_PTP_V2_L2_SYNC) |
1391 (1 << HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ) |
1392 (1 << HWTSTAMP_FILTER_PTP_V2_EVENT) |
1393 (1 << HWTSTAMP_FILTER_PTP_V2_SYNC) |
1394 (1 << HWTSTAMP_FILTER_PTP_V2_DELAY_REQ);
1398 static struct phy_driver dp83640_driver = {
1399 .phy_id = DP83640_PHY_ID,
1400 .phy_id_mask = 0xfffffff0,
1401 .name = "NatSemi DP83640",
1402 .features = PHY_BASIC_FEATURES,
1403 .flags = PHY_HAS_INTERRUPT,
1404 .probe = dp83640_probe,
1405 .remove = dp83640_remove,
1406 .config_init = dp83640_config_init,
1407 .config_aneg = genphy_config_aneg,
1408 .read_status = genphy_read_status,
1409 .ack_interrupt = dp83640_ack_interrupt,
1410 .config_intr = dp83640_config_intr,
1411 .ts_info = dp83640_ts_info,
1412 .hwtstamp = dp83640_hwtstamp,
1413 .rxtstamp = dp83640_rxtstamp,
1414 .txtstamp = dp83640_txtstamp,
1415 .driver = {.owner = THIS_MODULE,}
1418 static int __init dp83640_init(void)
1420 return phy_driver_register(&dp83640_driver);
1423 static void __exit dp83640_exit(void)
1425 dp83640_free_clocks();
1426 phy_driver_unregister(&dp83640_driver);
1429 MODULE_DESCRIPTION("National Semiconductor DP83640 PHY driver");
1431 MODULE_LICENSE("GPL");
1433 module_init(dp83640_init);
1434 module_exit(dp83640_exit);
1436 static struct mdio_device_id __maybe_unused dp83640_tbl[] = {
1437 { DP83640_PHY_ID, 0xfffffff0 },
1441 MODULE_DEVICE_TABLE(mdio, dp83640_tbl);