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 u32 flags; 33 u64 period; 34 u64 start_time; 35 }; 36 37 struct ice_extts_channel { 38 bool ena; 39 u32 gpio_pin; 40 u32 flags; 41 }; 42 43 /* The ice hardware captures Tx hardware timestamps in the PHY. The timestamp 44 * is stored in a buffer of registers. Depending on the specific hardware, 45 * this buffer might be shared across multiple PHY ports. 46 * 47 * On transmit of a packet to be timestamped, software is responsible for 48 * selecting an open index. Hardware makes no attempt to lock or prevent 49 * re-use of an index for multiple packets. 50 * 51 * To handle this, timestamp indexes must be tracked by software to ensure 52 * that an index is not re-used for multiple transmitted packets. The 53 * structures and functions declared in this file track the available Tx 54 * register indexes, as well as provide storage for the SKB pointers. 55 * 56 * To allow multiple ports to access the shared register block independently, 57 * the blocks are split up so that indexes are assigned to each port based on 58 * hardware logical port number. 59 * 60 * The timestamp blocks are handled differently for E810- and E822-based 61 * devices. In E810 devices, each port has its own block of timestamps, while in 62 * E822 there is a need to logically break the block of registers into smaller 63 * chunks based on the port number to avoid collisions. 64 * 65 * Example for port 5 in E810: 66 * +--------+--------+--------+--------+--------+--------+--------+--------+ 67 * |register|register|register|register|register|register|register|register| 68 * | block | block | block | block | block | block | block | block | 69 * | for | for | for | for | for | for | for | for | 70 * | port 0 | port 1 | port 2 | port 3 | port 4 | port 5 | port 6 | port 7 | 71 * +--------+--------+--------+--------+--------+--------+--------+--------+ 72 * ^^ 73 * || 74 * |--- quad offset is always 0 75 * ---- quad number 76 * 77 * Example for port 5 in E822: 78 * +-----------------------------+-----------------------------+ 79 * | register block for quad 0 | register block for quad 1 | 80 * |+------+------+------+------+|+------+------+------+------+| 81 * ||port 0|port 1|port 2|port 3|||port 0|port 1|port 2|port 3|| 82 * |+------+------+------+------+|+------+------+------+------+| 83 * +-----------------------------+-------^---------------------+ 84 * ^ | 85 * | --- quad offset* 86 * ---- quad number 87 * 88 * * PHY port 5 is port 1 in quad 1 89 * 90 */ 91 92 /** 93 * struct ice_tx_tstamp - Tracking for a single Tx timestamp 94 * @skb: pointer to the SKB for this timestamp request 95 * @start: jiffies when the timestamp was first requested 96 * @cached_tstamp: last read timestamp 97 * 98 * This structure tracks a single timestamp request. The SKB pointer is 99 * provided when initiating a request. The start time is used to ensure that 100 * we discard old requests that were not fulfilled within a 2 second time 101 * window. 102 * Timestamp values in the PHY are read only and do not get cleared except at 103 * hardware reset or when a new timestamp value is captured. 104 * 105 * Some PHY types do not provide a "ready" bitmap indicating which timestamp 106 * indexes are valid. In these cases, we use a cached_tstamp to keep track of 107 * the last timestamp we read for a given index. If the current timestamp 108 * value is the same as the cached value, we assume a new timestamp hasn't 109 * been captured. This avoids reporting stale timestamps to the stack. This is 110 * only done if the has_ready_bitmap flag is not set in ice_ptp_tx structure. 111 */ 112 struct ice_tx_tstamp { 113 struct sk_buff *skb; 114 unsigned long start; 115 u64 cached_tstamp; 116 }; 117 118 /** 119 * enum ice_tx_tstamp_work - Status of Tx timestamp work function 120 * @ICE_TX_TSTAMP_WORK_DONE: Tx timestamp processing is complete 121 * @ICE_TX_TSTAMP_WORK_PENDING: More Tx timestamps are pending 122 */ 123 enum ice_tx_tstamp_work { 124 ICE_TX_TSTAMP_WORK_DONE = 0, 125 ICE_TX_TSTAMP_WORK_PENDING, 126 }; 127 128 /** 129 * struct ice_ptp_tx - Tracking structure for all Tx timestamp requests on a port 130 * @lock: lock to prevent concurrent access to fields of this struct 131 * @tstamps: array of len to store outstanding requests 132 * @in_use: bitmap of len to indicate which slots are in use 133 * @stale: bitmap of len to indicate slots which have stale timestamps 134 * @block: which memory block (quad or port) the timestamps are captured in 135 * @offset: offset into timestamp block to get the real index 136 * @len: length of the tstamps and in_use fields. 137 * @init: if true, the tracker is initialized; 138 * @calibrating: if true, the PHY is calibrating the Tx offset. During this 139 * window, timestamps are temporarily disabled. 140 * @has_ready_bitmap: if true, the hardware has a valid Tx timestamp ready 141 * bitmap register. If false, fall back to verifying new 142 * timestamp values against previously cached copy. 143 * @last_ll_ts_idx_read: index of the last LL TS read by the FW 144 */ 145 struct ice_ptp_tx { 146 spinlock_t lock; /* lock protecting in_use bitmap */ 147 struct ice_tx_tstamp *tstamps; 148 unsigned long *in_use; 149 unsigned long *stale; 150 u8 block; 151 u8 offset; 152 u8 len; 153 u8 init : 1; 154 u8 calibrating : 1; 155 u8 has_ready_bitmap : 1; 156 s8 last_ll_ts_idx_read; 157 }; 158 159 /* Quad and port information for initializing timestamp blocks */ 160 #define INDEX_PER_QUAD 64 161 #define INDEX_PER_PORT_E82X 16 162 #define INDEX_PER_PORT_E810 64 163 164 /** 165 * struct ice_ptp_port - data used to initialize an external port for PTP 166 * 167 * This structure contains data indicating whether a single external port is 168 * ready for PTP functionality. It is used to track the port initialization 169 * and determine when the port's PHY offset is valid. 170 * 171 * @list_member: list member structure of auxiliary device 172 * @tx: Tx timestamp tracking for this port 173 * @aux_dev: auxiliary device associated with this port 174 * @ov_work: delayed work task for tracking when PHY offset is valid 175 * @ps_lock: mutex used to protect the overall PTP PHY start procedure 176 * @link_up: indicates whether the link is up 177 * @tx_fifo_busy_cnt: number of times the Tx FIFO was busy 178 * @port_num: the port number this structure represents 179 */ 180 struct ice_ptp_port { 181 struct list_head list_member; 182 struct ice_ptp_tx tx; 183 struct auxiliary_device aux_dev; 184 struct kthread_delayed_work ov_work; 185 struct mutex ps_lock; /* protects overall PTP PHY start procedure */ 186 bool link_up; 187 u8 tx_fifo_busy_cnt; 188 u8 port_num; 189 }; 190 191 enum ice_ptp_tx_interrupt { 192 ICE_PTP_TX_INTERRUPT_NONE = 0, 193 ICE_PTP_TX_INTERRUPT_SELF, 194 ICE_PTP_TX_INTERRUPT_ALL, 195 }; 196 197 /** 198 * struct ice_ptp_port_owner - data used to handle the PTP clock owner info 199 * 200 * This structure contains data necessary for the PTP clock owner to correctly 201 * handle the timestamping feature for all attached ports. 202 * 203 * @aux_driver: the structure carring the auxiliary driver information 204 * @ports: list of porst handled by this port owner 205 * @lock: protect access to ports list 206 */ 207 struct ice_ptp_port_owner { 208 struct auxiliary_driver aux_driver; 209 struct list_head ports; 210 struct mutex lock; 211 }; 212 213 #define GLTSYN_TGT_H_IDX_MAX 4 214 215 enum ice_ptp_state { 216 ICE_PTP_UNINIT = 0, 217 ICE_PTP_INITIALIZING, 218 ICE_PTP_READY, 219 ICE_PTP_RESETTING, 220 ICE_PTP_ERROR, 221 }; 222 223 /** 224 * struct ice_ptp - data used for integrating with CONFIG_PTP_1588_CLOCK 225 * @state: current state of PTP state machine 226 * @tx_interrupt_mode: the TX interrupt mode for the PTP clock 227 * @port: data for the PHY port initialization procedure 228 * @ports_owner: data for the auxiliary driver owner 229 * @work: delayed work function for periodic tasks 230 * @cached_phc_time: a cached copy of the PHC time for timestamp extension 231 * @cached_phc_jiffies: jiffies when cached_phc_time was last updated 232 * @ext_ts_chan: the external timestamp channel in use 233 * @ext_ts_irq: the external timestamp IRQ in use 234 * @kworker: kwork thread for handling periodic work 235 * @perout_channels: periodic output data 236 * @extts_channels: channels for external timestamps 237 * @info: structure defining PTP hardware capabilities 238 * @clock: pointer to registered PTP clock device 239 * @tstamp_config: hardware timestamping configuration 240 * @reset_time: kernel time after clock stop on reset 241 * @tx_hwtstamp_skipped: number of Tx time stamp requests skipped 242 * @tx_hwtstamp_timeouts: number of Tx skbs discarded with no time stamp 243 * @tx_hwtstamp_flushed: number of Tx skbs flushed due to interface closed 244 * @tx_hwtstamp_discarded: number of Tx skbs discarded due to cached PHC time 245 * being too old to correctly extend timestamp 246 * @late_cached_phc_updates: number of times cached PHC update is late 247 */ 248 struct ice_ptp { 249 enum ice_ptp_state state; 250 enum ice_ptp_tx_interrupt tx_interrupt_mode; 251 struct ice_ptp_port port; 252 struct ice_ptp_port_owner ports_owner; 253 struct kthread_delayed_work work; 254 u64 cached_phc_time; 255 unsigned long cached_phc_jiffies; 256 u8 ext_ts_chan; 257 u8 ext_ts_irq; 258 struct kthread_worker *kworker; 259 struct ice_perout_channel perout_channels[GLTSYN_TGT_H_IDX_MAX]; 260 struct ice_extts_channel extts_channels[GLTSYN_TGT_H_IDX_MAX]; 261 struct ptp_clock_info info; 262 struct ptp_clock *clock; 263 struct hwtstamp_config tstamp_config; 264 u64 reset_time; 265 u32 tx_hwtstamp_skipped; 266 u32 tx_hwtstamp_timeouts; 267 u32 tx_hwtstamp_flushed; 268 u32 tx_hwtstamp_discarded; 269 u32 late_cached_phc_updates; 270 }; 271 272 #define __ptp_port_to_ptp(p) \ 273 container_of((p), struct ice_ptp, port) 274 #define ptp_port_to_pf(p) \ 275 container_of(__ptp_port_to_ptp((p)), struct ice_pf, ptp) 276 277 #define __ptp_info_to_ptp(i) \ 278 container_of((i), struct ice_ptp, info) 279 #define ptp_info_to_pf(i) \ 280 container_of(__ptp_info_to_ptp((i)), struct ice_pf, ptp) 281 282 #define PFTSYN_SEM_BYTES 4 283 #define PTP_SHARED_CLK_IDX_VALID BIT(31) 284 #define TS_CMD_MASK 0xF 285 #define SYNC_EXEC_CMD 0x3 286 #define ICE_PTP_TS_VALID BIT(0) 287 288 #define FIFO_EMPTY BIT(2) 289 #define FIFO_OK 0xFF 290 #define ICE_PTP_FIFO_NUM_CHECKS 5 291 /* Per-channel register definitions */ 292 #define GLTSYN_AUX_OUT(_chan, _idx) (GLTSYN_AUX_OUT_0(_idx) + ((_chan) * 8)) 293 #define GLTSYN_AUX_IN(_chan, _idx) (GLTSYN_AUX_IN_0(_idx) + ((_chan) * 8)) 294 #define GLTSYN_CLKO(_chan, _idx) (GLTSYN_CLKO_0(_idx) + ((_chan) * 8)) 295 #define GLTSYN_TGT_L(_chan, _idx) (GLTSYN_TGT_L_0(_idx) + ((_chan) * 16)) 296 #define GLTSYN_TGT_H(_chan, _idx) (GLTSYN_TGT_H_0(_idx) + ((_chan) * 16)) 297 #define GLTSYN_EVNT_L(_chan, _idx) (GLTSYN_EVNT_L_0(_idx) + ((_chan) * 16)) 298 #define GLTSYN_EVNT_H(_chan, _idx) (GLTSYN_EVNT_H_0(_idx) + ((_chan) * 16)) 299 #define GLTSYN_EVNT_H_IDX_MAX 3 300 301 /* Pin definitions for PTP PPS out */ 302 #define PPS_CLK_GEN_CHAN 3 303 #define PPS_CLK_SRC_CHAN 2 304 #define PPS_PIN_INDEX 5 305 #define TIME_SYNC_PIN_INDEX 4 306 #define N_EXT_TS_E810 3 307 #define N_PER_OUT_E810 4 308 #define N_PER_OUT_E810T 3 309 #define N_PER_OUT_NO_SMA_E810T 2 310 #define N_EXT_TS_NO_SMA_E810T 2 311 #define ETH_GLTSYN_ENA(_i) (0x03000348 + ((_i) * 4)) 312 313 #if IS_ENABLED(CONFIG_PTP_1588_CLOCK) 314 int ice_ptp_clock_index(struct ice_pf *pf); 315 struct ice_pf; 316 int ice_ptp_set_ts_config(struct ice_pf *pf, struct ifreq *ifr); 317 int ice_ptp_get_ts_config(struct ice_pf *pf, struct ifreq *ifr); 318 void ice_ptp_restore_timestamp_mode(struct ice_pf *pf); 319 320 void ice_ptp_extts_event(struct ice_pf *pf); 321 s8 ice_ptp_request_ts(struct ice_ptp_tx *tx, struct sk_buff *skb); 322 void ice_ptp_req_tx_single_tstamp(struct ice_ptp_tx *tx, u8 idx); 323 void ice_ptp_complete_tx_single_tstamp(struct ice_ptp_tx *tx); 324 enum ice_tx_tstamp_work ice_ptp_process_ts(struct ice_pf *pf); 325 326 u64 ice_ptp_get_rx_hwts(const union ice_32b_rx_flex_desc *rx_desc, 327 const struct ice_pkt_ctx *pkt_ctx); 328 void ice_ptp_rebuild(struct ice_pf *pf, enum ice_reset_req reset_type); 329 void ice_ptp_prepare_for_reset(struct ice_pf *pf, 330 enum ice_reset_req reset_type); 331 void ice_ptp_init(struct ice_pf *pf); 332 void ice_ptp_release(struct ice_pf *pf); 333 void ice_ptp_link_change(struct ice_pf *pf, u8 port, bool linkup); 334 #else /* IS_ENABLED(CONFIG_PTP_1588_CLOCK) */ 335 static inline int ice_ptp_set_ts_config(struct ice_pf *pf, struct ifreq *ifr) 336 { 337 return -EOPNOTSUPP; 338 } 339 340 static inline int ice_ptp_get_ts_config(struct ice_pf *pf, struct ifreq *ifr) 341 { 342 return -EOPNOTSUPP; 343 } 344 345 static inline void ice_ptp_restore_timestamp_mode(struct ice_pf *pf) { } 346 static inline void ice_ptp_extts_event(struct ice_pf *pf) { } 347 static inline s8 348 ice_ptp_request_ts(struct ice_ptp_tx *tx, struct sk_buff *skb) 349 { 350 return -1; 351 } 352 353 static inline void ice_ptp_req_tx_single_tstamp(struct ice_ptp_tx *tx, u8 idx) 354 { } 355 356 static inline void ice_ptp_complete_tx_single_tstamp(struct ice_ptp_tx *tx) { } 357 358 static inline bool ice_ptp_process_ts(struct ice_pf *pf) 359 { 360 return true; 361 } 362 363 static inline u64 364 ice_ptp_get_rx_hwts(const union ice_32b_rx_flex_desc *rx_desc, 365 const struct ice_pkt_ctx *pkt_ctx) 366 { 367 return 0; 368 } 369 370 static inline void ice_ptp_rebuild(struct ice_pf *pf, 371 enum ice_reset_req reset_type) 372 { 373 } 374 375 static inline void ice_ptp_prepare_for_reset(struct ice_pf *pf, 376 enum ice_reset_req reset_type) 377 { 378 } 379 static inline void ice_ptp_init(struct ice_pf *pf) { } 380 static inline void ice_ptp_release(struct ice_pf *pf) { } 381 static inline void ice_ptp_link_change(struct ice_pf *pf, u8 port, bool linkup) 382 { 383 } 384 385 static inline int ice_ptp_clock_index(struct ice_pf *pf) 386 { 387 return -1; 388 } 389 #endif /* IS_ENABLED(CONFIG_PTP_1588_CLOCK) */ 390 #endif /* _ICE_PTP_H_ */ 391