[mirror_ubuntu-zesty-kernel.git] / drivers / bluetooth / btmrvl_drv.h

/*
 * Marvell Bluetooth driver: global definitions & declarations
 *
 * Copyright (C) 2009, Marvell International Ltd.
 *
 * This software file (the "File") is distributed by Marvell International
 * Ltd. under the terms of the GNU General Public License Version 2, June 1991
 * (the "License").  You may use, redistribute and/or modify this File in
 * accordance with the terms and conditions of the License, a copy of which
 * is available by writing to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
 * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
 *
 *
 * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
 * ARE EXPRESSLY DISCLAIMED.  The License provides additional details about
 * this warranty disclaimer.
 *
 */

#include <linux/kthread.h>
#include <linux/bitops.h>
#include <linux/slab.h>
#include <net/bluetooth/bluetooth.h>
#include <linux/err.h>
#include <linux/gpio.h>
#include <linux/gfp.h>
#include <linux/interrupt.h>
#include <linux/io.h>
#include <linux/of_gpio.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);
	void (*firmware_dump)(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);
void btmrvl_firmware_dump(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
132ff4e5 BZ	1	/*
	2	* Marvell Bluetooth driver: global definitions & declarations
	3	*
	4	* Copyright (C) 2009, Marvell International Ltd.
	5	*
	6	* This software file (the "File") is distributed by Marvell International
	7	* Ltd. under the terms of the GNU General Public License Version 2, June 1991
	8	* (the "License"). You may use, redistribute and/or modify this File in
	9	* accordance with the terms and conditions of the License, a copy of which
	10	* is available by writing to the Free Software Foundation, Inc.,
	11	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
	12	* worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
	13	*
	14	*
	15	* THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
	16	* IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
	17	* ARE EXPRESSLY DISCLAIMED. The License provides additional details about
	18	* this warranty disclaimer.
	19	*
	20	*/
	21
132ff4e5 BZ	22	#include <linux/kthread.h>
132ff4e5 BZ	23	#include <linux/bitops.h>
5a0e3ad6	24	#include <linux/slab.h>
132ff4e5	25	#include <net/bluetooth/bluetooth.h>
bb7f4f0b XH	26	#include <linux/err.h>
	27	#include <linux/gpio.h>
	28	#include <linux/gfp.h>
	29	#include <linux/interrupt.h>
	30	#include <linux/io.h>
	31	#include <linux/of_gpio.h>
	32	#include <linux/of_platform.h>
	33	#include <linux/platform_device.h>
	34	#include <linux/pm_runtime.h>
bb7f4f0b	35	#include <linux/of_irq.h>
132ff4e5 BZ	36
132ff4e5 BZ	37	#define BTM_HEADER_LEN 4
132ff4e5 BZ	38	#define BTM_UPLD_SIZE 2312
	39
	40	/* Time to wait until Host Sleep state change in millisecond */
0333d6dd	41	#define WAIT_UNTIL_HS_STATE_CHANGED msecs_to_jiffies(5000)
132ff4e5	42	/* Time to wait for command response in millisecond */
0333d6dd	43	#define WAIT_UNTIL_CMD_RESP msecs_to_jiffies(5000)
132ff4e5	44
dc759613 XH	45	enum rdwr_status {
	46	RDWR_STATUS_SUCCESS = 0,
	47	RDWR_STATUS_FAILURE = 1,
	48	RDWR_STATUS_DONE = 2
	49	};
	50
	51	#define FW_DUMP_MAX_NAME_LEN 8
	52	#define FW_DUMP_HOST_READY 0xEE
	53	#define FW_DUMP_DONE 0xFF
	54	#define FW_DUMP_READ_DONE 0xFE
	55
	56	struct memory_type_mapping {
	57	u8 mem_name[FW_DUMP_MAX_NAME_LEN];
	58	u8 *mem_ptr;
	59	u32 mem_size;
	60	u8 done_flag;
	61	};
	62
132ff4e5 BZ	63	struct btmrvl_thread {
	64	struct task_struct *task;
	65	wait_queue_head_t wait_q;
	66	void *priv;
	67	};
	68
	69	struct btmrvl_device {
132ff4e5 BZ	70	void *card;
	71	struct hci_dev *hcidev;
	72
f120c6b6 BZ	73	u8 dev_type;
f120c6b6 BZ	74
132ff4e5 BZ	75	u8 tx_dnld_rdy;
	76
	77	u8 psmode;
	78	u8 pscmd;
	79	u8 hsmode;
	80	u8 hscmd;
	81
	82	/* Low byte is gap, high byte is GPIO */
	83	u16 gpio_gap;
	84
	85	u8 hscfgcmd;
	86	u8 sendcmdflag;
	87	};
	88
	89	struct btmrvl_adapter {
0d367408 BZ	90	void *hw_regs_buf;
0d367408 BZ	91	u8 *hw_regs;
132ff4e5 BZ	92	u32 int_count;
	93	struct sk_buff_head tx_queue;
	94	u8 psmode;
	95	u8 ps_state;
	96	u8 hs_state;
	97	u8 wakeup_tries;
	98	wait_queue_head_t cmd_wait_q;
396e04f4	99	wait_queue_head_t event_hs_wait_q;
132ff4e5	100	u8 cmd_complete;
ba54a16f	101	bool is_suspended;
8cf60cf2	102	bool is_suspending;
132ff4e5 BZ	103	};
	104
	105	struct btmrvl_private {
	106	struct btmrvl_device btmrvl_dev;
	107	struct btmrvl_adapter *adapter;
	108	struct btmrvl_thread main_thread;
ba27b7ef	109	int (hw_host_to_card)(struct btmrvl_private priv,
132ff4e5	110	u8 *payload, u16 nb);
ba27b7ef PK	111	int (hw_wakeup_firmware)(struct btmrvl_private priv);
ba27b7ef PK	112	int (hw_process_int_status)(struct btmrvl_private priv);
dc759613	113	void (firmware_dump)(struct btmrvl_private priv);
132ff4e5	114	spinlock_t driver_lock; /* spinlock used by driver */
fb784f05 BZ	115	#ifdef CONFIG_DEBUG_FS
	116	void *debugfs_data;
	117	#endif
7b4b8740	118	bool surprise_removed;
132ff4e5 BZ	119	};
	120
	121	#define MRVL_VENDOR_PKT 0xFE
	122
3e4543ab	123	/* Vendor specific Bluetooth commands */
4df82b59	124	#define BT_CMD_PSCAN_WIN_REPORT_ENABLE 0xFC03
a715d11e	125	#define BT_CMD_ROUTE_SCO_TO_HOST 0xFC1D
27b869f5	126	#define BT_CMD_SET_BDADDR 0xFC22
3e4543ab BZ	127	#define BT_CMD_AUTO_SLEEP_MODE 0xFC23
	128	#define BT_CMD_HOST_SLEEP_CONFIG 0xFC59
	129	#define BT_CMD_HOST_SLEEP_ENABLE 0xFC5A
	130	#define BT_CMD_MODULE_CFG_REQ 0xFC5B
	131	#define BT_CMD_LOAD_CONFIG_DATA 0xFC61
132ff4e5	132
903c8437	133	/* Sub-commands: Module Bringup/Shutdown Request/Response */
132ff4e5	134	#define MODULE_BRINGUP_REQ 0xF1
903c8437 BZ	135	#define MODULE_BROUGHT_UP 0x00
	136	#define MODULE_ALREADY_UP 0x0C
	137
132ff4e5 BZ	138	#define MODULE_SHUTDOWN_REQ 0xF2
132ff4e5 BZ	139
3e4543ab BZ	140	/* Vendor specific Bluetooth events */
	141	#define BT_EVENT_AUTO_SLEEP_MODE 0x23
	142	#define BT_EVENT_HOST_SLEEP_CONFIG 0x59
	143	#define BT_EVENT_HOST_SLEEP_ENABLE 0x5A
	144	#define BT_EVENT_MODULE_CFG_REQ 0x5B
132ff4e5 BZ	145	#define BT_EVENT_POWER_STATE 0x20
	146
	147	/* Bluetooth Power States */
	148	#define BT_PS_ENABLE 0x02
	149	#define BT_PS_DISABLE 0x03
	150	#define BT_PS_SLEEP 0x01
	151
132ff4e5 BZ	152	/* Host Sleep states */
	153	#define HS_ACTIVATED 0x01
	154	#define HS_DEACTIVATED 0x00
	155
	156	/* Power Save modes */
	157	#define PS_SLEEP 0x01
	158	#define PS_AWAKE 0x00
	159
8a4934f1	160	#define BT_CAL_HDR_LEN 4
2cc86890 AK	161	#define BT_CAL_DATA_SIZE 28
2cc86890 AK	162
132ff4e5 BZ	163	struct btmrvl_event {
	164	u8 ec; /* event counter */
	165	u8 length;
	166	u8 data[4];
81ca405a	167	} __packed;
132ff4e5 BZ	168
	169	/* Prototype of global function */
	170
64061607	171	int btmrvl_register_hdev(struct btmrvl_private *priv);
132ff4e5 BZ	172	struct btmrvl_private btmrvl_add_card(void card);
	173	int btmrvl_remove_card(struct btmrvl_private *priv);
	174
	175	void btmrvl_interrupt(struct btmrvl_private *priv);
	176
ea1e76a3	177	bool btmrvl_check_evtpkt(struct btmrvl_private priv, struct sk_buff skb);
132ff4e5 BZ	178	int btmrvl_process_event(struct btmrvl_private priv, struct sk_buff skb);
132ff4e5 BZ	179
7125df53	180	int btmrvl_send_module_cfg_cmd(struct btmrvl_private *priv, u8 subcmd);
af963243	181	int btmrvl_pscan_window_reporting(struct btmrvl_private *priv, u8 subcmd);
2a8ff611	182	int btmrvl_send_hscfg_cmd(struct btmrvl_private *priv);
32fd6398	183	int btmrvl_enable_ps(struct btmrvl_private *priv);
132ff4e5	184	int btmrvl_prepare_command(struct btmrvl_private *priv);
ba54a16f	185	int btmrvl_enable_hs(struct btmrvl_private *priv);
dc759613	186	void btmrvl_firmware_dump(struct btmrvl_private *priv);
132ff4e5	187
fb784f05 BZ	188	#ifdef CONFIG_DEBUG_FS
	189	void btmrvl_debugfs_init(struct hci_dev *hdev);
	190	void btmrvl_debugfs_remove(struct hci_dev *hdev);
	191	#endif