Message ID | 1479478912-14067-1-git-send-email-andrei.pistirica@microchip.com (mailing list archive) |
---|---|
State | New, archived |
Headers | show |
On Fri, Nov 18, 2016 at 03:21:51PM +0100, Andrei Pistirica wrote: > - Frequency adjustment is not directly supported by this IP. This statement still makes no sense. Doesn't the following text... > addend is the initial value ns increment and similarly addendesub. > The ppb (parts per billion) provided is used as > ns_incr = addend +/- (ppb/rate). > Similarly the remainder of the above is used to populate subns increment. describe how frequency adjustment is in fact supported? > +config MACB_USE_HWSTAMP > + bool "Use IEEE 1588 hwstamp" > + depends on MACB > + default y > + select PTP_1588_CLOCK This "select" pattern is going to be replaced with "imply" soon. http://www.mail-archive.com/linux-kernel@vger.kernel.org/msg1269181.html You should use the new "imply" key word and reference that series in your change log. > diff --git a/drivers/net/ethernet/cadence/macb.h b/drivers/net/ethernet/cadence/macb.h > index 3f385ab..2ee9af8 100644 > --- a/drivers/net/ethernet/cadence/macb.h > +++ b/drivers/net/ethernet/cadence/macb.h > @@ -10,6 +10,10 @@ > #ifndef _MACB_H > #define _MACB_H > > +#include <linux/net_tstamp.h> > +#include <linux/ptp_clock.h> > +#include <linux/ptp_clock_kernel.h> Don't need net_tstamp.h here. Move it into the .c file please. > @@ -840,8 +902,26 @@ struct macb { > > unsigned int rx_frm_len_mask; > unsigned int jumbo_max_len; > + > +#ifdef CONFIG_MACB_USE_HWSTAMP > + unsigned int hwts_tx_en; > + unsigned int hwts_rx_en; These two can be bool'eans. > + spinlock_t tsu_clk_lock; > + unsigned int tsu_rate; > + > + struct ptp_clock *ptp_clock; > + struct ptp_clock_info ptp_caps; > + unsigned int ns_incr; > + unsigned int subns_incr; These two are 32 bit register values, right? Then use the u32 type. > +#endif > }; > +static inline void macb_tsu_set_time(struct macb *bp, > + const struct timespec64 *ts) > +{ > + u32 ns, sech, secl; > + s64 word_mask = 0xffffffff; > + > + sech = (u32)ts->tv_sec; > + secl = (u32)ts->tv_sec; > + ns = ts->tv_nsec; > + if (ts->tv_sec > word_mask) > + sech = (ts->tv_sec >> 32); > + > + spin_lock(&bp->tsu_clk_lock); > + > + /* TSH doesn't latch the time and no atomicity! */ > + gem_writel(bp, TSH, sech); > + gem_writel(bp, TSL, secl); If TN overflows here then the clock will be off by one whole second! Why not clear TN first? > + gem_writel(bp, TN, ns); > + > + spin_unlock(&bp->tsu_clk_lock); > +} > + > +static int macb_ptp_adjfreq(struct ptp_clock_info *ptp, s32 ppb) > +{ > + struct macb *bp = container_of(ptp, struct macb, ptp_caps); > + u32 addend, addend_frac, rem; > + u64 drift_tmr, diff, diff_frac = 0; > + int neg_adj = 0; > + > + if (ppb < 0) { > + neg_adj = 1; > + ppb = -ppb; > + } > + > + /* drift/period */ > + drift_tmr = (bp->ns_incr * ppb) + > + ((bp->subns_incr * ppb) >> 16); What? Why the 16 bit shift? Last time your said it was 24 bits. > + /* drift/cycle */ > + diff = div_u64_rem(drift_tmr, 1000000000ULL, &rem); > + > + /* drift fraction/cycle, if necessary */ > + if (rem) { > + u64 fraction = rem; > + fraction = fraction << 16; > + > + diff_frac = div_u64(fraction, 1000000000ULL); If you use a combined tuning word like I explained last time, then you will not need a second division. Also, please use the new adjfine() PHC method, as adjfreq() is now deprecated. > + } > + > + /* adjustmets */ > + addend = neg_adj ? (bp->ns_incr - diff) : (bp->ns_incr + diff); > + addend_frac = neg_adj ? (bp->subns_incr - diff_frac) : > + (bp->subns_incr + diff_frac); > + > + spin_lock(&bp->tsu_clk_lock); > + > + gem_writel(bp, TISUBN, GEM_BF(SUBNSINCR, addend_frac)); > + gem_writel(bp, TI, GEM_BF(NSINCR, addend)); > + > + spin_unlock(&bp->tsu_clk_lock); > + return 0; > +} > +void macb_ptp_init(struct net_device *ndev) > +{ > + struct macb *bp = netdev_priv(ndev); > + struct timespec64 now; > + u32 rem = 0; > + > + if (!(bp->caps | MACB_CAPS_GEM_HAS_PTP)){ > + netdev_vdbg(bp->dev, "Platform does not support PTP!\n"); > + return; > + } > + > + spin_lock_init(&bp->tsu_clk_lock); > + > + bp->ptp_caps = macb_ptp_caps; > + bp->tsu_rate = clk_get_rate(bp->pclk); > + > + getnstimeofday64(&now); > + macb_tsu_set_time(bp, (const struct timespec64 *)&now); > + > + bp->ns_incr = div_u64_rem(NSEC_PER_SEC, bp->tsu_rate, &rem); > + if (rem) { > + u64 adj = rem; > + /* Multiply by 2^16 as subns register is 16 bits */ Last time you said: > + /* Multiple by 2^24 as subns field is 24 bits */ > + adj <<= 16; > + bp->subns_incr = div_u64(adj, bp->tsu_rate); > + } else { > + bp->subns_incr = 0; > + } > + > + gem_writel(bp, TISUBN, GEM_BF(SUBNSINCR, bp->subns_incr)); > + gem_writel(bp, TI, GEM_BF(NSINCR, bp->ns_incr)); > + gem_writel(bp, TA, 0); > + > + bp->ptp_clock = ptp_clock_register(&bp->ptp_caps, NULL); You call regsiter, but you never call unregister! > + if (IS_ERR(&bp->ptp_clock)) { > + bp->ptp_clock = NULL; > + pr_err("ptp clock register failed\n"); > + return; > + } > + > + dev_info(&bp->pdev->dev, "%s ptp clock registered.\n", GMAC_TIMER_NAME); > +} > + > -- > 1.9.1 > Thanks, Richard
On Fri, Nov 18, 2016 at 03:21:51PM +0100, Andrei Pistirica wrote: > +#ifdef CONFIG_MACB_USE_HWSTAMP > +void macb_ptp_init(struct net_device *ndev); > +#else > +void macb_ptp_init(struct net_device *ndev) { } static inline ^^^ > +#endif > +void macb_ptp_init(struct net_device *ndev) > +{ > + struct macb *bp = netdev_priv(ndev); > + struct timespec64 now; > + u32 rem = 0; > + > + if (!(bp->caps | MACB_CAPS_GEM_HAS_PTP)){ > + netdev_vdbg(bp->dev, "Platform does not support PTP!\n"); > + return; > + } You would have needed '&' and not '|' here. Also, using a flag limits the code to your platform. This works for you, but it is short sighted. The other MACB PTP blocks have different register layouts, and this patch does not lay the ground work for the others. The driver needs to be designed to support the other platforms. Thanks, Richard
On 20.11.2016 20:18, Richard Cochran wrote: > On Fri, Nov 18, 2016 at 03:21:51PM +0100, Andrei Pistirica wrote: >> - Frequency adjustment is not directly supported by this IP. > > This statement still makes no sense. Doesn't the following text... This statement is inherited from original patch, and it refers to the fact that it doesn't change directly the frequency, it changes the increment value. I'll remove it to avoid any confusion. > >> addend is the initial value ns increment and similarly addendesub. >> The ppb (parts per billion) provided is used as >> ns_incr = addend +/- (ppb/rate). >> Similarly the remainder of the above is used to populate subns increment. > > describe how frequency adjustment is in fact supported? Ack, I will clarify. > >> +config MACB_USE_HWSTAMP >> + bool "Use IEEE 1588 hwstamp" >> + depends on MACB >> + default y >> + select PTP_1588_CLOCK > > This "select" pattern is going to be replaced with "imply" soon. > > http://www.mail-archive.com/linux-kernel@vger.kernel.org/msg1269181.html > > You should use the new "imply" key word and reference that series in > your change log. Ack. > >> diff --git a/drivers/net/ethernet/cadence/macb.h b/drivers/net/ethernet/cadence/macb.h >> index 3f385ab..2ee9af8 100644 >> --- a/drivers/net/ethernet/cadence/macb.h >> +++ b/drivers/net/ethernet/cadence/macb.h >> @@ -10,6 +10,10 @@ >> #ifndef _MACB_H >> #define _MACB_H >> >> +#include <linux/net_tstamp.h> >> +#include <linux/ptp_clock.h> >> +#include <linux/ptp_clock_kernel.h> > > Don't need net_tstamp.h here. Move it into the .c file please. Ack. > >> @@ -840,8 +902,26 @@ struct macb { >> >> unsigned int rx_frm_len_mask; >> unsigned int jumbo_max_len; >> + >> +#ifdef CONFIG_MACB_USE_HWSTAMP >> + unsigned int hwts_tx_en; >> + unsigned int hwts_rx_en; > > These two can be bool'eans. Ack. > >> + spinlock_t tsu_clk_lock; >> + unsigned int tsu_rate; >> + >> + struct ptp_clock *ptp_clock; >> + struct ptp_clock_info ptp_caps; >> + unsigned int ns_incr; >> + unsigned int subns_incr; > > These two are 32 bit register values, right? Then use the u32 type. Yes. I will make the change. > >> +#endif >> }; > >> +static inline void macb_tsu_set_time(struct macb *bp, >> + const struct timespec64 *ts) >> +{ >> + u32 ns, sech, secl; >> + s64 word_mask = 0xffffffff; >> + >> + sech = (u32)ts->tv_sec; >> + secl = (u32)ts->tv_sec; >> + ns = ts->tv_nsec; >> + if (ts->tv_sec > word_mask) >> + sech = (ts->tv_sec >> 32); >> + >> + spin_lock(&bp->tsu_clk_lock); >> + >> + /* TSH doesn't latch the time and no atomicity! */ >> + gem_writel(bp, TSH, sech); >> + gem_writel(bp, TSL, secl); > > If TN overflows here then the clock will be off by one whole second! > Why not clear TN first? Ack. > >> + gem_writel(bp, TN, ns); >> + >> + spin_unlock(&bp->tsu_clk_lock); >> +} >> + >> +static int macb_ptp_adjfreq(struct ptp_clock_info *ptp, s32 ppb) >> +{ >> + struct macb *bp = container_of(ptp, struct macb, ptp_caps); >> + u32 addend, addend_frac, rem; >> + u64 drift_tmr, diff, diff_frac = 0; >> + int neg_adj = 0; >> + >> + if (ppb < 0) { >> + neg_adj = 1; >> + ppb = -ppb; >> + } >> + >> + /* drift/period */ >> + drift_tmr = (bp->ns_incr * ppb) + >> + ((bp->subns_incr * ppb) >> 16); > > What? Why the 16 bit shift? Last time your said it was 24 bits. SAMA5D2/3/4 uses GEM-PTP version (16bit), while Harini wrote a driver for GEM-GXL (24bit). Probably will be a patch on top of this one for GXL. This confusion was because I tried to keep the original patch unchanged. > >> + /* drift/cycle */ >> + diff = div_u64_rem(drift_tmr, 1000000000ULL, &rem); >> + >> + /* drift fraction/cycle, if necessary */ >> + if (rem) { >> + u64 fraction = rem; >> + fraction = fraction << 16; >> + >> + diff_frac = div_u64(fraction, 1000000000ULL); > > If you use a combined tuning word like I explained last time, then you > will not need a second division. From what I understand, your suggestion is: (ns | frac) * ppb = (total_ns | total_frac) (total_ns | total_frac) / 10^9 = (adj_ns | adj_frac) This is correct iff total_ns/10^9 >= 1, but the problem is that there are missed fractions due to the following approximation: frac*ppb =~ (ns*ppb+frac*ppb*2^16)*2^16-10^9*2^16*flor(ns*ppb+frac*ppb*2^16, 10^9). An example which uses values from a real test: let ppb=4891, ns=12 and frac=3158 - using suggested algorithm, yields: adj_ns = 0 and adj_frac = 0 - using in-place algorithm, yields: adj_ns = 0, adj_frac = 4 You can check the calculus. Therefore, I would like to keep the in-place algorithm. > > Also, please use the new adjfine() PHC method, as adjfreq() is now deprecated. Yes, I will port the patches on net-next and use adjfine. > >> + } >> + >> + /* adjustmets */ >> + addend = neg_adj ? (bp->ns_incr - diff) : (bp->ns_incr + diff); >> + addend_frac = neg_adj ? (bp->subns_incr - diff_frac) : >> + (bp->subns_incr + diff_frac); >> + >> + spin_lock(&bp->tsu_clk_lock); >> + >> + gem_writel(bp, TISUBN, GEM_BF(SUBNSINCR, addend_frac)); >> + gem_writel(bp, TI, GEM_BF(NSINCR, addend)); >> + >> + spin_unlock(&bp->tsu_clk_lock); >> + return 0; >> +} > >> +void macb_ptp_init(struct net_device *ndev) >> +{ >> + struct macb *bp = netdev_priv(ndev); >> + struct timespec64 now; >> + u32 rem = 0; >> + >> + if (!(bp->caps | MACB_CAPS_GEM_HAS_PTP)){ >> + netdev_vdbg(bp->dev, "Platform does not support PTP!\n"); >> + return; >> + } >> + >> + spin_lock_init(&bp->tsu_clk_lock); >> + >> + bp->ptp_caps = macb_ptp_caps; >> + bp->tsu_rate = clk_get_rate(bp->pclk); >> + >> + getnstimeofday64(&now); >> + macb_tsu_set_time(bp, (const struct timespec64 *)&now); >> + >> + bp->ns_incr = div_u64_rem(NSEC_PER_SEC, bp->tsu_rate, &rem); >> + if (rem) { >> + u64 adj = rem; >> + /* Multiply by 2^16 as subns register is 16 bits */ > > Last time you said: >> + /* Multiple by 2^24 as subns field is 24 bits */ > >> + adj <<= 16; >> + bp->subns_incr = div_u64(adj, bp->tsu_rate); >> + } else { >> + bp->subns_incr = 0; >> + } >> + >> + gem_writel(bp, TISUBN, GEM_BF(SUBNSINCR, bp->subns_incr)); >> + gem_writel(bp, TI, GEM_BF(NSINCR, bp->ns_incr)); >> + gem_writel(bp, TA, 0); >> + >> + bp->ptp_clock = ptp_clock_register(&bp->ptp_caps, NULL); > > You call regsiter, but you never call unregister! Ack. I did a stupid mistake... sorry. > >> + if (IS_ERR(&bp->ptp_clock)) { >> + bp->ptp_clock = NULL; >> + pr_err("ptp clock register failed\n"); >> + return; >> + } >> + >> + dev_info(&bp->pdev->dev, "%s ptp clock registered.\n", GMAC_TIMER_NAME); >> +} >> + >> -- >> 1.9.1 >> > > Thanks, > Richard > Regards, Andrei
On 20.11.2016 20:37, Richard Cochran wrote: > On Fri, Nov 18, 2016 at 03:21:51PM +0100, Andrei Pistirica wrote: >> +#ifdef CONFIG_MACB_USE_HWSTAMP >> +void macb_ptp_init(struct net_device *ndev); >> +#else >> +void macb_ptp_init(struct net_device *ndev) { } > > static inline ^^^ I can do static inline only when PTP is not enabled (on else branch), thus the empty function is defined in the header file (since the init function is defined in macb_ptp and used in macb). To differentiate between macb versions, I'll add a wrapper. Would this be ok? > >> +#endif > > >> +void macb_ptp_init(struct net_device *ndev) >> +{ >> + struct macb *bp = netdev_priv(ndev); >> + struct timespec64 now; >> + u32 rem = 0; >> + >> + if (!(bp->caps | MACB_CAPS_GEM_HAS_PTP)){ >> + netdev_vdbg(bp->dev, "Platform does not support PTP!\n"); >> + return; >> + } > > You would have needed '&' and not '|' here. Yes. Another stupid mistake... sorry. I will be more careful next time. > > Also, using a flag limits the code to your platform. This works for > you, but it is short sighted. The other MACB PTP blocks have > different register layouts, and this patch does not lay the ground > work for the others. > > The driver needs to be designed to support the other platforms. It will support Xilinx. > > Thanks, > Richard > Regards, Andrei
On Wed, Nov 23, 2016 at 02:34:03PM +0100, Andrei Pistirica wrote: > From what I understand, your suggestion is: > (ns | frac) * ppb = (total_ns | total_frac) > (total_ns | total_frac) / 10^9 = (adj_ns | adj_frac) > This is correct iff total_ns/10^9 >= 1, but the problem is that there are > missed fractions due to the following approximation: > frac*ppb =~ (ns*ppb+frac*ppb*2^16)*2^16-10^9*2^16*flor(ns*ppb+frac*ppb*2^16, > 10^9). -ENOPARSE; > An example which uses values from a real test: > let ppb=4891, ns=12 and frac=3158 That is a very strange example for nominal frequency. The clock period is 12.048187255859375 nanoseconds, and so the frequency is 83000037.99 Hz. But hey, let's go with it... > - using suggested algorithm, yields: adj_ns = 0 and adj_frac = 0 > - using in-place algorithm, yields: adj_ns = 0, adj_frac = 4 > You can check the calculus. The test program, below, shows you what I meant. (Of course, you should adjust this to fit the adjfine() method.) Unfortunately, this device has a very coarse frequency resolution. Using a nominal period of ns=12 as an example, the resolution is 2^-16 / 12 or 1.27 ppm. The 24 bit device is much better in this repect. The output using your example numbers is: $ ./a.out 12 3158 4891 ns=12 frac=3158 ns=12 frac=3162 $ ./a.out 12 3158 -4891 ns=12 frac=3158 ns=12 frac=3154 See how you get a result of +/- 4 with just one division? Thanks, Richard --- #include <stdint.h> #include <stdio.h> #include <stdlib.h> static void adjfreq(uint32_t ns, uint32_t frac, int32_t ppb) { uint64_t adj; uint32_t diff, word; int neg_adj = 0; printf("ns=%u frac=%u\n", ns, frac); if (ppb < 0) { neg_adj = 1; ppb = -ppb; } word = (ns << 16) + frac; adj = word; adj *= ppb; adj += 500000000UL; diff = adj / 1000000000UL; word = neg_adj ? word - diff : word + diff; printf("ns=%u frac=%u\n", word >> 16, word & 0xffff); } int main(int argc, char *argv[]) { uint32_t ns, frac; int32_t ppb; if (argc != 4) { puts("need ns, frac, and ppb"); return -1; } ns = atoi(argv[1]); frac = atoi(argv[2]); ppb = atoi(argv[3]); adjfreq(ns, frac, ppb); return 0; }
> -----Original Message----- > From: Richard Cochran [mailto:richardcochran@gmail.com] > Sent: Wednesday, November 23, 2016 11:03 PM > To: Andrei Pistirica - M16132 > Cc: netdev@vger.kernel.org; linux-kernel@vger.kernel.org; linux-arm- > kernel@lists.infradead.org; davem@davemloft.net; > nicolas.ferre@atmel.com; harinikatakamlinux@gmail.com; > harini.katakam@xilinx.com; punnaia@xilinx.com; michals@xilinx.com; > anirudh@xilinx.com; boris.brezillon@free-electrons.com; > alexandre.belloni@free-electrons.com; tbultel@pixelsurmer.com > Subject: Re: [RFC PATCH v2 1/2] macb: Add 1588 support in Cadence GEM. > > On Wed, Nov 23, 2016 at 02:34:03PM +0100, Andrei Pistirica wrote: > > From what I understand, your suggestion is: > > (ns | frac) * ppb = (total_ns | total_frac) (total_ns | total_frac) / > > 10^9 = (adj_ns | adj_frac) This is correct iff total_ns/10^9 >= 1, but > > the problem is that there are missed fractions due to the following > > approximation: > > frac*ppb =~ > > (ns*ppb+frac*ppb*2^16)*2^16-10^9*2^16*flor(ns*ppb+frac*ppb*2^16, > > 10^9). > > -ENOPARSE; > > > An example which uses values from a real test: > > let ppb=4891, ns=12 and frac=3158 > > That is a very strange example for nominal frequency. The clock period is > 12.048187255859375 nanoseconds, and so the frequency is > 83000037.99 Hz. > > But hey, let's go with it... > > > - using suggested algorithm, yields: adj_ns = 0 and adj_frac = 0 > > - using in-place algorithm, yields: adj_ns = 0, adj_frac = 4 You can > > check the calculus. > > The test program, below, shows you what I meant. (Of course, you should > adjust this to fit the adjfine() method.) > > Unfortunately, this device has a very coarse frequency resolution. > Using a nominal period of ns=12 as an example, the resolution is > 2^-16 / 12 or 1.27 ppm. The 24 bit device is much better in this repect. > > The output using your example numbers is: > > $ ./a.out 12 3158 4891 > ns=12 frac=3158 > ns=12 frac=3162 > > $ ./a.out 12 3158 -4891 > ns=12 frac=3158 > ns=12 frac=3154 > > See how you get a result of +/- 4 with just one division? > > Thanks, > Richard > > --- > #include <stdint.h> > #include <stdio.h> > #include <stdlib.h> > > static void adjfreq(uint32_t ns, uint32_t frac, int32_t ppb) { > uint64_t adj; > uint32_t diff, word; > int neg_adj = 0; > > printf("ns=%u frac=%u\n", ns, frac); > > if (ppb < 0) { > neg_adj = 1; > ppb = -ppb; > } > word = (ns << 16) + frac; > adj = word; > adj *= ppb; > adj += 500000000UL; > diff = adj / 1000000000UL; > > word = neg_adj ? word - diff : word + diff; > printf("ns=%u frac=%u\n", word >> 16, word & 0xffff); } > > int main(int argc, char *argv[]) > { > uint32_t ns, frac; > int32_t ppb; > > if (argc != 4) { > puts("need ns, frac, and ppb"); > return -1; > } > ns = atoi(argv[1]); > frac = atoi(argv[2]); > ppb = atoi(argv[3]); > adjfreq(ns, frac, ppb); > return 0; > } Ok, thanks. I will use this one then. Regards, Andrei
diff --git a/drivers/net/ethernet/cadence/Kconfig b/drivers/net/ethernet/cadence/Kconfig index f0bcb15..ebbc65f 100644 --- a/drivers/net/ethernet/cadence/Kconfig +++ b/drivers/net/ethernet/cadence/Kconfig @@ -29,6 +29,14 @@ config MACB support for the MACB/GEM chip. To compile this driver as a module, choose M here: the module - will be called macb. + will be called cadence-macb. + +config MACB_USE_HWSTAMP + bool "Use IEEE 1588 hwstamp" + depends on MACB + default y + select PTP_1588_CLOCK + ---help--- + Enable IEEE 1588 Precision Time Protocol (PTP) support for MACB. endif # NET_CADENCE diff --git a/drivers/net/ethernet/cadence/Makefile b/drivers/net/ethernet/cadence/Makefile index 91f79b1..4402d42 100644 --- a/drivers/net/ethernet/cadence/Makefile +++ b/drivers/net/ethernet/cadence/Makefile @@ -2,4 +2,10 @@ # Makefile for the Atmel network device drivers. # -obj-$(CONFIG_MACB) += macb.o +cadence-macb-y := macb.o + +ifeq ($(CONFIG_MACB_USE_HWSTAMP),y) +cadence-macb-y += macb_ptp.o +endif + +obj-$(CONFIG_MACB) += cadence-macb.o diff --git a/drivers/net/ethernet/cadence/macb.h b/drivers/net/ethernet/cadence/macb.h index 3f385ab..2ee9af8 100644 --- a/drivers/net/ethernet/cadence/macb.h +++ b/drivers/net/ethernet/cadence/macb.h @@ -10,6 +10,10 @@ #ifndef _MACB_H #define _MACB_H +#include <linux/net_tstamp.h> +#include <linux/ptp_clock.h> +#include <linux/ptp_clock_kernel.h> + #define MACB_GREGS_NBR 16 #define MACB_GREGS_VERSION 2 #define MACB_MAX_QUEUES 8 @@ -129,6 +133,20 @@ #define GEM_RXIPCCNT 0x01a8 /* IP header Checksum Error Counter */ #define GEM_RXTCPCCNT 0x01ac /* TCP Checksum Error Counter */ #define GEM_RXUDPCCNT 0x01b0 /* UDP Checksum Error Counter */ +#define GEM_TISUBN 0x01bc /* 1588 Timer Increment Sub-ns */ +#define GEM_TSH 0x01c0 /* 1588 Timer Seconds High */ +#define GEM_TSL 0x01d0 /* 1588 Timer Seconds Low */ +#define GEM_TN 0x01d4 /* 1588 Timer Nanoseconds */ +#define GEM_TA 0x01d8 /* 1588 Timer Adjust */ +#define GEM_TI 0x01dc /* 1588 Timer Increment */ +#define GEM_EFTSL 0x01e0 /* PTP Event Frame Tx Seconds Low */ +#define GEM_EFTN 0x01e4 /* PTP Event Frame Tx Nanoseconds */ +#define GEM_EFRSL 0x01e8 /* PTP Event Frame Rx Seconds Low */ +#define GEM_EFRN 0x01ec /* PTP Event Frame Rx Nanoseconds */ +#define GEM_PEFTSL 0x01f0 /* PTP Peer Event Frame Tx Secs Low */ +#define GEM_PEFTN 0x01f4 /* PTP Peer Event Frame Tx Ns */ +#define GEM_PEFRSL 0x01f8 /* PTP Peer Event Frame Rx Sec Low */ +#define GEM_PEFRN 0x01fc /* PTP Peer Event Frame Rx Ns */ #define GEM_DCFG1 0x0280 /* Design Config 1 */ #define GEM_DCFG2 0x0284 /* Design Config 2 */ #define GEM_DCFG3 0x0288 /* Design Config 3 */ @@ -171,6 +189,7 @@ #define MACB_NCR_TPF_SIZE 1 #define MACB_TZQ_OFFSET 12 /* Transmit zero quantum pause frame */ #define MACB_TZQ_SIZE 1 +#define MACB_SRTSM_OFFSET 15 /* Bitfields in NCFGR */ #define MACB_SPD_OFFSET 0 /* Speed */ @@ -312,6 +331,36 @@ #define MACB_PFR_SIZE 1 #define MACB_PTZ_OFFSET 13 /* Enable pause time zero interrupt */ #define MACB_PTZ_SIZE 1 +#define MACB_PFTR_OFFSET 14 /* Pause Frame Transmitted */ +#define MACB_PFTR_SIZE 1 +#define MACB_DRQFR_OFFSET 18 /* PTP Delay Request Frame Received */ +#define MACB_DRQFR_SIZE 1 +#define MACB_SFR_OFFSET 19 /* PTP Sync Frame Received */ +#define MACB_SFR_SIZE 1 +#define MACB_DRQFT_OFFSET 20 /* PTP Delay Request Frame Transmitted */ +#define MACB_DRQFT_SIZE 1 +#define MACB_SFT_OFFSET 21 /* PTP Sync Frame Transmitted */ +#define MACB_SFT_SIZE 1 +#define MACB_PDRQFR_OFFSET 22 /* PDelay Request Frame Received */ +#define MACB_PDRQFR_SIZE 1 +#define MACB_PDRSFR_OFFSET 23 /* PDelay Response Frame Received */ +#define MACB_PDRSFR_SIZE 1 +#define MACB_PDRQFT_OFFSET 24 /* PDelay Request Frame Transmitted */ +#define MACB_PDRQFT_SIZE 1 +#define MACB_PDRSFT_OFFSET 25 /* PDelay Response Frame Transmitted */ +#define MACB_PDRSFT_SIZE 1 +#define MACB_SRI_OFFSET 26 /* TSU Seconds Register Increment */ +#define MACB_SRI_SIZE 1 +#define MACB_WOL_OFFSET 28 /* Wake On LAN */ +#define MACB_WOL_SIZE 1 + +/* Timer increment fields */ +#define MACB_TI_CNS_OFFSET 0 +#define MACB_TI_CNS_SIZE 8 +#define MACB_TI_ACNS_OFFSET 8 +#define MACB_TI_ACNS_SIZE 8 +#define MACB_TI_NIT_OFFSET 16 +#define MACB_TI_NIT_SIZE 8 /* Bitfields in MAN */ #define MACB_DATA_OFFSET 0 /* data */ @@ -375,6 +424,18 @@ #define GEM_TX_PKT_BUFF_OFFSET 21 #define GEM_TX_PKT_BUFF_SIZE 1 +/* Bitfields in TISUBN */ +#define GEM_SUBNSINCR_OFFSET 0 +#define GEM_SUBNSINCR_SIZE 16 + +/* Bitfields in TI */ +#define GEM_NSINCR_OFFSET 0 +#define GEM_NSINCR_SIZE 8 + +/* Bitfields in ADJ */ +#define GEM_ADDSUB_OFFSET 31 +#define GEM_ADDSUB_SIZE 1 + /* Constants for CLK */ #define MACB_CLK_DIV8 0 #define MACB_CLK_DIV16 1 @@ -405,6 +466,7 @@ #define MACB_CAPS_SG_DISABLED 0x40000000 #define MACB_CAPS_MACB_IS_GEM 0x80000000 #define MACB_CAPS_JUMBO 0x00000010 +#define MACB_CAPS_GEM_HAS_PTP 0x00000020 /* Bit manipulation macros */ #define MACB_BIT(name) \ @@ -840,8 +902,26 @@ struct macb { unsigned int rx_frm_len_mask; unsigned int jumbo_max_len; + +#ifdef CONFIG_MACB_USE_HWSTAMP + unsigned int hwts_tx_en; + unsigned int hwts_rx_en; + spinlock_t tsu_clk_lock; + unsigned int tsu_rate; + + struct ptp_clock *ptp_clock; + struct ptp_clock_info ptp_caps; + unsigned int ns_incr; + unsigned int subns_incr; +#endif }; +#ifdef CONFIG_MACB_USE_HWSTAMP +void macb_ptp_init(struct net_device *ndev); +#else +void macb_ptp_init(struct net_device *ndev) { } +#endif + static inline bool macb_is_gem(struct macb *bp) { return !!(bp->caps & MACB_CAPS_MACB_IS_GEM); diff --git a/drivers/net/ethernet/cadence/macb_ptp.c b/drivers/net/ethernet/cadence/macb_ptp.c new file mode 100644 index 0000000..81ce3a9 --- /dev/null +++ b/drivers/net/ethernet/cadence/macb_ptp.c @@ -0,0 +1,229 @@ +/* + * PTP 1588 clock for SAMA5D2 platform. + * + * Copyright (C) 2015 Xilinx Inc. + * Copyright (C) 2016 Microchip Technology + * + * Authors: Harini Katakam <harinik@xilinx.com> + * + * This file is licensed under the terms of the GNU General Public + * License version 2. This program is licensed "as is" without any + * warranty of any kind, whether express or implied. + */ + +#include <linux/clk.h> +#include <linux/device.h> +#include <linux/etherdevice.h> +#include <linux/platform_device.h> +#include <linux/time64.h> +#include <linux/ptp_classify.h> +#include <linux/if_ether.h> +#include <linux/if_vlan.h> + +#include "macb.h" + +#define GMAC_TIMER_NAME "gmac-gem-ptp" + +static inline void macb_tsu_get_time(struct macb *bp, struct timespec64 *ts) +{ + u64 sec, sech, secl; + + spin_lock(&bp->tsu_clk_lock); + + /* get GEM internal time */ + sech = gem_readl(bp, TSH); + secl = gem_readl(bp, TSL); + ts->tv_nsec = gem_readl(bp, TN); + ts->tv_sec = (sech << 32) | secl; + + /* minimize the error */ + sech = gem_readl(bp, TSH); + secl = gem_readl(bp, TSL); + sec = (sech << 32) | secl; + if (ts->tv_sec != sec) { + ts->tv_sec = sec; + ts->tv_nsec = gem_readl(bp, TN); + } + + spin_unlock(&bp->tsu_clk_lock); +} + +static inline void macb_tsu_set_time(struct macb *bp, + const struct timespec64 *ts) +{ + u32 ns, sech, secl; + s64 word_mask = 0xffffffff; + + sech = (u32)ts->tv_sec; + secl = (u32)ts->tv_sec; + ns = ts->tv_nsec; + if (ts->tv_sec > word_mask) + sech = (ts->tv_sec >> 32); + + spin_lock(&bp->tsu_clk_lock); + + /* TSH doesn't latch the time and no atomicity! */ + gem_writel(bp, TSH, sech); + gem_writel(bp, TSL, secl); + gem_writel(bp, TN, ns); + + spin_unlock(&bp->tsu_clk_lock); +} + +static int macb_ptp_adjfreq(struct ptp_clock_info *ptp, s32 ppb) +{ + struct macb *bp = container_of(ptp, struct macb, ptp_caps); + u32 addend, addend_frac, rem; + u64 drift_tmr, diff, diff_frac = 0; + int neg_adj = 0; + + if (ppb < 0) { + neg_adj = 1; + ppb = -ppb; + } + + /* drift/period */ + drift_tmr = (bp->ns_incr * ppb) + + ((bp->subns_incr * ppb) >> 16); + + /* drift/cycle */ + diff = div_u64_rem(drift_tmr, 1000000000ULL, &rem); + + /* drift fraction/cycle, if necessary */ + if (rem) { + u64 fraction = rem; + fraction = fraction << 16; + + diff_frac = div_u64(fraction, 1000000000ULL); + } + + /* adjustmets */ + addend = neg_adj ? (bp->ns_incr - diff) : (bp->ns_incr + diff); + addend_frac = neg_adj ? (bp->subns_incr - diff_frac) : + (bp->subns_incr + diff_frac); + + spin_lock(&bp->tsu_clk_lock); + + gem_writel(bp, TISUBN, GEM_BF(SUBNSINCR, addend_frac)); + gem_writel(bp, TI, GEM_BF(NSINCR, addend)); + + spin_unlock(&bp->tsu_clk_lock); + return 0; +} + +static int macb_ptp_adjtime(struct ptp_clock_info *ptp, s64 delta) +{ + struct macb *bp = container_of(ptp, struct macb, ptp_caps); + struct timespec64 now, then = ns_to_timespec64(delta); + u32 adj, sign = 0; + + if (delta < 0) { + delta = -delta; + sign = 1; + } + + if (delta > 0x3FFFFFFF) { + macb_tsu_get_time(bp, &now); + + if (sign) + now = timespec64_sub(now, then); + else + now = timespec64_add(now, then); + + macb_tsu_set_time(bp, (const struct timespec64 *)&now); + } else { + adj = delta; + if (sign) + adj |= GEM_BIT(ADDSUB); + + gem_writel(bp, TA, adj); + } + + return 0; +} + +static int macb_ptp_gettime(struct ptp_clock_info *ptp, + struct timespec64 *ts) +{ + struct macb *bp = container_of(ptp, struct macb, ptp_caps); + + macb_tsu_get_time(bp, ts); + + return 0; +} + +static int macb_ptp_settime(struct ptp_clock_info *ptp, + const struct timespec64 *ts) +{ + struct macb *bp = container_of(ptp, struct macb, ptp_caps); + + macb_tsu_set_time(bp, ts); + + return 0; +} + +static int macb_ptp_enable(struct ptp_clock_info *ptp, + struct ptp_clock_request *rq, int on) +{ + return -EOPNOTSUPP; +} + +static struct ptp_clock_info macb_ptp_caps = { + .owner = THIS_MODULE, + .name = GMAC_TIMER_NAME, + .max_adj = 250000000, + .n_alarm = 0, + .n_ext_ts = 0, + .n_per_out = 0, + .n_pins = 0, + .pps = 0, + .adjfreq = macb_ptp_adjfreq, + .adjtime = macb_ptp_adjtime, + .gettime64 = macb_ptp_gettime, + .settime64 = macb_ptp_settime, + .enable = macb_ptp_enable, +}; + +void macb_ptp_init(struct net_device *ndev) +{ + struct macb *bp = netdev_priv(ndev); + struct timespec64 now; + u32 rem = 0; + + if (!(bp->caps | MACB_CAPS_GEM_HAS_PTP)){ + netdev_vdbg(bp->dev, "Platform does not support PTP!\n"); + return; + } + + spin_lock_init(&bp->tsu_clk_lock); + + bp->ptp_caps = macb_ptp_caps; + bp->tsu_rate = clk_get_rate(bp->pclk); + + getnstimeofday64(&now); + macb_tsu_set_time(bp, (const struct timespec64 *)&now); + + bp->ns_incr = div_u64_rem(NSEC_PER_SEC, bp->tsu_rate, &rem); + if (rem) { + u64 adj = rem; + /* Multiply by 2^16 as subns register is 16 bits */ + adj <<= 16; + bp->subns_incr = div_u64(adj, bp->tsu_rate); + } else { + bp->subns_incr = 0; + } + + gem_writel(bp, TISUBN, GEM_BF(SUBNSINCR, bp->subns_incr)); + gem_writel(bp, TI, GEM_BF(NSINCR, bp->ns_incr)); + gem_writel(bp, TA, 0); + + bp->ptp_clock = ptp_clock_register(&bp->ptp_caps, NULL); + if (IS_ERR(&bp->ptp_clock)) { + bp->ptp_clock = NULL; + pr_err("ptp clock register failed\n"); + return; + } + + dev_info(&bp->pdev->dev, "%s ptp clock registered.\n", GMAC_TIMER_NAME); +} +