[mirror_ubuntu-hirsute-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/ctype.h>
#include <linux/firmware.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	5000
/* Time to wait for command response in millisecond */
#define WAIT_UNTIL_CMD_RESP		5000

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

struct btmrvl_device {
	void *card;
	struct hci_dev *hcidev;
	struct device *dev;
	const char *cal_data;

	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 {
	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;
	u8 cmd_complete;
	bool is_suspended;
};

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

#define MRVL_VENDOR_PKT			0xFE

/* Bluetooth commands  */
#define BT_CMD_AUTO_SLEEP_MODE		0x23
#define BT_CMD_HOST_SLEEP_CONFIG	0x59
#define BT_CMD_HOST_SLEEP_ENABLE	0x5A
#define BT_CMD_MODULE_CFG_REQ		0x5B
#define BT_CMD_LOAD_CONFIG_DATA		0x61

/* 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

#define BT_EVENT_POWER_STATE		0x20

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

#define OGF				0x3F

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

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

#define BT_CMD_DATA_SIZE		32
#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, int 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
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>
2cc86890 AK	26	#include <linux/ctype.h>
2cc86890 AK	27	#include <linux/firmware.h>
132ff4e5 BZ	28
132ff4e5 BZ	29	#define BTM_HEADER_LEN 4
132ff4e5 BZ	30	#define BTM_UPLD_SIZE 2312
	31
	32	/* Time to wait until Host Sleep state change in millisecond */
	33	#define WAIT_UNTIL_HS_STATE_CHANGED 5000
	34	/* Time to wait for command response in millisecond */
	35	#define WAIT_UNTIL_CMD_RESP 5000
	36
	37	struct btmrvl_thread {
	38	struct task_struct *task;
	39	wait_queue_head_t wait_q;
	40	void *priv;
	41	};
	42
	43	struct btmrvl_device {
132ff4e5 BZ	44	void *card;
132ff4e5 BZ	45	struct hci_dev *hcidev;
2cc86890 AK	46	struct device *dev;
2cc86890 AK	47	const char *cal_data;
132ff4e5	48
f120c6b6 BZ	49	u8 dev_type;
f120c6b6 BZ	50
132ff4e5 BZ	51	u8 tx_dnld_rdy;
	52
	53	u8 psmode;
	54	u8 pscmd;
	55	u8 hsmode;
	56	u8 hscmd;
	57
	58	/* Low byte is gap, high byte is GPIO */
	59	u16 gpio_gap;
	60
	61	u8 hscfgcmd;
	62	u8 sendcmdflag;
	63	};
	64
	65	struct btmrvl_adapter {
	66	u32 int_count;
	67	struct sk_buff_head tx_queue;
	68	u8 psmode;
	69	u8 ps_state;
	70	u8 hs_state;
	71	u8 wakeup_tries;
	72	wait_queue_head_t cmd_wait_q;
	73	u8 cmd_complete;
ba54a16f	74	bool is_suspended;
132ff4e5 BZ	75	};
	76
	77	struct btmrvl_private {
	78	struct btmrvl_device btmrvl_dev;
	79	struct btmrvl_adapter *adapter;
	80	struct btmrvl_thread main_thread;
	81	int (hw_host_to_card) (struct btmrvl_private priv,
	82	u8 *payload, u16 nb);
	83	int (hw_wakeup_firmware) (struct btmrvl_private priv);
d1d10d78	84	int (hw_process_int_status) (struct btmrvl_private priv);
132ff4e5	85	spinlock_t driver_lock; /* spinlock used by driver */
fb784f05 BZ	86	#ifdef CONFIG_DEBUG_FS
	87	void *debugfs_data;
	88	#endif
132ff4e5 BZ	89	};
	90
	91	#define MRVL_VENDOR_PKT 0xFE
	92
	93	/* Bluetooth commands */
	94	#define BT_CMD_AUTO_SLEEP_MODE 0x23
	95	#define BT_CMD_HOST_SLEEP_CONFIG 0x59
	96	#define BT_CMD_HOST_SLEEP_ENABLE 0x5A
	97	#define BT_CMD_MODULE_CFG_REQ 0x5B
2cc86890	98	#define BT_CMD_LOAD_CONFIG_DATA 0x61
132ff4e5	99
903c8437	100	/* Sub-commands: Module Bringup/Shutdown Request/Response */
132ff4e5	101	#define MODULE_BRINGUP_REQ 0xF1
903c8437 BZ	102	#define MODULE_BROUGHT_UP 0x00
	103	#define MODULE_ALREADY_UP 0x0C
	104
132ff4e5 BZ	105	#define MODULE_SHUTDOWN_REQ 0xF2
	106
	107	#define BT_EVENT_POWER_STATE 0x20
	108
	109	/* Bluetooth Power States */
	110	#define BT_PS_ENABLE 0x02
	111	#define BT_PS_DISABLE 0x03
	112	#define BT_PS_SLEEP 0x01
	113
	114	#define OGF 0x3F
	115
	116	/* Host Sleep states */
	117	#define HS_ACTIVATED 0x01
	118	#define HS_DEACTIVATED 0x00
	119
	120	/* Power Save modes */
	121	#define PS_SLEEP 0x01
	122	#define PS_AWAKE 0x00
	123
2cc86890 AK	124	#define BT_CMD_DATA_SIZE 32
	125	#define BT_CAL_DATA_SIZE 28
	126
132ff4e5 BZ	127	struct btmrvl_event {
	128	u8 ec; /* event counter */
	129	u8 length;
	130	u8 data[4];
81ca405a	131	} __packed;
132ff4e5 BZ	132
	133	/* Prototype of global function */
	134
64061607	135	int btmrvl_register_hdev(struct btmrvl_private *priv);
132ff4e5 BZ	136	struct btmrvl_private btmrvl_add_card(void card);
	137	int btmrvl_remove_card(struct btmrvl_private *priv);
	138
	139	void btmrvl_interrupt(struct btmrvl_private *priv);
	140
ea1e76a3	141	bool btmrvl_check_evtpkt(struct btmrvl_private priv, struct sk_buff skb);
132ff4e5 BZ	142	int btmrvl_process_event(struct btmrvl_private priv, struct sk_buff skb);
	143
	144	int btmrvl_send_module_cfg_cmd(struct btmrvl_private *priv, int subcmd);
2a8ff611	145	int btmrvl_send_hscfg_cmd(struct btmrvl_private *priv);
32fd6398	146	int btmrvl_enable_ps(struct btmrvl_private *priv);
132ff4e5	147	int btmrvl_prepare_command(struct btmrvl_private *priv);
ba54a16f	148	int btmrvl_enable_hs(struct btmrvl_private *priv);
132ff4e5	149
fb784f05 BZ	150	#ifdef CONFIG_DEBUG_FS
	151	void btmrvl_debugfs_init(struct hci_dev *hdev);
	152	void btmrvl_debugfs_remove(struct hci_dev *hdev);
	153	#endif