drivers/net/ethernet/intel/i40e/i40e_ptp.c

   1 /*******************************************************************************
   2  *
   3  * Intel Ethernet Controller XL710 Family Linux Driver
   4  * Copyright(c) 2013 - 2014 Intel Corporation.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms and conditions of the GNU General Public License,
   8  * version 2, as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * The full GNU General Public License is included in this distribution in
  19  * the file called "COPYING".
  20  *
  21  * Contact Information:
  22  * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  24  *
  25  ******************************************************************************/
  26
  27 #include "i40e.h"
  28 #include <linux/ptp_classify.h>
  29
  30 /* The XL710 timesync is very much like Intel's 82599 design when it comes to
  31  * the fundamental clock design. However, the clock operations are much simpler
  32  * in the XL710 because the device supports a full 64 bits of nanoseconds.
  33  * Because the field is so wide, we can forgo the cycle counter and just
  34  * operate with the nanosecond field directly without fear of overflow.
  35  *
  36  * Much like the 82599, the update period is dependent upon the link speed:
  37  * At 40Gb link or no link, the period is 1.6ns.
  38  * At 10Gb link, the period is multiplied by 2. (3.2ns)
  39  * At 1Gb link, the period is multiplied by 20. (32ns)
  40  * 1588 functionality is not supported at 100Mbps.
  41  */
  42 #define I40E_PTP_40GB_INCVAL 0x0199999999ULL
  43 #define I40E_PTP_10GB_INCVAL 0x0333333333ULL
  44 #define I40E_PTP_1GB_INCVAL  0x2000000000ULL
  45
  46 #define I40E_PRTTSYN_CTL1_TSYNTYPE_V1  (0x1 << \
  47                                         I40E_PRTTSYN_CTL1_TSYNTYPE_SHIFT)
  48 #define I40E_PRTTSYN_CTL1_TSYNTYPE_V2  (0x2 << \
  49                                         I40E_PRTTSYN_CTL1_TSYNTYPE_SHIFT)
  50
  51 /**
  52  * i40e_ptp_read - Read the PHC time from the device
  53  * @pf: Board private structure
  54  * @ts: timespec structure to hold the current time value
  55  *
  56  * This function reads the PRTTSYN_TIME registers and stores them in a
  57  * timespec. However, since the registers are 64 bits of nanoseconds, we must
  58  * convert the result to a timespec before we can return.
  59  **/
  60 static void i40e_ptp_read(struct i40e_pf *pf, struct timespec *ts)
  61 {
  62         struct i40e_hw *hw = &pf->hw;
  63         u32 hi, lo;
  64         u64 ns;
  65
  66         /* The timer latches on the lowest register read. */
  67         lo = rd32(hw, I40E_PRTTSYN_TIME_L);
  68         hi = rd32(hw, I40E_PRTTSYN_TIME_H);
  69
  70         ns = (((u64)hi) << 32) | lo;
  71
  72         *ts = ns_to_timespec(ns);
  73 }
  74
  75 /**
  76  * i40e_ptp_write - Write the PHC time to the device
  77  * @pf: Board private structure
  78  * @ts: timespec structure that holds the new time value
  79  *
  80  * This function writes the PRTTSYN_TIME registers with the user value. Since
  81  * we receive a timespec from the stack, we must convert that timespec into
  82  * nanoseconds before programming the registers.
  83  **/
  84 static void i40e_ptp_write(struct i40e_pf *pf, const struct timespec *ts)
  85 {
  86         struct i40e_hw *hw = &pf->hw;
  87         u64 ns = timespec_to_ns(ts);
  88
  89         /* The timer will not update until the high register is written, so
  90          * write the low register first.
  91          */
  92         wr32(hw, I40E_PRTTSYN_TIME_L, ns & 0xFFFFFFFF);
  93         wr32(hw, I40E_PRTTSYN_TIME_H, ns >> 32);
  94 }
  95
  96 /**
  97  * i40e_ptp_convert_to_hwtstamp - Convert device clock to system time
  98  * @hwtstamps: Timestamp structure to update
  99  * @timestamp: Timestamp from the hardware
 100  *
 101  * We need to convert the NIC clock value into a hwtstamp which can be used by
 102  * the upper level timestamping functions. Since the timestamp is simply a 64-
 103  * bit nanosecond value, we can call ns_to_ktime directly to handle this.
 104  **/
 105 static void i40e_ptp_convert_to_hwtstamp(struct skb_shared_hwtstamps *hwtstamps,
 106                                          u64 timestamp)
 107 {
 108         memset(hwtstamps, 0, sizeof(*hwtstamps));
 109
 110         hwtstamps->hwtstamp = ns_to_ktime(timestamp);
 111 }
 112
 113 /**
 114  * i40e_ptp_adjfreq - Adjust the PHC frequency
 115  * @ptp: The PTP clock structure
 116  * @ppb: Parts per billion adjustment from the base
 117  *
 118  * Adjust the frequency of the PHC by the indicated parts per billion from the
 119  * base frequency.
 120  **/
 121 static int i40e_ptp_adjfreq(struct ptp_clock_info *ptp, s32 ppb)
 122 {
 123         struct i40e_pf *pf = container_of(ptp, struct i40e_pf, ptp_caps);
 124         struct i40e_hw *hw = &pf->hw;
 125         u64 adj, freq, diff;
 126         int neg_adj = 0;
 127
 128         if (ppb < 0) {
 129                 neg_adj = 1;
 130                 ppb = -ppb;
 131         }
 132
 133         smp_mb(); /* Force any pending update before accessing. */
 134         adj = ACCESS_ONCE(pf->ptp_base_adj);
 135
 136         freq = adj;
 137         freq *= ppb;
 138         diff = div_u64(freq, 1000000000ULL);
 139
 140         if (neg_adj)
 141                 adj -= diff;
 142         else
 143                 adj += diff;
 144
 145         wr32(hw, I40E_PRTTSYN_INC_L, adj & 0xFFFFFFFF);
 146         wr32(hw, I40E_PRTTSYN_INC_H, adj >> 32);
 147
 148         return 0;
 149 }
 150
 151 /**
 152  * i40e_ptp_adjtime - Adjust the PHC time
 153  * @ptp: The PTP clock structure
 154  * @delta: Offset in nanoseconds to adjust the PHC time by
 155  *
 156  * Adjust the frequency of the PHC by the indicated parts per billion from the
 157  * base frequency.
 158  **/
 159 static int i40e_ptp_adjtime(struct ptp_clock_info *ptp, s64 delta)
 160 {
 161         struct i40e_pf *pf = container_of(ptp, struct i40e_pf, ptp_caps);
 162         struct timespec now, then = ns_to_timespec(delta);
 163         unsigned long flags;
 164
 165         spin_lock_irqsave(&pf->tmreg_lock, flags);
 166
 167         i40e_ptp_read(pf, &now);
 168         now = timespec_add(now, then);
 169         i40e_ptp_write(pf, (const struct timespec *)&now);
 170
 171         spin_unlock_irqrestore(&pf->tmreg_lock, flags);
 172
 173         return 0;
 174 }
 175
 176 /**
 177  * i40e_ptp_gettime - Get the time of the PHC
 178  * @ptp: The PTP clock structure
 179  * @ts: timespec structure to hold the current time value
 180  *
 181  * Read the device clock and return the correct value on ns, after converting it
 182  * into a timespec struct.
 183  **/
 184 static int i40e_ptp_gettime(struct ptp_clock_info *ptp, struct timespec *ts)
 185 {
 186         struct i40e_pf *pf = container_of(ptp, struct i40e_pf, ptp_caps);
 187         unsigned long flags;
 188
 189         spin_lock_irqsave(&pf->tmreg_lock, flags);
 190         i40e_ptp_read(pf, ts);
 191         spin_unlock_irqrestore(&pf->tmreg_lock, flags);
 192
 193         return 0;
 194 }
 195
 196 /**
 197  * i40e_ptp_settime - Set the time of the PHC
 198  * @ptp: The PTP clock structure
 199  * @ts: timespec structure that holds the new time value
 200  *
 201  * Set the device clock to the user input value. The conversion from timespec
 202  * to ns happens in the write function.
 203  **/
 204 static int i40e_ptp_settime(struct ptp_clock_info *ptp,
 205                             const struct timespec *ts)
 206 {
 207         struct i40e_pf *pf = container_of(ptp, struct i40e_pf, ptp_caps);
 208         unsigned long flags;
 209
 210         spin_lock_irqsave(&pf->tmreg_lock, flags);
 211         i40e_ptp_write(pf, ts);
 212         spin_unlock_irqrestore(&pf->tmreg_lock, flags);
 213
 214         return 0;
 215 }
 216
 217 /**
 218  * i40e_ptp_feature_enable - Enable/disable ancillary features of the PHC subsystem
 219  * @ptp: The PTP clock structure
 220  * @rq: The requested feature to change
 221  * @on: Enable/disable flag
 222  *
 223  * The XL710 does not support any of the ancillary features of the PHC
 224  * subsystem, so this function may just return.
 225  **/
 226 static int i40e_ptp_feature_enable(struct ptp_clock_info *ptp,
 227                                    struct ptp_clock_request *rq, int on)
 228 {
 229         return -EOPNOTSUPP;
 230 }
 231
 232 /**
 233  * i40e_ptp_rx_hang - Detect error case when Rx timestamp registers are hung
 234  * @vsi: The VSI with the rings relevant to 1588
 235  *
 236  * This watchdog task is scheduled to detect error case where hardware has
 237  * dropped an Rx packet that was timestamped when the ring is full. The
 238  * particular error is rare but leaves the device in a state unable to timestamp
 239  * any future packets.
 240  **/
 241 void i40e_ptp_rx_hang(struct i40e_vsi *vsi)
 242 {
 243         struct i40e_pf *pf = vsi->back;
 244         struct i40e_hw *hw = &pf->hw;
 245         struct i40e_ring *rx_ring;
 246         unsigned long rx_event;
 247         u32 prttsyn_stat;
 248         int n;
 249
 250         if (pf->flags & I40E_FLAG_PTP)
 251                 return;
 252
 253         prttsyn_stat = rd32(hw, I40E_PRTTSYN_STAT_1);
 254
 255         /* Unless all four receive timestamp registers are latched, we are not
 256          * concerned about a possible PTP Rx hang, so just update the timeout
 257          * counter and exit.
 258          */
 259         if (!(prttsyn_stat & ((I40E_PRTTSYN_STAT_1_RXT0_MASK <<
 260                                I40E_PRTTSYN_STAT_1_RXT0_SHIFT) |
 261                               (I40E_PRTTSYN_STAT_1_RXT1_MASK <<
 262                                I40E_PRTTSYN_STAT_1_RXT1_SHIFT) |
 263                               (I40E_PRTTSYN_STAT_1_RXT2_MASK <<
 264                                I40E_PRTTSYN_STAT_1_RXT2_SHIFT) |
 265                               (I40E_PRTTSYN_STAT_1_RXT3_MASK <<
 266                                I40E_PRTTSYN_STAT_1_RXT3_SHIFT)))) {
 267                 pf->last_rx_ptp_check = jiffies;
 268                 return;
 269         }
 270
 271         /* Determine the most recent watchdog or rx_timestamp event. */
 272         rx_event = pf->last_rx_ptp_check;
 273         for (n = 0; n < vsi->num_queue_pairs; n++) {
 274                 rx_ring = vsi->rx_rings[n];
 275                 if (time_after(rx_ring->last_rx_timestamp, rx_event))
 276                         rx_event = rx_ring->last_rx_timestamp;
 277         }
 278
 279         /* Only need to read the high RXSTMP register to clear the lock */
 280         if (time_is_before_jiffies(rx_event + 5 * HZ)) {
 281                 rd32(hw, I40E_PRTTSYN_RXTIME_H(0));
 282                 rd32(hw, I40E_PRTTSYN_RXTIME_H(1));
 283                 rd32(hw, I40E_PRTTSYN_RXTIME_H(2));
 284                 rd32(hw, I40E_PRTTSYN_RXTIME_H(3));
 285                 pf->last_rx_ptp_check = jiffies;
 286                 pf->rx_hwtstamp_cleared++;
 287                 dev_warn(&vsi->back->pdev->dev,
 288                          "%s: clearing Rx timestamp hang\n",
 289                          __func__);
 290         }
 291 }
 292
 293 /**
 294  * i40e_ptp_tx_hwtstamp - Utility function which returns the Tx timestamp
 295  * @pf: Board private structure
 296  *
 297  * Read the value of the Tx timestamp from the registers, convert it into a
 298  * value consumable by the stack, and store that result into the shhwtstamps
 299  * struct before returning it up the stack.
 300  **/
 301 void i40e_ptp_tx_hwtstamp(struct i40e_pf *pf)
 302 {
 303         struct skb_shared_hwtstamps shhwtstamps;
 304         struct i40e_hw *hw = &pf->hw;
 305         u32 hi, lo;
 306         u64 ns;
 307
 308         lo = rd32(hw, I40E_PRTTSYN_TXTIME_L);
 309         hi = rd32(hw, I40E_PRTTSYN_TXTIME_H);
 310
 311         ns = (((u64)hi) << 32) | lo;
 312
 313         i40e_ptp_convert_to_hwtstamp(&shhwtstamps, ns);
 314         skb_tstamp_tx(pf->ptp_tx_skb, &shhwtstamps);
 315         dev_kfree_skb_any(pf->ptp_tx_skb);
 316         pf->ptp_tx_skb = NULL;
 317 }
 318
 319 /**
 320  * i40e_ptp_rx_hwtstamp - Utility function which checks for an Rx timestamp
 321  * @pf: Board private structure
 322  * @skb: Particular skb to send timestamp with
 323  * @index: Index into the receive timestamp registers for the timestamp
 324  *
 325  * The XL710 receives a notification in the receive descriptor with an offset
 326  * into the set of RXTIME registers where the timestamp is for that skb. This
 327  * function goes and fetches the receive timestamp from that offset, if a valid
 328  * one exists. The RXTIME registers are in ns, so we must convert the result
 329  * first.
 330  **/
 331 void i40e_ptp_rx_hwtstamp(struct i40e_pf *pf, struct sk_buff *skb, u8 index)
 332 {
 333         u32 prttsyn_stat, hi, lo;
 334         struct i40e_hw *hw;
 335         u64 ns;
 336
 337         /* Since we cannot turn off the Rx timestamp logic if the device is
 338          * doing Tx timestamping, check if Rx timestamping is configured.
 339          */
 340         if (!pf->ptp_rx)
 341                 return;
 342
 343         hw = &pf->hw;
 344
 345         prttsyn_stat = rd32(hw, I40E_PRTTSYN_STAT_1);
 346
 347         if (!(prttsyn_stat & (1 << index)))
 348                 return;
 349
 350         lo = rd32(hw, I40E_PRTTSYN_RXTIME_L(index));
 351         hi = rd32(hw, I40E_PRTTSYN_RXTIME_H(index));
 352
 353         ns = (((u64)hi) << 32) | lo;
 354
 355         i40e_ptp_convert_to_hwtstamp(skb_hwtstamps(skb), ns);
 356 }
 357
 358 /**
 359  * i40e_ptp_set_increment - Utility function to update clock increment rate
 360  * @pf: Board private structure
 361  *
 362  * During a link change, the DMA frequency that drives the 1588 logic will
 363  * change. In order to keep the PRTTSYN_TIME registers in units of nanoseconds,
 364  * we must update the increment value per clock tick.
 365  **/
 366 void i40e_ptp_set_increment(struct i40e_pf *pf)
 367 {
 368         struct i40e_link_status *hw_link_info;
 369         struct i40e_hw *hw = &pf->hw;
 370         u64 incval;
 371
 372         hw_link_info = &hw->phy.link_info;
 373
 374         i40e_aq_get_link_info(&pf->hw, true, NULL, NULL);
 375
 376         switch (hw_link_info->link_speed) {
 377         case I40E_LINK_SPEED_10GB:
 378                 incval = I40E_PTP_10GB_INCVAL;
 379                 break;
 380         case I40E_LINK_SPEED_1GB:
 381                 incval = I40E_PTP_1GB_INCVAL;
 382                 break;
 383         case I40E_LINK_SPEED_100MB:
 384                 dev_warn(&pf->pdev->dev,
 385                          "%s: 1588 functionality is not supported at 100 Mbps. Stopping the PHC.\n",
 386                          __func__);
 387                 incval = 0;
 388                 break;
 389         case I40E_LINK_SPEED_40GB:
 390         default:
 391                 incval = I40E_PTP_40GB_INCVAL;
 392                 break;
 393         }
 394
 395         /* Write the new increment value into the increment register. The
 396          * hardware will not update the clock until both registers have been
 397          * written.
 398          */
 399         wr32(hw, I40E_PRTTSYN_INC_L, incval & 0xFFFFFFFF);
 400         wr32(hw, I40E_PRTTSYN_INC_H, incval >> 32);
 401
 402         /* Update the base adjustement value. */
 403         ACCESS_ONCE(pf->ptp_base_adj) = incval;
 404         smp_mb(); /* Force the above update. */
 405 }
 406
 407 /**
 408  * i40e_ptp_get_ts_config - ioctl interface to read the HW timestamping
 409  * @pf: Board private structure
 410  * @ifreq: ioctl data
 411  *
 412  * Obtain the current hardware timestamping settigs as requested. To do this,
 413  * keep a shadow copy of the timestamp settings rather than attempting to
 414  * deconstruct it from the registers.
 415  **/
 416 int i40e_ptp_get_ts_config(struct i40e_pf *pf, struct ifreq *ifr)
 417 {
 418         struct hwtstamp_config *config = &pf->tstamp_config;
 419
 420         return copy_to_user(ifr->ifr_data, config, sizeof(*config)) ?
 421                 -EFAULT : 0;
 422 }
 423
 424 /**
 425  * i40e_ptp_set_timestamp_mode - setup hardware for requested timestamp mode
 426  * @pf: Board private structure
 427  * @config: hwtstamp settings requested or saved
 428  *
 429  * Control hardware registers to enter the specific mode requested by the
 430  * user. Also used during reset path to ensure that timestamp settings are
 431  * maintained.
 432  *
 433  * Note: modifies config in place, and may update the requested mode to be
 434  * more broad if the specific filter is not directly supported.
 435  **/
 436 static int i40e_ptp_set_timestamp_mode(struct i40e_pf *pf,
 437                                        struct hwtstamp_config *config)
 438 {
 439         struct i40e_hw *hw = &pf->hw;
 440         u32 pf_id, tsyntype, regval;
 441
 442         /* Reserved for future extensions. */
 443         if (config->flags)
 444                 return -EINVAL;
 445
 446         /* Confirm that 1588 is supported on this PF. */
 447         pf_id = (rd32(hw, I40E_PRTTSYN_CTL0) & I40E_PRTTSYN_CTL0_PF_ID_MASK) >>
 448                 I40E_PRTTSYN_CTL0_PF_ID_SHIFT;
 449         if (hw->pf_id != pf_id)
 450                 return -EINVAL;
 451
 452         switch (config->tx_type) {
 453         case HWTSTAMP_TX_OFF:
 454                 pf->ptp_tx = false;
 455                 break;
 456         case HWTSTAMP_TX_ON:
 457                 pf->ptp_tx = true;
 458                 break;
 459         default:
 460                 return -ERANGE;
 461         }
 462
 463         switch (config->rx_filter) {
 464         case HWTSTAMP_FILTER_NONE:
 465                 pf->ptp_rx = false;
 466                 tsyntype = 0;
 467                 break;
 468         case HWTSTAMP_FILTER_PTP_V1_L4_SYNC:
 469         case HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ:
 470         case HWTSTAMP_FILTER_PTP_V1_L4_EVENT:
 471                 pf->ptp_rx = true;
 472                 tsyntype = I40E_PRTTSYN_CTL1_V1MESSTYPE0_MASK |
 473                            I40E_PRTTSYN_CTL1_TSYNTYPE_V1 |
 474                            I40E_PRTTSYN_CTL1_UDP_ENA_MASK;
 475                 config->rx_filter = HWTSTAMP_FILTER_PTP_V1_L4_EVENT;
 476                 break;
 477         case HWTSTAMP_FILTER_PTP_V2_EVENT:
 478         case HWTSTAMP_FILTER_PTP_V2_L2_EVENT:
 479         case HWTSTAMP_FILTER_PTP_V2_L4_EVENT:
 480         case HWTSTAMP_FILTER_PTP_V2_SYNC:
 481         case HWTSTAMP_FILTER_PTP_V2_L2_SYNC:
 482         case HWTSTAMP_FILTER_PTP_V2_L4_SYNC:
 483         case HWTSTAMP_FILTER_PTP_V2_DELAY_REQ:
 484         case HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ:
 485         case HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ:
 486                 pf->ptp_rx = true;
 487                 tsyntype = I40E_PRTTSYN_CTL1_V2MESSTYPE0_MASK |
 488                            I40E_PRTTSYN_CTL1_TSYNTYPE_V2 |
 489                            I40E_PRTTSYN_CTL1_UDP_ENA_MASK;
 490                 config->rx_filter = HWTSTAMP_FILTER_PTP_V2_EVENT;
 491                 break;
 492         case HWTSTAMP_FILTER_ALL:
 493         default:
 494                 return -ERANGE;
 495         }
 496
 497         /* Clear out all 1588-related registers to clear and unlatch them. */
 498         rd32(hw, I40E_PRTTSYN_STAT_0);
 499         rd32(hw, I40E_PRTTSYN_TXTIME_H);
 500         rd32(hw, I40E_PRTTSYN_RXTIME_H(0));
 501         rd32(hw, I40E_PRTTSYN_RXTIME_H(1));
 502         rd32(hw, I40E_PRTTSYN_RXTIME_H(2));
 503         rd32(hw, I40E_PRTTSYN_RXTIME_H(3));
 504
 505         /* Enable/disable the Tx timestamp interrupt based on user input. */
 506         regval = rd32(hw, I40E_PRTTSYN_CTL0);
 507         if (pf->ptp_tx)
 508                 regval |= I40E_PRTTSYN_CTL0_TXTIME_INT_ENA_MASK;
 509         else
 510                 regval &= ~I40E_PRTTSYN_CTL0_TXTIME_INT_ENA_MASK;
 511         wr32(hw, I40E_PRTTSYN_CTL0, regval);
 512
 513         regval = rd32(hw, I40E_PFINT_ICR0_ENA);
 514         if (pf->ptp_tx)
 515                 regval |= I40E_PFINT_ICR0_ENA_TIMESYNC_MASK;
 516         else
 517                 regval &= ~I40E_PFINT_ICR0_ENA_TIMESYNC_MASK;
 518         wr32(hw, I40E_PFINT_ICR0_ENA, regval);
 519
 520         /* There is no simple on/off switch for Rx. To "disable" Rx support,
 521          * ignore any received timestamps, rather than turn off the clock.
 522          */
 523         if (pf->ptp_rx) {
 524                 regval = rd32(hw, I40E_PRTTSYN_CTL1);
 525                 /* clear everything but the enable bit */
 526                 regval &= I40E_PRTTSYN_CTL1_TSYNENA_MASK;
 527                 /* now enable bits for desired Rx timestamps */
 528                 regval |= tsyntype;
 529                 wr32(hw, I40E_PRTTSYN_CTL1, regval);
 530         }
 531
 532         return 0;
 533 }
 534
 535 /**
 536  * i40e_ptp_set_ts_config - ioctl interface to control the HW timestamping
 537  * @pf: Board private structure
 538  * @ifreq: ioctl data
 539  *
 540  * Respond to the user filter requests and make the appropriate hardware
 541  * changes here. The XL710 cannot support splitting of the Tx/Rx timestamping
 542  * logic, so keep track in software of whether to indicate these timestamps
 543  * or not.
 544  *
 545  * It is permissible to "upgrade" the user request to a broader filter, as long
 546  * as the user receives the timestamps they care about and the user is notified
 547  * the filter has been broadened.
 548  **/
 549 int i40e_ptp_set_ts_config(struct i40e_pf *pf, struct ifreq *ifr)
 550 {
 551         struct hwtstamp_config config;
 552         int err;
 553
 554         if (copy_from_user(&config, ifr->ifr_data, sizeof(config)))
 555                 return -EFAULT;
 556
 557         err = i40e_ptp_set_timestamp_mode(pf, &config);
 558         if (err)
 559                 return err;
 560
 561         /* save these settings for future reference */
 562         pf->tstamp_config = config;
 563
 564         return copy_to_user(ifr->ifr_data, &config, sizeof(config)) ?
 565                 -EFAULT : 0;
 566 }
 567
 568 /**
 569  * i40e_ptp_create_clock - Create PTP clock device for userspace
 570  * @pf: Board private structure
 571  *
 572  * This function creates a new PTP clock device. It only creates one if we
 573  * don't already have one, so it is safe to call. Will return error if it
 574  * can't create one, but success if we already have a device. Should be used
 575  * by i40e_ptp_init to create clock initially, and prevent global resets from
 576  * creating new clock devices.
 577  **/
 578 static long i40e_ptp_create_clock(struct i40e_pf *pf)
 579 {
 580         /* no need to create a clock device if we already have one */
 581         if (!IS_ERR_OR_NULL(pf->ptp_clock))
 582                 return 0;
 583
 584         strncpy(pf->ptp_caps.name, i40e_driver_name, sizeof(pf->ptp_caps.name));
 585         pf->ptp_caps.owner = THIS_MODULE;
 586         pf->ptp_caps.max_adj = 999999999;
 587         pf->ptp_caps.n_ext_ts = 0;
 588         pf->ptp_caps.pps = 0;
 589         pf->ptp_caps.adjfreq = i40e_ptp_adjfreq;
 590         pf->ptp_caps.adjtime = i40e_ptp_adjtime;
 591         pf->ptp_caps.gettime = i40e_ptp_gettime;
 592         pf->ptp_caps.settime = i40e_ptp_settime;
 593         pf->ptp_caps.enable = i40e_ptp_feature_enable;
 594
 595         /* Attempt to register the clock before enabling the hardware. */
 596         pf->ptp_clock = ptp_clock_register(&pf->ptp_caps, &pf->pdev->dev);
 597         if (IS_ERR(pf->ptp_clock)) {
 598                 return PTR_ERR(pf->ptp_clock);
 599         }
 600
 601         /* clear the hwtstamp settings here during clock create, instead of
 602          * during regular init, so that we can maintain settings across a
 603          * reset or suspend.
 604          */
 605         pf->tstamp_config.rx_filter = HWTSTAMP_FILTER_NONE;
 606         pf->tstamp_config.tx_type = HWTSTAMP_TX_OFF;
 607
 608         return 0;
 609 }
 610
 611 /**
 612  * i40e_ptp_init - Initialize the 1588 support after device probe or reset
 613  * @pf: Board private structure
 614  *
 615  * This function sets device up for 1588 support. The first time it is run, it
 616  * will create a PHC clock device. It does not create a clock device if one
 617  * already exists. It also reconfigures the device after a reset.
 618  **/
 619 void i40e_ptp_init(struct i40e_pf *pf)
 620 {
 621         struct net_device *netdev = pf->vsi[pf->lan_vsi]->netdev;
 622         struct i40e_hw *hw = &pf->hw;
 623         long err;
 624
 625         /* we have to initialize the lock first, since we can't control
 626          * when the user will enter the PHC device entry points
 627          */
 628         spin_lock_init(&pf->tmreg_lock);
 629
 630         /* ensure we have a clock device */
 631         err = i40e_ptp_create_clock(pf);
 632         if (err) {
 633                 pf->ptp_clock = NULL;
 634                 dev_err(&pf->pdev->dev, "%s: ptp_clock_register failed\n",
 635                         __func__);
 636         } else {
 637                 struct timespec ts;
 638                 u32 regval;
 639
 640                 dev_info(&pf->pdev->dev, "%s: added PHC on %s\n", __func__,
 641                          netdev->name);
 642                 pf->flags |= I40E_FLAG_PTP;
 643
 644                 /* Ensure the clocks are running. */
 645                 regval = rd32(hw, I40E_PRTTSYN_CTL0);
 646                 regval |= I40E_PRTTSYN_CTL0_TSYNENA_MASK;
 647                 wr32(hw, I40E_PRTTSYN_CTL0, regval);
 648                 regval = rd32(hw, I40E_PRTTSYN_CTL1);
 649                 regval |= I40E_PRTTSYN_CTL1_TSYNENA_MASK;
 650                 wr32(hw, I40E_PRTTSYN_CTL1, regval);
 651
 652                 /* Set the increment value per clock tick. */
 653                 i40e_ptp_set_increment(pf);
 654
 655                 /* reset timestamping mode */
 656                 i40e_ptp_set_timestamp_mode(pf, &pf->tstamp_config);
 657
 658                 /* Set the clock value. */
 659                 ts = ktime_to_timespec(ktime_get_real());
 660                 i40e_ptp_settime(&pf->ptp_caps, &ts);
 661         }
 662 }
 663
 664 /**
 665  * i40e_ptp_stop - Disable the driver/hardware support and unregister the PHC
 666  * @pf: Board private structure
 667  *
 668  * This function handles the cleanup work required from the initialization by
 669  * clearing out the important information and unregistering the PHC.
 670  **/
 671 void i40e_ptp_stop(struct i40e_pf *pf)
 672 {
 673         pf->flags &= ~I40E_FLAG_PTP;
 674         pf->ptp_tx = false;
 675         pf->ptp_rx = false;
 676
 677         if (pf->ptp_tx_skb) {
 678                 dev_kfree_skb_any(pf->ptp_tx_skb);
 679                 pf->ptp_tx_skb = NULL;
 680         }
 681
 682         if (pf->ptp_clock) {
 683                 ptp_clock_unregister(pf->ptp_clock);
 684                 pf->ptp_clock = NULL;
 685                 dev_info(&pf->pdev->dev, "%s: removed PHC on %s\n", __func__,
 686                          pf->vsi[pf->lan_vsi]->netdev->name);
 687         }
 688 }