xref: /openbmc/linux/drivers/bluetooth/btintel.h (revision e9b7b8b3)
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_OP_PPAG_CMD		0xFE0B
141 struct hci_ppag_enable_cmd {
142 	__le32	ppag_enable_flags;
143 } __packed;
144 
145 #define INTEL_TLV_TYPE_ID		0x01
146 
147 #define INTEL_TLV_SYSTEM_EXCEPTION	0x00
148 #define INTEL_TLV_FATAL_EXCEPTION	0x01
149 #define INTEL_TLV_DEBUG_EXCEPTION	0x02
150 #define INTEL_TLV_TEST_EXCEPTION	0xDE
151 
152 #define INTEL_HW_PLATFORM(cnvx_bt)	((u8)(((cnvx_bt) & 0x0000ff00) >> 8))
153 #define INTEL_HW_VARIANT(cnvx_bt)	((u8)(((cnvx_bt) & 0x003f0000) >> 16))
154 #define INTEL_CNVX_TOP_TYPE(cnvx_top)	((cnvx_top) & 0x00000fff)
155 #define INTEL_CNVX_TOP_STEP(cnvx_top)	(((cnvx_top) & 0x0f000000) >> 24)
156 #define INTEL_CNVX_TOP_PACK_SWAB(t, s)	__swab16(((__u16)(((t) << 4) | (s))))
157 
158 enum {
159 	INTEL_BOOTLOADER,
160 	INTEL_DOWNLOADING,
161 	INTEL_FIRMWARE_LOADED,
162 	INTEL_FIRMWARE_FAILED,
163 	INTEL_BOOTING,
164 	INTEL_BROKEN_INITIAL_NCMD,
165 	INTEL_BROKEN_SHUTDOWN_LED,
166 	INTEL_ROM_LEGACY,
167 	INTEL_ROM_LEGACY_NO_WBS_SUPPORT,
168 	INTEL_ACPI_RESET_ACTIVE,
169 
170 	__INTEL_NUM_FLAGS,
171 };
172 
173 struct btintel_data {
174 	DECLARE_BITMAP(flags, __INTEL_NUM_FLAGS);
175 	int (*acpi_reset_method)(struct hci_dev *hdev);
176 };
177 
178 #define btintel_set_flag(hdev, nr)					\
179 	do {								\
180 		struct btintel_data *intel = hci_get_priv((hdev));	\
181 		set_bit((nr), intel->flags);				\
182 	} while (0)
183 
184 #define btintel_clear_flag(hdev, nr)					\
185 	do {								\
186 		struct btintel_data *intel = hci_get_priv((hdev));	\
187 		clear_bit((nr), intel->flags);				\
188 	} while (0)
189 
190 #define btintel_wake_up_flag(hdev, nr)					\
191 	do {								\
192 		struct btintel_data *intel = hci_get_priv((hdev));	\
193 		wake_up_bit(intel->flags, (nr));			\
194 	} while (0)
195 
196 #define btintel_get_flag(hdev)						\
197 	(((struct btintel_data *)hci_get_priv(hdev))->flags)
198 
199 #define btintel_test_flag(hdev, nr)	test_bit((nr), btintel_get_flag(hdev))
200 #define btintel_test_and_clear_flag(hdev, nr) test_and_clear_bit((nr), btintel_get_flag(hdev))
201 #define btintel_wait_on_flag_timeout(hdev, nr, m, to)			\
202 		wait_on_bit_timeout(btintel_get_flag(hdev), (nr), m, to)
203 
204 #if IS_ENABLED(CONFIG_BT_INTEL)
205 
206 int btintel_check_bdaddr(struct hci_dev *hdev);
207 int btintel_enter_mfg(struct hci_dev *hdev);
208 int btintel_exit_mfg(struct hci_dev *hdev, bool reset, bool patched);
209 int btintel_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr);
210 int btintel_set_diag(struct hci_dev *hdev, bool enable);
211 
212 int btintel_version_info(struct hci_dev *hdev, struct intel_version *ver);
213 int btintel_load_ddc_config(struct hci_dev *hdev, const char *ddc_name);
214 int btintel_set_event_mask_mfg(struct hci_dev *hdev, bool debug);
215 int btintel_read_version(struct hci_dev *hdev, struct intel_version *ver);
216 struct regmap *btintel_regmap_init(struct hci_dev *hdev, u16 opcode_read,
217 				   u16 opcode_write);
218 int btintel_send_intel_reset(struct hci_dev *hdev, u32 boot_param);
219 int btintel_read_boot_params(struct hci_dev *hdev,
220 			     struct intel_boot_params *params);
221 int btintel_download_firmware(struct hci_dev *dev, struct intel_version *ver,
222 			      const struct firmware *fw, u32 *boot_param);
223 int btintel_configure_setup(struct hci_dev *hdev, const char *driver_name);
224 int btintel_recv_event(struct hci_dev *hdev, struct sk_buff *skb);
225 void btintel_bootup(struct hci_dev *hdev, const void *ptr, unsigned int len);
226 void btintel_secure_send_result(struct hci_dev *hdev,
227 				const void *ptr, unsigned int len);
228 int btintel_set_quality_report(struct hci_dev *hdev, bool enable);
229 #else
230 
231 static inline int btintel_check_bdaddr(struct hci_dev *hdev)
232 {
233 	return -EOPNOTSUPP;
234 }
235 
236 static inline int btintel_enter_mfg(struct hci_dev *hdev)
237 {
238 	return -EOPNOTSUPP;
239 }
240 
241 static inline int btintel_exit_mfg(struct hci_dev *hdev, bool reset, bool patched)
242 {
243 	return -EOPNOTSUPP;
244 }
245 
246 static inline int btintel_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr)
247 {
248 	return -EOPNOTSUPP;
249 }
250 
251 static inline int btintel_set_diag(struct hci_dev *hdev, bool enable)
252 {
253 	return -EOPNOTSUPP;
254 }
255 
256 static inline int btintel_version_info(struct hci_dev *hdev,
257 				       struct intel_version *ver)
258 {
259 	return -EOPNOTSUPP;
260 }
261 
262 static inline int btintel_load_ddc_config(struct hci_dev *hdev,
263 					  const char *ddc_name)
264 {
265 	return -EOPNOTSUPP;
266 }
267 
268 static inline int btintel_set_event_mask_mfg(struct hci_dev *hdev, bool debug)
269 {
270 	return -EOPNOTSUPP;
271 }
272 
273 static inline int btintel_read_version(struct hci_dev *hdev,
274 				       struct intel_version *ver)
275 {
276 	return -EOPNOTSUPP;
277 }
278 
279 static inline struct regmap *btintel_regmap_init(struct hci_dev *hdev,
280 						 u16 opcode_read,
281 						 u16 opcode_write)
282 {
283 	return ERR_PTR(-EINVAL);
284 }
285 
286 static inline int btintel_send_intel_reset(struct hci_dev *hdev,
287 					   u32 reset_param)
288 {
289 	return -EOPNOTSUPP;
290 }
291 
292 static inline int btintel_read_boot_params(struct hci_dev *hdev,
293 					   struct intel_boot_params *params)
294 {
295 	return -EOPNOTSUPP;
296 }
297 
298 static inline int btintel_download_firmware(struct hci_dev *dev,
299 					    const struct firmware *fw,
300 					    u32 *boot_param)
301 {
302 	return -EOPNOTSUPP;
303 }
304 
305 static inline int btintel_configure_setup(struct hci_dev *hdev,
306 					  const char *driver_name)
307 {
308 	return -ENODEV;
309 }
310 
311 static inline void btintel_bootup(struct hci_dev *hdev,
312 				  const void *ptr, unsigned int len)
313 {
314 }
315 
316 static inline void btintel_secure_send_result(struct hci_dev *hdev,
317 				const void *ptr, unsigned int len)
318 {
319 }
320 
321 static inline int btintel_set_quality_report(struct hci_dev *hdev, bool enable)
322 {
323 	return -ENODEV;
324 }
325 #endif
326