1 /*******************************************************************************
3 * Intel Ethernet Controller XL710 Family Linux Driver
4 * Copyright(c) 2013 - 2014 Intel Corporation.
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.
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
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/>.
18 * The full GNU General Public License is included in this distribution in
19 * the file called "COPYING".
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
25 ******************************************************************************/
28 #include <linux/export.h>
29 #include <linux/ptp_classify.h>
31 /* The XL710 timesync is very much like Intel's 82599 design when it comes to
32 * the fundamental clock design. However, the clock operations are much simpler
33 * in the XL710 because the device supports a full 64 bits of nanoseconds.
34 * Because the field is so wide, we can forgo the cycle counter and just
35 * operate with the nanosecond field directly without fear of overflow.
37 * Much like the 82599, the update period is dependent upon the link speed:
38 * At 40Gb link or no link, the period is 1.6ns.
39 * At 10Gb link, the period is multiplied by 2. (3.2ns)
40 * At 1Gb link, the period is multiplied by 20. (32ns)
41 * 1588 functionality is not supported at 100Mbps.
43 #define I40E_PTP_40GB_INCVAL 0x0199999999ULL
44 #define I40E_PTP_10GB_INCVAL 0x0333333333ULL
45 #define I40E_PTP_1GB_INCVAL 0x2000000000ULL
47 #define I40E_PRTTSYN_CTL1_TSYNTYPE_V1 (0x1 << \
48 I40E_PRTTSYN_CTL1_TSYNTYPE_SHIFT)
49 #define I40E_PRTTSYN_CTL1_TSYNTYPE_V2 (0x2 << \
50 I40E_PRTTSYN_CTL1_TSYNTYPE_SHIFT)
53 * i40e_ptp_read - Read the PHC time from the device
54 * @pf: Board private structure
55 * @ts: timespec structure to hold the current time value
57 * This function reads the PRTTSYN_TIME registers and stores them in a
58 * timespec. However, since the registers are 64 bits of nanoseconds, we must
59 * convert the result to a timespec before we can return.
61 static void i40e_ptp_read(struct i40e_pf *pf, struct timespec *ts)
63 struct i40e_hw *hw = &pf->hw;
67 /* The timer latches on the lowest register read. */
68 lo = rd32(hw, I40E_PRTTSYN_TIME_L);
69 hi = rd32(hw, I40E_PRTTSYN_TIME_H);
71 ns = (((u64)hi) << 32) | lo;
73 *ts = ns_to_timespec(ns);
77 * i40e_ptp_write - Write the PHC time to the device
78 * @pf: Board private structure
79 * @ts: timespec structure that holds the new time value
81 * This function writes the PRTTSYN_TIME registers with the user value. Since
82 * we receive a timespec from the stack, we must convert that timespec into
83 * nanoseconds before programming the registers.
85 static void i40e_ptp_write(struct i40e_pf *pf, const struct timespec *ts)
87 struct i40e_hw *hw = &pf->hw;
88 u64 ns = timespec_to_ns(ts);
90 /* The timer will not update until the high register is written, so
91 * write the low register first.
93 wr32(hw, I40E_PRTTSYN_TIME_L, ns & 0xFFFFFFFF);
94 wr32(hw, I40E_PRTTSYN_TIME_H, ns >> 32);
98 * i40e_ptp_convert_to_hwtstamp - Convert device clock to system time
99 * @hwtstamps: Timestamp structure to update
100 * @timestamp: Timestamp from the hardware
102 * We need to convert the NIC clock value into a hwtstamp which can be used by
103 * the upper level timestamping functions. Since the timestamp is simply a 64-
104 * bit nanosecond value, we can call ns_to_ktime directly to handle this.
106 static void i40e_ptp_convert_to_hwtstamp(struct skb_shared_hwtstamps *hwtstamps,
109 memset(hwtstamps, 0, sizeof(*hwtstamps));
111 hwtstamps->hwtstamp = ns_to_ktime(timestamp);
115 * i40e_ptp_adjfreq - Adjust the PHC frequency
116 * @ptp: The PTP clock structure
117 * @ppb: Parts per billion adjustment from the base
119 * Adjust the frequency of the PHC by the indicated parts per billion from the
122 static int i40e_ptp_adjfreq(struct ptp_clock_info *ptp, s32 ppb)
124 struct i40e_pf *pf = container_of(ptp, struct i40e_pf, ptp_caps);
125 struct i40e_hw *hw = &pf->hw;
134 smp_mb(); /* Force any pending update before accessing. */
135 adj = ACCESS_ONCE(pf->ptp_base_adj);
139 diff = div_u64(freq, 1000000000ULL);
146 wr32(hw, I40E_PRTTSYN_INC_L, adj & 0xFFFFFFFF);
147 wr32(hw, I40E_PRTTSYN_INC_H, adj >> 32);
153 * i40e_ptp_adjtime - Adjust the PHC time
154 * @ptp: The PTP clock structure
155 * @delta: Offset in nanoseconds to adjust the PHC time by
157 * Adjust the frequency of the PHC by the indicated parts per billion from the
160 static int i40e_ptp_adjtime(struct ptp_clock_info *ptp, s64 delta)
162 struct i40e_pf *pf = container_of(ptp, struct i40e_pf, ptp_caps);
163 struct timespec now, then = ns_to_timespec(delta);
166 spin_lock_irqsave(&pf->tmreg_lock, flags);
168 i40e_ptp_read(pf, &now);
169 now = timespec_add(now, then);
170 i40e_ptp_write(pf, (const struct timespec *)&now);
172 spin_unlock_irqrestore(&pf->tmreg_lock, flags);
178 * i40e_ptp_gettime - Get the time of the PHC
179 * @ptp: The PTP clock structure
180 * @ts: timespec structure to hold the current time value
182 * Read the device clock and return the correct value on ns, after converting it
183 * into a timespec struct.
185 static int i40e_ptp_gettime(struct ptp_clock_info *ptp, struct timespec *ts)
187 struct i40e_pf *pf = container_of(ptp, struct i40e_pf, ptp_caps);
190 spin_lock_irqsave(&pf->tmreg_lock, flags);
191 i40e_ptp_read(pf, ts);
192 spin_unlock_irqrestore(&pf->tmreg_lock, flags);
198 * i40e_ptp_settime - Set the time of the PHC
199 * @ptp: The PTP clock structure
200 * @ts: timespec structure that holds the new time value
202 * Set the device clock to the user input value. The conversion from timespec
203 * to ns happens in the write function.
205 static int i40e_ptp_settime(struct ptp_clock_info *ptp,
206 const struct timespec *ts)
208 struct i40e_pf *pf = container_of(ptp, struct i40e_pf, ptp_caps);
211 spin_lock_irqsave(&pf->tmreg_lock, flags);
212 i40e_ptp_write(pf, ts);
213 spin_unlock_irqrestore(&pf->tmreg_lock, flags);
219 * i40e_ptp_feature_enable - Enable/disable ancillary features of the PHC subsystem
220 * @ptp: The PTP clock structure
221 * @rq: The requested feature to change
222 * @on: Enable/disable flag
224 * The XL710 does not support any of the ancillary features of the PHC
225 * subsystem, so this function may just return.
227 static int i40e_ptp_feature_enable(struct ptp_clock_info *ptp,
228 struct ptp_clock_request *rq, int on)
234 * i40e_ptp_rx_hang - Detect error case when Rx timestamp registers are hung
235 * @vsi: The VSI with the rings relevant to 1588
237 * This watchdog task is scheduled to detect error case where hardware has
238 * dropped an Rx packet that was timestamped when the ring is full. The
239 * particular error is rare but leaves the device in a state unable to timestamp
240 * any future packets.
242 void i40e_ptp_rx_hang(struct i40e_vsi *vsi)
244 struct i40e_pf *pf = vsi->back;
245 struct i40e_hw *hw = &pf->hw;
246 struct i40e_ring *rx_ring;
247 unsigned long rx_event;
251 if (pf->flags & I40E_FLAG_PTP)
254 prttsyn_stat = rd32(hw, I40E_PRTTSYN_STAT_1);
256 /* Unless all four receive timestamp registers are latched, we are not
257 * concerned about a possible PTP Rx hang, so just update the timeout
260 if (!(prttsyn_stat & ((I40E_PRTTSYN_STAT_1_RXT0_MASK <<
261 I40E_PRTTSYN_STAT_1_RXT0_SHIFT) |
262 (I40E_PRTTSYN_STAT_1_RXT1_MASK <<
263 I40E_PRTTSYN_STAT_1_RXT1_SHIFT) |
264 (I40E_PRTTSYN_STAT_1_RXT2_MASK <<
265 I40E_PRTTSYN_STAT_1_RXT2_SHIFT) |
266 (I40E_PRTTSYN_STAT_1_RXT3_MASK <<
267 I40E_PRTTSYN_STAT_1_RXT3_SHIFT)))) {
268 pf->last_rx_ptp_check = jiffies;
272 /* Determine the most recent watchdog or rx_timestamp event. */
273 rx_event = pf->last_rx_ptp_check;
274 for (n = 0; n < vsi->num_queue_pairs; n++) {
275 rx_ring = vsi->rx_rings[n];
276 if (time_after(rx_ring->last_rx_timestamp, rx_event))
277 rx_event = rx_ring->last_rx_timestamp;
280 /* Only need to read the high RXSTMP register to clear the lock */
281 if (time_is_before_jiffies(rx_event + 5 * HZ)) {
282 rd32(hw, I40E_PRTTSYN_RXTIME_H(0));
283 rd32(hw, I40E_PRTTSYN_RXTIME_H(1));
284 rd32(hw, I40E_PRTTSYN_RXTIME_H(2));
285 rd32(hw, I40E_PRTTSYN_RXTIME_H(3));
286 pf->last_rx_ptp_check = jiffies;
287 pf->rx_hwtstamp_cleared++;
288 dev_warn(&vsi->back->pdev->dev,
289 "%s: clearing Rx timestamp hang\n",
295 * i40e_ptp_tx_hwtstamp - Utility function which returns the Tx timestamp
296 * @pf: Board private structure
298 * Read the value of the Tx timestamp from the registers, convert it into a
299 * value consumable by the stack, and store that result into the shhwtstamps
300 * struct before returning it up the stack.
302 void i40e_ptp_tx_hwtstamp(struct i40e_pf *pf)
304 struct skb_shared_hwtstamps shhwtstamps;
305 struct i40e_hw *hw = &pf->hw;
309 lo = rd32(hw, I40E_PRTTSYN_TXTIME_L);
310 hi = rd32(hw, I40E_PRTTSYN_TXTIME_H);
312 ns = (((u64)hi) << 32) | lo;
314 i40e_ptp_convert_to_hwtstamp(&shhwtstamps, ns);
315 skb_tstamp_tx(pf->ptp_tx_skb, &shhwtstamps);
316 dev_kfree_skb_any(pf->ptp_tx_skb);
317 pf->ptp_tx_skb = NULL;
321 * i40e_ptp_rx_hwtstamp - Utility function which checks for an Rx timestamp
322 * @pf: Board private structure
323 * @skb: Particular skb to send timestamp with
324 * @index: Index into the receive timestamp registers for the timestamp
326 * The XL710 receives a notification in the receive descriptor with an offset
327 * into the set of RXTIME registers where the timestamp is for that skb. This
328 * function goes and fetches the receive timestamp from that offset, if a valid
329 * one exists. The RXTIME registers are in ns, so we must convert the result
332 void i40e_ptp_rx_hwtstamp(struct i40e_pf *pf, struct sk_buff *skb, u8 index)
334 u32 prttsyn_stat, hi, lo;
338 /* Since we cannot turn off the Rx timestamp logic if the device is
339 * doing Tx timestamping, check if Rx timestamping is configured.
346 prttsyn_stat = rd32(hw, I40E_PRTTSYN_STAT_1);
348 if (!(prttsyn_stat & (1 << index)))
351 lo = rd32(hw, I40E_PRTTSYN_RXTIME_L(index));
352 hi = rd32(hw, I40E_PRTTSYN_RXTIME_H(index));
354 ns = (((u64)hi) << 32) | lo;
356 i40e_ptp_convert_to_hwtstamp(skb_hwtstamps(skb), ns);
360 * i40e_ptp_set_increment - Utility function to update clock increment rate
361 * @pf: Board private structure
363 * During a link change, the DMA frequency that drives the 1588 logic will
364 * change. In order to keep the PRTTSYN_TIME registers in units of nanoseconds,
365 * we must update the increment value per clock tick.
367 void i40e_ptp_set_increment(struct i40e_pf *pf)
369 struct i40e_link_status *hw_link_info;
370 struct i40e_hw *hw = &pf->hw;
373 hw_link_info = &hw->phy.link_info;
375 i40e_aq_get_link_info(&pf->hw, true, NULL, NULL);
377 switch (hw_link_info->link_speed) {
378 case I40E_LINK_SPEED_10GB:
379 incval = I40E_PTP_10GB_INCVAL;
381 case I40E_LINK_SPEED_1GB:
382 incval = I40E_PTP_1GB_INCVAL;
384 case I40E_LINK_SPEED_100MB:
385 dev_warn(&pf->pdev->dev,
386 "%s: 1588 functionality is not supported at 100 Mbps. Stopping the PHC.\n",
390 case I40E_LINK_SPEED_40GB:
392 incval = I40E_PTP_40GB_INCVAL;
396 /* Write the new increment value into the increment register. The
397 * hardware will not update the clock until both registers have been
400 wr32(hw, I40E_PRTTSYN_INC_L, incval & 0xFFFFFFFF);
401 wr32(hw, I40E_PRTTSYN_INC_H, incval >> 32);
403 /* Update the base adjustement value. */
404 ACCESS_ONCE(pf->ptp_base_adj) = incval;
405 smp_mb(); /* Force the above update. */
409 * i40e_ptp_get_ts_config - ioctl interface to read the HW timestamping
410 * @pf: Board private structure
413 * Obtain the current hardware timestamping settigs as requested. To do this,
414 * keep a shadow copy of the timestamp settings rather than attempting to
415 * deconstruct it from the registers.
417 int i40e_ptp_get_ts_config(struct i40e_pf *pf, struct ifreq *ifr)
419 struct hwtstamp_config *config = &pf->tstamp_config;
421 return copy_to_user(ifr->ifr_data, config, sizeof(*config)) ?
426 * i40e_ptp_set_timestamp_mode - setup hardware for requested timestamp mode
427 * @pf: Board private structure
428 * @config: hwtstamp settings requested or saved
430 * Control hardware registers to enter the specific mode requested by the
431 * user. Also used during reset path to ensure that timestamp settings are
434 * Note: modifies config in place, and may update the requested mode to be
435 * more broad if the specific filter is not directly supported.
437 static int i40e_ptp_set_timestamp_mode(struct i40e_pf *pf,
438 struct hwtstamp_config *config)
440 struct i40e_hw *hw = &pf->hw;
441 u32 pf_id, tsyntype, regval;
443 /* Reserved for future extensions. */
447 /* Confirm that 1588 is supported on this PF. */
448 pf_id = (rd32(hw, I40E_PRTTSYN_CTL0) & I40E_PRTTSYN_CTL0_PF_ID_MASK) >>
449 I40E_PRTTSYN_CTL0_PF_ID_SHIFT;
450 if (hw->pf_id != pf_id)
453 switch (config->tx_type) {
454 case HWTSTAMP_TX_OFF:
464 switch (config->rx_filter) {
465 case HWTSTAMP_FILTER_NONE:
469 case HWTSTAMP_FILTER_PTP_V1_L4_SYNC:
470 case HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ:
471 case HWTSTAMP_FILTER_PTP_V1_L4_EVENT:
473 tsyntype = I40E_PRTTSYN_CTL1_V1MESSTYPE0_MASK |
474 I40E_PRTTSYN_CTL1_TSYNTYPE_V1 |
475 I40E_PRTTSYN_CTL1_UDP_ENA_MASK;
476 config->rx_filter = HWTSTAMP_FILTER_PTP_V1_L4_EVENT;
478 case HWTSTAMP_FILTER_PTP_V2_EVENT:
479 case HWTSTAMP_FILTER_PTP_V2_L2_EVENT:
480 case HWTSTAMP_FILTER_PTP_V2_L4_EVENT:
481 case HWTSTAMP_FILTER_PTP_V2_SYNC:
482 case HWTSTAMP_FILTER_PTP_V2_L2_SYNC:
483 case HWTSTAMP_FILTER_PTP_V2_L4_SYNC:
484 case HWTSTAMP_FILTER_PTP_V2_DELAY_REQ:
485 case HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ:
486 case HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ:
488 tsyntype = I40E_PRTTSYN_CTL1_V2MESSTYPE0_MASK |
489 I40E_PRTTSYN_CTL1_TSYNTYPE_V2 |
490 I40E_PRTTSYN_CTL1_UDP_ENA_MASK;
491 config->rx_filter = HWTSTAMP_FILTER_PTP_V2_EVENT;
493 case HWTSTAMP_FILTER_ALL:
498 /* Clear out all 1588-related registers to clear and unlatch them. */
499 rd32(hw, I40E_PRTTSYN_STAT_0);
500 rd32(hw, I40E_PRTTSYN_TXTIME_H);
501 rd32(hw, I40E_PRTTSYN_RXTIME_H(0));
502 rd32(hw, I40E_PRTTSYN_RXTIME_H(1));
503 rd32(hw, I40E_PRTTSYN_RXTIME_H(2));
504 rd32(hw, I40E_PRTTSYN_RXTIME_H(3));
506 /* Enable/disable the Tx timestamp interrupt based on user input. */
507 regval = rd32(hw, I40E_PRTTSYN_CTL0);
509 regval |= I40E_PRTTSYN_CTL0_TXTIME_INT_ENA_MASK;
511 regval &= ~I40E_PRTTSYN_CTL0_TXTIME_INT_ENA_MASK;
512 wr32(hw, I40E_PRTTSYN_CTL0, regval);
514 regval = rd32(hw, I40E_PFINT_ICR0_ENA);
516 regval |= I40E_PFINT_ICR0_ENA_TIMESYNC_MASK;
518 regval &= ~I40E_PFINT_ICR0_ENA_TIMESYNC_MASK;
519 wr32(hw, I40E_PFINT_ICR0_ENA, regval);
521 /* There is no simple on/off switch for Rx. To "disable" Rx support,
522 * ignore any received timestamps, rather than turn off the clock.
525 regval = rd32(hw, I40E_PRTTSYN_CTL1);
526 /* clear everything but the enable bit */
527 regval &= I40E_PRTTSYN_CTL1_TSYNENA_MASK;
528 /* now enable bits for desired Rx timestamps */
530 wr32(hw, I40E_PRTTSYN_CTL1, regval);
537 * i40e_ptp_set_ts_config - ioctl interface to control the HW timestamping
538 * @pf: Board private structure
541 * Respond to the user filter requests and make the appropriate hardware
542 * changes here. The XL710 cannot support splitting of the Tx/Rx timestamping
543 * logic, so keep track in software of whether to indicate these timestamps
546 * It is permissible to "upgrade" the user request to a broader filter, as long
547 * as the user receives the timestamps they care about and the user is notified
548 * the filter has been broadened.
550 int i40e_ptp_set_ts_config(struct i40e_pf *pf, struct ifreq *ifr)
552 struct hwtstamp_config *config = &pf->tstamp_config;
555 if (copy_from_user(config, ifr->ifr_data, sizeof(*config)))
558 err = i40e_ptp_set_timestamp_mode(pf, config);
562 return copy_to_user(ifr->ifr_data, config, sizeof(*config)) ?
567 * i40e_ptp_init - Initialize the 1588 support and register the PHC
568 * @pf: Board private structure
570 * This function registers the device clock as a PHC. If it is successful, it
571 * starts the clock in the hardware.
573 void i40e_ptp_init(struct i40e_pf *pf)
575 struct i40e_hw *hw = &pf->hw;
576 struct net_device *netdev = pf->vsi[pf->lan_vsi]->netdev;
578 strncpy(pf->ptp_caps.name, "i40e", sizeof(pf->ptp_caps.name));
579 pf->ptp_caps.owner = THIS_MODULE;
580 pf->ptp_caps.max_adj = 999999999;
581 pf->ptp_caps.n_ext_ts = 0;
582 pf->ptp_caps.pps = 0;
583 pf->ptp_caps.adjfreq = i40e_ptp_adjfreq;
584 pf->ptp_caps.adjtime = i40e_ptp_adjtime;
585 pf->ptp_caps.gettime = i40e_ptp_gettime;
586 pf->ptp_caps.settime = i40e_ptp_settime;
587 pf->ptp_caps.enable = i40e_ptp_feature_enable;
589 /* Attempt to register the clock before enabling the hardware. */
590 pf->ptp_clock = ptp_clock_register(&pf->ptp_caps, &pf->pdev->dev);
591 if (IS_ERR(pf->ptp_clock)) {
592 pf->ptp_clock = NULL;
593 dev_err(&pf->pdev->dev, "%s: ptp_clock_register failed\n",
599 spin_lock_init(&pf->tmreg_lock);
601 dev_info(&pf->pdev->dev, "%s: added PHC on %s\n", __func__,
603 pf->flags |= I40E_FLAG_PTP;
605 pf->tstamp_config.rx_filter = HWTSTAMP_FILTER_NONE;
606 pf->tstamp_config.tx_type = HWTSTAMP_TX_OFF;
608 /* Ensure the clocks are running. */
609 regval = rd32(hw, I40E_PRTTSYN_CTL0);
610 regval |= I40E_PRTTSYN_CTL0_TSYNENA_MASK;
611 wr32(hw, I40E_PRTTSYN_CTL0, regval);
612 regval = rd32(hw, I40E_PRTTSYN_CTL1);
613 regval |= I40E_PRTTSYN_CTL1_TSYNENA_MASK;
614 wr32(hw, I40E_PRTTSYN_CTL1, regval);
616 /* Set the increment value per clock tick. */
617 i40e_ptp_set_increment(pf);
619 /* reset timestamping mode */
620 i40e_ptp_set_timestamp_mode(pf, &pf->tstamp_config);
622 /* Set the clock value. */
623 ts = ktime_to_timespec(ktime_get_real());
624 i40e_ptp_settime(&pf->ptp_caps, &ts);
629 * i40e_ptp_stop - Disable the driver/hardware support and unregister the PHC
630 * @pf: Board private structure
632 * This function handles the cleanup work required from the initialization by
633 * clearing out the important information and unregistering the PHC.
635 void i40e_ptp_stop(struct i40e_pf *pf)
637 pf->flags &= ~I40E_FLAG_PTP;
641 if (pf->ptp_tx_skb) {
642 dev_kfree_skb_any(pf->ptp_tx_skb);
643 pf->ptp_tx_skb = NULL;
647 ptp_clock_unregister(pf->ptp_clock);
648 pf->ptp_clock = NULL;
649 dev_info(&pf->pdev->dev, "%s: removed PHC on %s\n", __func__,
650 pf->vsi[pf->lan_vsi]->netdev->name);