1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (c) 2019 Intel Corporation */
3
4 #include "igc.h"
5
6 #include <linux/module.h>
7 #include <linux/device.h>
8 #include <linux/pci.h>
9 #include <linux/ptp_classify.h>
10 #include <linux/clocksource.h>
11 #include <linux/ktime.h>
12 #include <linux/delay.h>
13 #include <linux/iopoll.h>
14
15 #define INCVALUE_MASK 0x7fffffff
16 #define ISGN 0x80000000
17
18 #define IGC_SYSTIM_OVERFLOW_PERIOD (HZ * 60 * 9)
19 #define IGC_PTP_TX_TIMEOUT (HZ * 15)
20
21 #define IGC_PTM_STAT_SLEEP 2
22 #define IGC_PTM_STAT_TIMEOUT 100
23
24 /* SYSTIM read access for I225 */
igc_ptp_read(struct igc_adapter * adapter,struct timespec64 * ts)25 void igc_ptp_read(struct igc_adapter *adapter, struct timespec64 *ts)
26 {
27 struct igc_hw *hw = &adapter->hw;
28 u32 sec, nsec;
29
30 /* The timestamp is latched when SYSTIML is read. */
31 nsec = rd32(IGC_SYSTIML);
32 sec = rd32(IGC_SYSTIMH);
33
34 ts->tv_sec = sec;
35 ts->tv_nsec = nsec;
36 }
37
igc_ptp_write_i225(struct igc_adapter * adapter,const struct timespec64 * ts)38 static void igc_ptp_write_i225(struct igc_adapter *adapter,
39 const struct timespec64 *ts)
40 {
41 struct igc_hw *hw = &adapter->hw;
42
43 wr32(IGC_SYSTIML, ts->tv_nsec);
44 wr32(IGC_SYSTIMH, ts->tv_sec);
45 }
46
igc_ptp_adjfine_i225(struct ptp_clock_info * ptp,long scaled_ppm)47 static int igc_ptp_adjfine_i225(struct ptp_clock_info *ptp, long scaled_ppm)
48 {
49 struct igc_adapter *igc = container_of(ptp, struct igc_adapter,
50 ptp_caps);
51 struct igc_hw *hw = &igc->hw;
52 int neg_adj = 0;
53 u64 rate;
54 u32 inca;
55
56 if (scaled_ppm < 0) {
57 neg_adj = 1;
58 scaled_ppm = -scaled_ppm;
59 }
60 rate = scaled_ppm;
61 rate <<= 14;
62 rate = div_u64(rate, 78125);
63
64 inca = rate & INCVALUE_MASK;
65 if (neg_adj)
66 inca |= ISGN;
67
68 wr32(IGC_TIMINCA, inca);
69
70 return 0;
71 }
72
igc_ptp_adjtime_i225(struct ptp_clock_info * ptp,s64 delta)73 static int igc_ptp_adjtime_i225(struct ptp_clock_info *ptp, s64 delta)
74 {
75 struct igc_adapter *igc = container_of(ptp, struct igc_adapter,
76 ptp_caps);
77 struct timespec64 now, then = ns_to_timespec64(delta);
78 unsigned long flags;
79
80 spin_lock_irqsave(&igc->tmreg_lock, flags);
81
82 igc_ptp_read(igc, &now);
83 now = timespec64_add(now, then);
84 igc_ptp_write_i225(igc, (const struct timespec64 *)&now);
85
86 spin_unlock_irqrestore(&igc->tmreg_lock, flags);
87
88 return 0;
89 }
90
igc_ptp_gettimex64_i225(struct ptp_clock_info * ptp,struct timespec64 * ts,struct ptp_system_timestamp * sts)91 static int igc_ptp_gettimex64_i225(struct ptp_clock_info *ptp,
92 struct timespec64 *ts,
93 struct ptp_system_timestamp *sts)
94 {
95 struct igc_adapter *igc = container_of(ptp, struct igc_adapter,
96 ptp_caps);
97 struct igc_hw *hw = &igc->hw;
98 unsigned long flags;
99
100 spin_lock_irqsave(&igc->tmreg_lock, flags);
101
102 ptp_read_system_prets(sts);
103 ts->tv_nsec = rd32(IGC_SYSTIML);
104 ts->tv_sec = rd32(IGC_SYSTIMH);
105 ptp_read_system_postts(sts);
106
107 spin_unlock_irqrestore(&igc->tmreg_lock, flags);
108
109 return 0;
110 }
111
igc_ptp_settime_i225(struct ptp_clock_info * ptp,const struct timespec64 * ts)112 static int igc_ptp_settime_i225(struct ptp_clock_info *ptp,
113 const struct timespec64 *ts)
114 {
115 struct igc_adapter *igc = container_of(ptp, struct igc_adapter,
116 ptp_caps);
117 unsigned long flags;
118
119 spin_lock_irqsave(&igc->tmreg_lock, flags);
120
121 igc_ptp_write_i225(igc, ts);
122
123 spin_unlock_irqrestore(&igc->tmreg_lock, flags);
124
125 return 0;
126 }
127
igc_pin_direction(int pin,int input,u32 * ctrl,u32 * ctrl_ext)128 static void igc_pin_direction(int pin, int input, u32 *ctrl, u32 *ctrl_ext)
129 {
130 u32 *ptr = pin < 2 ? ctrl : ctrl_ext;
131 static const u32 mask[IGC_N_SDP] = {
132 IGC_CTRL_SDP0_DIR,
133 IGC_CTRL_SDP1_DIR,
134 IGC_CTRL_EXT_SDP2_DIR,
135 IGC_CTRL_EXT_SDP3_DIR,
136 };
137
138 if (input)
139 *ptr &= ~mask[pin];
140 else
141 *ptr |= mask[pin];
142 }
143
igc_pin_perout(struct igc_adapter * igc,int chan,int pin,int freq)144 static void igc_pin_perout(struct igc_adapter *igc, int chan, int pin, int freq)
145 {
146 static const u32 igc_aux0_sel_sdp[IGC_N_SDP] = {
147 IGC_AUX0_SEL_SDP0, IGC_AUX0_SEL_SDP1, IGC_AUX0_SEL_SDP2, IGC_AUX0_SEL_SDP3,
148 };
149 static const u32 igc_aux1_sel_sdp[IGC_N_SDP] = {
150 IGC_AUX1_SEL_SDP0, IGC_AUX1_SEL_SDP1, IGC_AUX1_SEL_SDP2, IGC_AUX1_SEL_SDP3,
151 };
152 static const u32 igc_ts_sdp_en[IGC_N_SDP] = {
153 IGC_TS_SDP0_EN, IGC_TS_SDP1_EN, IGC_TS_SDP2_EN, IGC_TS_SDP3_EN,
154 };
155 static const u32 igc_ts_sdp_sel_tt0[IGC_N_SDP] = {
156 IGC_TS_SDP0_SEL_TT0, IGC_TS_SDP1_SEL_TT0,
157 IGC_TS_SDP2_SEL_TT0, IGC_TS_SDP3_SEL_TT0,
158 };
159 static const u32 igc_ts_sdp_sel_tt1[IGC_N_SDP] = {
160 IGC_TS_SDP0_SEL_TT1, IGC_TS_SDP1_SEL_TT1,
161 IGC_TS_SDP2_SEL_TT1, IGC_TS_SDP3_SEL_TT1,
162 };
163 static const u32 igc_ts_sdp_sel_fc0[IGC_N_SDP] = {
164 IGC_TS_SDP0_SEL_FC0, IGC_TS_SDP1_SEL_FC0,
165 IGC_TS_SDP2_SEL_FC0, IGC_TS_SDP3_SEL_FC0,
166 };
167 static const u32 igc_ts_sdp_sel_fc1[IGC_N_SDP] = {
168 IGC_TS_SDP0_SEL_FC1, IGC_TS_SDP1_SEL_FC1,
169 IGC_TS_SDP2_SEL_FC1, IGC_TS_SDP3_SEL_FC1,
170 };
171 static const u32 igc_ts_sdp_sel_clr[IGC_N_SDP] = {
172 IGC_TS_SDP0_SEL_FC1, IGC_TS_SDP1_SEL_FC1,
173 IGC_TS_SDP2_SEL_FC1, IGC_TS_SDP3_SEL_FC1,
174 };
175 struct igc_hw *hw = &igc->hw;
176 u32 ctrl, ctrl_ext, tssdp = 0;
177
178 ctrl = rd32(IGC_CTRL);
179 ctrl_ext = rd32(IGC_CTRL_EXT);
180 tssdp = rd32(IGC_TSSDP);
181
182 igc_pin_direction(pin, 0, &ctrl, &ctrl_ext);
183
184 /* Make sure this pin is not enabled as an input. */
185 if ((tssdp & IGC_AUX0_SEL_SDP3) == igc_aux0_sel_sdp[pin])
186 tssdp &= ~IGC_AUX0_TS_SDP_EN;
187
188 if ((tssdp & IGC_AUX1_SEL_SDP3) == igc_aux1_sel_sdp[pin])
189 tssdp &= ~IGC_AUX1_TS_SDP_EN;
190
191 tssdp &= ~igc_ts_sdp_sel_clr[pin];
192 if (freq) {
193 if (chan == 1)
194 tssdp |= igc_ts_sdp_sel_fc1[pin];
195 else
196 tssdp |= igc_ts_sdp_sel_fc0[pin];
197 } else {
198 if (chan == 1)
199 tssdp |= igc_ts_sdp_sel_tt1[pin];
200 else
201 tssdp |= igc_ts_sdp_sel_tt0[pin];
202 }
203 tssdp |= igc_ts_sdp_en[pin];
204
205 wr32(IGC_TSSDP, tssdp);
206 wr32(IGC_CTRL, ctrl);
207 wr32(IGC_CTRL_EXT, ctrl_ext);
208 }
209
igc_pin_extts(struct igc_adapter * igc,int chan,int pin)210 static void igc_pin_extts(struct igc_adapter *igc, int chan, int pin)
211 {
212 static const u32 igc_aux0_sel_sdp[IGC_N_SDP] = {
213 IGC_AUX0_SEL_SDP0, IGC_AUX0_SEL_SDP1, IGC_AUX0_SEL_SDP2, IGC_AUX0_SEL_SDP3,
214 };
215 static const u32 igc_aux1_sel_sdp[IGC_N_SDP] = {
216 IGC_AUX1_SEL_SDP0, IGC_AUX1_SEL_SDP1, IGC_AUX1_SEL_SDP2, IGC_AUX1_SEL_SDP3,
217 };
218 static const u32 igc_ts_sdp_en[IGC_N_SDP] = {
219 IGC_TS_SDP0_EN, IGC_TS_SDP1_EN, IGC_TS_SDP2_EN, IGC_TS_SDP3_EN,
220 };
221 struct igc_hw *hw = &igc->hw;
222 u32 ctrl, ctrl_ext, tssdp = 0;
223
224 ctrl = rd32(IGC_CTRL);
225 ctrl_ext = rd32(IGC_CTRL_EXT);
226 tssdp = rd32(IGC_TSSDP);
227
228 igc_pin_direction(pin, 1, &ctrl, &ctrl_ext);
229
230 /* Make sure this pin is not enabled as an output. */
231 tssdp &= ~igc_ts_sdp_en[pin];
232
233 if (chan == 1) {
234 tssdp &= ~IGC_AUX1_SEL_SDP3;
235 tssdp |= igc_aux1_sel_sdp[pin] | IGC_AUX1_TS_SDP_EN;
236 } else {
237 tssdp &= ~IGC_AUX0_SEL_SDP3;
238 tssdp |= igc_aux0_sel_sdp[pin] | IGC_AUX0_TS_SDP_EN;
239 }
240
241 wr32(IGC_TSSDP, tssdp);
242 wr32(IGC_CTRL, ctrl);
243 wr32(IGC_CTRL_EXT, ctrl_ext);
244 }
245
igc_ptp_feature_enable_i225(struct ptp_clock_info * ptp,struct ptp_clock_request * rq,int on)246 static int igc_ptp_feature_enable_i225(struct ptp_clock_info *ptp,
247 struct ptp_clock_request *rq, int on)
248 {
249 struct igc_adapter *igc =
250 container_of(ptp, struct igc_adapter, ptp_caps);
251 struct igc_hw *hw = &igc->hw;
252 unsigned long flags;
253 struct timespec64 ts;
254 int use_freq = 0, pin = -1;
255 u32 tsim, tsauxc, tsauxc_mask, tsim_mask, trgttiml, trgttimh, freqout;
256 s64 ns;
257
258 switch (rq->type) {
259 case PTP_CLK_REQ_EXTTS:
260 /* Reject requests with unsupported flags */
261 if (rq->extts.flags & ~(PTP_ENABLE_FEATURE |
262 PTP_RISING_EDGE |
263 PTP_FALLING_EDGE |
264 PTP_STRICT_FLAGS))
265 return -EOPNOTSUPP;
266
267 /* Reject requests failing to enable both edges. */
268 if ((rq->extts.flags & PTP_STRICT_FLAGS) &&
269 (rq->extts.flags & PTP_ENABLE_FEATURE) &&
270 (rq->extts.flags & PTP_EXTTS_EDGES) != PTP_EXTTS_EDGES)
271 return -EOPNOTSUPP;
272
273 if (on) {
274 pin = ptp_find_pin(igc->ptp_clock, PTP_PF_EXTTS,
275 rq->extts.index);
276 if (pin < 0)
277 return -EBUSY;
278 }
279 if (rq->extts.index == 1) {
280 tsauxc_mask = IGC_TSAUXC_EN_TS1;
281 tsim_mask = IGC_TSICR_AUTT1;
282 } else {
283 tsauxc_mask = IGC_TSAUXC_EN_TS0;
284 tsim_mask = IGC_TSICR_AUTT0;
285 }
286 spin_lock_irqsave(&igc->tmreg_lock, flags);
287 tsauxc = rd32(IGC_TSAUXC);
288 tsim = rd32(IGC_TSIM);
289 if (on) {
290 igc_pin_extts(igc, rq->extts.index, pin);
291 tsauxc |= tsauxc_mask;
292 tsim |= tsim_mask;
293 } else {
294 tsauxc &= ~tsauxc_mask;
295 tsim &= ~tsim_mask;
296 }
297 wr32(IGC_TSAUXC, tsauxc);
298 wr32(IGC_TSIM, tsim);
299 spin_unlock_irqrestore(&igc->tmreg_lock, flags);
300 return 0;
301
302 case PTP_CLK_REQ_PEROUT:
303 /* Reject requests with unsupported flags */
304 if (rq->perout.flags)
305 return -EOPNOTSUPP;
306
307 if (on) {
308 pin = ptp_find_pin(igc->ptp_clock, PTP_PF_PEROUT,
309 rq->perout.index);
310 if (pin < 0)
311 return -EBUSY;
312 }
313 ts.tv_sec = rq->perout.period.sec;
314 ts.tv_nsec = rq->perout.period.nsec;
315 ns = timespec64_to_ns(&ts);
316 ns = ns >> 1;
317 if (on && (ns <= 70000000LL || ns == 125000000LL ||
318 ns == 250000000LL || ns == 500000000LL)) {
319 if (ns < 8LL)
320 return -EINVAL;
321 use_freq = 1;
322 }
323 ts = ns_to_timespec64(ns);
324 if (rq->perout.index == 1) {
325 if (use_freq) {
326 tsauxc_mask = IGC_TSAUXC_EN_CLK1;
327 tsim_mask = 0;
328 } else {
329 tsauxc_mask = IGC_TSAUXC_EN_TT1;
330 tsim_mask = IGC_TSICR_TT1;
331 }
332 trgttiml = IGC_TRGTTIML1;
333 trgttimh = IGC_TRGTTIMH1;
334 freqout = IGC_FREQOUT1;
335 } else {
336 if (use_freq) {
337 tsauxc_mask = IGC_TSAUXC_EN_CLK0;
338 tsim_mask = 0;
339 } else {
340 tsauxc_mask = IGC_TSAUXC_EN_TT0;
341 tsim_mask = IGC_TSICR_TT0;
342 }
343 trgttiml = IGC_TRGTTIML0;
344 trgttimh = IGC_TRGTTIMH0;
345 freqout = IGC_FREQOUT0;
346 }
347 spin_lock_irqsave(&igc->tmreg_lock, flags);
348 tsauxc = rd32(IGC_TSAUXC);
349 tsim = rd32(IGC_TSIM);
350 if (rq->perout.index == 1) {
351 tsauxc &= ~(IGC_TSAUXC_EN_TT1 | IGC_TSAUXC_EN_CLK1);
352 tsim &= ~IGC_TSICR_TT1;
353 } else {
354 tsauxc &= ~(IGC_TSAUXC_EN_TT0 | IGC_TSAUXC_EN_CLK0);
355 tsim &= ~IGC_TSICR_TT0;
356 }
357 if (on) {
358 int i = rq->perout.index;
359
360 igc_pin_perout(igc, i, pin, use_freq);
361 igc->perout[i].start.tv_sec = rq->perout.start.sec;
362 igc->perout[i].start.tv_nsec = rq->perout.start.nsec;
363 igc->perout[i].period.tv_sec = ts.tv_sec;
364 igc->perout[i].period.tv_nsec = ts.tv_nsec;
365 wr32(trgttimh, rq->perout.start.sec);
366 /* For now, always select timer 0 as source. */
367 wr32(trgttiml, rq->perout.start.nsec | IGC_TT_IO_TIMER_SEL_SYSTIM0);
368 if (use_freq)
369 wr32(freqout, ns);
370 tsauxc |= tsauxc_mask;
371 tsim |= tsim_mask;
372 }
373 wr32(IGC_TSAUXC, tsauxc);
374 wr32(IGC_TSIM, tsim);
375 spin_unlock_irqrestore(&igc->tmreg_lock, flags);
376 return 0;
377
378 case PTP_CLK_REQ_PPS:
379 spin_lock_irqsave(&igc->tmreg_lock, flags);
380 tsim = rd32(IGC_TSIM);
381 if (on)
382 tsim |= IGC_TSICR_SYS_WRAP;
383 else
384 tsim &= ~IGC_TSICR_SYS_WRAP;
385 igc->pps_sys_wrap_on = on;
386 wr32(IGC_TSIM, tsim);
387 spin_unlock_irqrestore(&igc->tmreg_lock, flags);
388 return 0;
389
390 default:
391 break;
392 }
393
394 return -EOPNOTSUPP;
395 }
396
igc_ptp_verify_pin(struct ptp_clock_info * ptp,unsigned int pin,enum ptp_pin_function func,unsigned int chan)397 static int igc_ptp_verify_pin(struct ptp_clock_info *ptp, unsigned int pin,
398 enum ptp_pin_function func, unsigned int chan)
399 {
400 switch (func) {
401 case PTP_PF_NONE:
402 case PTP_PF_EXTTS:
403 case PTP_PF_PEROUT:
404 break;
405 case PTP_PF_PHYSYNC:
406 return -1;
407 }
408 return 0;
409 }
410
411 /**
412 * igc_ptp_systim_to_hwtstamp - convert system time value to HW timestamp
413 * @adapter: board private structure
414 * @hwtstamps: timestamp structure to update
415 * @systim: unsigned 64bit system time value
416 *
417 * We need to convert the system time value stored in the RX/TXSTMP registers
418 * into a hwtstamp which can be used by the upper level timestamping functions.
419 **/
igc_ptp_systim_to_hwtstamp(struct igc_adapter * adapter,struct skb_shared_hwtstamps * hwtstamps,u64 systim)420 static void igc_ptp_systim_to_hwtstamp(struct igc_adapter *adapter,
421 struct skb_shared_hwtstamps *hwtstamps,
422 u64 systim)
423 {
424 switch (adapter->hw.mac.type) {
425 case igc_i225:
426 memset(hwtstamps, 0, sizeof(*hwtstamps));
427 /* Upper 32 bits contain s, lower 32 bits contain ns. */
428 hwtstamps->hwtstamp = ktime_set(systim >> 32,
429 systim & 0xFFFFFFFF);
430 break;
431 default:
432 break;
433 }
434 }
435
436 /**
437 * igc_ptp_rx_pktstamp - Retrieve timestamp from Rx packet buffer
438 * @adapter: Pointer to adapter the packet buffer belongs to
439 * @buf: Pointer to packet buffer
440 *
441 * This function retrieves the timestamp saved in the beginning of packet
442 * buffer. While two timestamps are available, one in timer0 reference and the
443 * other in timer1 reference, this function considers only the timestamp in
444 * timer0 reference.
445 *
446 * Returns timestamp value.
447 */
igc_ptp_rx_pktstamp(struct igc_adapter * adapter,__le32 * buf)448 ktime_t igc_ptp_rx_pktstamp(struct igc_adapter *adapter, __le32 *buf)
449 {
450 ktime_t timestamp;
451 u32 secs, nsecs;
452 int adjust;
453
454 /* Timestamps are saved in little endian at the beginning of the packet
455 * buffer following the layout:
456 *
457 * DWORD: | 0 | 1 | 2 | 3 |
458 * Field: | Timer1 SYSTIML | Timer1 SYSTIMH | Timer0 SYSTIML | Timer0 SYSTIMH |
459 *
460 * SYSTIML holds the nanoseconds part while SYSTIMH holds the seconds
461 * part of the timestamp.
462 */
463 nsecs = le32_to_cpu(buf[2]);
464 secs = le32_to_cpu(buf[3]);
465
466 timestamp = ktime_set(secs, nsecs);
467
468 /* Adjust timestamp for the RX latency based on link speed */
469 switch (adapter->link_speed) {
470 case SPEED_10:
471 adjust = IGC_I225_RX_LATENCY_10;
472 break;
473 case SPEED_100:
474 adjust = IGC_I225_RX_LATENCY_100;
475 break;
476 case SPEED_1000:
477 adjust = IGC_I225_RX_LATENCY_1000;
478 break;
479 case SPEED_2500:
480 adjust = IGC_I225_RX_LATENCY_2500;
481 break;
482 default:
483 adjust = 0;
484 netdev_warn_once(adapter->netdev, "Imprecise timestamp\n");
485 break;
486 }
487
488 return ktime_sub_ns(timestamp, adjust);
489 }
490
igc_ptp_disable_rx_timestamp(struct igc_adapter * adapter)491 static void igc_ptp_disable_rx_timestamp(struct igc_adapter *adapter)
492 {
493 struct igc_hw *hw = &adapter->hw;
494 u32 val;
495 int i;
496
497 wr32(IGC_TSYNCRXCTL, 0);
498
499 for (i = 0; i < adapter->num_rx_queues; i++) {
500 val = rd32(IGC_SRRCTL(i));
501 val &= ~IGC_SRRCTL_TIMESTAMP;
502 wr32(IGC_SRRCTL(i), val);
503 }
504
505 val = rd32(IGC_RXPBS);
506 val &= ~IGC_RXPBS_CFG_TS_EN;
507 wr32(IGC_RXPBS, val);
508 }
509
igc_ptp_enable_rx_timestamp(struct igc_adapter * adapter)510 static void igc_ptp_enable_rx_timestamp(struct igc_adapter *adapter)
511 {
512 struct igc_hw *hw = &adapter->hw;
513 u32 val;
514 int i;
515
516 val = rd32(IGC_RXPBS);
517 val |= IGC_RXPBS_CFG_TS_EN;
518 wr32(IGC_RXPBS, val);
519
520 for (i = 0; i < adapter->num_rx_queues; i++) {
521 val = rd32(IGC_SRRCTL(i));
522 /* FIXME: For now, only support retrieving RX timestamps from
523 * timer 0.
524 */
525 val |= IGC_SRRCTL_TIMER1SEL(0) | IGC_SRRCTL_TIMER0SEL(0) |
526 IGC_SRRCTL_TIMESTAMP;
527 wr32(IGC_SRRCTL(i), val);
528 }
529
530 val = IGC_TSYNCRXCTL_ENABLED | IGC_TSYNCRXCTL_TYPE_ALL |
531 IGC_TSYNCRXCTL_RXSYNSIG;
532 wr32(IGC_TSYNCRXCTL, val);
533 }
534
igc_ptp_disable_tx_timestamp(struct igc_adapter * adapter)535 static void igc_ptp_disable_tx_timestamp(struct igc_adapter *adapter)
536 {
537 struct igc_hw *hw = &adapter->hw;
538
539 wr32(IGC_TSYNCTXCTL, 0);
540 }
541
igc_ptp_enable_tx_timestamp(struct igc_adapter * adapter)542 static void igc_ptp_enable_tx_timestamp(struct igc_adapter *adapter)
543 {
544 struct igc_hw *hw = &adapter->hw;
545
546 wr32(IGC_TSYNCTXCTL, IGC_TSYNCTXCTL_ENABLED | IGC_TSYNCTXCTL_TXSYNSIG);
547
548 /* Read TXSTMP registers to discard any timestamp previously stored. */
549 rd32(IGC_TXSTMPL);
550 rd32(IGC_TXSTMPH);
551 }
552
553 /**
554 * igc_ptp_set_timestamp_mode - setup hardware for timestamping
555 * @adapter: networking device structure
556 * @config: hwtstamp configuration
557 *
558 * Return: 0 in case of success, negative errno code otherwise.
559 */
igc_ptp_set_timestamp_mode(struct igc_adapter * adapter,struct hwtstamp_config * config)560 static int igc_ptp_set_timestamp_mode(struct igc_adapter *adapter,
561 struct hwtstamp_config *config)
562 {
563 /* reserved for future extensions */
564 if (config->flags)
565 return -EINVAL;
566
567 switch (config->tx_type) {
568 case HWTSTAMP_TX_OFF:
569 igc_ptp_disable_tx_timestamp(adapter);
570 break;
571 case HWTSTAMP_TX_ON:
572 igc_ptp_enable_tx_timestamp(adapter);
573 break;
574 default:
575 return -ERANGE;
576 }
577
578 switch (config->rx_filter) {
579 case HWTSTAMP_FILTER_NONE:
580 igc_ptp_disable_rx_timestamp(adapter);
581 break;
582 case HWTSTAMP_FILTER_PTP_V1_L4_SYNC:
583 case HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ:
584 case HWTSTAMP_FILTER_PTP_V2_EVENT:
585 case HWTSTAMP_FILTER_PTP_V2_L2_EVENT:
586 case HWTSTAMP_FILTER_PTP_V2_L4_EVENT:
587 case HWTSTAMP_FILTER_PTP_V2_SYNC:
588 case HWTSTAMP_FILTER_PTP_V2_L2_SYNC:
589 case HWTSTAMP_FILTER_PTP_V2_L4_SYNC:
590 case HWTSTAMP_FILTER_PTP_V2_DELAY_REQ:
591 case HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ:
592 case HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ:
593 case HWTSTAMP_FILTER_PTP_V1_L4_EVENT:
594 case HWTSTAMP_FILTER_NTP_ALL:
595 case HWTSTAMP_FILTER_ALL:
596 igc_ptp_enable_rx_timestamp(adapter);
597 config->rx_filter = HWTSTAMP_FILTER_ALL;
598 break;
599 default:
600 return -ERANGE;
601 }
602
603 return 0;
604 }
605
igc_ptp_tx_timeout(struct igc_adapter * adapter)606 static void igc_ptp_tx_timeout(struct igc_adapter *adapter)
607 {
608 struct igc_hw *hw = &adapter->hw;
609
610 dev_kfree_skb_any(adapter->ptp_tx_skb);
611 adapter->ptp_tx_skb = NULL;
612 adapter->tx_hwtstamp_timeouts++;
613 clear_bit_unlock(__IGC_PTP_TX_IN_PROGRESS, &adapter->state);
614 /* Clear the tx valid bit in TSYNCTXCTL register to enable interrupt. */
615 rd32(IGC_TXSTMPH);
616 netdev_warn(adapter->netdev, "Tx timestamp timeout\n");
617 }
618
igc_ptp_tx_hang(struct igc_adapter * adapter)619 void igc_ptp_tx_hang(struct igc_adapter *adapter)
620 {
621 bool timeout = time_is_before_jiffies(adapter->ptp_tx_start +
622 IGC_PTP_TX_TIMEOUT);
623
624 if (!test_bit(__IGC_PTP_TX_IN_PROGRESS, &adapter->state))
625 return;
626
627 /* If we haven't received a timestamp within the timeout, it is
628 * reasonable to assume that it will never occur, so we can unlock the
629 * timestamp bit when this occurs.
630 */
631 if (timeout) {
632 cancel_work_sync(&adapter->ptp_tx_work);
633 igc_ptp_tx_timeout(adapter);
634 }
635 }
636
637 /**
638 * igc_ptp_tx_hwtstamp - utility function which checks for TX time stamp
639 * @adapter: Board private structure
640 *
641 * If we were asked to do hardware stamping and such a time stamp is
642 * available, then it must have been for this skb here because we only
643 * allow only one such packet into the queue.
644 */
igc_ptp_tx_hwtstamp(struct igc_adapter * adapter)645 static void igc_ptp_tx_hwtstamp(struct igc_adapter *adapter)
646 {
647 struct sk_buff *skb = adapter->ptp_tx_skb;
648 struct skb_shared_hwtstamps shhwtstamps;
649 struct igc_hw *hw = &adapter->hw;
650 int adjust = 0;
651 u64 regval;
652
653 if (WARN_ON_ONCE(!skb))
654 return;
655
656 regval = rd32(IGC_TXSTMPL);
657 regval |= (u64)rd32(IGC_TXSTMPH) << 32;
658 igc_ptp_systim_to_hwtstamp(adapter, &shhwtstamps, regval);
659
660 switch (adapter->link_speed) {
661 case SPEED_10:
662 adjust = IGC_I225_TX_LATENCY_10;
663 break;
664 case SPEED_100:
665 adjust = IGC_I225_TX_LATENCY_100;
666 break;
667 case SPEED_1000:
668 adjust = IGC_I225_TX_LATENCY_1000;
669 break;
670 case SPEED_2500:
671 adjust = IGC_I225_TX_LATENCY_2500;
672 break;
673 }
674
675 shhwtstamps.hwtstamp =
676 ktime_add_ns(shhwtstamps.hwtstamp, adjust);
677
678 /* Clear the lock early before calling skb_tstamp_tx so that
679 * applications are not woken up before the lock bit is clear. We use
680 * a copy of the skb pointer to ensure other threads can't change it
681 * while we're notifying the stack.
682 */
683 adapter->ptp_tx_skb = NULL;
684 clear_bit_unlock(__IGC_PTP_TX_IN_PROGRESS, &adapter->state);
685
686 /* Notify the stack and free the skb after we've unlocked */
687 skb_tstamp_tx(skb, &shhwtstamps);
688 dev_kfree_skb_any(skb);
689 }
690
691 /**
692 * igc_ptp_tx_work
693 * @work: pointer to work struct
694 *
695 * This work function polls the TSYNCTXCTL valid bit to determine when a
696 * timestamp has been taken for the current stored skb.
697 */
igc_ptp_tx_work(struct work_struct * work)698 static void igc_ptp_tx_work(struct work_struct *work)
699 {
700 struct igc_adapter *adapter = container_of(work, struct igc_adapter,
701 ptp_tx_work);
702 struct igc_hw *hw = &adapter->hw;
703 u32 tsynctxctl;
704
705 if (!test_bit(__IGC_PTP_TX_IN_PROGRESS, &adapter->state))
706 return;
707
708 tsynctxctl = rd32(IGC_TSYNCTXCTL);
709 if (WARN_ON_ONCE(!(tsynctxctl & IGC_TSYNCTXCTL_TXTT_0)))
710 return;
711
712 igc_ptp_tx_hwtstamp(adapter);
713 }
714
715 /**
716 * igc_ptp_set_ts_config - set hardware time stamping config
717 * @netdev: network interface device structure
718 * @ifr: interface request data
719 *
720 **/
igc_ptp_set_ts_config(struct net_device * netdev,struct ifreq * ifr)721 int igc_ptp_set_ts_config(struct net_device *netdev, struct ifreq *ifr)
722 {
723 struct igc_adapter *adapter = netdev_priv(netdev);
724 struct hwtstamp_config config;
725 int err;
726
727 if (copy_from_user(&config, ifr->ifr_data, sizeof(config)))
728 return -EFAULT;
729
730 err = igc_ptp_set_timestamp_mode(adapter, &config);
731 if (err)
732 return err;
733
734 /* save these settings for future reference */
735 memcpy(&adapter->tstamp_config, &config,
736 sizeof(adapter->tstamp_config));
737
738 return copy_to_user(ifr->ifr_data, &config, sizeof(config)) ?
739 -EFAULT : 0;
740 }
741
742 /**
743 * igc_ptp_get_ts_config - get hardware time stamping config
744 * @netdev: network interface device structure
745 * @ifr: interface request data
746 *
747 * Get the hwtstamp_config settings to return to the user. Rather than attempt
748 * to deconstruct the settings from the registers, just return a shadow copy
749 * of the last known settings.
750 **/
igc_ptp_get_ts_config(struct net_device * netdev,struct ifreq * ifr)751 int igc_ptp_get_ts_config(struct net_device *netdev, struct ifreq *ifr)
752 {
753 struct igc_adapter *adapter = netdev_priv(netdev);
754 struct hwtstamp_config *config = &adapter->tstamp_config;
755
756 return copy_to_user(ifr->ifr_data, config, sizeof(*config)) ?
757 -EFAULT : 0;
758 }
759
760 /* The two conditions below must be met for cross timestamping via
761 * PCIe PTM:
762 *
763 * 1. We have an way to convert the timestamps in the PTM messages
764 * to something related to the system clocks (right now, only
765 * X86 systems with support for the Always Running Timer allow that);
766 *
767 * 2. We have PTM enabled in the path from the device to the PCIe root port.
768 */
igc_is_crosststamp_supported(struct igc_adapter * adapter)769 static bool igc_is_crosststamp_supported(struct igc_adapter *adapter)
770 {
771 if (!IS_ENABLED(CONFIG_X86_TSC))
772 return false;
773
774 /* FIXME: it was noticed that enabling support for PCIe PTM in
775 * some i225-V models could cause lockups when bringing the
776 * interface up/down. There should be no downsides to
777 * disabling crosstimestamping support for i225-V, as it
778 * doesn't have any PTP support. That way we gain some time
779 * while root causing the issue.
780 */
781 if (adapter->pdev->device == IGC_DEV_ID_I225_V)
782 return false;
783
784 return pcie_ptm_enabled(adapter->pdev);
785 }
786
igc_device_tstamp_to_system(u64 tstamp)787 static struct system_counterval_t igc_device_tstamp_to_system(u64 tstamp)
788 {
789 #if IS_ENABLED(CONFIG_X86_TSC) && !defined(CONFIG_UML)
790 return convert_art_ns_to_tsc(tstamp);
791 #else
792 return (struct system_counterval_t) { };
793 #endif
794 }
795
igc_ptm_log_error(struct igc_adapter * adapter,u32 ptm_stat)796 static void igc_ptm_log_error(struct igc_adapter *adapter, u32 ptm_stat)
797 {
798 struct net_device *netdev = adapter->netdev;
799
800 switch (ptm_stat) {
801 case IGC_PTM_STAT_RET_ERR:
802 netdev_err(netdev, "PTM Error: Root port timeout\n");
803 break;
804 case IGC_PTM_STAT_BAD_PTM_RES:
805 netdev_err(netdev, "PTM Error: Bad response, PTM Response Data expected\n");
806 break;
807 case IGC_PTM_STAT_T4M1_OVFL:
808 netdev_err(netdev, "PTM Error: T4 minus T1 overflow\n");
809 break;
810 case IGC_PTM_STAT_ADJUST_1ST:
811 netdev_err(netdev, "PTM Error: 1588 timer adjusted during first PTM cycle\n");
812 break;
813 case IGC_PTM_STAT_ADJUST_CYC:
814 netdev_err(netdev, "PTM Error: 1588 timer adjusted during non-first PTM cycle\n");
815 break;
816 default:
817 netdev_err(netdev, "PTM Error: Unknown error (%#x)\n", ptm_stat);
818 break;
819 }
820 }
821
igc_phc_get_syncdevicetime(ktime_t * device,struct system_counterval_t * system,void * ctx)822 static int igc_phc_get_syncdevicetime(ktime_t *device,
823 struct system_counterval_t *system,
824 void *ctx)
825 {
826 u32 stat, t2_curr_h, t2_curr_l, ctrl;
827 struct igc_adapter *adapter = ctx;
828 struct igc_hw *hw = &adapter->hw;
829 int err, count = 100;
830 ktime_t t1, t2_curr;
831
832 /* Get a snapshot of system clocks to use as historic value. */
833 ktime_get_snapshot(&adapter->snapshot);
834
835 do {
836 /* Doing this in a loop because in the event of a
837 * badly timed (ha!) system clock adjustment, we may
838 * get PTM errors from the PCI root, but these errors
839 * are transitory. Repeating the process returns valid
840 * data eventually.
841 */
842
843 /* To "manually" start the PTM cycle we need to clear and
844 * then set again the TRIG bit.
845 */
846 ctrl = rd32(IGC_PTM_CTRL);
847 ctrl &= ~IGC_PTM_CTRL_TRIG;
848 wr32(IGC_PTM_CTRL, ctrl);
849 ctrl |= IGC_PTM_CTRL_TRIG;
850 wr32(IGC_PTM_CTRL, ctrl);
851
852 /* The cycle only starts "for real" when software notifies
853 * that it has read the registers, this is done by setting
854 * VALID bit.
855 */
856 wr32(IGC_PTM_STAT, IGC_PTM_STAT_VALID);
857
858 err = readx_poll_timeout(rd32, IGC_PTM_STAT, stat,
859 stat, IGC_PTM_STAT_SLEEP,
860 IGC_PTM_STAT_TIMEOUT);
861 if (err < 0) {
862 netdev_err(adapter->netdev, "Timeout reading IGC_PTM_STAT register\n");
863 return err;
864 }
865
866 if ((stat & IGC_PTM_STAT_VALID) == IGC_PTM_STAT_VALID)
867 break;
868
869 if (stat & ~IGC_PTM_STAT_VALID) {
870 /* An error occurred, log it. */
871 igc_ptm_log_error(adapter, stat);
872 /* The STAT register is write-1-to-clear (W1C),
873 * so write the previous error status to clear it.
874 */
875 wr32(IGC_PTM_STAT, stat);
876 continue;
877 }
878 } while (--count);
879
880 if (!count) {
881 netdev_err(adapter->netdev, "Exceeded number of tries for PTM cycle\n");
882 return -ETIMEDOUT;
883 }
884
885 t1 = ktime_set(rd32(IGC_PTM_T1_TIM0_H), rd32(IGC_PTM_T1_TIM0_L));
886
887 t2_curr_l = rd32(IGC_PTM_CURR_T2_L);
888 t2_curr_h = rd32(IGC_PTM_CURR_T2_H);
889
890 /* FIXME: When the register that tells the endianness of the
891 * PTM registers are implemented, check them here and add the
892 * appropriate conversion.
893 */
894 t2_curr_h = swab32(t2_curr_h);
895
896 t2_curr = ((s64)t2_curr_h << 32 | t2_curr_l);
897
898 *device = t1;
899 *system = igc_device_tstamp_to_system(t2_curr);
900
901 return 0;
902 }
903
igc_ptp_getcrosststamp(struct ptp_clock_info * ptp,struct system_device_crosststamp * cts)904 static int igc_ptp_getcrosststamp(struct ptp_clock_info *ptp,
905 struct system_device_crosststamp *cts)
906 {
907 struct igc_adapter *adapter = container_of(ptp, struct igc_adapter,
908 ptp_caps);
909
910 return get_device_system_crosststamp(igc_phc_get_syncdevicetime,
911 adapter, &adapter->snapshot, cts);
912 }
913
914 /**
915 * igc_ptp_init - Initialize PTP functionality
916 * @adapter: Board private structure
917 *
918 * This function is called at device probe to initialize the PTP
919 * functionality.
920 */
igc_ptp_init(struct igc_adapter * adapter)921 void igc_ptp_init(struct igc_adapter *adapter)
922 {
923 struct net_device *netdev = adapter->netdev;
924 struct igc_hw *hw = &adapter->hw;
925 int i;
926
927 switch (hw->mac.type) {
928 case igc_i225:
929 for (i = 0; i < IGC_N_SDP; i++) {
930 struct ptp_pin_desc *ppd = &adapter->sdp_config[i];
931
932 snprintf(ppd->name, sizeof(ppd->name), "SDP%d", i);
933 ppd->index = i;
934 ppd->func = PTP_PF_NONE;
935 }
936 snprintf(adapter->ptp_caps.name, 16, "%pm", netdev->dev_addr);
937 adapter->ptp_caps.owner = THIS_MODULE;
938 adapter->ptp_caps.max_adj = 62499999;
939 adapter->ptp_caps.adjfine = igc_ptp_adjfine_i225;
940 adapter->ptp_caps.adjtime = igc_ptp_adjtime_i225;
941 adapter->ptp_caps.gettimex64 = igc_ptp_gettimex64_i225;
942 adapter->ptp_caps.settime64 = igc_ptp_settime_i225;
943 adapter->ptp_caps.enable = igc_ptp_feature_enable_i225;
944 adapter->ptp_caps.pps = 1;
945 adapter->ptp_caps.pin_config = adapter->sdp_config;
946 adapter->ptp_caps.n_ext_ts = IGC_N_EXTTS;
947 adapter->ptp_caps.n_per_out = IGC_N_PEROUT;
948 adapter->ptp_caps.n_pins = IGC_N_SDP;
949 adapter->ptp_caps.verify = igc_ptp_verify_pin;
950
951 if (!igc_is_crosststamp_supported(adapter))
952 break;
953
954 adapter->ptp_caps.getcrosststamp = igc_ptp_getcrosststamp;
955 break;
956 default:
957 adapter->ptp_clock = NULL;
958 return;
959 }
960
961 spin_lock_init(&adapter->tmreg_lock);
962 INIT_WORK(&adapter->ptp_tx_work, igc_ptp_tx_work);
963
964 adapter->tstamp_config.rx_filter = HWTSTAMP_FILTER_NONE;
965 adapter->tstamp_config.tx_type = HWTSTAMP_TX_OFF;
966
967 adapter->prev_ptp_time = ktime_to_timespec64(ktime_get_real());
968 adapter->ptp_reset_start = ktime_get();
969
970 adapter->ptp_clock = ptp_clock_register(&adapter->ptp_caps,
971 &adapter->pdev->dev);
972 if (IS_ERR(adapter->ptp_clock)) {
973 adapter->ptp_clock = NULL;
974 netdev_err(netdev, "ptp_clock_register failed\n");
975 } else if (adapter->ptp_clock) {
976 netdev_info(netdev, "PHC added\n");
977 adapter->ptp_flags |= IGC_PTP_ENABLED;
978 }
979 }
980
igc_ptp_time_save(struct igc_adapter * adapter)981 static void igc_ptp_time_save(struct igc_adapter *adapter)
982 {
983 igc_ptp_read(adapter, &adapter->prev_ptp_time);
984 adapter->ptp_reset_start = ktime_get();
985 }
986
igc_ptp_time_restore(struct igc_adapter * adapter)987 static void igc_ptp_time_restore(struct igc_adapter *adapter)
988 {
989 struct timespec64 ts = adapter->prev_ptp_time;
990 ktime_t delta;
991
992 delta = ktime_sub(ktime_get(), adapter->ptp_reset_start);
993
994 timespec64_add_ns(&ts, ktime_to_ns(delta));
995
996 igc_ptp_write_i225(adapter, &ts);
997 }
998
999 /**
1000 * igc_ptp_suspend - Disable PTP work items and prepare for suspend
1001 * @adapter: Board private structure
1002 *
1003 * This function stops the overflow check work and PTP Tx timestamp work, and
1004 * will prepare the device for OS suspend.
1005 */
igc_ptp_suspend(struct igc_adapter * adapter)1006 void igc_ptp_suspend(struct igc_adapter *adapter)
1007 {
1008 if (!(adapter->ptp_flags & IGC_PTP_ENABLED))
1009 return;
1010
1011 cancel_work_sync(&adapter->ptp_tx_work);
1012 dev_kfree_skb_any(adapter->ptp_tx_skb);
1013 adapter->ptp_tx_skb = NULL;
1014 clear_bit_unlock(__IGC_PTP_TX_IN_PROGRESS, &adapter->state);
1015
1016 if (pci_device_is_present(adapter->pdev))
1017 igc_ptp_time_save(adapter);
1018 }
1019
1020 /**
1021 * igc_ptp_stop - Disable PTP device and stop the overflow check.
1022 * @adapter: Board private structure.
1023 *
1024 * This function stops the PTP support and cancels the delayed work.
1025 **/
igc_ptp_stop(struct igc_adapter * adapter)1026 void igc_ptp_stop(struct igc_adapter *adapter)
1027 {
1028 igc_ptp_suspend(adapter);
1029
1030 if (adapter->ptp_clock) {
1031 ptp_clock_unregister(adapter->ptp_clock);
1032 netdev_info(adapter->netdev, "PHC removed\n");
1033 adapter->ptp_flags &= ~IGC_PTP_ENABLED;
1034 }
1035 }
1036
1037 /**
1038 * igc_ptp_reset - Re-enable the adapter for PTP following a reset.
1039 * @adapter: Board private structure.
1040 *
1041 * This function handles the reset work required to re-enable the PTP device.
1042 **/
igc_ptp_reset(struct igc_adapter * adapter)1043 void igc_ptp_reset(struct igc_adapter *adapter)
1044 {
1045 struct igc_hw *hw = &adapter->hw;
1046 u32 cycle_ctrl, ctrl;
1047 unsigned long flags;
1048 u32 timadj;
1049
1050 /* reset the tstamp_config */
1051 igc_ptp_set_timestamp_mode(adapter, &adapter->tstamp_config);
1052
1053 spin_lock_irqsave(&adapter->tmreg_lock, flags);
1054
1055 switch (adapter->hw.mac.type) {
1056 case igc_i225:
1057 timadj = rd32(IGC_TIMADJ);
1058 timadj |= IGC_TIMADJ_ADJUST_METH;
1059 wr32(IGC_TIMADJ, timadj);
1060
1061 wr32(IGC_TSAUXC, 0x0);
1062 wr32(IGC_TSSDP, 0x0);
1063 wr32(IGC_TSIM,
1064 IGC_TSICR_INTERRUPTS |
1065 (adapter->pps_sys_wrap_on ? IGC_TSICR_SYS_WRAP : 0));
1066 wr32(IGC_IMS, IGC_IMS_TS);
1067
1068 if (!igc_is_crosststamp_supported(adapter))
1069 break;
1070
1071 wr32(IGC_PCIE_DIG_DELAY, IGC_PCIE_DIG_DELAY_DEFAULT);
1072 wr32(IGC_PCIE_PHY_DELAY, IGC_PCIE_PHY_DELAY_DEFAULT);
1073
1074 cycle_ctrl = IGC_PTM_CYCLE_CTRL_CYC_TIME(IGC_PTM_CYC_TIME_DEFAULT);
1075
1076 wr32(IGC_PTM_CYCLE_CTRL, cycle_ctrl);
1077
1078 ctrl = IGC_PTM_CTRL_EN |
1079 IGC_PTM_CTRL_START_NOW |
1080 IGC_PTM_CTRL_SHRT_CYC(IGC_PTM_SHORT_CYC_DEFAULT) |
1081 IGC_PTM_CTRL_PTM_TO(IGC_PTM_TIMEOUT_DEFAULT) |
1082 IGC_PTM_CTRL_TRIG;
1083
1084 wr32(IGC_PTM_CTRL, ctrl);
1085
1086 /* Force the first cycle to run. */
1087 wr32(IGC_PTM_STAT, IGC_PTM_STAT_VALID);
1088
1089 break;
1090 default:
1091 /* No work to do. */
1092 goto out;
1093 }
1094
1095 /* Re-initialize the timer. */
1096 if (hw->mac.type == igc_i225) {
1097 igc_ptp_time_restore(adapter);
1098 } else {
1099 timecounter_init(&adapter->tc, &adapter->cc,
1100 ktime_to_ns(ktime_get_real()));
1101 }
1102 out:
1103 spin_unlock_irqrestore(&adapter->tmreg_lock, flags);
1104
1105 wrfl();
1106 }
1107