[linux-block.git] / drivers / bluetooth / btqca.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 *  Bluetooth supports for Qualcomm Atheros ROME chips
 *
 *  Copyright (c) 2015 The Linux Foundation. All rights reserved.
 */

#define EDL_PATCH_CMD_OPCODE		(0xFC00)
#define EDL_NVM_ACCESS_OPCODE		(0xFC0B)
#define EDL_WRITE_BD_ADDR_OPCODE	(0xFC14)
#define EDL_PATCH_CMD_LEN		(1)
#define EDL_PATCH_VER_REQ_CMD		(0x19)
#define EDL_PATCH_TLV_REQ_CMD		(0x1E)
#define EDL_GET_BUILD_INFO_CMD		(0x20)
#define EDL_NVM_ACCESS_SET_REQ_CMD	(0x01)
#define MAX_SIZE_PER_TLV_SEGMENT	(243)
#define QCA_PRE_SHUTDOWN_CMD		(0xFC08)
#define QCA_DISABLE_LOGGING		(0xFC17)

#define EDL_CMD_REQ_RES_EVT		(0x00)
#define EDL_PATCH_VER_RES_EVT		(0x19)
#define EDL_APP_VER_RES_EVT		(0x02)
#define EDL_TVL_DNLD_RES_EVT		(0x04)
#define EDL_CMD_EXE_STATUS_EVT		(0x00)
#define EDL_SET_BAUDRATE_RSP_EVT	(0x92)
#define EDL_NVM_ACCESS_CODE_EVT		(0x0B)
#define QCA_DISABLE_LOGGING_SUB_OP	(0x14)

#define EDL_TAG_ID_HCI			(17)
#define EDL_TAG_ID_DEEP_SLEEP		(27)

#define QCA_WCN3990_POWERON_PULSE	0xFC
#define QCA_WCN3990_POWEROFF_PULSE	0xC0

#define QCA_HCI_CC_OPCODE		0xFC00
#define QCA_HCI_CC_SUCCESS		0x00

#define QCA_WCN3991_SOC_ID		(0x40014320)

/* QCA chipset version can be decided by patch and SoC
 * version, combination with upper 2 bytes from SoC
 * and lower 2 bytes from patch will be used.
 */
#define get_soc_ver(soc_id, rom_ver)	\
	((le32_to_cpu(soc_id) << 16) | (le16_to_cpu(rom_ver)))

#define QCA_FW_BUILD_VER_LEN		255


enum qca_baudrate {
	QCA_BAUDRATE_115200 	= 0,
	QCA_BAUDRATE_57600,
	QCA_BAUDRATE_38400,
	QCA_BAUDRATE_19200,
	QCA_BAUDRATE_9600,
	QCA_BAUDRATE_230400,
	QCA_BAUDRATE_250000,
	QCA_BAUDRATE_460800,
	QCA_BAUDRATE_500000,
	QCA_BAUDRATE_720000,
	QCA_BAUDRATE_921600,
	QCA_BAUDRATE_1000000,
	QCA_BAUDRATE_1250000,
	QCA_BAUDRATE_2000000,
	QCA_BAUDRATE_3000000,
	QCA_BAUDRATE_4000000,
	QCA_BAUDRATE_1600000,
	QCA_BAUDRATE_3200000,
	QCA_BAUDRATE_3500000,
	QCA_BAUDRATE_AUTO 	= 0xFE,
	QCA_BAUDRATE_RESERVED
};

enum qca_tlv_dnld_mode {
	QCA_SKIP_EVT_NONE,
	QCA_SKIP_EVT_VSE,
	QCA_SKIP_EVT_CC,
	QCA_SKIP_EVT_VSE_CC
};

enum qca_tlv_type {
	TLV_TYPE_PATCH = 1,
	TLV_TYPE_NVM,
	ELF_TYPE_PATCH,
};

struct qca_fw_config {
	u8 type;
	char fwname[64];
	uint8_t user_baud_rate;
	enum qca_tlv_dnld_mode dnld_mode;
	enum qca_tlv_dnld_mode dnld_type;
};

struct edl_event_hdr {
	__u8 cresp;
	__u8 rtype;
	__u8 data[];
} __packed;

struct qca_btsoc_version {
	__le32 product_id;
	__le16 patch_ver;
	__le16 rom_ver;
	__le32 soc_id;
} __packed;

struct tlv_seg_resp {
	__u8 result;
} __packed;

struct tlv_type_patch {
	__le32 total_size;
	__le32 data_length;
	__u8   format_version;
	__u8   signature;
	__u8   download_mode;
	__u8   reserved1;
	__le16 product_id;
	__le16 rom_build;
	__le16 patch_version;
	__le16 reserved2;
	__le32 entry;
} __packed;

struct tlv_type_nvm {
	__le16 tag_id;
	__le16 tag_len;
	__le32 reserve1;
	__le32 reserve2;
	__u8   data[];
} __packed;

struct tlv_type_hdr {
	__le32 type_len;
	__u8   data[];
} __packed;

enum qca_btsoc_type {
	QCA_INVALID = -1,
	QCA_AR3002,
	QCA_ROME,
	QCA_WCN3990,
	QCA_WCN3998,
	QCA_WCN3991,
	QCA_QCA6390,
	QCA_WCN6750,
};

#if IS_ENABLED(CONFIG_BT_QCA)

int qca_set_bdaddr_rome(struct hci_dev *hdev, const bdaddr_t *bdaddr);
int qca_uart_setup(struct hci_dev *hdev, uint8_t baudrate,
		   enum qca_btsoc_type soc_type, struct qca_btsoc_version ver,
		   const char *firmware_name);
int qca_read_soc_version(struct hci_dev *hdev, struct qca_btsoc_version *ver,
			 enum qca_btsoc_type);
int qca_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr);
int qca_send_pre_shutdown_cmd(struct hci_dev *hdev);
static inline bool qca_is_wcn399x(enum qca_btsoc_type soc_type)
{
	return soc_type == QCA_WCN3990 || soc_type == QCA_WCN3991 ||
	       soc_type == QCA_WCN3998;
}
static inline bool qca_is_wcn6750(enum qca_btsoc_type soc_type)
{
	return soc_type == QCA_WCN6750;
}

#else

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

static inline int qca_uart_setup(struct hci_dev *hdev, uint8_t baudrate,
				 enum qca_btsoc_type soc_type,
				 struct qca_btsoc_version ver,
				 const char *firmware_name)
{
	return -EOPNOTSUPP;
}

static inline int qca_read_soc_version(struct hci_dev *hdev,
				       struct qca_btsoc_version *ver,
				       enum qca_btsoc_type)
{
	return -EOPNOTSUPP;
}

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

static inline bool qca_is_wcn399x(enum qca_btsoc_type soc_type)
{
	return false;
}

static inline bool qca_is_wcn6750(enum qca_btsoc_type soc_type)
{
	return false;
}

static inline int qca_send_pre_shutdown_cmd(struct hci_dev *hdev)
{
	return -EOPNOTSUPP;
}
#endif
Commit	Line	Data
45051539	1	/* SPDX-License-Identifier: GPL-2.0-only */
83e81961 BYTK	2	/*
	3	* Bluetooth supports for Qualcomm Atheros ROME chips
	4	*
	5	* Copyright (c) 2015 The Linux Foundation. All rights reserved.
83e81961 BYTK	6	*/
	7
	8	#define EDL_PATCH_CMD_OPCODE (0xFC00)
	9	#define EDL_NVM_ACCESS_OPCODE (0xFC0B)
5c0a1001	10	#define EDL_WRITE_BD_ADDR_OPCODE (0xFC14)
83e81961 BYTK	11	#define EDL_PATCH_CMD_LEN (1)
	12	#define EDL_PATCH_VER_REQ_CMD (0x19)
	13	#define EDL_PATCH_TLV_REQ_CMD (0x1E)
c0187b0b	14	#define EDL_GET_BUILD_INFO_CMD (0x20)
83e81961 BYTK	15	#define EDL_NVM_ACCESS_SET_REQ_CMD (0x01)
83e81961 BYTK	16	#define MAX_SIZE_PER_TLV_SEGMENT (243)
a2780889	17	#define QCA_PRE_SHUTDOWN_CMD (0xFC08)
590deccf	18	#define QCA_DISABLE_LOGGING (0xFC17)
83e81961 BYTK	19
	20	#define EDL_CMD_REQ_RES_EVT (0x00)
	21	#define EDL_PATCH_VER_RES_EVT (0x19)
	22	#define EDL_APP_VER_RES_EVT (0x02)
	23	#define EDL_TVL_DNLD_RES_EVT (0x04)
	24	#define EDL_CMD_EXE_STATUS_EVT (0x00)
	25	#define EDL_SET_BAUDRATE_RSP_EVT (0x92)
	26	#define EDL_NVM_ACCESS_CODE_EVT (0x0B)
590deccf	27	#define QCA_DISABLE_LOGGING_SUB_OP (0x14)
83e81961 BYTK	28
	29	#define EDL_TAG_ID_HCI (17)
	30	#define EDL_TAG_ID_DEEP_SLEEP (27)
	31
fa9ad876 BG	32	#define QCA_WCN3990_POWERON_PULSE 0xFC
	33	#define QCA_WCN3990_POWEROFF_PULSE 0xC0
	34
32646db8 BG	35	#define QCA_HCI_CC_OPCODE 0xFC00
	36	#define QCA_HCI_CC_SUCCESS 0x00
	37
059924fd VLNG	38	#define QCA_WCN3991_SOC_ID (0x40014320)
	39
	40	/* QCA chipset version can be decided by patch and SoC
	41	* version, combination with upper 2 bytes from SoC
	42	* and lower 2 bytes from patch will be used.
	43	*/
	44	#define get_soc_ver(soc_id, rom_ver) \
	45	((le32_to_cpu(soc_id) << 16) \| (le16_to_cpu(rom_ver)))
	46
	47	#define QCA_FW_BUILD_VER_LEN 255
	48
	49
75c98a97	50	enum qca_baudrate {
83e81961 BYTK	51	QCA_BAUDRATE_115200 = 0,
	52	QCA_BAUDRATE_57600,
	53	QCA_BAUDRATE_38400,
	54	QCA_BAUDRATE_19200,
	55	QCA_BAUDRATE_9600,
	56	QCA_BAUDRATE_230400,
	57	QCA_BAUDRATE_250000,
	58	QCA_BAUDRATE_460800,
	59	QCA_BAUDRATE_500000,
	60	QCA_BAUDRATE_720000,
	61	QCA_BAUDRATE_921600,
	62	QCA_BAUDRATE_1000000,
	63	QCA_BAUDRATE_1250000,
	64	QCA_BAUDRATE_2000000,
	65	QCA_BAUDRATE_3000000,
	66	QCA_BAUDRATE_4000000,
	67	QCA_BAUDRATE_1600000,
	68	QCA_BAUDRATE_3200000,
	69	QCA_BAUDRATE_3500000,
	70	QCA_BAUDRATE_AUTO = 0xFE,
	71	QCA_BAUDRATE_RESERVED
	72	};
	73
e303d124 BG	74	enum qca_tlv_dnld_mode {
	75	QCA_SKIP_EVT_NONE,
	76	QCA_SKIP_EVT_VSE,
	77	QCA_SKIP_EVT_CC,
	78	QCA_SKIP_EVT_VSE_CC
6e03126a LP	79	};
6e03126a LP	80
e303d124	81	enum qca_tlv_type {
83e81961	82	TLV_TYPE_PATCH = 1,
ecf6b2d9 VLNG	83	TLV_TYPE_NVM,
ecf6b2d9 VLNG	84	ELF_TYPE_PATCH,
83e81961 BYTK	85	};
83e81961 BYTK	86
e303d124	87	struct qca_fw_config {
83e81961 BYTK	88	u8 type;
	89	char fwname[64];
	90	uint8_t user_baud_rate;
e303d124 BG	91	enum qca_tlv_dnld_mode dnld_mode;
e303d124 BG	92	enum qca_tlv_dnld_mode dnld_type;
83e81961 BYTK	93	};
	94
	95	struct edl_event_hdr {
	96	__u8 cresp;
	97	__u8 rtype;
a7e45454	98	__u8 data[];
83e81961 BYTK	99	} __packed;
83e81961 BYTK	100
e303d124	101	struct qca_btsoc_version {
83e81961 BYTK	102	__le32 product_id;
83e81961 BYTK	103	__le16 patch_ver;
e303d124	104	__le16 rom_ver;
83e81961 BYTK	105	__le32 soc_id;
	106	} __packed;
	107
	108	struct tlv_seg_resp {
	109	__u8 result;
	110	} __packed;
	111
	112	struct tlv_type_patch {
	113	__le32 total_size;
	114	__le32 data_length;
	115	__u8 format_version;
	116	__u8 signature;
6e03126a LP	117	__u8 download_mode;
6e03126a LP	118	__u8 reserved1;
83e81961 BYTK	119	__le16 product_id;
	120	__le16 rom_build;
	121	__le16 patch_version;
	122	__le16 reserved2;
	123	__le32 entry;
	124	} __packed;
	125
	126	struct tlv_type_nvm {
	127	__le16 tag_id;
	128	__le16 tag_len;
	129	__le32 reserve1;
	130	__le32 reserve2;
a7e45454	131	__u8 data[];
83e81961 BYTK	132	} __packed;
	133
	134	struct tlv_type_hdr {
	135	__le32 type_len;
a7e45454	136	__u8 data[];
83e81961 BYTK	137	} __packed;
83e81961 BYTK	138
aadebac4 BG	139	enum qca_btsoc_type {
	140	QCA_INVALID = -1,
	141	QCA_AR3002,
	142	QCA_ROME,
523760b7 HB	143	QCA_WCN3990,
523760b7 HB	144	QCA_WCN3998,
e5d6468f RL	145	QCA_WCN3991,
e5d6468f RL	146	QCA_QCA6390,
d8f97da1	147	QCA_WCN6750,
aadebac4 BG	148	};
aadebac4 BG	149
83e81961 BYTK	150	#if IS_ENABLED(CONFIG_BT_QCA)
	151
	152	int qca_set_bdaddr_rome(struct hci_dev hdev, const bdaddr_t bdaddr);
aadebac4	153	int qca_uart_setup(struct hci_dev *hdev, uint8_t baudrate,
059924fd	154	enum qca_btsoc_type soc_type, struct qca_btsoc_version ver,
99c905c6	155	const char *firmware_name);
059924fd	156	int qca_read_soc_version(struct hci_dev hdev, struct qca_btsoc_version ver,
7d250a06	157	enum qca_btsoc_type);
5c0a1001	158	int qca_set_bdaddr(struct hci_dev hdev, const bdaddr_t bdaddr);
a2780889	159	int qca_send_pre_shutdown_cmd(struct hci_dev *hdev);
523760b7 HB	160	static inline bool qca_is_wcn399x(enum qca_btsoc_type soc_type)
523760b7 HB	161	{
7d250a06 BG	162	return soc_type == QCA_WCN3990 \|\| soc_type == QCA_WCN3991 \|\|
7d250a06 BG	163	soc_type == QCA_WCN3998;
523760b7	164	}
d8f97da1 VLNG	165	static inline bool qca_is_wcn6750(enum qca_btsoc_type soc_type)
	166	{
	167	return soc_type == QCA_WCN6750;
	168	}
	169
83e81961 BYTK	170	#else
	171
	172	static inline int qca_set_bdaddr_rome(struct hci_dev hdev, const bdaddr_t bdaddr)
	173	{
	174	return -EOPNOTSUPP;
	175	}
	176
aadebac4	177	static inline int qca_uart_setup(struct hci_dev *hdev, uint8_t baudrate,
059924fd VLNG	178	enum qca_btsoc_type soc_type,
059924fd VLNG	179	struct qca_btsoc_version ver,
99c905c6	180	const char *firmware_name)
ba493d4f BG	181	{
	182	return -EOPNOTSUPP;
	183	}
	184
059924fd VLNG	185	static inline int qca_read_soc_version(struct hci_dev *hdev,
059924fd VLNG	186	struct qca_btsoc_version *ver,
7d250a06	187	enum qca_btsoc_type)
83e81961 BYTK	188	{
	189	return -EOPNOTSUPP;
	190	}
	191
5c0a1001 BG	192	static inline int qca_set_bdaddr(struct hci_dev hdev, const bdaddr_t bdaddr)
	193	{
	194	return -EOPNOTSUPP;
	195	}
	196
523760b7 HB	197	static inline bool qca_is_wcn399x(enum qca_btsoc_type soc_type)
	198	{
	199	return false;
	200	}
a2780889	201
d8f97da1 VLNG	202	static inline bool qca_is_wcn6750(enum qca_btsoc_type soc_type)
	203	{
	204	return false;
	205	}
	206
a2780889 HB	207	static inline int qca_send_pre_shutdown_cmd(struct hci_dev *hdev)
	208	{
	209	return -EOPNOTSUPP;
	210	}
83e81961	211	#endif