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