2 * Copyright (c) 2015, Mellanox Technologies. All rights reserved.
4 * This software is available to you under a choice of one of two
5 * licenses. You may choose to be licensed under the terms of the GNU
6 * General Public License (GPL) Version 2, available from the file
7 * COPYING in the main directory of this source tree, or the
8 * OpenIB.org BSD license below:
10 * Redistribution and use in source and binary forms, with or
11 * without modification, are permitted provided that the following
14 * - Redistributions of source code must retain the above
15 * copyright notice, this list of conditions and the following
18 * - Redistributions in binary form must reproduce the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer in the documentation and/or other materials
21 * provided with the distribution.
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33 #include <linux/clocksource.h>
34 #include <linux/highmem.h>
35 #include <linux/log2.h>
36 #include <linux/ptp_clock_kernel.h>
37 #include <rdma/mlx5-abi.h>
43 MLX5_PIN_MODE_IN = 0x0,
44 MLX5_PIN_MODE_OUT = 0x1,
48 MLX5_OUT_PATTERN_PULSE = 0x0,
49 MLX5_OUT_PATTERN_PERIODIC = 0x1,
53 MLX5_EVENT_MODE_DISABLE = 0x0,
54 MLX5_EVENT_MODE_REPETETIVE = 0x1,
55 MLX5_EVENT_MODE_ONCE_TILL_ARM = 0x2,
59 MLX5_MTPPS_FS_ENABLE = BIT(0x0),
60 MLX5_MTPPS_FS_PATTERN = BIT(0x2),
61 MLX5_MTPPS_FS_PIN_MODE = BIT(0x3),
62 MLX5_MTPPS_FS_TIME_STAMP = BIT(0x4),
63 MLX5_MTPPS_FS_OUT_PULSE_DURATION = BIT(0x5),
64 MLX5_MTPPS_FS_ENH_OUT_PER_ADJ = BIT(0x7),
65 MLX5_MTPPS_FS_NPPS_PERIOD = BIT(0x9),
66 MLX5_MTPPS_FS_OUT_PULSE_DURATION_NS = BIT(0xa),
70 MLX5_MTUTC_OPERATION_ADJUST_TIME_MIN = S16_MIN,
71 MLX5_MTUTC_OPERATION_ADJUST_TIME_MAX = S16_MAX,
72 MLX5_MTUTC_OPERATION_ADJUST_TIME_EXTENDED_MIN = -200000,
73 MLX5_MTUTC_OPERATION_ADJUST_TIME_EXTENDED_MAX = 200000,
76 static bool mlx5_real_time_mode(struct mlx5_core_dev *mdev)
78 return (mlx5_is_real_time_rq(mdev) || mlx5_is_real_time_sq(mdev));
81 static bool mlx5_npps_real_time_supported(struct mlx5_core_dev *mdev)
83 return (mlx5_real_time_mode(mdev) &&
84 MLX5_CAP_MCAM_FEATURE(mdev, npps_period) &&
85 MLX5_CAP_MCAM_FEATURE(mdev, out_pulse_duration_ns));
88 static bool mlx5_modify_mtutc_allowed(struct mlx5_core_dev *mdev)
90 return MLX5_CAP_MCAM_FEATURE(mdev, ptpcyc2realtime_modify);
93 static u32 mlx5_ptp_shift_constant(u32 dev_freq_khz)
95 /* Optimal shift constant leads to corrections above just 1 scaled ppm.
97 * Two sets of equations are needed to derive the optimal shift
98 * constant for the cyclecounter.
100 * dev_freq_khz * 1000 / 2^shift_constant = 1 scaled_ppm
101 * ppb = scaled_ppm * 1000 / 2^16
103 * Using the two equations together
105 * dev_freq_khz * 1000 / 1 scaled_ppm = 2^shift_constant
106 * dev_freq_khz * 2^16 / 1 ppb = 2^shift_constant
107 * dev_freq_khz = 2^(shift_constant - 16)
111 * shift_constant = ilog2(dev_freq_khz) + 16
114 return min(ilog2(dev_freq_khz) + 16,
115 ilog2((U32_MAX / NSEC_PER_MSEC) * dev_freq_khz));
118 static s32 mlx5_ptp_getmaxphase(struct ptp_clock_info *ptp)
120 struct mlx5_clock *clock = container_of(ptp, struct mlx5_clock, ptp_info);
121 struct mlx5_core_dev *mdev;
123 mdev = container_of(clock, struct mlx5_core_dev, clock);
125 return MLX5_CAP_MCAM_FEATURE(mdev, mtutc_time_adjustment_extended_range) ?
126 MLX5_MTUTC_OPERATION_ADJUST_TIME_EXTENDED_MAX :
127 MLX5_MTUTC_OPERATION_ADJUST_TIME_MAX;
130 static bool mlx5_is_mtutc_time_adj_cap(struct mlx5_core_dev *mdev, s64 delta)
132 s64 max = mlx5_ptp_getmaxphase(&mdev->clock.ptp_info);
134 if (delta < -max || delta > max)
140 static int mlx5_set_mtutc(struct mlx5_core_dev *dev, u32 *mtutc, u32 size)
142 u32 out[MLX5_ST_SZ_DW(mtutc_reg)] = {};
144 if (!MLX5_CAP_MCAM_REG(dev, mtutc))
147 return mlx5_core_access_reg(dev, mtutc, size, out, sizeof(out),
148 MLX5_REG_MTUTC, 0, 1);
151 static u64 mlx5_read_time(struct mlx5_core_dev *dev,
152 struct ptp_system_timestamp *sts,
155 u32 timer_h, timer_h1, timer_l;
157 timer_h = ioread32be(real_time ? &dev->iseg->real_time_h :
158 &dev->iseg->internal_timer_h);
159 ptp_read_system_prets(sts);
160 timer_l = ioread32be(real_time ? &dev->iseg->real_time_l :
161 &dev->iseg->internal_timer_l);
162 ptp_read_system_postts(sts);
163 timer_h1 = ioread32be(real_time ? &dev->iseg->real_time_h :
164 &dev->iseg->internal_timer_h);
165 if (timer_h != timer_h1) {
167 ptp_read_system_prets(sts);
168 timer_l = ioread32be(real_time ? &dev->iseg->real_time_l :
169 &dev->iseg->internal_timer_l);
170 ptp_read_system_postts(sts);
173 return real_time ? REAL_TIME_TO_NS(timer_h1, timer_l) :
174 (u64)timer_l | (u64)timer_h1 << 32;
177 static u64 read_internal_timer(const struct cyclecounter *cc)
179 struct mlx5_timer *timer = container_of(cc, struct mlx5_timer, cycles);
180 struct mlx5_clock *clock = container_of(timer, struct mlx5_clock, timer);
181 struct mlx5_core_dev *mdev = container_of(clock, struct mlx5_core_dev,
184 return mlx5_read_time(mdev, NULL, false) & cc->mask;
187 static void mlx5_update_clock_info_page(struct mlx5_core_dev *mdev)
189 struct mlx5_ib_clock_info *clock_info = mdev->clock_info;
190 struct mlx5_clock *clock = &mdev->clock;
191 struct mlx5_timer *timer;
197 sign = smp_load_acquire(&clock_info->sign);
198 smp_store_mb(clock_info->sign,
199 sign | MLX5_IB_CLOCK_INFO_KERNEL_UPDATING);
201 timer = &clock->timer;
202 clock_info->cycles = timer->tc.cycle_last;
203 clock_info->mult = timer->cycles.mult;
204 clock_info->nsec = timer->tc.nsec;
205 clock_info->frac = timer->tc.frac;
207 smp_store_release(&clock_info->sign,
208 sign + MLX5_IB_CLOCK_INFO_KERNEL_UPDATING * 2);
211 static void mlx5_pps_out(struct work_struct *work)
213 struct mlx5_pps *pps_info = container_of(work, struct mlx5_pps,
215 struct mlx5_clock *clock = container_of(pps_info, struct mlx5_clock,
217 struct mlx5_core_dev *mdev = container_of(clock, struct mlx5_core_dev,
219 u32 in[MLX5_ST_SZ_DW(mtpps_reg)] = {0};
223 for (i = 0; i < clock->ptp_info.n_pins; i++) {
226 write_seqlock_irqsave(&clock->lock, flags);
227 tstart = clock->pps_info.start[i];
228 clock->pps_info.start[i] = 0;
229 write_sequnlock_irqrestore(&clock->lock, flags);
233 MLX5_SET(mtpps_reg, in, pin, i);
234 MLX5_SET64(mtpps_reg, in, time_stamp, tstart);
235 MLX5_SET(mtpps_reg, in, field_select, MLX5_MTPPS_FS_TIME_STAMP);
236 mlx5_set_mtpps(mdev, in, sizeof(in));
240 static void mlx5_timestamp_overflow(struct work_struct *work)
242 struct delayed_work *dwork = to_delayed_work(work);
243 struct mlx5_core_dev *mdev;
244 struct mlx5_timer *timer;
245 struct mlx5_clock *clock;
248 timer = container_of(dwork, struct mlx5_timer, overflow_work);
249 clock = container_of(timer, struct mlx5_clock, timer);
250 mdev = container_of(clock, struct mlx5_core_dev, clock);
252 if (mdev->state == MLX5_DEVICE_STATE_INTERNAL_ERROR)
255 write_seqlock_irqsave(&clock->lock, flags);
256 timecounter_read(&timer->tc);
257 mlx5_update_clock_info_page(mdev);
258 write_sequnlock_irqrestore(&clock->lock, flags);
261 schedule_delayed_work(&timer->overflow_work, timer->overflow_period);
264 static int mlx5_ptp_settime_real_time(struct mlx5_core_dev *mdev,
265 const struct timespec64 *ts)
267 u32 in[MLX5_ST_SZ_DW(mtutc_reg)] = {};
269 if (!mlx5_modify_mtutc_allowed(mdev))
272 if (ts->tv_sec < 0 || ts->tv_sec > U32_MAX ||
273 ts->tv_nsec < 0 || ts->tv_nsec > NSEC_PER_SEC)
276 MLX5_SET(mtutc_reg, in, operation, MLX5_MTUTC_OPERATION_SET_TIME_IMMEDIATE);
277 MLX5_SET(mtutc_reg, in, utc_sec, ts->tv_sec);
278 MLX5_SET(mtutc_reg, in, utc_nsec, ts->tv_nsec);
280 return mlx5_set_mtutc(mdev, in, sizeof(in));
283 static int mlx5_ptp_settime(struct ptp_clock_info *ptp, const struct timespec64 *ts)
285 struct mlx5_clock *clock = container_of(ptp, struct mlx5_clock, ptp_info);
286 struct mlx5_timer *timer = &clock->timer;
287 struct mlx5_core_dev *mdev;
291 mdev = container_of(clock, struct mlx5_core_dev, clock);
292 err = mlx5_ptp_settime_real_time(mdev, ts);
296 write_seqlock_irqsave(&clock->lock, flags);
297 timecounter_init(&timer->tc, &timer->cycles, timespec64_to_ns(ts));
298 mlx5_update_clock_info_page(mdev);
299 write_sequnlock_irqrestore(&clock->lock, flags);
305 struct timespec64 mlx5_ptp_gettimex_real_time(struct mlx5_core_dev *mdev,
306 struct ptp_system_timestamp *sts)
308 struct timespec64 ts;
311 time = mlx5_read_time(mdev, sts, true);
312 ts = ns_to_timespec64(time);
316 static int mlx5_ptp_gettimex(struct ptp_clock_info *ptp, struct timespec64 *ts,
317 struct ptp_system_timestamp *sts)
319 struct mlx5_clock *clock = container_of(ptp, struct mlx5_clock, ptp_info);
320 struct mlx5_timer *timer = &clock->timer;
321 struct mlx5_core_dev *mdev;
325 mdev = container_of(clock, struct mlx5_core_dev, clock);
326 if (mlx5_real_time_mode(mdev)) {
327 *ts = mlx5_ptp_gettimex_real_time(mdev, sts);
331 write_seqlock_irqsave(&clock->lock, flags);
332 cycles = mlx5_read_time(mdev, sts, false);
333 ns = timecounter_cyc2time(&timer->tc, cycles);
334 write_sequnlock_irqrestore(&clock->lock, flags);
335 *ts = ns_to_timespec64(ns);
340 static int mlx5_ptp_adjtime_real_time(struct mlx5_core_dev *mdev, s64 delta)
342 u32 in[MLX5_ST_SZ_DW(mtutc_reg)] = {};
344 if (!mlx5_modify_mtutc_allowed(mdev))
347 /* HW time adjustment range is checked. If out of range, settime instead */
348 if (!mlx5_is_mtutc_time_adj_cap(mdev, delta)) {
349 struct timespec64 ts;
352 ts = mlx5_ptp_gettimex_real_time(mdev, NULL);
353 ns = timespec64_to_ns(&ts) + delta;
354 ts = ns_to_timespec64(ns);
355 return mlx5_ptp_settime_real_time(mdev, &ts);
358 MLX5_SET(mtutc_reg, in, operation, MLX5_MTUTC_OPERATION_ADJUST_TIME);
359 MLX5_SET(mtutc_reg, in, time_adjustment, delta);
361 return mlx5_set_mtutc(mdev, in, sizeof(in));
364 static int mlx5_ptp_adjtime(struct ptp_clock_info *ptp, s64 delta)
366 struct mlx5_clock *clock = container_of(ptp, struct mlx5_clock, ptp_info);
367 struct mlx5_timer *timer = &clock->timer;
368 struct mlx5_core_dev *mdev;
372 mdev = container_of(clock, struct mlx5_core_dev, clock);
374 err = mlx5_ptp_adjtime_real_time(mdev, delta);
377 write_seqlock_irqsave(&clock->lock, flags);
378 timecounter_adjtime(&timer->tc, delta);
379 mlx5_update_clock_info_page(mdev);
380 write_sequnlock_irqrestore(&clock->lock, flags);
385 static int mlx5_ptp_adjphase(struct ptp_clock_info *ptp, s32 delta)
387 struct mlx5_clock *clock = container_of(ptp, struct mlx5_clock, ptp_info);
388 struct mlx5_core_dev *mdev;
390 mdev = container_of(clock, struct mlx5_core_dev, clock);
392 return mlx5_ptp_adjtime_real_time(mdev, delta);
395 static int mlx5_ptp_freq_adj_real_time(struct mlx5_core_dev *mdev, long scaled_ppm)
397 u32 in[MLX5_ST_SZ_DW(mtutc_reg)] = {};
399 if (!mlx5_modify_mtutc_allowed(mdev))
402 MLX5_SET(mtutc_reg, in, operation, MLX5_MTUTC_OPERATION_ADJUST_FREQ_UTC);
404 if (MLX5_CAP_MCAM_FEATURE(mdev, mtutc_freq_adj_units)) {
405 MLX5_SET(mtutc_reg, in, freq_adj_units,
406 MLX5_MTUTC_FREQ_ADJ_UNITS_SCALED_PPM);
407 MLX5_SET(mtutc_reg, in, freq_adjustment, scaled_ppm);
409 MLX5_SET(mtutc_reg, in, freq_adj_units, MLX5_MTUTC_FREQ_ADJ_UNITS_PPB);
410 MLX5_SET(mtutc_reg, in, freq_adjustment, scaled_ppm_to_ppb(scaled_ppm));
413 return mlx5_set_mtutc(mdev, in, sizeof(in));
416 static int mlx5_ptp_adjfine(struct ptp_clock_info *ptp, long scaled_ppm)
418 struct mlx5_clock *clock = container_of(ptp, struct mlx5_clock, ptp_info);
419 struct mlx5_timer *timer = &clock->timer;
420 struct mlx5_core_dev *mdev;
425 mdev = container_of(clock, struct mlx5_core_dev, clock);
427 err = mlx5_ptp_freq_adj_real_time(mdev, scaled_ppm);
431 mult = (u32)adjust_by_scaled_ppm(timer->nominal_c_mult, scaled_ppm);
433 write_seqlock_irqsave(&clock->lock, flags);
434 timecounter_read(&timer->tc);
435 timer->cycles.mult = mult;
436 mlx5_update_clock_info_page(mdev);
437 write_sequnlock_irqrestore(&clock->lock, flags);
442 static int mlx5_extts_configure(struct ptp_clock_info *ptp,
443 struct ptp_clock_request *rq,
446 struct mlx5_clock *clock =
447 container_of(ptp, struct mlx5_clock, ptp_info);
448 struct mlx5_core_dev *mdev =
449 container_of(clock, struct mlx5_core_dev, clock);
450 u32 in[MLX5_ST_SZ_DW(mtpps_reg)] = {0};
451 u32 field_select = 0;
457 if (!MLX5_PPS_CAP(mdev))
460 /* Reject requests with unsupported flags */
461 if (rq->extts.flags & ~(PTP_ENABLE_FEATURE |
467 /* Reject requests to enable time stamping on both edges. */
468 if ((rq->extts.flags & PTP_STRICT_FLAGS) &&
469 (rq->extts.flags & PTP_ENABLE_FEATURE) &&
470 (rq->extts.flags & PTP_EXTTS_EDGES) == PTP_EXTTS_EDGES)
473 if (rq->extts.index >= clock->ptp_info.n_pins)
476 pin = ptp_find_pin(clock->ptp, PTP_PF_EXTTS, rq->extts.index);
481 pin_mode = MLX5_PIN_MODE_IN;
482 pattern = !!(rq->extts.flags & PTP_FALLING_EDGE);
483 field_select = MLX5_MTPPS_FS_PIN_MODE |
484 MLX5_MTPPS_FS_PATTERN |
485 MLX5_MTPPS_FS_ENABLE;
487 field_select = MLX5_MTPPS_FS_ENABLE;
490 MLX5_SET(mtpps_reg, in, pin, pin);
491 MLX5_SET(mtpps_reg, in, pin_mode, pin_mode);
492 MLX5_SET(mtpps_reg, in, pattern, pattern);
493 MLX5_SET(mtpps_reg, in, enable, on);
494 MLX5_SET(mtpps_reg, in, field_select, field_select);
496 err = mlx5_set_mtpps(mdev, in, sizeof(in));
500 return mlx5_set_mtppse(mdev, pin, 0,
501 MLX5_EVENT_MODE_REPETETIVE & on);
504 static u64 find_target_cycles(struct mlx5_core_dev *mdev, s64 target_ns)
506 struct mlx5_clock *clock = &mdev->clock;
507 u64 cycles_now, cycles_delta;
508 u64 nsec_now, nsec_delta;
509 struct mlx5_timer *timer;
512 timer = &clock->timer;
514 cycles_now = mlx5_read_time(mdev, NULL, false);
515 write_seqlock_irqsave(&clock->lock, flags);
516 nsec_now = timecounter_cyc2time(&timer->tc, cycles_now);
517 nsec_delta = target_ns - nsec_now;
518 cycles_delta = div64_u64(nsec_delta << timer->cycles.shift,
520 write_sequnlock_irqrestore(&clock->lock, flags);
522 return cycles_now + cycles_delta;
525 static u64 perout_conf_internal_timer(struct mlx5_core_dev *mdev, s64 sec)
527 struct timespec64 ts = {};
531 target_ns = timespec64_to_ns(&ts);
533 return find_target_cycles(mdev, target_ns);
536 static u64 perout_conf_real_time(s64 sec, u32 nsec)
538 return (u64)nsec | (u64)sec << 32;
541 static int perout_conf_1pps(struct mlx5_core_dev *mdev, struct ptp_clock_request *rq,
542 u64 *time_stamp, bool real_time)
544 struct timespec64 ts;
547 ts.tv_nsec = rq->perout.period.nsec;
548 ts.tv_sec = rq->perout.period.sec;
549 ns = timespec64_to_ns(&ts);
551 if ((ns >> 1) != 500000000LL)
554 *time_stamp = real_time ? perout_conf_real_time(rq->perout.start.sec, 0) :
555 perout_conf_internal_timer(mdev, rq->perout.start.sec);
560 #define MLX5_MAX_PULSE_DURATION (BIT(__mlx5_bit_sz(mtpps_reg, out_pulse_duration_ns)) - 1)
561 static int mlx5_perout_conf_out_pulse_duration(struct mlx5_core_dev *mdev,
562 struct ptp_clock_request *rq,
563 u32 *out_pulse_duration_ns)
565 struct mlx5_pps *pps_info = &mdev->clock.pps_info;
566 u32 out_pulse_duration;
567 struct timespec64 ts;
569 if (rq->perout.flags & PTP_PEROUT_DUTY_CYCLE) {
570 ts.tv_sec = rq->perout.on.sec;
571 ts.tv_nsec = rq->perout.on.nsec;
572 out_pulse_duration = (u32)timespec64_to_ns(&ts);
574 /* out_pulse_duration_ns should be up to 50% of the
575 * pulse period as default
577 ts.tv_sec = rq->perout.period.sec;
578 ts.tv_nsec = rq->perout.period.nsec;
579 out_pulse_duration = (u32)timespec64_to_ns(&ts) >> 1;
582 if (out_pulse_duration < pps_info->min_out_pulse_duration_ns ||
583 out_pulse_duration > MLX5_MAX_PULSE_DURATION) {
584 mlx5_core_err(mdev, "NPPS pulse duration %u is not in [%llu, %lu]\n",
585 out_pulse_duration, pps_info->min_out_pulse_duration_ns,
586 MLX5_MAX_PULSE_DURATION);
589 *out_pulse_duration_ns = out_pulse_duration;
594 static int perout_conf_npps_real_time(struct mlx5_core_dev *mdev, struct ptp_clock_request *rq,
595 u32 *field_select, u32 *out_pulse_duration_ns,
596 u64 *period, u64 *time_stamp)
598 struct mlx5_pps *pps_info = &mdev->clock.pps_info;
599 struct ptp_clock_time *time = &rq->perout.start;
600 struct timespec64 ts;
602 ts.tv_sec = rq->perout.period.sec;
603 ts.tv_nsec = rq->perout.period.nsec;
604 if (timespec64_to_ns(&ts) < pps_info->min_npps_period) {
605 mlx5_core_err(mdev, "NPPS period is lower than minimal npps period %llu\n",
606 pps_info->min_npps_period);
609 *period = perout_conf_real_time(rq->perout.period.sec, rq->perout.period.nsec);
611 if (mlx5_perout_conf_out_pulse_duration(mdev, rq, out_pulse_duration_ns))
614 *time_stamp = perout_conf_real_time(time->sec, time->nsec);
615 *field_select |= MLX5_MTPPS_FS_NPPS_PERIOD |
616 MLX5_MTPPS_FS_OUT_PULSE_DURATION_NS;
621 static bool mlx5_perout_verify_flags(struct mlx5_core_dev *mdev, unsigned int flags)
623 return ((!mlx5_npps_real_time_supported(mdev) && flags) ||
624 (mlx5_npps_real_time_supported(mdev) && flags & ~PTP_PEROUT_DUTY_CYCLE));
627 static int mlx5_perout_configure(struct ptp_clock_info *ptp,
628 struct ptp_clock_request *rq,
631 struct mlx5_clock *clock =
632 container_of(ptp, struct mlx5_clock, ptp_info);
633 struct mlx5_core_dev *mdev =
634 container_of(clock, struct mlx5_core_dev, clock);
635 bool rt_mode = mlx5_real_time_mode(mdev);
636 u32 in[MLX5_ST_SZ_DW(mtpps_reg)] = {0};
637 u32 out_pulse_duration_ns = 0;
638 u32 field_select = 0;
646 if (!MLX5_PPS_CAP(mdev))
649 /* Reject requests with unsupported flags */
650 if (mlx5_perout_verify_flags(mdev, rq->perout.flags))
653 if (rq->perout.index >= clock->ptp_info.n_pins)
656 field_select = MLX5_MTPPS_FS_ENABLE;
657 pin = ptp_find_pin(clock->ptp, PTP_PF_PEROUT, rq->perout.index);
662 bool rt_mode = mlx5_real_time_mode(mdev);
664 pin_mode = MLX5_PIN_MODE_OUT;
665 pattern = MLX5_OUT_PATTERN_PERIODIC;
667 if (rt_mode && rq->perout.start.sec > U32_MAX)
670 field_select |= MLX5_MTPPS_FS_PIN_MODE |
671 MLX5_MTPPS_FS_PATTERN |
672 MLX5_MTPPS_FS_TIME_STAMP;
674 if (mlx5_npps_real_time_supported(mdev))
675 err = perout_conf_npps_real_time(mdev, rq, &field_select,
676 &out_pulse_duration_ns, &npps_period,
679 err = perout_conf_1pps(mdev, rq, &time_stamp, rt_mode);
684 MLX5_SET(mtpps_reg, in, pin, pin);
685 MLX5_SET(mtpps_reg, in, pin_mode, pin_mode);
686 MLX5_SET(mtpps_reg, in, pattern, pattern);
687 MLX5_SET(mtpps_reg, in, enable, on);
688 MLX5_SET64(mtpps_reg, in, time_stamp, time_stamp);
689 MLX5_SET(mtpps_reg, in, field_select, field_select);
690 MLX5_SET64(mtpps_reg, in, npps_period, npps_period);
691 MLX5_SET(mtpps_reg, in, out_pulse_duration_ns, out_pulse_duration_ns);
692 err = mlx5_set_mtpps(mdev, in, sizeof(in));
699 return mlx5_set_mtppse(mdev, pin, 0,
700 MLX5_EVENT_MODE_REPETETIVE & on);
703 static int mlx5_pps_configure(struct ptp_clock_info *ptp,
704 struct ptp_clock_request *rq,
707 struct mlx5_clock *clock =
708 container_of(ptp, struct mlx5_clock, ptp_info);
710 clock->pps_info.enabled = !!on;
714 static int mlx5_ptp_enable(struct ptp_clock_info *ptp,
715 struct ptp_clock_request *rq,
719 case PTP_CLK_REQ_EXTTS:
720 return mlx5_extts_configure(ptp, rq, on);
721 case PTP_CLK_REQ_PEROUT:
722 return mlx5_perout_configure(ptp, rq, on);
723 case PTP_CLK_REQ_PPS:
724 return mlx5_pps_configure(ptp, rq, on);
732 MLX5_MTPPS_REG_CAP_PIN_X_MODE_SUPPORT_PPS_IN = BIT(0),
733 MLX5_MTPPS_REG_CAP_PIN_X_MODE_SUPPORT_PPS_OUT = BIT(1),
736 static int mlx5_ptp_verify(struct ptp_clock_info *ptp, unsigned int pin,
737 enum ptp_pin_function func, unsigned int chan)
739 struct mlx5_clock *clock = container_of(ptp, struct mlx5_clock,
746 return !(clock->pps_info.pin_caps[pin] &
747 MLX5_MTPPS_REG_CAP_PIN_X_MODE_SUPPORT_PPS_IN);
749 return !(clock->pps_info.pin_caps[pin] &
750 MLX5_MTPPS_REG_CAP_PIN_X_MODE_SUPPORT_PPS_OUT);
756 static const struct ptp_clock_info mlx5_ptp_clock_info = {
757 .owner = THIS_MODULE,
765 .adjfine = mlx5_ptp_adjfine,
766 .adjphase = mlx5_ptp_adjphase,
767 .getmaxphase = mlx5_ptp_getmaxphase,
768 .adjtime = mlx5_ptp_adjtime,
769 .gettimex64 = mlx5_ptp_gettimex,
770 .settime64 = mlx5_ptp_settime,
775 static int mlx5_query_mtpps_pin_mode(struct mlx5_core_dev *mdev, u8 pin,
776 u32 *mtpps, u32 mtpps_size)
778 u32 in[MLX5_ST_SZ_DW(mtpps_reg)] = {};
780 MLX5_SET(mtpps_reg, in, pin, pin);
782 return mlx5_core_access_reg(mdev, in, sizeof(in), mtpps,
783 mtpps_size, MLX5_REG_MTPPS, 0, 0);
786 static int mlx5_get_pps_pin_mode(struct mlx5_clock *clock, u8 pin)
788 struct mlx5_core_dev *mdev = container_of(clock, struct mlx5_core_dev, clock);
790 u32 out[MLX5_ST_SZ_DW(mtpps_reg)] = {};
794 err = mlx5_query_mtpps_pin_mode(mdev, pin, out, sizeof(out));
795 if (err || !MLX5_GET(mtpps_reg, out, enable))
798 mode = MLX5_GET(mtpps_reg, out, pin_mode);
800 if (mode == MLX5_PIN_MODE_IN)
802 else if (mode == MLX5_PIN_MODE_OUT)
803 return PTP_PF_PEROUT;
808 static void mlx5_init_pin_config(struct mlx5_clock *clock)
812 if (!clock->ptp_info.n_pins)
815 clock->ptp_info.pin_config =
816 kcalloc(clock->ptp_info.n_pins,
817 sizeof(*clock->ptp_info.pin_config),
819 if (!clock->ptp_info.pin_config)
821 clock->ptp_info.enable = mlx5_ptp_enable;
822 clock->ptp_info.verify = mlx5_ptp_verify;
823 clock->ptp_info.pps = 1;
825 for (i = 0; i < clock->ptp_info.n_pins; i++) {
826 snprintf(clock->ptp_info.pin_config[i].name,
827 sizeof(clock->ptp_info.pin_config[i].name),
829 clock->ptp_info.pin_config[i].index = i;
830 clock->ptp_info.pin_config[i].func = mlx5_get_pps_pin_mode(clock, i);
831 clock->ptp_info.pin_config[i].chan = 0;
835 static void mlx5_get_pps_caps(struct mlx5_core_dev *mdev)
837 struct mlx5_clock *clock = &mdev->clock;
838 u32 out[MLX5_ST_SZ_DW(mtpps_reg)] = {0};
840 mlx5_query_mtpps(mdev, out, sizeof(out));
842 clock->ptp_info.n_pins = MLX5_GET(mtpps_reg, out,
843 cap_number_of_pps_pins);
844 clock->ptp_info.n_ext_ts = MLX5_GET(mtpps_reg, out,
845 cap_max_num_of_pps_in_pins);
846 clock->ptp_info.n_per_out = MLX5_GET(mtpps_reg, out,
847 cap_max_num_of_pps_out_pins);
849 if (MLX5_CAP_MCAM_FEATURE(mdev, npps_period))
850 clock->pps_info.min_npps_period = 1 << MLX5_GET(mtpps_reg, out,
851 cap_log_min_npps_period);
852 if (MLX5_CAP_MCAM_FEATURE(mdev, out_pulse_duration_ns))
853 clock->pps_info.min_out_pulse_duration_ns = 1 << MLX5_GET(mtpps_reg, out,
854 cap_log_min_out_pulse_duration_ns);
856 clock->pps_info.pin_caps[0] = MLX5_GET(mtpps_reg, out, cap_pin_0_mode);
857 clock->pps_info.pin_caps[1] = MLX5_GET(mtpps_reg, out, cap_pin_1_mode);
858 clock->pps_info.pin_caps[2] = MLX5_GET(mtpps_reg, out, cap_pin_2_mode);
859 clock->pps_info.pin_caps[3] = MLX5_GET(mtpps_reg, out, cap_pin_3_mode);
860 clock->pps_info.pin_caps[4] = MLX5_GET(mtpps_reg, out, cap_pin_4_mode);
861 clock->pps_info.pin_caps[5] = MLX5_GET(mtpps_reg, out, cap_pin_5_mode);
862 clock->pps_info.pin_caps[6] = MLX5_GET(mtpps_reg, out, cap_pin_6_mode);
863 clock->pps_info.pin_caps[7] = MLX5_GET(mtpps_reg, out, cap_pin_7_mode);
866 static void ts_next_sec(struct timespec64 *ts)
872 static u64 perout_conf_next_event_timer(struct mlx5_core_dev *mdev,
873 struct mlx5_clock *clock)
875 struct timespec64 ts;
878 mlx5_ptp_gettimex(&clock->ptp_info, &ts, NULL);
880 target_ns = timespec64_to_ns(&ts);
882 return find_target_cycles(mdev, target_ns);
885 static int mlx5_pps_event(struct notifier_block *nb,
886 unsigned long type, void *data)
888 struct mlx5_clock *clock = mlx5_nb_cof(nb, struct mlx5_clock, pps_nb);
889 struct ptp_clock_event ptp_event;
890 struct mlx5_eqe *eqe = data;
891 int pin = eqe->data.pps.pin;
892 struct mlx5_core_dev *mdev;
896 mdev = container_of(clock, struct mlx5_core_dev, clock);
898 switch (clock->ptp_info.pin_config[pin].func) {
900 ptp_event.index = pin;
901 ptp_event.timestamp = mlx5_real_time_mode(mdev) ?
902 mlx5_real_time_cyc2time(clock,
903 be64_to_cpu(eqe->data.pps.time_stamp)) :
904 mlx5_timecounter_cyc2time(clock,
905 be64_to_cpu(eqe->data.pps.time_stamp));
906 if (clock->pps_info.enabled) {
907 ptp_event.type = PTP_CLOCK_PPSUSR;
908 ptp_event.pps_times.ts_real =
909 ns_to_timespec64(ptp_event.timestamp);
911 ptp_event.type = PTP_CLOCK_EXTTS;
913 /* TODOL clock->ptp can be NULL if ptp_clock_register fails */
914 ptp_clock_event(clock->ptp, &ptp_event);
917 ns = perout_conf_next_event_timer(mdev, clock);
918 write_seqlock_irqsave(&clock->lock, flags);
919 clock->pps_info.start[pin] = ns;
920 write_sequnlock_irqrestore(&clock->lock, flags);
921 schedule_work(&clock->pps_info.out_work);
924 mlx5_core_err(mdev, " Unhandled clock PPS event, func %d\n",
925 clock->ptp_info.pin_config[pin].func);
931 static void mlx5_timecounter_init(struct mlx5_core_dev *mdev)
933 struct mlx5_clock *clock = &mdev->clock;
934 struct mlx5_timer *timer = &clock->timer;
937 dev_freq = MLX5_CAP_GEN(mdev, device_frequency_khz);
938 timer->cycles.read = read_internal_timer;
939 timer->cycles.shift = mlx5_ptp_shift_constant(dev_freq);
940 timer->cycles.mult = clocksource_khz2mult(dev_freq,
941 timer->cycles.shift);
942 timer->nominal_c_mult = timer->cycles.mult;
943 timer->cycles.mask = CLOCKSOURCE_MASK(41);
945 timecounter_init(&timer->tc, &timer->cycles,
946 ktime_to_ns(ktime_get_real()));
949 static void mlx5_init_overflow_period(struct mlx5_clock *clock)
951 struct mlx5_core_dev *mdev = container_of(clock, struct mlx5_core_dev, clock);
952 struct mlx5_ib_clock_info *clock_info = mdev->clock_info;
953 struct mlx5_timer *timer = &clock->timer;
958 /* Calculate period in seconds to call the overflow watchdog - to make
959 * sure counter is checked at least twice every wrap around.
960 * The period is calculated as the minimum between max HW cycles count
961 * (The clock source mask) and max amount of cycles that can be
962 * multiplied by clock multiplier where the result doesn't exceed
965 overflow_cycles = div64_u64(~0ULL >> 1, timer->cycles.mult);
966 overflow_cycles = min(overflow_cycles, div_u64(timer->cycles.mask, 3));
968 ns = cyclecounter_cyc2ns(&timer->cycles, overflow_cycles,
970 do_div(ns, NSEC_PER_SEC / HZ);
971 timer->overflow_period = ns;
973 INIT_DELAYED_WORK(&timer->overflow_work, mlx5_timestamp_overflow);
974 if (timer->overflow_period)
975 schedule_delayed_work(&timer->overflow_work, 0);
978 "invalid overflow period, overflow_work is not scheduled\n");
981 clock_info->overflow_period = timer->overflow_period;
984 static void mlx5_init_clock_info(struct mlx5_core_dev *mdev)
986 struct mlx5_clock *clock = &mdev->clock;
987 struct mlx5_ib_clock_info *info;
988 struct mlx5_timer *timer;
990 mdev->clock_info = (struct mlx5_ib_clock_info *)get_zeroed_page(GFP_KERNEL);
991 if (!mdev->clock_info) {
992 mlx5_core_warn(mdev, "Failed to allocate IB clock info page\n");
996 info = mdev->clock_info;
997 timer = &clock->timer;
999 info->nsec = timer->tc.nsec;
1000 info->cycles = timer->tc.cycle_last;
1001 info->mask = timer->cycles.mask;
1002 info->mult = timer->nominal_c_mult;
1003 info->shift = timer->cycles.shift;
1004 info->frac = timer->tc.frac;
1007 static void mlx5_init_timer_clock(struct mlx5_core_dev *mdev)
1009 struct mlx5_clock *clock = &mdev->clock;
1011 mlx5_timecounter_init(mdev);
1012 mlx5_init_clock_info(mdev);
1013 mlx5_init_overflow_period(clock);
1014 clock->ptp_info = mlx5_ptp_clock_info;
1016 if (mlx5_real_time_mode(mdev)) {
1017 struct timespec64 ts;
1019 ktime_get_real_ts64(&ts);
1020 mlx5_ptp_settime(&clock->ptp_info, &ts);
1024 static void mlx5_init_pps(struct mlx5_core_dev *mdev)
1026 struct mlx5_clock *clock = &mdev->clock;
1028 if (!MLX5_PPS_CAP(mdev))
1031 mlx5_get_pps_caps(mdev);
1032 mlx5_init_pin_config(clock);
1035 void mlx5_init_clock(struct mlx5_core_dev *mdev)
1037 struct mlx5_clock *clock = &mdev->clock;
1039 if (!MLX5_CAP_GEN(mdev, device_frequency_khz)) {
1040 mlx5_core_warn(mdev, "invalid device_frequency_khz, aborting HW clock init\n");
1044 seqlock_init(&clock->lock);
1045 mlx5_init_timer_clock(mdev);
1046 INIT_WORK(&clock->pps_info.out_work, mlx5_pps_out);
1048 /* Configure the PHC */
1049 clock->ptp_info = mlx5_ptp_clock_info;
1051 /* Initialize 1PPS data structures */
1052 mlx5_init_pps(mdev);
1054 clock->ptp = ptp_clock_register(&clock->ptp_info,
1056 if (IS_ERR(clock->ptp)) {
1057 mlx5_core_warn(mdev, "ptp_clock_register failed %ld\n",
1058 PTR_ERR(clock->ptp));
1062 MLX5_NB_INIT(&clock->pps_nb, mlx5_pps_event, PPS_EVENT);
1063 mlx5_eq_notifier_register(mdev, &clock->pps_nb);
1066 void mlx5_cleanup_clock(struct mlx5_core_dev *mdev)
1068 struct mlx5_clock *clock = &mdev->clock;
1070 if (!MLX5_CAP_GEN(mdev, device_frequency_khz))
1073 mlx5_eq_notifier_unregister(mdev, &clock->pps_nb);
1075 ptp_clock_unregister(clock->ptp);
1079 cancel_work_sync(&clock->pps_info.out_work);
1080 cancel_delayed_work_sync(&clock->timer.overflow_work);
1082 if (mdev->clock_info) {
1083 free_page((unsigned long)mdev->clock_info);
1084 mdev->clock_info = NULL;
1087 kfree(clock->ptp_info.pin_config);