[people/ms/linux.git] / drivers / bluetooth / btmrvl_drv.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Marvell Bluetooth driver: global definitions & declarations
 *
 * Copyright (C) 2009, Marvell International Ltd.
 */

#include <linux/kthread.h>
#include <linux/bitops.h>
#include <linux/slab.h>
#include <net/bluetooth/bluetooth.h>
#include <linux/err.h>
#include <linux/gfp.h>
#include <linux/interrupt.h>
#include <linux/io.h>
#include <linux/of_platform.h>
#include <linux/platform_device.h>
#include <linux/pm_runtime.h>
#include <linux/of_irq.h>

#define BTM_HEADER_LEN			4
#define BTM_UPLD_SIZE			2312

/* Time to wait until Host Sleep state change in millisecond */
#define WAIT_UNTIL_HS_STATE_CHANGED	msecs_to_jiffies(5000)
/* Time to wait for command response in millisecond */
#define WAIT_UNTIL_CMD_RESP		msecs_to_jiffies(5000)

enum rdwr_status {
	RDWR_STATUS_SUCCESS = 0,
	RDWR_STATUS_FAILURE = 1,
	RDWR_STATUS_DONE = 2
};

#define FW_DUMP_MAX_NAME_LEN    8
#define FW_DUMP_HOST_READY      0xEE
#define FW_DUMP_DONE            0xFF
#define FW_DUMP_READ_DONE       0xFE

struct memory_type_mapping {
	u8 mem_name[FW_DUMP_MAX_NAME_LEN];
	u8 *mem_ptr;
	u32 mem_size;
	u8 done_flag;
};

struct btmrvl_thread {
	struct task_struct *task;
	wait_queue_head_t wait_q;
	void *priv;
};

struct btmrvl_device {
	void *card;
	struct hci_dev *hcidev;

	u8 dev_type;

	u8 tx_dnld_rdy;

	u8 psmode;
	u8 pscmd;
	u8 hsmode;
	u8 hscmd;

	/* Low byte is gap, high byte is GPIO */
	u16 gpio_gap;

	u8 hscfgcmd;
	u8 sendcmdflag;
};

struct btmrvl_adapter {
	void *hw_regs_buf;
	u8 *hw_regs;
	u32 int_count;
	struct sk_buff_head tx_queue;
	u8 psmode;
	u8 ps_state;
	u8 hs_state;
	u8 wakeup_tries;
	wait_queue_head_t cmd_wait_q;
	wait_queue_head_t event_hs_wait_q;
	u8 cmd_complete;
	bool is_suspended;
	bool is_suspending;
};

struct btmrvl_private {
	struct btmrvl_device btmrvl_dev;
	struct btmrvl_adapter *adapter;
	struct btmrvl_thread main_thread;
	int (*hw_host_to_card)(struct btmrvl_private *priv,
				u8 *payload, u16 nb);
	int (*hw_wakeup_firmware)(struct btmrvl_private *priv);
	int (*hw_process_int_status)(struct btmrvl_private *priv);
	spinlock_t driver_lock;		/* spinlock used by driver */
#ifdef CONFIG_DEBUG_FS
	void *debugfs_data;
#endif
	bool surprise_removed;
};

#define MRVL_VENDOR_PKT			0xFE

/* Vendor specific Bluetooth commands */
#define BT_CMD_PSCAN_WIN_REPORT_ENABLE	0xFC03
#define BT_CMD_ROUTE_SCO_TO_HOST	0xFC1D
#define BT_CMD_SET_BDADDR		0xFC22
#define BT_CMD_AUTO_SLEEP_MODE		0xFC23
#define BT_CMD_HOST_SLEEP_CONFIG	0xFC59
#define BT_CMD_HOST_SLEEP_ENABLE	0xFC5A
#define BT_CMD_MODULE_CFG_REQ		0xFC5B
#define BT_CMD_LOAD_CONFIG_DATA		0xFC61

/* Sub-commands: Module Bringup/Shutdown Request/Response */
#define MODULE_BRINGUP_REQ		0xF1
#define MODULE_BROUGHT_UP		0x00
#define MODULE_ALREADY_UP		0x0C

#define MODULE_SHUTDOWN_REQ		0xF2

/* Vendor specific Bluetooth events */
#define BT_EVENT_AUTO_SLEEP_MODE	0x23
#define BT_EVENT_HOST_SLEEP_CONFIG	0x59
#define BT_EVENT_HOST_SLEEP_ENABLE	0x5A
#define BT_EVENT_MODULE_CFG_REQ		0x5B
#define BT_EVENT_POWER_STATE		0x20

/* Bluetooth Power States */
#define BT_PS_ENABLE			0x02
#define BT_PS_DISABLE			0x03
#define BT_PS_SLEEP			0x01

/* Host Sleep states */
#define HS_ACTIVATED			0x01
#define HS_DEACTIVATED			0x00

/* Power Save modes */
#define PS_SLEEP			0x01
#define PS_AWAKE			0x00

#define BT_CAL_HDR_LEN			4
#define BT_CAL_DATA_SIZE		28

struct btmrvl_event {
	u8 ec;		/* event counter */
	u8 length;
	u8 data[4];
} __packed;

/* Prototype of global function */

int btmrvl_register_hdev(struct btmrvl_private *priv);
struct btmrvl_private *btmrvl_add_card(void *card);
int btmrvl_remove_card(struct btmrvl_private *priv);

void btmrvl_interrupt(struct btmrvl_private *priv);

bool btmrvl_check_evtpkt(struct btmrvl_private *priv, struct sk_buff *skb);
int btmrvl_process_event(struct btmrvl_private *priv, struct sk_buff *skb);

int btmrvl_send_module_cfg_cmd(struct btmrvl_private *priv, u8 subcmd);
int btmrvl_pscan_window_reporting(struct btmrvl_private *priv, u8 subcmd);
int btmrvl_send_hscfg_cmd(struct btmrvl_private *priv);
int btmrvl_enable_ps(struct btmrvl_private *priv);
int btmrvl_prepare_command(struct btmrvl_private *priv);
int btmrvl_enable_hs(struct btmrvl_private *priv);

#ifdef CONFIG_DEBUG_FS
void btmrvl_debugfs_init(struct hci_dev *hdev);
void btmrvl_debugfs_remove(struct hci_dev *hdev);
#endif
Commit	Line	Data
99c926ce	1	/* SPDX-License-Identifier: GPL-2.0-only */
132ff4e5 BZ	2	/*
	3	* Marvell Bluetooth driver: global definitions & declarations
	4	*
	5	* Copyright (C) 2009, Marvell International Ltd.
132ff4e5 BZ	6	*/
132ff4e5 BZ	7
132ff4e5 BZ	8	#include <linux/kthread.h>
132ff4e5 BZ	9	#include <linux/bitops.h>
5a0e3ad6	10	#include <linux/slab.h>
132ff4e5	11	#include <net/bluetooth/bluetooth.h>
bb7f4f0b	12	#include <linux/err.h>
bb7f4f0b XH	13	#include <linux/gfp.h>
	14	#include <linux/interrupt.h>
	15	#include <linux/io.h>
bb7f4f0b XH	16	#include <linux/of_platform.h>
	17	#include <linux/platform_device.h>
	18	#include <linux/pm_runtime.h>
bb7f4f0b	19	#include <linux/of_irq.h>
132ff4e5 BZ	20
132ff4e5 BZ	21	#define BTM_HEADER_LEN 4
132ff4e5 BZ	22	#define BTM_UPLD_SIZE 2312
	23
	24	/* Time to wait until Host Sleep state change in millisecond */
0333d6dd	25	#define WAIT_UNTIL_HS_STATE_CHANGED msecs_to_jiffies(5000)
132ff4e5	26	/* Time to wait for command response in millisecond */
0333d6dd	27	#define WAIT_UNTIL_CMD_RESP msecs_to_jiffies(5000)
132ff4e5	28
dc759613 XH	29	enum rdwr_status {
	30	RDWR_STATUS_SUCCESS = 0,
	31	RDWR_STATUS_FAILURE = 1,
	32	RDWR_STATUS_DONE = 2
	33	};
	34
	35	#define FW_DUMP_MAX_NAME_LEN 8
	36	#define FW_DUMP_HOST_READY 0xEE
	37	#define FW_DUMP_DONE 0xFF
	38	#define FW_DUMP_READ_DONE 0xFE
	39
	40	struct memory_type_mapping {
	41	u8 mem_name[FW_DUMP_MAX_NAME_LEN];
	42	u8 *mem_ptr;
	43	u32 mem_size;
	44	u8 done_flag;
	45	};
	46
132ff4e5 BZ	47	struct btmrvl_thread {
	48	struct task_struct *task;
	49	wait_queue_head_t wait_q;
	50	void *priv;
	51	};
	52
	53	struct btmrvl_device {
132ff4e5 BZ	54	void *card;
	55	struct hci_dev *hcidev;
	56
f120c6b6 BZ	57	u8 dev_type;
f120c6b6 BZ	58
132ff4e5 BZ	59	u8 tx_dnld_rdy;
	60
	61	u8 psmode;
	62	u8 pscmd;
	63	u8 hsmode;
	64	u8 hscmd;
	65
	66	/* Low byte is gap, high byte is GPIO */
	67	u16 gpio_gap;
	68
	69	u8 hscfgcmd;
	70	u8 sendcmdflag;
	71	};
	72
	73	struct btmrvl_adapter {
0d367408 BZ	74	void *hw_regs_buf;
0d367408 BZ	75	u8 *hw_regs;
132ff4e5 BZ	76	u32 int_count;
	77	struct sk_buff_head tx_queue;
	78	u8 psmode;
	79	u8 ps_state;
	80	u8 hs_state;
	81	u8 wakeup_tries;
	82	wait_queue_head_t cmd_wait_q;
396e04f4	83	wait_queue_head_t event_hs_wait_q;
132ff4e5	84	u8 cmd_complete;
ba54a16f	85	bool is_suspended;
8cf60cf2	86	bool is_suspending;
132ff4e5 BZ	87	};
	88
	89	struct btmrvl_private {
	90	struct btmrvl_device btmrvl_dev;
	91	struct btmrvl_adapter *adapter;
	92	struct btmrvl_thread main_thread;
ba27b7ef	93	int (hw_host_to_card)(struct btmrvl_private priv,
132ff4e5	94	u8 *payload, u16 nb);
ba27b7ef PK	95	int (hw_wakeup_firmware)(struct btmrvl_private priv);
ba27b7ef PK	96	int (hw_process_int_status)(struct btmrvl_private priv);
132ff4e5	97	spinlock_t driver_lock; /* spinlock used by driver */
fb784f05 BZ	98	#ifdef CONFIG_DEBUG_FS
	99	void *debugfs_data;
	100	#endif
7b4b8740	101	bool surprise_removed;
132ff4e5 BZ	102	};
	103
	104	#define MRVL_VENDOR_PKT 0xFE
	105
3e4543ab	106	/* Vendor specific Bluetooth commands */
4df82b59	107	#define BT_CMD_PSCAN_WIN_REPORT_ENABLE 0xFC03
a715d11e	108	#define BT_CMD_ROUTE_SCO_TO_HOST 0xFC1D
27b869f5	109	#define BT_CMD_SET_BDADDR 0xFC22
3e4543ab BZ	110	#define BT_CMD_AUTO_SLEEP_MODE 0xFC23
	111	#define BT_CMD_HOST_SLEEP_CONFIG 0xFC59
	112	#define BT_CMD_HOST_SLEEP_ENABLE 0xFC5A
	113	#define BT_CMD_MODULE_CFG_REQ 0xFC5B
	114	#define BT_CMD_LOAD_CONFIG_DATA 0xFC61
132ff4e5	115
903c8437	116	/* Sub-commands: Module Bringup/Shutdown Request/Response */
132ff4e5	117	#define MODULE_BRINGUP_REQ 0xF1
903c8437 BZ	118	#define MODULE_BROUGHT_UP 0x00
	119	#define MODULE_ALREADY_UP 0x0C
	120
132ff4e5 BZ	121	#define MODULE_SHUTDOWN_REQ 0xF2
132ff4e5 BZ	122
3e4543ab BZ	123	/* Vendor specific Bluetooth events */
	124	#define BT_EVENT_AUTO_SLEEP_MODE 0x23
	125	#define BT_EVENT_HOST_SLEEP_CONFIG 0x59
	126	#define BT_EVENT_HOST_SLEEP_ENABLE 0x5A
	127	#define BT_EVENT_MODULE_CFG_REQ 0x5B
132ff4e5 BZ	128	#define BT_EVENT_POWER_STATE 0x20
	129
	130	/* Bluetooth Power States */
	131	#define BT_PS_ENABLE 0x02
	132	#define BT_PS_DISABLE 0x03
	133	#define BT_PS_SLEEP 0x01
	134
132ff4e5 BZ	135	/* Host Sleep states */
	136	#define HS_ACTIVATED 0x01
	137	#define HS_DEACTIVATED 0x00
	138
	139	/* Power Save modes */
	140	#define PS_SLEEP 0x01
	141	#define PS_AWAKE 0x00
	142
8a4934f1	143	#define BT_CAL_HDR_LEN 4
2cc86890 AK	144	#define BT_CAL_DATA_SIZE 28
2cc86890 AK	145
132ff4e5 BZ	146	struct btmrvl_event {
	147	u8 ec; /* event counter */
	148	u8 length;
	149	u8 data[4];
81ca405a	150	} __packed;
132ff4e5 BZ	151
	152	/* Prototype of global function */
	153
64061607	154	int btmrvl_register_hdev(struct btmrvl_private *priv);
132ff4e5 BZ	155	struct btmrvl_private btmrvl_add_card(void card);
	156	int btmrvl_remove_card(struct btmrvl_private *priv);
	157
	158	void btmrvl_interrupt(struct btmrvl_private *priv);
	159
ea1e76a3	160	bool btmrvl_check_evtpkt(struct btmrvl_private priv, struct sk_buff skb);
132ff4e5 BZ	161	int btmrvl_process_event(struct btmrvl_private priv, struct sk_buff skb);
132ff4e5 BZ	162
7125df53	163	int btmrvl_send_module_cfg_cmd(struct btmrvl_private *priv, u8 subcmd);
af963243	164	int btmrvl_pscan_window_reporting(struct btmrvl_private *priv, u8 subcmd);
2a8ff611	165	int btmrvl_send_hscfg_cmd(struct btmrvl_private *priv);
32fd6398	166	int btmrvl_enable_ps(struct btmrvl_private *priv);
132ff4e5	167	int btmrvl_prepare_command(struct btmrvl_private *priv);
ba54a16f	168	int btmrvl_enable_hs(struct btmrvl_private *priv);
132ff4e5	169
fb784f05 BZ	170	#ifdef CONFIG_DEBUG_FS
	171	void btmrvl_debugfs_init(struct hci_dev *hdev);
	172	void btmrvl_debugfs_remove(struct hci_dev *hdev);
	173	#endif