1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (C) 2021, Intel Corporation. */
3 
4 #ifndef _ICE_PTP_H_
5 #define _ICE_PTP_H_
6 
7 #include <linux/ptp_clock_kernel.h>
8 #include <linux/kthread.h>
9 
10 #include "ice_ptp_hw.h"
11 
12 enum ice_ptp_pin_e810 {
13 	GPIO_20 = 0,
14 	GPIO_21,
15 	GPIO_22,
16 	GPIO_23,
17 	NUM_PTP_PIN_E810
18 };
19 
20 enum ice_ptp_pin_e810t {
21 	GNSS = 0,
22 	SMA1,
23 	UFL1,
24 	SMA2,
25 	UFL2,
26 	NUM_PTP_PINS_E810T
27 };
28 
29 struct ice_perout_channel {
30 	bool ena;
31 	u32 gpio_pin;
32 	u64 period;
33 	u64 start_time;
34 };
35 
36 /* The ice hardware captures Tx hardware timestamps in the PHY. The timestamp
37  * is stored in a buffer of registers. Depending on the specific hardware,
38  * this buffer might be shared across multiple PHY ports.
39  *
40  * On transmit of a packet to be timestamped, software is responsible for
41  * selecting an open index. Hardware makes no attempt to lock or prevent
42  * re-use of an index for multiple packets.
43  *
44  * To handle this, timestamp indexes must be tracked by software to ensure
45  * that an index is not re-used for multiple transmitted packets. The
46  * structures and functions declared in this file track the available Tx
47  * register indexes, as well as provide storage for the SKB pointers.
48  *
49  * To allow multiple ports to access the shared register block independently,
50  * the blocks are split up so that indexes are assigned to each port based on
51  * hardware logical port number.
52  *
53  * The timestamp blocks are handled differently for E810- and E822-based
54  * devices. In E810 devices, each port has its own block of timestamps, while in
55  * E822 there is a need to logically break the block of registers into smaller
56  * chunks based on the port number to avoid collisions.
57  *
58  * Example for port 5 in E810:
59  *  +--------+--------+--------+--------+--------+--------+--------+--------+
60  *  |register|register|register|register|register|register|register|register|
61  *  | block  | block  | block  | block  | block  | block  | block  | block  |
62  *  |  for   |  for   |  for   |  for   |  for   |  for   |  for   |  for   |
63  *  | port 0 | port 1 | port 2 | port 3 | port 4 | port 5 | port 6 | port 7 |
64  *  +--------+--------+--------+--------+--------+--------+--------+--------+
65  *                                               ^^
66  *                                               ||
67  *                                               |---  quad offset is always 0
68  *                                               ---- quad number
69  *
70  * Example for port 5 in E822:
71  * +-----------------------------+-----------------------------+
72  * |  register block for quad 0  |  register block for quad 1  |
73  * |+------+------+------+------+|+------+------+------+------+|
74  * ||port 0|port 1|port 2|port 3|||port 0|port 1|port 2|port 3||
75  * |+------+------+------+------+|+------+------+------+------+|
76  * +-----------------------------+-------^---------------------+
77  *                                ^      |
78  *                                |      --- quad offset*
79  *                                ---- quad number
80  *
81  *   * PHY port 5 is port 1 in quad 1
82  *
83  */
84 
85 /**
86  * struct ice_tx_tstamp - Tracking for a single Tx timestamp
87  * @skb: pointer to the SKB for this timestamp request
88  * @start: jiffies when the timestamp was first requested
89  * @cached_tstamp: last read timestamp
90  *
91  * This structure tracks a single timestamp request. The SKB pointer is
92  * provided when initiating a request. The start time is used to ensure that
93  * we discard old requests that were not fulfilled within a 2 second time
94  * window.
95  * Timestamp values in the PHY are read only and do not get cleared except at
96  * hardware reset or when a new timestamp value is captured.
97  *
98  * Some PHY types do not provide a "ready" bitmap indicating which timestamp
99  * indexes are valid. In these cases, we use a cached_tstamp to keep track of
100  * the last timestamp we read for a given index. If the current timestamp
101  * value is the same as the cached value, we assume a new timestamp hasn't
102  * been captured. This avoids reporting stale timestamps to the stack. This is
103  * only done if the verify_cached flag is set in ice_ptp_tx structure.
104  */
105 struct ice_tx_tstamp {
106 	struct sk_buff *skb;
107 	unsigned long start;
108 	u64 cached_tstamp;
109 };
110 
111 /**
112  * enum ice_tx_tstamp_work - Status of Tx timestamp work function
113  * @ICE_TX_TSTAMP_WORK_DONE: Tx timestamp processing is complete
114  * @ICE_TX_TSTAMP_WORK_PENDING: More Tx timestamps are pending
115  */
116 enum ice_tx_tstamp_work {
117 	ICE_TX_TSTAMP_WORK_DONE = 0,
118 	ICE_TX_TSTAMP_WORK_PENDING,
119 };
120 
121 /**
122  * struct ice_ptp_tx - Tracking structure for all Tx timestamp requests on a port
123  * @lock: lock to prevent concurrent access to fields of this struct
124  * @tstamps: array of len to store outstanding requests
125  * @in_use: bitmap of len to indicate which slots are in use
126  * @stale: bitmap of len to indicate slots which have stale timestamps
127  * @block: which memory block (quad or port) the timestamps are captured in
128  * @offset: offset into timestamp block to get the real index
129  * @len: length of the tstamps and in_use fields.
130  * @init: if true, the tracker is initialized;
131  * @calibrating: if true, the PHY is calibrating the Tx offset. During this
132  *               window, timestamps are temporarily disabled.
133  * @verify_cached: if true, verify new timestamp differs from last read value
134  */
135 struct ice_ptp_tx {
136 	spinlock_t lock; /* lock protecting in_use bitmap */
137 	struct ice_tx_tstamp *tstamps;
138 	unsigned long *in_use;
139 	unsigned long *stale;
140 	u8 block;
141 	u8 offset;
142 	u8 len;
143 	u8 init : 1;
144 	u8 calibrating : 1;
145 	u8 verify_cached : 1;
146 };
147 
148 /* Quad and port information for initializing timestamp blocks */
149 #define INDEX_PER_QUAD			64
150 #define INDEX_PER_PORT_E822		16
151 #define INDEX_PER_PORT_E810		64
152 
153 /**
154  * struct ice_ptp_port - data used to initialize an external port for PTP
155  *
156  * This structure contains data indicating whether a single external port is
157  * ready for PTP functionality. It is used to track the port initialization
158  * and determine when the port's PHY offset is valid.
159  *
160  * @tx: Tx timestamp tracking for this port
161  * @ov_work: delayed work task for tracking when PHY offset is valid
162  * @ps_lock: mutex used to protect the overall PTP PHY start procedure
163  * @link_up: indicates whether the link is up
164  * @tx_fifo_busy_cnt: number of times the Tx FIFO was busy
165  * @port_num: the port number this structure represents
166  */
167 struct ice_ptp_port {
168 	struct ice_ptp_tx tx;
169 	struct kthread_delayed_work ov_work;
170 	struct mutex ps_lock; /* protects overall PTP PHY start procedure */
171 	bool link_up;
172 	u8 tx_fifo_busy_cnt;
173 	u8 port_num;
174 };
175 
176 #define GLTSYN_TGT_H_IDX_MAX		4
177 
178 /**
179  * struct ice_ptp - data used for integrating with CONFIG_PTP_1588_CLOCK
180  * @port: data for the PHY port initialization procedure
181  * @work: delayed work function for periodic tasks
182  * @cached_phc_time: a cached copy of the PHC time for timestamp extension
183  * @cached_phc_jiffies: jiffies when cached_phc_time was last updated
184  * @ext_ts_chan: the external timestamp channel in use
185  * @ext_ts_irq: the external timestamp IRQ in use
186  * @kworker: kwork thread for handling periodic work
187  * @perout_channels: periodic output data
188  * @info: structure defining PTP hardware capabilities
189  * @clock: pointer to registered PTP clock device
190  * @tstamp_config: hardware timestamping configuration
191  * @reset_time: kernel time after clock stop on reset
192  * @tx_hwtstamp_skipped: number of Tx time stamp requests skipped
193  * @tx_hwtstamp_timeouts: number of Tx skbs discarded with no time stamp
194  * @tx_hwtstamp_flushed: number of Tx skbs flushed due to interface closed
195  * @tx_hwtstamp_discarded: number of Tx skbs discarded due to cached PHC time
196  *                         being too old to correctly extend timestamp
197  * @late_cached_phc_updates: number of times cached PHC update is late
198  */
199 struct ice_ptp {
200 	struct ice_ptp_port port;
201 	struct kthread_delayed_work work;
202 	u64 cached_phc_time;
203 	unsigned long cached_phc_jiffies;
204 	u8 ext_ts_chan;
205 	u8 ext_ts_irq;
206 	struct kthread_worker *kworker;
207 	struct ice_perout_channel perout_channels[GLTSYN_TGT_H_IDX_MAX];
208 	struct ptp_clock_info info;
209 	struct ptp_clock *clock;
210 	struct hwtstamp_config tstamp_config;
211 	u64 reset_time;
212 	u32 tx_hwtstamp_skipped;
213 	u32 tx_hwtstamp_timeouts;
214 	u32 tx_hwtstamp_flushed;
215 	u32 tx_hwtstamp_discarded;
216 	u32 late_cached_phc_updates;
217 };
218 
219 #define __ptp_port_to_ptp(p) \
220 	container_of((p), struct ice_ptp, port)
221 #define ptp_port_to_pf(p) \
222 	container_of(__ptp_port_to_ptp((p)), struct ice_pf, ptp)
223 
224 #define __ptp_info_to_ptp(i) \
225 	container_of((i), struct ice_ptp, info)
226 #define ptp_info_to_pf(i) \
227 	container_of(__ptp_info_to_ptp((i)), struct ice_pf, ptp)
228 
229 #define PFTSYN_SEM_BYTES		4
230 #define PTP_SHARED_CLK_IDX_VALID	BIT(31)
231 #define TS_CMD_MASK			0xF
232 #define SYNC_EXEC_CMD			0x3
233 #define ICE_PTP_TS_VALID		BIT(0)
234 
235 #define FIFO_EMPTY			BIT(2)
236 #define FIFO_OK				0xFF
237 #define ICE_PTP_FIFO_NUM_CHECKS		5
238 /* Per-channel register definitions */
239 #define GLTSYN_AUX_OUT(_chan, _idx)	(GLTSYN_AUX_OUT_0(_idx) + ((_chan) * 8))
240 #define GLTSYN_AUX_IN(_chan, _idx)	(GLTSYN_AUX_IN_0(_idx) + ((_chan) * 8))
241 #define GLTSYN_CLKO(_chan, _idx)	(GLTSYN_CLKO_0(_idx) + ((_chan) * 8))
242 #define GLTSYN_TGT_L(_chan, _idx)	(GLTSYN_TGT_L_0(_idx) + ((_chan) * 16))
243 #define GLTSYN_TGT_H(_chan, _idx)	(GLTSYN_TGT_H_0(_idx) + ((_chan) * 16))
244 #define GLTSYN_EVNT_L(_chan, _idx)	(GLTSYN_EVNT_L_0(_idx) + ((_chan) * 16))
245 #define GLTSYN_EVNT_H(_chan, _idx)	(GLTSYN_EVNT_H_0(_idx) + ((_chan) * 16))
246 #define GLTSYN_EVNT_H_IDX_MAX		3
247 
248 /* Pin definitions for PTP PPS out */
249 #define PPS_CLK_GEN_CHAN		3
250 #define PPS_CLK_SRC_CHAN		2
251 #define PPS_PIN_INDEX			5
252 #define TIME_SYNC_PIN_INDEX		4
253 #define N_EXT_TS_E810			3
254 #define N_PER_OUT_E810			4
255 #define N_PER_OUT_E810T			3
256 #define N_PER_OUT_NO_SMA_E810T		2
257 #define N_EXT_TS_NO_SMA_E810T		2
258 #define ETH_GLTSYN_ENA(_i)		(0x03000348 + ((_i) * 4))
259 
260 #if IS_ENABLED(CONFIG_PTP_1588_CLOCK)
261 struct ice_pf;
262 int ice_ptp_set_ts_config(struct ice_pf *pf, struct ifreq *ifr);
263 int ice_ptp_get_ts_config(struct ice_pf *pf, struct ifreq *ifr);
264 void ice_ptp_cfg_timestamp(struct ice_pf *pf, bool ena);
265 int ice_get_ptp_clock_index(struct ice_pf *pf);
266 
267 void ice_ptp_extts_event(struct ice_pf *pf);
268 s8 ice_ptp_request_ts(struct ice_ptp_tx *tx, struct sk_buff *skb);
269 enum ice_tx_tstamp_work ice_ptp_process_ts(struct ice_pf *pf);
270 
271 void
272 ice_ptp_rx_hwtstamp(struct ice_rx_ring *rx_ring,
273 		    union ice_32b_rx_flex_desc *rx_desc, struct sk_buff *skb);
274 void ice_ptp_reset(struct ice_pf *pf);
275 void ice_ptp_prepare_for_reset(struct ice_pf *pf);
276 void ice_ptp_init(struct ice_pf *pf);
277 void ice_ptp_release(struct ice_pf *pf);
278 void ice_ptp_link_change(struct ice_pf *pf, u8 port, bool linkup);
279 #else /* IS_ENABLED(CONFIG_PTP_1588_CLOCK) */
280 static inline int ice_ptp_set_ts_config(struct ice_pf *pf, struct ifreq *ifr)
281 {
282 	return -EOPNOTSUPP;
283 }
284 
285 static inline int ice_ptp_get_ts_config(struct ice_pf *pf, struct ifreq *ifr)
286 {
287 	return -EOPNOTSUPP;
288 }
289 
290 static inline void ice_ptp_cfg_timestamp(struct ice_pf *pf, bool ena) { }
291 static inline int ice_get_ptp_clock_index(struct ice_pf *pf)
292 {
293 	return -1;
294 }
295 
296 static inline void ice_ptp_extts_event(struct ice_pf *pf) { }
297 static inline s8
298 ice_ptp_request_ts(struct ice_ptp_tx *tx, struct sk_buff *skb)
299 {
300 	return -1;
301 }
302 
303 static inline bool ice_ptp_process_ts(struct ice_pf *pf)
304 {
305 	return true;
306 }
307 static inline void
308 ice_ptp_rx_hwtstamp(struct ice_rx_ring *rx_ring,
309 		    union ice_32b_rx_flex_desc *rx_desc, struct sk_buff *skb) { }
310 static inline void ice_ptp_reset(struct ice_pf *pf) { }
311 static inline void ice_ptp_prepare_for_reset(struct ice_pf *pf) { }
312 static inline void ice_ptp_init(struct ice_pf *pf) { }
313 static inline void ice_ptp_release(struct ice_pf *pf) { }
314 static inline void ice_ptp_link_change(struct ice_pf *pf, u8 port, bool linkup)
315 {
316 }
317 #endif /* IS_ENABLED(CONFIG_PTP_1588_CLOCK) */
318 #endif /* _ICE_PTP_H_ */
319