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 
22 #include <linux/kthread.h>
23 #include <linux/bitops.h>
24 #include <linux/slab.h>
25 #include <net/bluetooth/bluetooth.h>
26 #include <linux/ctype.h>
27 #include <linux/firmware.h>
28 
29 #define BTM_HEADER_LEN			4
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 {
44 	void *card;
45 	struct hci_dev *hcidev;
46 	struct device *dev;
47 	const char *cal_data;
48 
49 	u8 dev_type;
50 
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;
74 	bool is_suspended;
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);
84 	int (*hw_process_int_status) (struct btmrvl_private *priv);
85 	spinlock_t driver_lock;		/* spinlock used by driver */
86 #ifdef CONFIG_DEBUG_FS
87 	void *debugfs_data;
88 #endif
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
98 #define BT_CMD_LOAD_CONFIG_DATA		0x61
99 
100 /* Sub-commands: Module Bringup/Shutdown Request/Response */
101 #define MODULE_BRINGUP_REQ		0xF1
102 #define MODULE_BROUGHT_UP		0x00
103 #define MODULE_ALREADY_UP		0x0C
104 
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 
124 #define BT_CMD_DATA_SIZE		32
125 #define BT_CAL_DATA_SIZE		28
126 
127 struct btmrvl_event {
128 	u8 ec;		/* event counter */
129 	u8 length;
130 	u8 data[4];
131 } __packed;
132 
133 /* Prototype of global function */
134 
135 int btmrvl_register_hdev(struct btmrvl_private *priv);
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 
141 bool btmrvl_check_evtpkt(struct btmrvl_private *priv, struct sk_buff *skb);
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);
145 int btmrvl_send_hscfg_cmd(struct btmrvl_private *priv);
146 int btmrvl_enable_ps(struct btmrvl_private *priv);
147 int btmrvl_prepare_command(struct btmrvl_private *priv);
148 int btmrvl_enable_hs(struct btmrvl_private *priv);
149 
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
154