xref: /linux/drivers/net/ethernet/intel/ice/ice_gnss.h (revision 54e47eade73046e860634736d2651ddc118ca694)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (C) 2021-2022, Intel Corporation. */
3 
4 #ifndef _ICE_GNSS_H_
5 #define _ICE_GNSS_H_
6 
7 #define ICE_E810T_GNSS_I2C_BUS		0x2
8 #define ICE_GNSS_POLL_DATA_DELAY_TIME	(HZ / 50) /* poll every 20 ms */
9 #define ICE_GNSS_TIMER_DELAY_TIME	(HZ / 10) /* 0.1 second per message */
10 #define ICE_GNSS_TTY_WRITE_BUF		250
11 #define ICE_MAX_I2C_DATA_SIZE		FIELD_MAX(ICE_AQC_I2C_DATA_SIZE_M)
12 #define ICE_MAX_I2C_WRITE_BYTES		4
13 
14 /* u-blox ZED-F9T specific definitions */
15 #define ICE_GNSS_UBX_I2C_BUS_ADDR	0x42
16 /* Data length register is big endian */
17 #define ICE_GNSS_UBX_DATA_LEN_H		0xFD
18 #define ICE_GNSS_UBX_DATA_LEN_WIDTH	2
19 #define ICE_GNSS_UBX_EMPTY_DATA		0xFF
20 /* For u-blox writes are performed without address so the first byte to write is
21  * passed as I2C addr parameter.
22  */
23 #define ICE_GNSS_UBX_WRITE_BYTES	(ICE_MAX_I2C_WRITE_BYTES + 1)
24 
25 /**
26  * struct gnss_serial - data used to initialize GNSS TTY port
27  * @back: back pointer to PF
28  * @kworker: kwork thread for handling periodic work
29  * @read_work: read_work function for handling GNSS reads
30  */
31 struct gnss_serial {
32 	struct ice_pf *back;
33 	struct kthread_worker *kworker;
34 	struct kthread_delayed_work read_work;
35 };
36 
37 #if IS_ENABLED(CONFIG_GNSS)
38 void ice_gnss_init(struct ice_pf *pf);
39 void ice_gnss_exit(struct ice_pf *pf);
40 bool ice_gnss_is_gps_present(struct ice_hw *hw);
41 #else
42 static inline void ice_gnss_init(struct ice_pf *pf) { }
43 static inline void ice_gnss_exit(struct ice_pf *pf) { }
44 static inline bool ice_gnss_is_gps_present(struct ice_hw *hw)
45 {
46 	return false;
47 }
48 #endif /* IS_ENABLED(CONFIG_GNSS) */
49 #endif /* _ICE_GNSS_H_ */
50