xref: /linux/drivers/net/ethernet/mellanox/mlx5/core/lib/clock.h (revision 1a9239bb4253f9076b5b4b2a1a4e8d7defd77a95)
1 /*
2  * Copyright (c) 2017, Mellanox Technologies, Ltd.  All rights reserved.
3  *
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:
9  *
10  *     Redistribution and use in source and binary forms, with or
11  *     without modification, are permitted provided that the following
12  *     conditions are met:
13  *
14  *      - Redistributions of source code must retain the above
15  *        copyright notice, this list of conditions and the following
16  *        disclaimer.
17  *
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.
22  *
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
30  * SOFTWARE.
31  */
32 
33 #ifndef __LIB_CLOCK_H__
34 #define __LIB_CLOCK_H__
35 
36 #include <linux/ptp_clock_kernel.h>
37 
38 #define MAX_PIN_NUM	8
39 struct mlx5_pps {
40 	u8                         pin_caps[MAX_PIN_NUM];
41 	u64                        start[MAX_PIN_NUM];
42 	u8                         enabled;
43 	u64                        min_npps_period;
44 	u64                        min_out_pulse_duration_ns;
45 	bool                       pin_armed[MAX_PIN_NUM];
46 };
47 
48 struct mlx5_timer {
49 	struct cyclecounter        cycles;
50 	struct timecounter         tc;
51 	u32                        nominal_c_mult;
52 	unsigned long              overflow_period;
53 };
54 
55 struct mlx5_clock {
56 	seqlock_t                  lock;
57 	struct hwtstamp_config     hwtstamp_config;
58 	struct ptp_clock          *ptp;
59 	struct ptp_clock_info      ptp_info;
60 	struct mlx5_pps            pps_info;
61 	struct mlx5_timer          timer;
62 	bool                       shared;
63 };
64 
mlx5_is_real_time_rq(struct mlx5_core_dev * mdev)65 static inline bool mlx5_is_real_time_rq(struct mlx5_core_dev *mdev)
66 {
67 	u8 rq_ts_format_cap = MLX5_CAP_GEN(mdev, rq_ts_format);
68 
69 	return (rq_ts_format_cap == MLX5_TIMESTAMP_FORMAT_CAP_REAL_TIME ||
70 		rq_ts_format_cap ==
71 			MLX5_TIMESTAMP_FORMAT_CAP_FREE_RUNNING_AND_REAL_TIME);
72 }
73 
mlx5_is_real_time_sq(struct mlx5_core_dev * mdev)74 static inline bool mlx5_is_real_time_sq(struct mlx5_core_dev *mdev)
75 {
76 	u8 sq_ts_format_cap = MLX5_CAP_GEN(mdev, sq_ts_format);
77 
78 	return (sq_ts_format_cap == MLX5_TIMESTAMP_FORMAT_CAP_REAL_TIME ||
79 		sq_ts_format_cap ==
80 			MLX5_TIMESTAMP_FORMAT_CAP_FREE_RUNNING_AND_REAL_TIME);
81 }
82 
83 typedef ktime_t (*cqe_ts_to_ns)(struct mlx5_clock *, u64);
84 
85 #if IS_ENABLED(CONFIG_PTP_1588_CLOCK)
86 int mlx5_init_clock(struct mlx5_core_dev *mdev);
87 void mlx5_cleanup_clock(struct mlx5_core_dev *mdev);
88 void mlx5_clock_load(struct mlx5_core_dev *mdev);
89 void mlx5_clock_unload(struct mlx5_core_dev *mdev);
90 
mlx5_clock_get_ptp_index(struct mlx5_core_dev * mdev)91 static inline int mlx5_clock_get_ptp_index(struct mlx5_core_dev *mdev)
92 {
93 	return mdev->clock->ptp ? ptp_clock_index(mdev->clock->ptp) : -1;
94 }
95 
mlx5_timecounter_cyc2time(struct mlx5_clock * clock,u64 timestamp)96 static inline ktime_t mlx5_timecounter_cyc2time(struct mlx5_clock *clock,
97 						u64 timestamp)
98 {
99 	struct mlx5_timer *timer = &clock->timer;
100 	unsigned int seq;
101 	u64 nsec;
102 
103 	do {
104 		seq = read_seqbegin(&clock->lock);
105 		nsec = timecounter_cyc2time(&timer->tc, timestamp);
106 	} while (read_seqretry(&clock->lock, seq));
107 
108 	return ns_to_ktime(nsec);
109 }
110 
111 #define REAL_TIME_TO_NS(hi, low) (((u64)hi) * NSEC_PER_SEC + ((u64)low))
112 
mlx5_real_time_cyc2time(struct mlx5_clock * clock,u64 timestamp)113 static inline ktime_t mlx5_real_time_cyc2time(struct mlx5_clock *clock,
114 					      u64 timestamp)
115 {
116 	u64 time = REAL_TIME_TO_NS(timestamp >> 32, timestamp & 0xFFFFFFFF);
117 
118 	return ns_to_ktime(time);
119 }
120 #else
mlx5_init_clock(struct mlx5_core_dev * mdev)121 static inline int mlx5_init_clock(struct mlx5_core_dev *mdev) { return 0; }
mlx5_cleanup_clock(struct mlx5_core_dev * mdev)122 static inline void mlx5_cleanup_clock(struct mlx5_core_dev *mdev) {}
mlx5_clock_load(struct mlx5_core_dev * mdev)123 static inline void mlx5_clock_load(struct mlx5_core_dev *mdev) {}
mlx5_clock_unload(struct mlx5_core_dev * mdev)124 static inline void mlx5_clock_unload(struct mlx5_core_dev *mdev) {}
mlx5_clock_get_ptp_index(struct mlx5_core_dev * mdev)125 static inline int mlx5_clock_get_ptp_index(struct mlx5_core_dev *mdev)
126 {
127 	return -1;
128 }
129 
mlx5_timecounter_cyc2time(struct mlx5_clock * clock,u64 timestamp)130 static inline ktime_t mlx5_timecounter_cyc2time(struct mlx5_clock *clock,
131 						u64 timestamp)
132 {
133 	return 0;
134 }
135 
mlx5_real_time_cyc2time(struct mlx5_clock * clock,u64 timestamp)136 static inline ktime_t mlx5_real_time_cyc2time(struct mlx5_clock *clock,
137 					      u64 timestamp)
138 {
139 	return 0;
140 }
141 #endif
142 
mlx5_rq_ts_translator(struct mlx5_core_dev * mdev)143 static inline cqe_ts_to_ns mlx5_rq_ts_translator(struct mlx5_core_dev *mdev)
144 {
145 	return mlx5_is_real_time_rq(mdev) ? mlx5_real_time_cyc2time :
146 					    mlx5_timecounter_cyc2time;
147 }
148 
mlx5_sq_ts_translator(struct mlx5_core_dev * mdev)149 static inline cqe_ts_to_ns mlx5_sq_ts_translator(struct mlx5_core_dev *mdev)
150 {
151 	return mlx5_is_real_time_sq(mdev) ? mlx5_real_time_cyc2time :
152 					    mlx5_timecounter_cyc2time;
153 }
154 #endif
155