xref: /openbmc/linux/drivers/bluetooth/btintel.h (revision 94d964e5)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  *
4  *  Bluetooth support for Intel devices
5  *
6  *  Copyright (C) 2015  Intel Corporation
7  */
8 
9 /* List of tlv type */
10 enum {
11 	INTEL_TLV_CNVI_TOP = 0x10,
12 	INTEL_TLV_CNVR_TOP,
13 	INTEL_TLV_CNVI_BT,
14 	INTEL_TLV_CNVR_BT,
15 	INTEL_TLV_CNVI_OTP,
16 	INTEL_TLV_CNVR_OTP,
17 	INTEL_TLV_DEV_REV_ID,
18 	INTEL_TLV_USB_VENDOR_ID,
19 	INTEL_TLV_USB_PRODUCT_ID,
20 	INTEL_TLV_PCIE_VENDOR_ID,
21 	INTEL_TLV_PCIE_DEVICE_ID,
22 	INTEL_TLV_PCIE_SUBSYSTEM_ID,
23 	INTEL_TLV_IMAGE_TYPE,
24 	INTEL_TLV_TIME_STAMP,
25 	INTEL_TLV_BUILD_TYPE,
26 	INTEL_TLV_BUILD_NUM,
27 	INTEL_TLV_FW_BUILD_PRODUCT,
28 	INTEL_TLV_FW_BUILD_HW,
29 	INTEL_TLV_FW_STEP,
30 	INTEL_TLV_BT_SPEC,
31 	INTEL_TLV_MFG_NAME,
32 	INTEL_TLV_HCI_REV,
33 	INTEL_TLV_LMP_SUBVER,
34 	INTEL_TLV_OTP_PATCH_VER,
35 	INTEL_TLV_SECURE_BOOT,
36 	INTEL_TLV_KEY_FROM_HDR,
37 	INTEL_TLV_OTP_LOCK,
38 	INTEL_TLV_API_LOCK,
39 	INTEL_TLV_DEBUG_LOCK,
40 	INTEL_TLV_MIN_FW,
41 	INTEL_TLV_LIMITED_CCE,
42 	INTEL_TLV_SBE_TYPE,
43 	INTEL_TLV_OTP_BDADDR,
44 	INTEL_TLV_UNLOCKED_STATE
45 };
46 
47 struct intel_tlv {
48 	u8 type;
49 	u8 len;
50 	u8 val[];
51 } __packed;
52 
53 struct intel_version_tlv {
54 	u32	cnvi_top;
55 	u32	cnvr_top;
56 	u32	cnvi_bt;
57 	u32	cnvr_bt;
58 	u16	dev_rev_id;
59 	u8	img_type;
60 	u16	timestamp;
61 	u8	build_type;
62 	u32	build_num;
63 	u8	secure_boot;
64 	u8	otp_lock;
65 	u8	api_lock;
66 	u8	debug_lock;
67 	u8	min_fw_build_nn;
68 	u8	min_fw_build_cw;
69 	u8	min_fw_build_yy;
70 	u8	limited_cce;
71 	u8	sbe_type;
72 	bdaddr_t otp_bd_addr;
73 };
74 
75 struct intel_version {
76 	u8 status;
77 	u8 hw_platform;
78 	u8 hw_variant;
79 	u8 hw_revision;
80 	u8 fw_variant;
81 	u8 fw_revision;
82 	u8 fw_build_num;
83 	u8 fw_build_ww;
84 	u8 fw_build_yy;
85 	u8 fw_patch_num;
86 } __packed;
87 
88 struct intel_boot_params {
89 	__u8     status;
90 	__u8     otp_format;
91 	__u8     otp_content;
92 	__u8     otp_patch;
93 	__le16   dev_revid;
94 	__u8     secure_boot;
95 	__u8     key_from_hdr;
96 	__u8     key_type;
97 	__u8     otp_lock;
98 	__u8     api_lock;
99 	__u8     debug_lock;
100 	bdaddr_t otp_bdaddr;
101 	__u8     min_fw_build_nn;
102 	__u8     min_fw_build_cw;
103 	__u8     min_fw_build_yy;
104 	__u8     limited_cce;
105 	__u8     unlocked_state;
106 } __packed;
107 
108 struct intel_bootup {
109 	__u8     zero;
110 	__u8     num_cmds;
111 	__u8     source;
112 	__u8     reset_type;
113 	__u8     reset_reason;
114 	__u8     ddc_status;
115 } __packed;
116 
117 struct intel_secure_send_result {
118 	__u8     result;
119 	__le16   opcode;
120 	__u8     status;
121 } __packed;
122 
123 struct intel_reset {
124 	__u8     reset_type;
125 	__u8     patch_enable;
126 	__u8     ddc_reload;
127 	__u8     boot_option;
128 	__le32   boot_param;
129 } __packed;
130 
131 struct intel_debug_features {
132 	__u8    page1[16];
133 } __packed;
134 
135 struct intel_offload_use_cases {
136 	__u8	status;
137 	__u8	preset[8];
138 } __packed;
139 
140 #define INTEL_HW_PLATFORM(cnvx_bt)	((u8)(((cnvx_bt) & 0x0000ff00) >> 8))
141 #define INTEL_HW_VARIANT(cnvx_bt)	((u8)(((cnvx_bt) & 0x003f0000) >> 16))
142 #define INTEL_CNVX_TOP_TYPE(cnvx_top)	((cnvx_top) & 0x00000fff)
143 #define INTEL_CNVX_TOP_STEP(cnvx_top)	(((cnvx_top) & 0x0f000000) >> 24)
144 #define INTEL_CNVX_TOP_PACK_SWAB(t, s)	__swab16(((__u16)(((t) << 4) | (s))))
145 
146 enum {
147 	INTEL_BOOTLOADER,
148 	INTEL_DOWNLOADING,
149 	INTEL_FIRMWARE_LOADED,
150 	INTEL_FIRMWARE_FAILED,
151 	INTEL_BOOTING,
152 	INTEL_BROKEN_INITIAL_NCMD,
153 	INTEL_BROKEN_SHUTDOWN_LED,
154 	INTEL_ROM_LEGACY,
155 
156 	__INTEL_NUM_FLAGS,
157 };
158 
159 struct btintel_data {
160 	DECLARE_BITMAP(flags, __INTEL_NUM_FLAGS);
161 };
162 
163 #define btintel_set_flag(hdev, nr)					\
164 	do {								\
165 		struct btintel_data *intel = hci_get_priv((hdev));	\
166 		set_bit((nr), intel->flags);				\
167 	} while (0)
168 
169 #define btintel_clear_flag(hdev, nr)					\
170 	do {								\
171 		struct btintel_data *intel = hci_get_priv((hdev));	\
172 		clear_bit((nr), intel->flags);				\
173 	} while (0)
174 
175 #define btintel_wake_up_flag(hdev, nr)					\
176 	do {								\
177 		struct btintel_data *intel = hci_get_priv((hdev));	\
178 		wake_up_bit(intel->flags, (nr));			\
179 	} while (0)
180 
181 #define btintel_get_flag(hdev)						\
182 	(((struct btintel_data *)hci_get_priv(hdev))->flags)
183 
184 #define btintel_test_flag(hdev, nr)	test_bit((nr), btintel_get_flag(hdev))
185 #define btintel_test_and_clear_flag(hdev, nr) test_and_clear_bit((nr), btintel_get_flag(hdev))
186 #define btintel_wait_on_flag_timeout(hdev, nr, m, to)			\
187 		wait_on_bit_timeout(btintel_get_flag(hdev), (nr), m, to)
188 
189 #if IS_ENABLED(CONFIG_BT_INTEL)
190 
191 int btintel_check_bdaddr(struct hci_dev *hdev);
192 int btintel_enter_mfg(struct hci_dev *hdev);
193 int btintel_exit_mfg(struct hci_dev *hdev, bool reset, bool patched);
194 int btintel_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr);
195 int btintel_set_diag(struct hci_dev *hdev, bool enable);
196 
197 int btintel_version_info(struct hci_dev *hdev, struct intel_version *ver);
198 int btintel_load_ddc_config(struct hci_dev *hdev, const char *ddc_name);
199 int btintel_set_event_mask_mfg(struct hci_dev *hdev, bool debug);
200 int btintel_read_version(struct hci_dev *hdev, struct intel_version *ver);
201 struct regmap *btintel_regmap_init(struct hci_dev *hdev, u16 opcode_read,
202 				   u16 opcode_write);
203 int btintel_send_intel_reset(struct hci_dev *hdev, u32 boot_param);
204 int btintel_read_boot_params(struct hci_dev *hdev,
205 			     struct intel_boot_params *params);
206 int btintel_download_firmware(struct hci_dev *dev, struct intel_version *ver,
207 			      const struct firmware *fw, u32 *boot_param);
208 int btintel_configure_setup(struct hci_dev *hdev);
209 void btintel_bootup(struct hci_dev *hdev, const void *ptr, unsigned int len);
210 void btintel_secure_send_result(struct hci_dev *hdev,
211 				const void *ptr, unsigned int len);
212 int btintel_set_quality_report(struct hci_dev *hdev, bool enable);
213 #else
214 
215 static inline int btintel_check_bdaddr(struct hci_dev *hdev)
216 {
217 	return -EOPNOTSUPP;
218 }
219 
220 static inline int btintel_enter_mfg(struct hci_dev *hdev)
221 {
222 	return -EOPNOTSUPP;
223 }
224 
225 static inline int btintel_exit_mfg(struct hci_dev *hdev, bool reset, bool patched)
226 {
227 	return -EOPNOTSUPP;
228 }
229 
230 static inline int btintel_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr)
231 {
232 	return -EOPNOTSUPP;
233 }
234 
235 static inline int btintel_set_diag(struct hci_dev *hdev, bool enable)
236 {
237 	return -EOPNOTSUPP;
238 }
239 
240 static inline int btintel_version_info(struct hci_dev *hdev,
241 				       struct intel_version *ver)
242 {
243 	return -EOPNOTSUPP;
244 }
245 
246 static inline int btintel_load_ddc_config(struct hci_dev *hdev,
247 					  const char *ddc_name)
248 {
249 	return -EOPNOTSUPP;
250 }
251 
252 static inline int btintel_set_event_mask_mfg(struct hci_dev *hdev, bool debug)
253 {
254 	return -EOPNOTSUPP;
255 }
256 
257 static inline int btintel_read_version(struct hci_dev *hdev,
258 				       struct intel_version *ver)
259 {
260 	return -EOPNOTSUPP;
261 }
262 
263 static inline struct regmap *btintel_regmap_init(struct hci_dev *hdev,
264 						 u16 opcode_read,
265 						 u16 opcode_write)
266 {
267 	return ERR_PTR(-EINVAL);
268 }
269 
270 static inline int btintel_send_intel_reset(struct hci_dev *hdev,
271 					   u32 reset_param)
272 {
273 	return -EOPNOTSUPP;
274 }
275 
276 static inline int btintel_read_boot_params(struct hci_dev *hdev,
277 					   struct intel_boot_params *params)
278 {
279 	return -EOPNOTSUPP;
280 }
281 
282 static inline int btintel_download_firmware(struct hci_dev *dev,
283 					    const struct firmware *fw,
284 					    u32 *boot_param)
285 {
286 	return -EOPNOTSUPP;
287 }
288 
289 static inline int btintel_configure_setup(struct hci_dev *hdev)
290 {
291 	return -ENODEV;
292 }
293 
294 static inline void btintel_bootup(struct hci_dev *hdev,
295 				  const void *ptr, unsigned int len)
296 {
297 }
298 
299 static inline void btintel_secure_send_result(struct hci_dev *hdev,
300 				const void *ptr, unsigned int len)
301 {
302 }
303 
304 static inline int btintel_set_quality_report(struct hci_dev *hdev, bool enable)
305 {
306 	return -ENODEV;
307 }
308 #endif
309