[mirror_ubuntu-hirsute-kernel.git] / drivers / bluetooth / btintel.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 *
 *  Bluetooth support for Intel devices
 *
 *  Copyright (C) 2015  Intel Corporation
 */

/* List of tlv type */
enum {
	INTEL_TLV_CNVI_TOP = 0x10,
	INTEL_TLV_CNVR_TOP,
	INTEL_TLV_CNVI_BT,
	INTEL_TLV_CNVR_BT,
	INTEL_TLV_CNVI_OTP,
	INTEL_TLV_CNVR_OTP,
	INTEL_TLV_DEV_REV_ID,
	INTEL_TLV_USB_VENDOR_ID,
	INTEL_TLV_USB_PRODUCT_ID,
	INTEL_TLV_PCIE_VENDOR_ID,
	INTEL_TLV_PCIE_DEVICE_ID,
	INTEL_TLV_PCIE_SUBSYSTEM_ID,
	INTEL_TLV_IMAGE_TYPE,
	INTEL_TLV_TIME_STAMP,
	INTEL_TLV_BUILD_TYPE,
	INTEL_TLV_BUILD_NUM,
	INTEL_TLV_FW_BUILD_PRODUCT,
	INTEL_TLV_FW_BUILD_HW,
	INTEL_TLV_FW_STEP,
	INTEL_TLV_BT_SPEC,
	INTEL_TLV_MFG_NAME,
	INTEL_TLV_HCI_REV,
	INTEL_TLV_LMP_SUBVER,
	INTEL_TLV_OTP_PATCH_VER,
	INTEL_TLV_SECURE_BOOT,
	INTEL_TLV_KEY_FROM_HDR,
	INTEL_TLV_OTP_LOCK,
	INTEL_TLV_API_LOCK,
	INTEL_TLV_DEBUG_LOCK,
	INTEL_TLV_MIN_FW,
	INTEL_TLV_LIMITED_CCE,
	INTEL_TLV_SBE_TYPE,
	INTEL_TLV_OTP_BDADDR,
	INTEL_TLV_UNLOCKED_STATE
};

struct intel_tlv {
	u8 type;
	u8 len;
	u8 val[];
} __packed;

struct intel_version_tlv {
	u32	cnvi_top;
	u32	cnvr_top;
	u32	cnvi_bt;
	u32	cnvr_bt;
	u16	dev_rev_id;
	u8	img_type;
	u16	timestamp;
	u8	build_type;
	u32	build_num;
	u8	secure_boot;
	u8	otp_lock;
	u8	api_lock;
	u8	debug_lock;
	u8	min_fw_build_nn;
	u8	min_fw_build_cw;
	u8	min_fw_build_yy;
	u8	limited_cce;
	u8	sbe_type;
	bdaddr_t otp_bd_addr;
};

struct intel_version {
	u8 status;
	u8 hw_platform;
	u8 hw_variant;
	u8 hw_revision;
	u8 fw_variant;
	u8 fw_revision;
	u8 fw_build_num;
	u8 fw_build_ww;
	u8 fw_build_yy;
	u8 fw_patch_num;
} __packed;

struct intel_boot_params {
	__u8     status;
	__u8     otp_format;
	__u8     otp_content;
	__u8     otp_patch;
	__le16   dev_revid;
	__u8     secure_boot;
	__u8     key_from_hdr;
	__u8     key_type;
	__u8     otp_lock;
	__u8     api_lock;
	__u8     debug_lock;
	bdaddr_t otp_bdaddr;
	__u8     min_fw_build_nn;
	__u8     min_fw_build_cw;
	__u8     min_fw_build_yy;
	__u8     limited_cce;
	__u8     unlocked_state;
} __packed;

struct intel_bootup {
	__u8     zero;
	__u8     num_cmds;
	__u8     source;
	__u8     reset_type;
	__u8     reset_reason;
	__u8     ddc_status;
} __packed;

struct intel_secure_send_result {
	__u8     result;
	__le16   opcode;
	__u8     status;
} __packed;

struct intel_reset {
	__u8     reset_type;
	__u8     patch_enable;
	__u8     ddc_reload;
	__u8     boot_option;
	__le32   boot_param;
} __packed;

struct intel_debug_features {
	__u8    page1[16];
} __packed;

#define INTEL_HW_PLATFORM(cnvx_bt)	((u8)(((cnvx_bt) & 0x0000ff00) >> 8))
#define INTEL_HW_VARIANT(cnvx_bt)	((u8)(((cnvx_bt) & 0x003f0000) >> 16))
#define INTEL_CNVX_TOP_TYPE(cnvx_top)	((cnvx_top) & 0x00000fff)
#define INTEL_CNVX_TOP_STEP(cnvx_top)	(((cnvx_top) & 0x0f000000) >> 24)
#define INTEL_CNVX_TOP_PACK_SWAB(t, s)	__swab16(((__u16)(((t) << 4) | (s))))

#if IS_ENABLED(CONFIG_BT_INTEL)

int btintel_check_bdaddr(struct hci_dev *hdev);
int btintel_enter_mfg(struct hci_dev *hdev);
int btintel_exit_mfg(struct hci_dev *hdev, bool reset, bool patched);
int btintel_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr);
int btintel_set_diag(struct hci_dev *hdev, bool enable);
int btintel_set_diag_mfg(struct hci_dev *hdev, bool enable);
void btintel_hw_error(struct hci_dev *hdev, u8 code);

void btintel_version_info(struct hci_dev *hdev, struct intel_version *ver);
void btintel_version_info_tlv(struct hci_dev *hdev, struct intel_version_tlv *version);
int btintel_secure_send(struct hci_dev *hdev, u8 fragment_type, u32 plen,
			const void *param);
int btintel_load_ddc_config(struct hci_dev *hdev, const char *ddc_name);
int btintel_set_event_mask(struct hci_dev *hdev, bool debug);
int btintel_set_event_mask_mfg(struct hci_dev *hdev, bool debug);
int btintel_read_version(struct hci_dev *hdev, struct intel_version *ver);
int btintel_read_version_tlv(struct hci_dev *hdev, struct intel_version_tlv *ver);

struct regmap *btintel_regmap_init(struct hci_dev *hdev, u16 opcode_read,
				   u16 opcode_write);
int btintel_send_intel_reset(struct hci_dev *hdev, u32 boot_param);
int btintel_read_boot_params(struct hci_dev *hdev,
			     struct intel_boot_params *params);
int btintel_download_firmware(struct hci_dev *dev, const struct firmware *fw,
			      u32 *boot_param);
int btintel_download_firmware_newgen(struct hci_dev *hdev,
				     const struct firmware *fw,
				     u32 *boot_param, u8 hw_variant,
				     u8 sbe_type);
void btintel_reset_to_bootloader(struct hci_dev *hdev);
int btintel_read_debug_features(struct hci_dev *hdev,
				struct intel_debug_features *features);
int btintel_set_debug_features(struct hci_dev *hdev,
			       const struct intel_debug_features *features);
#else

static inline int btintel_check_bdaddr(struct hci_dev *hdev)
{
	return -EOPNOTSUPP;
}

static inline int btintel_enter_mfg(struct hci_dev *hdev)
{
	return -EOPNOTSUPP;
}

static inline int btintel_exit_mfg(struct hci_dev *hdev, bool reset, bool patched)
{
	return -EOPNOTSUPP;
}

static inline int btintel_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr)
{
	return -EOPNOTSUPP;
}

static inline int btintel_set_diag(struct hci_dev *hdev, bool enable)
{
	return -EOPNOTSUPP;
}

static inline int btintel_set_diag_mfg(struct hci_dev *hdev, bool enable)
{
	return -EOPNOTSUPP;
}

static inline void btintel_hw_error(struct hci_dev *hdev, u8 code)
{
}

static inline void btintel_version_info(struct hci_dev *hdev,
					struct intel_version *ver)
{
}

static inline void btintel_version_info_tlv(struct hci_dev *hdev,
					    struct intel_version_tlv *version)
{
}

static inline int btintel_secure_send(struct hci_dev *hdev, u8 fragment_type,
				      u32 plen, const void *param)
{
	return -EOPNOTSUPP;
}

static inline int btintel_load_ddc_config(struct hci_dev *hdev,
					  const char *ddc_name)
{
	return -EOPNOTSUPP;
}

static inline int btintel_set_event_mask(struct hci_dev *hdev, bool debug)
{
	return -EOPNOTSUPP;
}

static inline int btintel_set_event_mask_mfg(struct hci_dev *hdev, bool debug)
{
	return -EOPNOTSUPP;
}

static inline int btintel_read_version(struct hci_dev *hdev,
				       struct intel_version *ver)
{
	return -EOPNOTSUPP;
}

static inline int btintel_read_version_tlv(struct hci_dev *hdev,
					   struct intel_version_tlv *ver)
{
	return -EOPNOTSUPP;
}

static inline struct regmap *btintel_regmap_init(struct hci_dev *hdev,
						 u16 opcode_read,
						 u16 opcode_write)
{
	return ERR_PTR(-EINVAL);
}

static inline int btintel_send_intel_reset(struct hci_dev *hdev,
					   u32 reset_param)
{
	return -EOPNOTSUPP;
}

static inline int btintel_read_boot_params(struct hci_dev *hdev,
					   struct intel_boot_params *params)
{
	return -EOPNOTSUPP;
}

static inline int btintel_download_firmware(struct hci_dev *dev,
					    const struct firmware *fw,
					    u32 *boot_param)
{
	return -EOPNOTSUPP;
}

static inline int btintel_download_firmware_newgen(struct hci_dev *hdev,
						   const struct firmware *fw,
						   u32 *boot_param,
						   u8 hw_variant, u8 sbe_type)
{
	return -EOPNOTSUPP;
}

static inline void btintel_reset_to_bootloader(struct hci_dev *hdev)
{
}

static inline int btintel_read_debug_features(struct hci_dev *hdev,
					      struct intel_debug_features *features)
{
	return -EOPNOTSUPP;
}

static inline int btintel_set_debug_features(struct hci_dev *hdev,
					     const struct intel_debug_features *features)
{
	return -EOPNOTSUPP;
}

#endif
Commit	Line	Data
1a59d1b8	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
48f0ed1b MH	2	/*
	3	*
	4	* Bluetooth support for Intel devices
	5	*
	6	* Copyright (C) 2015 Intel Corporation
48f0ed1b MH	7	*/
48f0ed1b MH	8
57375bee K	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;
4acbf554	50	u8 val[];
57375bee K	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
59a077c4 MH	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
ccd6da2a MH	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
e5889af6 THJA	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
d74abe21 C	131	struct intel_debug_features {
	132	__u8 page1[16];
	133	} __packed;
	134
9a93b8b8 K	135	#define INTEL_HW_PLATFORM(cnvx_bt) ((u8)(((cnvx_bt) & 0x0000ff00) >> 8))
	136	#define INTEL_HW_VARIANT(cnvx_bt) ((u8)(((cnvx_bt) & 0x003f0000) >> 16))
	137	#define INTEL_CNVX_TOP_TYPE(cnvx_top) ((cnvx_top) & 0x00000fff)
	138	#define INTEL_CNVX_TOP_STEP(cnvx_top) (((cnvx_top) & 0x0f000000) >> 24)
	139	#define INTEL_CNVX_TOP_PACK_SWAB(t, s) __swab16(((__u16)(((t) << 4) \| (s))))
	140
48f0ed1b MH	141	#if IS_ENABLED(CONFIG_BT_INTEL)
	142
	143	int btintel_check_bdaddr(struct hci_dev *hdev);
28dc4b92 LP	144	int btintel_enter_mfg(struct hci_dev *hdev);
28dc4b92 LP	145	int btintel_exit_mfg(struct hci_dev *hdev, bool reset, bool patched);
48f0ed1b	146	int btintel_set_bdaddr(struct hci_dev hdev, const bdaddr_t bdaddr);
6d2e50d2	147	int btintel_set_diag(struct hci_dev *hdev, bool enable);
3e24767b	148	int btintel_set_diag_mfg(struct hci_dev *hdev, bool enable);
973bb97e	149	void btintel_hw_error(struct hci_dev *hdev, u8 code);
48f0ed1b	150
7feb99e1	151	void btintel_version_info(struct hci_dev hdev, struct intel_version ver);
57375bee	152	void btintel_version_info_tlv(struct hci_dev hdev, struct intel_version_tlv version);
09df123d MH	153	int btintel_secure_send(struct hci_dev *hdev, u8 fragment_type, u32 plen,
09df123d MH	154	const void *param);
145f2368	155	int btintel_load_ddc_config(struct hci_dev hdev, const char ddc_name);
213445b2 MH	156	int btintel_set_event_mask(struct hci_dev *hdev, bool debug);
213445b2 MH	157	int btintel_set_event_mask_mfg(struct hci_dev *hdev, bool debug);
6c483de1	158	int btintel_read_version(struct hci_dev hdev, struct intel_version ver);
57375bee	159	int btintel_read_version_tlv(struct hci_dev hdev, struct intel_version_tlv ver);
09df123d	160
d06f107b LP	161	struct regmap btintel_regmap_init(struct hci_dev hdev, u16 opcode_read,
d06f107b LP	162	u16 opcode_write);
e5889af6	163	int btintel_send_intel_reset(struct hci_dev *hdev, u32 boot_param);
faf174d2 THJA	164	int btintel_read_boot_params(struct hci_dev *hdev,
faf174d2 THJA	165	struct intel_boot_params *params);
fbbe83c5 THJA	166	int btintel_download_firmware(struct hci_dev dev, const struct firmware fw,
fbbe83c5 THJA	167	u32 *boot_param);
81ebea53 K	168	int btintel_download_firmware_newgen(struct hci_dev *hdev,
	169	const struct firmware *fw,
	170	u32 *boot_param, u8 hw_variant,
	171	u8 sbe_type);
b9a2562f	172	void btintel_reset_to_bootloader(struct hci_dev *hdev);
d74abe21 C	173	int btintel_read_debug_features(struct hci_dev *hdev,
d74abe21 C	174	struct intel_debug_features *features);
c453b10c C	175	int btintel_set_debug_features(struct hci_dev *hdev,
c453b10c C	176	const struct intel_debug_features *features);
48f0ed1b MH	177	#else
	178
	179	static inline int btintel_check_bdaddr(struct hci_dev *hdev)
	180	{
	181	return -EOPNOTSUPP;
	182	}
	183
28dc4b92 LP	184	static inline int btintel_enter_mfg(struct hci_dev *hdev)
	185	{
	186	return -EOPNOTSUPP;
	187	}
	188
	189	static inline int btintel_exit_mfg(struct hci_dev *hdev, bool reset, bool patched)
	190	{
	191	return -EOPNOTSUPP;
	192	}
	193
48f0ed1b MH	194	static inline int btintel_set_bdaddr(struct hci_dev hdev, const bdaddr_t bdaddr)
	195	{
	196	return -EOPNOTSUPP;
	197	}
	198
6d2e50d2 MH	199	static inline int btintel_set_diag(struct hci_dev *hdev, bool enable)
	200	{
	201	return -EOPNOTSUPP;
	202	}
	203
3e24767b MH	204	static inline int btintel_set_diag_mfg(struct hci_dev *hdev, bool enable)
	205	{
	206	return -EOPNOTSUPP;
	207	}
	208
973bb97e MH	209	static inline void btintel_hw_error(struct hci_dev *hdev, u8 code)
	210	{
	211	}
	212
0eee53cd VS	213	static inline void btintel_version_info(struct hci_dev *hdev,
0eee53cd VS	214	struct intel_version *ver)
7feb99e1 MH	215	{
	216	}
	217
57375bee K	218	static inline void btintel_version_info_tlv(struct hci_dev *hdev,
	219	struct intel_version_tlv *version)
	220	{
	221	}
	222
09df123d MH	223	static inline int btintel_secure_send(struct hci_dev *hdev, u8 fragment_type,
	224	u32 plen, const void *param)
	225	{
	226	return -EOPNOTSUPP;
	227	}
	228
145f2368 LP	229	static inline int btintel_load_ddc_config(struct hci_dev *hdev,
	230	const char *ddc_name)
	231	{
	232	return -EOPNOTSUPP;
	233	}
	234
213445b2 MH	235	static inline int btintel_set_event_mask(struct hci_dev *hdev, bool debug)
	236	{
	237	return -EOPNOTSUPP;
	238	}
	239
	240	static inline int btintel_set_event_mask_mfg(struct hci_dev *hdev, bool debug)
	241	{
	242	return -EOPNOTSUPP;
	243	}
	244
6c483de1 LP	245	static inline int btintel_read_version(struct hci_dev *hdev,
	246	struct intel_version *ver)
	247	{
	248	return -EOPNOTSUPP;
	249	}
	250
57375bee K	251	static inline int btintel_read_version_tlv(struct hci_dev *hdev,
	252	struct intel_version_tlv *ver)
	253	{
	254	return -EOPNOTSUPP;
	255	}
	256
d06f107b LP	257	static inline struct regmap btintel_regmap_init(struct hci_dev hdev,
	258	u16 opcode_read,
	259	u16 opcode_write)
	260	{
	261	return ERR_PTR(-EINVAL);
	262	}
e5889af6 THJA	263
	264	static inline int btintel_send_intel_reset(struct hci_dev *hdev,
	265	u32 reset_param)
	266	{
	267	return -EOPNOTSUPP;
	268	}
faf174d2 THJA	269
	270	static inline int btintel_read_boot_params(struct hci_dev *hdev,
	271	struct intel_boot_params *params)
	272	{
	273	return -EOPNOTSUPP;
	274	}
fbbe83c5 THJA	275
	276	static inline int btintel_download_firmware(struct hci_dev *dev,
	277	const struct firmware *fw,
	278	u32 *boot_param)
	279	{
	280	return -EOPNOTSUPP;
	281	}
b9a2562f	282
81ebea53 K	283	static inline int btintel_download_firmware_newgen(struct hci_dev *hdev,
	284	const struct firmware *fw,
	285	u32 *boot_param,
	286	u8 hw_variant, u8 sbe_type)
	287	{
	288	return -EOPNOTSUPP;
	289	}
	290
b9a2562f AB	291	static inline void btintel_reset_to_bootloader(struct hci_dev *hdev)
b9a2562f AB	292	{
b9a2562f	293	}
d74abe21 C	294
	295	static inline int btintel_read_debug_features(struct hci_dev *hdev,
	296	struct intel_debug_features *features)
	297	{
	298	return -EOPNOTSUPP;
	299	}
	300
c453b10c C	301	static inline int btintel_set_debug_features(struct hci_dev *hdev,
	302	const struct intel_debug_features *features)
	303	{
	304	return -EOPNOTSUPP;
	305	}
	306
48f0ed1b	307	#endif