1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright(c) 2017 - 2021 Pensando Systems, Inc */
4 #include <linux/netdevice.h>
5 #include <linux/etherdevice.h>
10 #include "ionic_ethtool.h"
12 static int ionic_hwstamp_tx_mode(int config_tx_type)
14 switch (config_tx_type) {
16 return IONIC_TXSTAMP_OFF;
18 return IONIC_TXSTAMP_ON;
19 case HWTSTAMP_TX_ONESTEP_SYNC:
20 return IONIC_TXSTAMP_ONESTEP_SYNC;
21 case HWTSTAMP_TX_ONESTEP_P2P:
22 return IONIC_TXSTAMP_ONESTEP_P2P;
28 static u64 ionic_hwstamp_rx_filt(int config_rx_filter)
30 switch (config_rx_filter) {
31 case HWTSTAMP_FILTER_PTP_V1_L4_EVENT:
32 return IONIC_PKT_CLS_PTP1_ALL;
33 case HWTSTAMP_FILTER_PTP_V1_L4_SYNC:
34 return IONIC_PKT_CLS_PTP1_SYNC;
35 case HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ:
36 return IONIC_PKT_CLS_PTP1_SYNC | IONIC_PKT_CLS_PTP1_DREQ;
38 case HWTSTAMP_FILTER_PTP_V2_L4_EVENT:
39 return IONIC_PKT_CLS_PTP2_L4_ALL;
40 case HWTSTAMP_FILTER_PTP_V2_L4_SYNC:
41 return IONIC_PKT_CLS_PTP2_L4_SYNC;
42 case HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ:
43 return IONIC_PKT_CLS_PTP2_L4_SYNC | IONIC_PKT_CLS_PTP2_L4_DREQ;
45 case HWTSTAMP_FILTER_PTP_V2_L2_EVENT:
46 return IONIC_PKT_CLS_PTP2_L2_ALL;
47 case HWTSTAMP_FILTER_PTP_V2_L2_SYNC:
48 return IONIC_PKT_CLS_PTP2_L2_SYNC;
49 case HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ:
50 return IONIC_PKT_CLS_PTP2_L2_SYNC | IONIC_PKT_CLS_PTP2_L2_DREQ;
52 case HWTSTAMP_FILTER_PTP_V2_EVENT:
53 return IONIC_PKT_CLS_PTP2_ALL;
54 case HWTSTAMP_FILTER_PTP_V2_SYNC:
55 return IONIC_PKT_CLS_PTP2_SYNC;
56 case HWTSTAMP_FILTER_PTP_V2_DELAY_REQ:
57 return IONIC_PKT_CLS_PTP2_SYNC | IONIC_PKT_CLS_PTP2_DREQ;
59 case HWTSTAMP_FILTER_NTP_ALL:
60 return IONIC_PKT_CLS_NTP_ALL;
67 static int ionic_lif_hwstamp_set_ts_config(struct ionic_lif *lif,
68 struct hwtstamp_config *new_ts)
70 struct ionic *ionic = lif->ionic;
71 struct hwtstamp_config *config;
72 struct hwtstamp_config ts;
79 if (!lif->phc || !lif->phc->ptp)
82 mutex_lock(&lif->phc->config_lock);
87 /* If called with new_ts == NULL, replay the previous request
88 * primarily for recovery after a FW_RESET.
89 * We saved the previous configuration request info, so copy
90 * the previous request for reference, clear the current state
91 * to match the device's reset state, and run with it.
94 memcpy(config, &lif->phc->ts_config, sizeof(*config));
95 memset(&lif->phc->ts_config, 0, sizeof(lif->phc->ts_config));
96 lif->phc->ts_config_tx_mode = 0;
97 lif->phc->ts_config_rx_filt = 0;
100 tx_mode = ionic_hwstamp_tx_mode(config->tx_type);
106 mask = cpu_to_le64(BIT_ULL(tx_mode));
107 if ((ionic->ident.lif.eth.hwstamp_tx_modes & mask) != mask) {
112 rx_filt = ionic_hwstamp_rx_filt(config->rx_filter);
113 rx_all = config->rx_filter != HWTSTAMP_FILTER_NONE && !rx_filt;
115 mask = cpu_to_le64(rx_filt);
116 if ((ionic->ident.lif.eth.hwstamp_rx_filters & mask) != mask) {
119 config->rx_filter = HWTSTAMP_FILTER_ALL;
122 dev_dbg(ionic->dev, "config_rx_filter %d rx_filt %#llx rx_all %d\n",
123 config->rx_filter, rx_filt, rx_all);
126 err = ionic_lif_create_hwstamp_txq(lif);
132 err = ionic_lif_create_hwstamp_rxq(lif);
137 if (tx_mode != lif->phc->ts_config_tx_mode) {
138 err = ionic_lif_set_hwstamp_txmode(lif, tx_mode);
143 if (rx_filt != lif->phc->ts_config_rx_filt) {
144 err = ionic_lif_set_hwstamp_rxfilt(lif, rx_filt);
149 if (rx_all != (lif->phc->ts_config.rx_filter == HWTSTAMP_FILTER_ALL)) {
150 err = ionic_lif_config_hwstamp_rxq_all(lif, rx_all);
155 memcpy(&lif->phc->ts_config, config, sizeof(*config));
156 lif->phc->ts_config_rx_filt = rx_filt;
157 lif->phc->ts_config_tx_mode = tx_mode;
159 mutex_unlock(&lif->phc->config_lock);
164 if (rx_filt != lif->phc->ts_config_rx_filt) {
165 rx_filt = lif->phc->ts_config_rx_filt;
166 err2 = ionic_lif_set_hwstamp_rxfilt(lif, rx_filt);
169 "Failed to revert rx timestamp filter: %d\n", err2);
172 if (tx_mode != lif->phc->ts_config_tx_mode) {
173 tx_mode = lif->phc->ts_config_tx_mode;
174 err2 = ionic_lif_set_hwstamp_txmode(lif, tx_mode);
177 "Failed to revert tx timestamp mode: %d\n", err2);
180 /* special queues remain allocated, just unused */
182 mutex_unlock(&lif->phc->config_lock);
186 int ionic_lif_hwstamp_set(struct ionic_lif *lif, struct ifreq *ifr)
188 struct hwtstamp_config config;
191 if (!lif->phc || !lif->phc->ptp)
194 if (copy_from_user(&config, ifr->ifr_data, sizeof(config)))
197 err = ionic_lif_hwstamp_set_ts_config(lif, &config);
199 netdev_info(lif->netdev, "hwstamp set failed: %d\n", err);
203 if (copy_to_user(ifr->ifr_data, &config, sizeof(config)))
209 void ionic_lif_hwstamp_replay(struct ionic_lif *lif)
213 if (!lif->phc || !lif->phc->ptp)
216 err = ionic_lif_hwstamp_set_ts_config(lif, NULL);
218 netdev_info(lif->netdev, "hwstamp replay failed: %d\n", err);
221 int ionic_lif_hwstamp_get(struct ionic_lif *lif, struct ifreq *ifr)
223 struct hwtstamp_config config;
225 if (!lif->phc || !lif->phc->ptp)
228 mutex_lock(&lif->phc->config_lock);
229 memcpy(&config, &lif->phc->ts_config, sizeof(config));
230 mutex_unlock(&lif->phc->config_lock);
232 if (copy_to_user(ifr->ifr_data, &config, sizeof(config)))
237 static u64 ionic_hwstamp_read(struct ionic *ionic,
238 struct ptp_system_timestamp *sts)
240 u32 tick_high_before, tick_high, tick_low;
242 /* read and discard low part to defeat hw staging of high part */
243 (void)ioread32(&ionic->idev.hwstamp_regs->tick_low);
245 tick_high_before = ioread32(&ionic->idev.hwstamp_regs->tick_high);
247 ptp_read_system_prets(sts);
248 tick_low = ioread32(&ionic->idev.hwstamp_regs->tick_low);
249 ptp_read_system_postts(sts);
251 tick_high = ioread32(&ionic->idev.hwstamp_regs->tick_high);
253 /* If tick_high changed, re-read tick_low once more. Assume tick_high
254 * cannot change again so soon as in the span of re-reading tick_low.
256 if (tick_high != tick_high_before) {
257 ptp_read_system_prets(sts);
258 tick_low = ioread32(&ionic->idev.hwstamp_regs->tick_low);
259 ptp_read_system_postts(sts);
262 return (u64)tick_low | ((u64)tick_high << 32);
265 static u64 ionic_cc_read(const struct cyclecounter *cc)
267 struct ionic_phc *phc = container_of(cc, struct ionic_phc, cc);
268 struct ionic *ionic = phc->lif->ionic;
270 return ionic_hwstamp_read(ionic, NULL);
273 static int ionic_setphc_cmd(struct ionic_phc *phc, struct ionic_admin_ctx *ctx)
275 ctx->work = COMPLETION_INITIALIZER_ONSTACK(ctx->work);
277 ctx->cmd.lif_setphc.opcode = IONIC_CMD_LIF_SETPHC;
278 ctx->cmd.lif_setphc.lif_index = cpu_to_le16(phc->lif->index);
280 ctx->cmd.lif_setphc.tick = cpu_to_le64(phc->tc.cycle_last);
281 ctx->cmd.lif_setphc.nsec = cpu_to_le64(phc->tc.nsec);
282 ctx->cmd.lif_setphc.frac = cpu_to_le64(phc->tc.frac);
283 ctx->cmd.lif_setphc.mult = cpu_to_le32(phc->cc.mult);
284 ctx->cmd.lif_setphc.shift = cpu_to_le32(phc->cc.shift);
286 return ionic_adminq_post(phc->lif, ctx);
289 static int ionic_phc_adjfine(struct ptp_clock_info *info, long scaled_ppm)
291 struct ionic_phc *phc = container_of(info, struct ionic_phc, ptp_info);
292 struct ionic_admin_ctx ctx = {};
293 unsigned long irqflags;
297 /* Reject phc adjustments during device upgrade */
298 if (test_bit(IONIC_LIF_F_FW_RESET, phc->lif->state))
301 /* Adjustment value scaled by 2^16 million */
302 adj = (s64)scaled_ppm * phc->init_cc_mult;
304 /* Adjustment value to scale */
305 adj /= (s64)SCALED_PPM;
307 /* Final adjusted multiplier */
308 adj += phc->init_cc_mult;
310 spin_lock_irqsave(&phc->lock, irqflags);
312 /* update the point-in-time basis to now, before adjusting the rate */
313 timecounter_read(&phc->tc);
316 /* Setphc commands are posted in-order, sequenced by phc->lock. We
317 * need to drop the lock before waiting for the command to complete.
319 err = ionic_setphc_cmd(phc, &ctx);
321 spin_unlock_irqrestore(&phc->lock, irqflags);
323 return ionic_adminq_wait(phc->lif, &ctx, err);
326 static int ionic_phc_adjtime(struct ptp_clock_info *info, s64 delta)
328 struct ionic_phc *phc = container_of(info, struct ionic_phc, ptp_info);
329 struct ionic_admin_ctx ctx = {};
330 unsigned long irqflags;
333 /* Reject phc adjustments during device upgrade */
334 if (test_bit(IONIC_LIF_F_FW_RESET, phc->lif->state))
337 spin_lock_irqsave(&phc->lock, irqflags);
339 timecounter_adjtime(&phc->tc, delta);
341 /* Setphc commands are posted in-order, sequenced by phc->lock. We
342 * need to drop the lock before waiting for the command to complete.
344 err = ionic_setphc_cmd(phc, &ctx);
346 spin_unlock_irqrestore(&phc->lock, irqflags);
348 return ionic_adminq_wait(phc->lif, &ctx, err);
351 static int ionic_phc_settime64(struct ptp_clock_info *info,
352 const struct timespec64 *ts)
354 struct ionic_phc *phc = container_of(info, struct ionic_phc, ptp_info);
355 struct ionic_admin_ctx ctx = {};
356 unsigned long irqflags;
360 /* Reject phc adjustments during device upgrade */
361 if (test_bit(IONIC_LIF_F_FW_RESET, phc->lif->state))
364 ns = timespec64_to_ns(ts);
366 spin_lock_irqsave(&phc->lock, irqflags);
368 timecounter_init(&phc->tc, &phc->cc, ns);
370 /* Setphc commands are posted in-order, sequenced by phc->lock. We
371 * need to drop the lock before waiting for the command to complete.
373 err = ionic_setphc_cmd(phc, &ctx);
375 spin_unlock_irqrestore(&phc->lock, irqflags);
377 return ionic_adminq_wait(phc->lif, &ctx, err);
380 static int ionic_phc_gettimex64(struct ptp_clock_info *info,
381 struct timespec64 *ts,
382 struct ptp_system_timestamp *sts)
384 struct ionic_phc *phc = container_of(info, struct ionic_phc, ptp_info);
385 struct ionic *ionic = phc->lif->ionic;
386 unsigned long irqflags;
389 /* Do not attempt to read device time during upgrade */
390 if (test_bit(IONIC_LIF_F_FW_RESET, phc->lif->state))
393 spin_lock_irqsave(&phc->lock, irqflags);
395 tick = ionic_hwstamp_read(ionic, sts);
397 ns = timecounter_cyc2time(&phc->tc, tick);
399 spin_unlock_irqrestore(&phc->lock, irqflags);
401 *ts = ns_to_timespec64(ns);
406 static long ionic_phc_aux_work(struct ptp_clock_info *info)
408 struct ionic_phc *phc = container_of(info, struct ionic_phc, ptp_info);
409 struct ionic_admin_ctx ctx = {};
410 unsigned long irqflags;
413 /* Do not update phc during device upgrade, but keep polling to resume
414 * after upgrade. Since we don't update the point in time basis, there
415 * is no expectation that we are maintaining the phc time during the
416 * upgrade. After upgrade, it will need to be readjusted back to the
417 * correct time by the ptp daemon.
419 if (test_bit(IONIC_LIF_F_FW_RESET, phc->lif->state))
420 return phc->aux_work_delay;
422 spin_lock_irqsave(&phc->lock, irqflags);
424 /* update point-in-time basis to now */
425 timecounter_read(&phc->tc);
427 /* Setphc commands are posted in-order, sequenced by phc->lock. We
428 * need to drop the lock before waiting for the command to complete.
430 err = ionic_setphc_cmd(phc, &ctx);
432 spin_unlock_irqrestore(&phc->lock, irqflags);
434 ionic_adminq_wait(phc->lif, &ctx, err);
436 return phc->aux_work_delay;
439 ktime_t ionic_lif_phc_ktime(struct ionic_lif *lif, u64 tick)
441 unsigned long irqflags;
447 spin_lock_irqsave(&lif->phc->lock, irqflags);
448 ns = timecounter_cyc2time(&lif->phc->tc, tick);
449 spin_unlock_irqrestore(&lif->phc->lock, irqflags);
451 return ns_to_ktime(ns);
454 static const struct ptp_clock_info ionic_ptp_info = {
455 .owner = THIS_MODULE,
457 .adjfine = ionic_phc_adjfine,
458 .adjtime = ionic_phc_adjtime,
459 .gettimex64 = ionic_phc_gettimex64,
460 .settime64 = ionic_phc_settime64,
461 .do_aux_work = ionic_phc_aux_work,
464 void ionic_lif_register_phc(struct ionic_lif *lif)
466 if (!lif->phc || !(lif->hw_features & IONIC_ETH_HW_TIMESTAMP))
469 lif->phc->ptp = ptp_clock_register(&lif->phc->ptp_info, lif->ionic->dev);
471 if (IS_ERR(lif->phc->ptp)) {
472 dev_warn(lif->ionic->dev, "Cannot register phc device: %ld\n",
473 PTR_ERR(lif->phc->ptp));
475 lif->phc->ptp = NULL;
479 ptp_schedule_worker(lif->phc->ptp, lif->phc->aux_work_delay);
482 void ionic_lif_unregister_phc(struct ionic_lif *lif)
484 if (!lif->phc || !lif->phc->ptp)
487 ptp_clock_unregister(lif->phc->ptp);
489 lif->phc->ptp = NULL;
492 void ionic_lif_alloc_phc(struct ionic_lif *lif)
494 struct ionic *ionic = lif->ionic;
495 struct ionic_phc *phc;
496 u64 delay, diff, mult;
501 if (!ionic->idev.hwstamp_regs)
504 features = le64_to_cpu(ionic->ident.lif.eth.config.features);
505 if (!(features & IONIC_ETH_HW_TIMESTAMP))
508 phc = devm_kzalloc(ionic->dev, sizeof(*phc), GFP_KERNEL);
514 phc->cc.read = ionic_cc_read;
515 phc->cc.mask = le64_to_cpu(ionic->ident.dev.hwstamp_mask);
516 phc->cc.mult = le32_to_cpu(ionic->ident.dev.hwstamp_mult);
517 phc->cc.shift = le32_to_cpu(ionic->ident.dev.hwstamp_shift);
520 dev_err(lif->ionic->dev,
521 "Invalid device PHC mask multiplier %u, disabling HW timestamp support\n",
523 devm_kfree(lif->ionic->dev, phc);
528 dev_dbg(lif->ionic->dev, "Device PHC mask %#llx mult %u shift %u\n",
529 phc->cc.mask, phc->cc.mult, phc->cc.shift);
531 spin_lock_init(&phc->lock);
532 mutex_init(&phc->config_lock);
534 /* max ticks is limited by the multiplier, or by the update period. */
535 if (phc->cc.shift + 2 + ilog2(IONIC_PHC_UPDATE_NS) >= 64) {
536 /* max ticks that do not overflow when multiplied by max
537 * adjusted multiplier (twice the initial multiplier)
539 diff = U64_MAX / phc->cc.mult / 2;
541 /* approx ticks at four times the update period */
542 diff = (u64)IONIC_PHC_UPDATE_NS << (phc->cc.shift + 2);
543 diff = DIV_ROUND_UP(diff, phc->cc.mult);
546 /* transform to bitmask */
554 /* constrain to the hardware bitmask, and use this as the bitmask */
555 diff &= phc->cc.mask;
558 /* the wrap period is now defined by diff (or phc->cc.mask)
560 * we will update the time basis at about 1/4 the wrap period, so
561 * should not see a difference of more than +/- diff/4.
563 * this is sufficient not see a difference of more than +/- diff/2, as
564 * required by timecounter_cyc2time, to detect an old time stamp.
566 * adjust the initial multiplier, being careful to avoid overflow:
567 * - do not overflow 63 bits: init_cc_mult * SCALED_PPM
568 * - do not overflow 64 bits: max_mult * (diff / 2)
570 * we want to increase the initial multiplier as much as possible, to
571 * allow for more precise adjustment in ionic_phc_adjfine.
573 * only adjust the multiplier if we can double it or more.
575 mult = U64_MAX / 2 / max(diff / 2, SCALED_PPM);
576 shift = mult / phc->cc.mult;
578 /* initial multiplier will be 2^n of hardware cc.mult */
580 /* increase cc.mult and cc.shift by the same 2^n and n. */
581 phc->cc.mult <<= shift;
582 phc->cc.shift += shift;
585 dev_dbg(lif->ionic->dev, "Initial PHC mask %#llx mult %u shift %u\n",
586 phc->cc.mask, phc->cc.mult, phc->cc.shift);
588 /* frequency adjustments are relative to the initial multiplier */
589 phc->init_cc_mult = phc->cc.mult;
591 timecounter_init(&phc->tc, &phc->cc, ktime_get_real_ns());
593 /* Update cycle_last at 1/4 the wrap period, or IONIC_PHC_UPDATE_NS */
594 delay = min_t(u64, IONIC_PHC_UPDATE_NS,
595 cyclecounter_cyc2ns(&phc->cc, diff / 4, 0, &frac));
596 dev_dbg(lif->ionic->dev, "Work delay %llu ms\n", delay / NSEC_PER_MSEC);
598 phc->aux_work_delay = nsecs_to_jiffies(delay);
600 phc->ptp_info = ionic_ptp_info;
602 /* We have allowed to adjust the multiplier up to +/- 1 part per 1.
603 * Here expressed as NORMAL_PPB (1 billion parts per billion).
605 phc->ptp_info.max_adj = NORMAL_PPB;
610 void ionic_lif_free_phc(struct ionic_lif *lif)
615 mutex_destroy(&lif->phc->config_lock);
617 devm_kfree(lif->ionic->dev, lif->phc);