[mirror_ubuntu-jammy-kernel.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_NVM_ACCESS_SET_REQ_CMD	(0x01)
#define MAX_SIZE_PER_TLV_SEGMENT	(243)
#define QCA_PRE_SHUTDOWN_CMD		(0xFC08)

#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 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

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
};

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,
};

#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, u32 soc_ver,
		   const char *firmware_name);
int qca_read_soc_version(struct hci_dev *hdev, u32 *soc_version,
			 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;
}
#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, u32 soc_ver,
				 const char *firmware_name)
{
	return -EOPNOTSUPP;
}

static inline int qca_read_soc_version(struct hci_dev *hdev, u32 *soc_version,
				       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 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)
	14	#define EDL_NVM_ACCESS_SET_REQ_CMD (0x01)
	15	#define MAX_SIZE_PER_TLV_SEGMENT (243)
a2780889	16	#define QCA_PRE_SHUTDOWN_CMD (0xFC08)
83e81961 BYTK	17
	18	#define EDL_CMD_REQ_RES_EVT (0x00)
	19	#define EDL_PATCH_VER_RES_EVT (0x19)
	20	#define EDL_APP_VER_RES_EVT (0x02)
	21	#define EDL_TVL_DNLD_RES_EVT (0x04)
	22	#define EDL_CMD_EXE_STATUS_EVT (0x00)
	23	#define EDL_SET_BAUDRATE_RSP_EVT (0x92)
	24	#define EDL_NVM_ACCESS_CODE_EVT (0x0B)
	25
	26	#define EDL_TAG_ID_HCI (17)
	27	#define EDL_TAG_ID_DEEP_SLEEP (27)
	28
fa9ad876 BG	29	#define QCA_WCN3990_POWERON_PULSE 0xFC
	30	#define QCA_WCN3990_POWEROFF_PULSE 0xC0
	31
32646db8 BG	32	#define QCA_HCI_CC_OPCODE 0xFC00
	33	#define QCA_HCI_CC_SUCCESS 0x00
	34
75c98a97	35	enum qca_baudrate {
83e81961 BYTK	36	QCA_BAUDRATE_115200 = 0,
	37	QCA_BAUDRATE_57600,
	38	QCA_BAUDRATE_38400,
	39	QCA_BAUDRATE_19200,
	40	QCA_BAUDRATE_9600,
	41	QCA_BAUDRATE_230400,
	42	QCA_BAUDRATE_250000,
	43	QCA_BAUDRATE_460800,
	44	QCA_BAUDRATE_500000,
	45	QCA_BAUDRATE_720000,
	46	QCA_BAUDRATE_921600,
	47	QCA_BAUDRATE_1000000,
	48	QCA_BAUDRATE_1250000,
	49	QCA_BAUDRATE_2000000,
	50	QCA_BAUDRATE_3000000,
	51	QCA_BAUDRATE_4000000,
	52	QCA_BAUDRATE_1600000,
	53	QCA_BAUDRATE_3200000,
	54	QCA_BAUDRATE_3500000,
	55	QCA_BAUDRATE_AUTO = 0xFE,
	56	QCA_BAUDRATE_RESERVED
	57	};
	58
e303d124 BG	59	enum qca_tlv_dnld_mode {
	60	QCA_SKIP_EVT_NONE,
	61	QCA_SKIP_EVT_VSE,
	62	QCA_SKIP_EVT_CC,
	63	QCA_SKIP_EVT_VSE_CC
6e03126a LP	64	};
6e03126a LP	65
e303d124	66	enum qca_tlv_type {
83e81961 BYTK	67	TLV_TYPE_PATCH = 1,
	68	TLV_TYPE_NVM
	69	};
	70
e303d124	71	struct qca_fw_config {
83e81961 BYTK	72	u8 type;
	73	char fwname[64];
	74	uint8_t user_baud_rate;
e303d124 BG	75	enum qca_tlv_dnld_mode dnld_mode;
e303d124 BG	76	enum qca_tlv_dnld_mode dnld_type;
83e81961 BYTK	77	};
	78
	79	struct edl_event_hdr {
	80	__u8 cresp;
	81	__u8 rtype;
a7e45454	82	__u8 data[];
83e81961 BYTK	83	} __packed;
83e81961 BYTK	84
e303d124	85	struct qca_btsoc_version {
83e81961 BYTK	86	__le32 product_id;
83e81961 BYTK	87	__le16 patch_ver;
e303d124	88	__le16 rom_ver;
83e81961 BYTK	89	__le32 soc_id;
	90	} __packed;
	91
	92	struct tlv_seg_resp {
	93	__u8 result;
	94	} __packed;
	95
	96	struct tlv_type_patch {
	97	__le32 total_size;
	98	__le32 data_length;
	99	__u8 format_version;
	100	__u8 signature;
6e03126a LP	101	__u8 download_mode;
6e03126a LP	102	__u8 reserved1;
83e81961 BYTK	103	__le16 product_id;
	104	__le16 rom_build;
	105	__le16 patch_version;
	106	__le16 reserved2;
	107	__le32 entry;
	108	} __packed;
	109
	110	struct tlv_type_nvm {
	111	__le16 tag_id;
	112	__le16 tag_len;
	113	__le32 reserve1;
	114	__le32 reserve2;
a7e45454	115	__u8 data[];
83e81961 BYTK	116	} __packed;
	117
	118	struct tlv_type_hdr {
	119	__le32 type_len;
a7e45454	120	__u8 data[];
83e81961 BYTK	121	} __packed;
83e81961 BYTK	122
aadebac4 BG	123	enum qca_btsoc_type {
	124	QCA_INVALID = -1,
	125	QCA_AR3002,
	126	QCA_ROME,
523760b7 HB	127	QCA_WCN3990,
523760b7 HB	128	QCA_WCN3998,
e5d6468f RL	129	QCA_WCN3991,
e5d6468f RL	130	QCA_QCA6390,
aadebac4 BG	131	};
aadebac4 BG	132
83e81961 BYTK	133	#if IS_ENABLED(CONFIG_BT_QCA)
	134
	135	int qca_set_bdaddr_rome(struct hci_dev hdev, const bdaddr_t bdaddr);
aadebac4	136	int qca_uart_setup(struct hci_dev *hdev, uint8_t baudrate,
99c905c6 RL	137	enum qca_btsoc_type soc_type, u32 soc_ver,
99c905c6 RL	138	const char *firmware_name);
7d250a06 BG	139	int qca_read_soc_version(struct hci_dev hdev, u32 soc_version,
7d250a06 BG	140	enum qca_btsoc_type);
5c0a1001	141	int qca_set_bdaddr(struct hci_dev hdev, const bdaddr_t bdaddr);
a2780889	142	int qca_send_pre_shutdown_cmd(struct hci_dev *hdev);
523760b7 HB	143	static inline bool qca_is_wcn399x(enum qca_btsoc_type soc_type)
523760b7 HB	144	{
7d250a06 BG	145	return soc_type == QCA_WCN3990 \|\| soc_type == QCA_WCN3991 \|\|
7d250a06 BG	146	soc_type == QCA_WCN3998;
523760b7	147	}
83e81961 BYTK	148	#else
	149
	150	static inline int qca_set_bdaddr_rome(struct hci_dev hdev, const bdaddr_t bdaddr)
	151	{
	152	return -EOPNOTSUPP;
	153	}
	154
aadebac4	155	static inline int qca_uart_setup(struct hci_dev *hdev, uint8_t baudrate,
99c905c6 RL	156	enum qca_btsoc_type soc_type, u32 soc_ver,
99c905c6 RL	157	const char *firmware_name)
ba493d4f BG	158	{
	159	return -EOPNOTSUPP;
	160	}
	161
7d250a06 BG	162	static inline int qca_read_soc_version(struct hci_dev hdev, u32 soc_version,
7d250a06 BG	163	enum qca_btsoc_type)
83e81961 BYTK	164	{
	165	return -EOPNOTSUPP;
	166	}
	167
5c0a1001 BG	168	static inline int qca_set_bdaddr(struct hci_dev hdev, const bdaddr_t bdaddr)
	169	{
	170	return -EOPNOTSUPP;
	171	}
	172
523760b7 HB	173	static inline bool qca_is_wcn399x(enum qca_btsoc_type soc_type)
	174	{
	175	return false;
	176	}
a2780889 HB	177
	178	static inline int qca_send_pre_shutdown_cmd(struct hci_dev *hdev)
	179	{
	180	return -EOPNOTSUPP;
	181	}
83e81961	182	#endif