drivers/net/ethernet/cadence/macb_ptp.c

   1 /**
   2  * 1588 PTP support for Cadence GEM device.
   3  *
   4  * Copyright (C) 2017 Cadence Design Systems - http://www.cadence.com
   5  *
   6  * Authors: Rafal Ozieblo <rafalo@cadence.com>
   7  *          Bartosz Folta <bfolta@cadence.com>
   8  *
   9  * This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 2  of
  11  * the License as published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21 #include <linux/kernel.h>
  22 #include <linux/types.h>
  23 #include <linux/clk.h>
  24 #include <linux/device.h>
  25 #include <linux/etherdevice.h>
  26 #include <linux/platform_device.h>
  27 #include <linux/time64.h>
  28 #include <linux/ptp_classify.h>
  29 #include <linux/if_ether.h>
  30 #include <linux/if_vlan.h>
  31 #include <linux/net_tstamp.h>
  32 #include <linux/circ_buf.h>
  33 #include <linux/spinlock.h>
  34
  35 #include "macb.h"
  36
  37 #define  GEM_PTP_TIMER_NAME "gem-ptp-timer"
  38
  39 static struct macb_dma_desc_ptp *macb_ptp_desc(struct macb *bp,
  40                                                struct macb_dma_desc *desc)
  41 {
  42         if (bp->hw_dma_cap == HW_DMA_CAP_PTP)
  43                 return (struct macb_dma_desc_ptp *)
  44                                 ((u8 *)desc + sizeof(struct macb_dma_desc));
  45         if (bp->hw_dma_cap == HW_DMA_CAP_64B_PTP)
  46                 return (struct macb_dma_desc_ptp *)
  47                                 ((u8 *)desc + sizeof(struct macb_dma_desc)
  48                                 + sizeof(struct macb_dma_desc_64));
  49         return NULL;
  50 }
  51
  52 static int gem_tsu_get_time(struct ptp_clock_info *ptp, struct timespec64 *ts)
  53 {
  54         struct macb *bp = container_of(ptp, struct macb, ptp_clock_info);
  55         unsigned long flags;
  56         long first, second;
  57         u32 secl, sech;
  58
  59         spin_lock_irqsave(&bp->tsu_clk_lock, flags);
  60         first = gem_readl(bp, TN);
  61         secl = gem_readl(bp, TSL);
  62         sech = gem_readl(bp, TSH);
  63         second = gem_readl(bp, TN);
  64
  65         /* test for nsec rollover */
  66         if (first > second) {
  67                 /* if so, use later read & re-read seconds
  68                  * (assume all done within 1s)
  69                  */
  70                 ts->tv_nsec = gem_readl(bp, TN);
  71                 secl = gem_readl(bp, TSL);
  72                 sech = gem_readl(bp, TSH);
  73         } else {
  74                 ts->tv_nsec = first;
  75         }
  76
  77         spin_unlock_irqrestore(&bp->tsu_clk_lock, flags);
  78         ts->tv_sec = (((u64)sech << GEM_TSL_SIZE) | secl)
  79                         & TSU_SEC_MAX_VAL;
  80         return 0;
  81 }
  82
  83 static int gem_tsu_set_time(struct ptp_clock_info *ptp,
  84                             const struct timespec64 *ts)
  85 {
  86         struct macb *bp = container_of(ptp, struct macb, ptp_clock_info);
  87         unsigned long flags;
  88         u32 ns, sech, secl;
  89
  90         secl = (u32)ts->tv_sec;
  91         sech = (ts->tv_sec >> GEM_TSL_SIZE) & ((1 << GEM_TSH_SIZE) - 1);
  92         ns = ts->tv_nsec;
  93
  94         spin_lock_irqsave(&bp->tsu_clk_lock, flags);
  95
  96         /* TSH doesn't latch the time and no atomicity! */
  97         gem_writel(bp, TN, 0); /* clear to avoid overflow */
  98         gem_writel(bp, TSH, sech);
  99         /* write lower bits 2nd, for synchronized secs update */
 100         gem_writel(bp, TSL, secl);
 101         gem_writel(bp, TN, ns);
 102
 103         spin_unlock_irqrestore(&bp->tsu_clk_lock, flags);
 104
 105         return 0;
 106 }
 107
 108 static int gem_tsu_incr_set(struct macb *bp, struct tsu_incr *incr_spec)
 109 {
 110         unsigned long flags;
 111
 112         /* tsu_timer_incr register must be written after
 113          * the tsu_timer_incr_sub_ns register and the write operation
 114          * will cause the value written to the tsu_timer_incr_sub_ns register
 115          * to take effect.
 116          */
 117         spin_lock_irqsave(&bp->tsu_clk_lock, flags);
 118         /* RegBit[15:0] = Subns[23:8]; RegBit[31:24] = Subns[7:0] */
 119         gem_writel(bp, TISUBN, GEM_BF(SUBNSINCRL, incr_spec->sub_ns) |
 120                    GEM_BF(SUBNSINCRH, (incr_spec->sub_ns >>
 121                           GEM_SUBNSINCRL_SIZE)));
 122         gem_writel(bp, TI, GEM_BF(NSINCR, incr_spec->ns));
 123         spin_unlock_irqrestore(&bp->tsu_clk_lock, flags);
 124
 125         return 0;
 126 }
 127
 128 static int gem_ptp_adjfine(struct ptp_clock_info *ptp, long scaled_ppm)
 129 {
 130         struct macb *bp = container_of(ptp, struct macb, ptp_clock_info);
 131         struct tsu_incr incr_spec;
 132         bool neg_adj = false;
 133         u32 word;
 134         u64 adj;
 135
 136         if (scaled_ppm < 0) {
 137                 neg_adj = true;
 138                 scaled_ppm = -scaled_ppm;
 139         }
 140
 141         /* Adjustment is relative to base frequency */
 142         incr_spec.sub_ns = bp->tsu_incr.sub_ns;
 143         incr_spec.ns = bp->tsu_incr.ns;
 144
 145         /* scaling: unused(8bit) | ns(8bit) | fractions(16bit) */
 146         word = ((u64)incr_spec.ns << GEM_SUBNSINCR_SIZE) + incr_spec.sub_ns;
 147         adj = (u64)scaled_ppm * word;
 148         /* Divide with rounding, equivalent to floating dividing:
 149          * (temp / USEC_PER_SEC) + 0.5
 150          */
 151         adj += (USEC_PER_SEC >> 1);
 152         adj >>= GEM_SUBNSINCR_SIZE; /* remove fractions */
 153         adj = div_u64(adj, USEC_PER_SEC);
 154         adj = neg_adj ? (word - adj) : (word + adj);
 155
 156         incr_spec.ns = (adj >> GEM_SUBNSINCR_SIZE)
 157                         & ((1 << GEM_NSINCR_SIZE) - 1);
 158         incr_spec.sub_ns = adj & ((1 << GEM_SUBNSINCR_SIZE) - 1);
 159         gem_tsu_incr_set(bp, &incr_spec);
 160         return 0;
 161 }
 162
 163 static int gem_ptp_adjtime(struct ptp_clock_info *ptp, s64 delta)
 164 {
 165         struct macb *bp = container_of(ptp, struct macb, ptp_clock_info);
 166         struct timespec64 now, then = ns_to_timespec64(delta);
 167         u32 adj, sign = 0;
 168
 169         if (delta < 0) {
 170                 sign = 1;
 171                 delta = -delta;
 172         }
 173
 174         if (delta > TSU_NSEC_MAX_VAL) {
 175                 gem_tsu_get_time(&bp->ptp_clock_info, &now);
 176                 now = timespec64_add(now, then);
 177
 178                 gem_tsu_set_time(&bp->ptp_clock_info,
 179                                  (const struct timespec64 *)&now);
 180         } else {
 181                 adj = (sign << GEM_ADDSUB_OFFSET) | delta;
 182
 183                 gem_writel(bp, TA, adj);
 184         }
 185
 186         return 0;
 187 }
 188
 189 static int gem_ptp_enable(struct ptp_clock_info *ptp,
 190                           struct ptp_clock_request *rq, int on)
 191 {
 192         return -EOPNOTSUPP;
 193 }
 194
 195 static const struct ptp_clock_info gem_ptp_caps_template = {
 196         .owner          = THIS_MODULE,
 197         .name           = GEM_PTP_TIMER_NAME,
 198         .max_adj        = 0,
 199         .n_alarm        = 0,
 200         .n_ext_ts       = 0,
 201         .n_per_out      = 0,
 202         .n_pins         = 0,
 203         .pps            = 1,
 204         .adjfine        = gem_ptp_adjfine,
 205         .adjtime        = gem_ptp_adjtime,
 206         .gettime64      = gem_tsu_get_time,
 207         .settime64      = gem_tsu_set_time,
 208         .enable         = gem_ptp_enable,
 209 };
 210
 211 static void gem_ptp_init_timer(struct macb *bp)
 212 {
 213         u32 rem = 0;
 214         u64 adj;
 215
 216         bp->tsu_incr.ns = div_u64_rem(NSEC_PER_SEC, bp->tsu_rate, &rem);
 217         if (rem) {
 218                 adj = rem;
 219                 adj <<= GEM_SUBNSINCR_SIZE;
 220                 bp->tsu_incr.sub_ns = div_u64(adj, bp->tsu_rate);
 221         } else {
 222                 bp->tsu_incr.sub_ns = 0;
 223         }
 224 }
 225
 226 static void gem_ptp_init_tsu(struct macb *bp)
 227 {
 228         struct timespec64 ts;
 229
 230         /* 1. get current system time */
 231         ts = ns_to_timespec64(ktime_to_ns(ktime_get_real()));
 232
 233         /* 2. set ptp timer */
 234         gem_tsu_set_time(&bp->ptp_clock_info, &ts);
 235
 236         /* 3. set PTP timer increment value to BASE_INCREMENT */
 237         gem_tsu_incr_set(bp, &bp->tsu_incr);
 238
 239         gem_writel(bp, TA, 0);
 240 }
 241
 242 static void gem_ptp_clear_timer(struct macb *bp)
 243 {
 244         bp->tsu_incr.sub_ns = 0;
 245         bp->tsu_incr.ns = 0;
 246
 247         gem_writel(bp, TISUBN, GEM_BF(SUBNSINCR, 0));
 248         gem_writel(bp, TI, GEM_BF(NSINCR, 0));
 249         gem_writel(bp, TA, 0);
 250 }
 251
 252 static int gem_hw_timestamp(struct macb *bp, u32 dma_desc_ts_1,
 253                             u32 dma_desc_ts_2, struct timespec64 *ts)
 254 {
 255         struct timespec64 tsu;
 256
 257         ts->tv_sec = (GEM_BFEXT(DMA_SECH, dma_desc_ts_2) << GEM_DMA_SECL_SIZE) |
 258                         GEM_BFEXT(DMA_SECL, dma_desc_ts_1);
 259         ts->tv_nsec = GEM_BFEXT(DMA_NSEC, dma_desc_ts_1);
 260
 261         /* TSU overlapping workaround
 262          * The timestamp only contains lower few bits of seconds,
 263          * so add value from 1588 timer
 264          */
 265         gem_tsu_get_time(&bp->ptp_clock_info, &tsu);
 266
 267         /* If the top bit is set in the timestamp,
 268          * but not in 1588 timer, it has rolled over,
 269          * so subtract max size
 270          */
 271         if ((ts->tv_sec & (GEM_DMA_SEC_TOP >> 1)) &&
 272             !(tsu.tv_sec & (GEM_DMA_SEC_TOP >> 1)))
 273                 ts->tv_sec -= GEM_DMA_SEC_TOP;
 274
 275         ts->tv_sec += ((~GEM_DMA_SEC_MASK) & tsu.tv_sec);
 276
 277         return 0;
 278 }
 279
 280 void gem_ptp_rxstamp(struct macb *bp, struct sk_buff *skb,
 281                      struct macb_dma_desc *desc)
 282 {
 283         struct skb_shared_hwtstamps *shhwtstamps = skb_hwtstamps(skb);
 284         struct macb_dma_desc_ptp *desc_ptp;
 285         struct timespec64 ts;
 286
 287         if (GEM_BFEXT(DMA_RXVALID, desc->addr)) {
 288                 desc_ptp = macb_ptp_desc(bp, desc);
 289                 /* Unlikely but check */
 290                 if (!desc_ptp) {
 291                         dev_warn_ratelimited(&bp->pdev->dev,
 292                                              "Timestamp not supported in BD\n");
 293                         return;
 294                 }
 295                 gem_hw_timestamp(bp, desc_ptp->ts_1, desc_ptp->ts_2, &ts);
 296                 memset(shhwtstamps, 0, sizeof(struct skb_shared_hwtstamps));
 297                 shhwtstamps->hwtstamp = ktime_set(ts.tv_sec, ts.tv_nsec);
 298         }
 299 }
 300
 301 static void gem_tstamp_tx(struct macb *bp, struct sk_buff *skb,
 302                           struct macb_dma_desc_ptp *desc_ptp)
 303 {
 304         struct skb_shared_hwtstamps shhwtstamps;
 305         struct timespec64 ts;
 306
 307         gem_hw_timestamp(bp, desc_ptp->ts_1, desc_ptp->ts_2, &ts);
 308         memset(&shhwtstamps, 0, sizeof(shhwtstamps));
 309         shhwtstamps.hwtstamp = ktime_set(ts.tv_sec, ts.tv_nsec);
 310         skb_tstamp_tx(skb, &shhwtstamps);
 311 }
 312
 313 int gem_ptp_txstamp(struct macb_queue *queue, struct sk_buff *skb,
 314                     struct macb_dma_desc *desc)
 315 {
 316         unsigned long tail = READ_ONCE(queue->tx_ts_tail);
 317         unsigned long head = queue->tx_ts_head;
 318         struct macb_dma_desc_ptp *desc_ptp;
 319         struct gem_tx_ts *tx_timestamp;
 320
 321         if (!GEM_BFEXT(DMA_TXVALID, desc->ctrl))
 322                 return -EINVAL;
 323
 324         if (CIRC_SPACE(head, tail, PTP_TS_BUFFER_SIZE) == 0)
 325                 return -ENOMEM;
 326
 327         desc_ptp = macb_ptp_desc(queue->bp, desc);
 328         /* Unlikely but check */
 329         if (!desc_ptp)
 330                 return -EINVAL;
 331         skb_shinfo(skb)->tx_flags |= SKBTX_IN_PROGRESS;
 332         tx_timestamp = &queue->tx_timestamps[head];
 333         tx_timestamp->skb = skb;
 334         tx_timestamp->desc_ptp.ts_1 = desc_ptp->ts_1;
 335         tx_timestamp->desc_ptp.ts_2 = desc_ptp->ts_2;
 336         /* move head */
 337         smp_store_release(&queue->tx_ts_head,
 338                           (head + 1) & (PTP_TS_BUFFER_SIZE - 1));
 339
 340         schedule_work(&queue->tx_ts_task);
 341         return 0;
 342 }
 343
 344 static void gem_tx_timestamp_flush(struct work_struct *work)
 345 {
 346         struct macb_queue *queue =
 347                         container_of(work, struct macb_queue, tx_ts_task);
 348         unsigned long head, tail;
 349         struct gem_tx_ts *tx_ts;
 350
 351         /* take current head */
 352         head = smp_load_acquire(&queue->tx_ts_head);
 353         tail = queue->tx_ts_tail;
 354
 355         while (CIRC_CNT(head, tail, PTP_TS_BUFFER_SIZE)) {
 356                 tx_ts = &queue->tx_timestamps[tail];
 357                 gem_tstamp_tx(queue->bp, tx_ts->skb, &tx_ts->desc_ptp);
 358                 /* cleanup */
 359                 dev_kfree_skb_any(tx_ts->skb);
 360                 /* remove old tail */
 361                 smp_store_release(&queue->tx_ts_tail,
 362                                   (tail + 1) & (PTP_TS_BUFFER_SIZE - 1));
 363                 tail = queue->tx_ts_tail;
 364         }
 365 }
 366
 367 void gem_ptp_init(struct net_device *dev)
 368 {
 369         struct macb *bp = netdev_priv(dev);
 370         struct macb_queue *queue;
 371         unsigned int q;
 372
 373         bp->ptp_clock_info = gem_ptp_caps_template;
 374
 375         /* nominal frequency and maximum adjustment in ppb */
 376         bp->tsu_rate = bp->ptp_info->get_tsu_rate(bp);
 377         bp->ptp_clock_info.max_adj = bp->ptp_info->get_ptp_max_adj();
 378         gem_ptp_init_timer(bp);
 379         bp->ptp_clock = ptp_clock_register(&bp->ptp_clock_info, &dev->dev);
 380         if (IS_ERR(bp->ptp_clock)) {
 381                 pr_err("ptp clock register failed: %ld\n",
 382                         PTR_ERR(bp->ptp_clock));
 383                 bp->ptp_clock = NULL;
 384                 return;
 385         } else if (bp->ptp_clock == NULL) {
 386                 pr_err("ptp clock register failed\n");
 387                 return;
 388         }
 389
 390         spin_lock_init(&bp->tsu_clk_lock);
 391         for (q = 0, queue = bp->queues; q < bp->num_queues; ++q, ++queue) {
 392                 queue->tx_ts_head = 0;
 393                 queue->tx_ts_tail = 0;
 394                 INIT_WORK(&queue->tx_ts_task, gem_tx_timestamp_flush);
 395         }
 396
 397         gem_ptp_init_tsu(bp);
 398
 399         dev_info(&bp->pdev->dev, "%s ptp clock registered.\n",
 400                  GEM_PTP_TIMER_NAME);
 401 }
 402
 403 void gem_ptp_remove(struct net_device *ndev)
 404 {
 405         struct macb *bp = netdev_priv(ndev);
 406
 407         if (bp->ptp_clock)
 408                 ptp_clock_unregister(bp->ptp_clock);
 409
 410         gem_ptp_clear_timer(bp);
 411
 412         dev_info(&bp->pdev->dev, "%s ptp clock unregistered.\n",
 413                  GEM_PTP_TIMER_NAME);
 414 }
 415
 416 static int gem_ptp_set_ts_mode(struct macb *bp,
 417                                enum macb_bd_control tx_bd_control,
 418                                enum macb_bd_control rx_bd_control)
 419 {
 420         gem_writel(bp, TXBDCTRL, GEM_BF(TXTSMODE, tx_bd_control));
 421         gem_writel(bp, RXBDCTRL, GEM_BF(RXTSMODE, rx_bd_control));
 422
 423         return 0;
 424 }
 425
 426 int gem_get_hwtst(struct net_device *dev, struct ifreq *rq)
 427 {
 428         struct hwtstamp_config *tstamp_config;
 429         struct macb *bp = netdev_priv(dev);
 430
 431         tstamp_config = &bp->tstamp_config;
 432         if ((bp->hw_dma_cap & HW_DMA_CAP_PTP) == 0)
 433                 return -EOPNOTSUPP;
 434
 435         if (copy_to_user(rq->ifr_data, tstamp_config, sizeof(*tstamp_config)))
 436                 return -EFAULT;
 437         else
 438                 return 0;
 439 }
 440
 441 static int gem_ptp_set_one_step_sync(struct macb *bp, u8 enable)
 442 {
 443         u32 reg_val;
 444
 445         reg_val = macb_readl(bp, NCR);
 446
 447         if (enable)
 448                 macb_writel(bp, NCR, reg_val | MACB_BIT(OSSMODE));
 449         else
 450                 macb_writel(bp, NCR, reg_val & ~MACB_BIT(OSSMODE));
 451
 452         return 0;
 453 }
 454
 455 int gem_set_hwtst(struct net_device *dev, struct ifreq *ifr, int cmd)
 456 {
 457         enum macb_bd_control tx_bd_control = TSTAMP_DISABLED;
 458         enum macb_bd_control rx_bd_control = TSTAMP_DISABLED;
 459         struct hwtstamp_config *tstamp_config;
 460         struct macb *bp = netdev_priv(dev);
 461         u32 regval;
 462
 463         tstamp_config = &bp->tstamp_config;
 464         if ((bp->hw_dma_cap & HW_DMA_CAP_PTP) == 0)
 465                 return -EOPNOTSUPP;
 466
 467         if (copy_from_user(tstamp_config, ifr->ifr_data,
 468                            sizeof(*tstamp_config)))
 469                 return -EFAULT;
 470
 471         /* reserved for future extensions */
 472         if (tstamp_config->flags)
 473                 return -EINVAL;
 474
 475         switch (tstamp_config->tx_type) {
 476         case HWTSTAMP_TX_OFF:
 477                 break;
 478         case HWTSTAMP_TX_ONESTEP_SYNC:
 479                 if (gem_ptp_set_one_step_sync(bp, 1) != 0)
 480                         return -ERANGE;
 481         case HWTSTAMP_TX_ON:
 482                 tx_bd_control = TSTAMP_ALL_FRAMES;
 483                 break;
 484         default:
 485                 return -ERANGE;
 486         }
 487
 488         switch (tstamp_config->rx_filter) {
 489         case HWTSTAMP_FILTER_NONE:
 490                 break;
 491         case HWTSTAMP_FILTER_PTP_V1_L4_SYNC:
 492                 break;
 493         case HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ:
 494                 break;
 495         case HWTSTAMP_FILTER_PTP_V2_EVENT:
 496         case HWTSTAMP_FILTER_PTP_V2_L2_EVENT:
 497         case HWTSTAMP_FILTER_PTP_V2_L4_EVENT:
 498         case HWTSTAMP_FILTER_PTP_V2_SYNC:
 499         case HWTSTAMP_FILTER_PTP_V2_L2_SYNC:
 500         case HWTSTAMP_FILTER_PTP_V2_L4_SYNC:
 501         case HWTSTAMP_FILTER_PTP_V2_DELAY_REQ:
 502         case HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ:
 503         case HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ:
 504                 rx_bd_control =  TSTAMP_ALL_PTP_FRAMES;
 505                 tstamp_config->rx_filter = HWTSTAMP_FILTER_PTP_V2_EVENT;
 506                 regval = macb_readl(bp, NCR);
 507                 macb_writel(bp, NCR, (regval | MACB_BIT(SRTSM)));
 508                 break;
 509         case HWTSTAMP_FILTER_PTP_V1_L4_EVENT:
 510         case HWTSTAMP_FILTER_ALL:
 511                 rx_bd_control = TSTAMP_ALL_FRAMES;
 512                 tstamp_config->rx_filter = HWTSTAMP_FILTER_ALL;
 513                 break;
 514         default:
 515                 tstamp_config->rx_filter = HWTSTAMP_FILTER_NONE;
 516                 return -ERANGE;
 517         }
 518
 519         if (gem_ptp_set_ts_mode(bp, tx_bd_control, rx_bd_control) != 0)
 520                 return -ERANGE;
 521
 522         if (copy_to_user(ifr->ifr_data, tstamp_config, sizeof(*tstamp_config)))
 523                 return -EFAULT;
 524         else
 525                 return 0;
 526 }
 527