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/err.h>
27#include <linux/gfp.h>
28#include <linux/interrupt.h>
29#include <linux/io.h>
30#include <linux/of_platform.h>
31#include <linux/platform_device.h>
32#include <linux/pm_runtime.h>
33#include <linux/of_irq.h>
34
35#define BTM_HEADER_LEN 4
36#define BTM_UPLD_SIZE 2312
37
38/* Time to wait until Host Sleep state change in millisecond */
39#define WAIT_UNTIL_HS_STATE_CHANGED msecs_to_jiffies(5000)
40/* Time to wait for command response in millisecond */
41#define WAIT_UNTIL_CMD_RESP msecs_to_jiffies(5000)
42
43enum rdwr_status {
44 RDWR_STATUS_SUCCESS = 0,
45 RDWR_STATUS_FAILURE = 1,
46 RDWR_STATUS_DONE = 2
47};
48
49#define FW_DUMP_MAX_NAME_LEN 8
50#define FW_DUMP_HOST_READY 0xEE
51#define FW_DUMP_DONE 0xFF
52#define FW_DUMP_READ_DONE 0xFE
53
54struct memory_type_mapping {
55 u8 mem_name[FW_DUMP_MAX_NAME_LEN];
56 u8 *mem_ptr;
57 u32 mem_size;
58 u8 done_flag;
59};
60
61struct btmrvl_thread {
62 struct task_struct *task;
63 wait_queue_head_t wait_q;
64 void *priv;
65};
66
67struct btmrvl_device {
68 void *card;
69 struct hci_dev *hcidev;
70
71 u8 dev_type;
72
73 u8 tx_dnld_rdy;
74
75 u8 psmode;
76 u8 pscmd;
77 u8 hsmode;
78 u8 hscmd;
79
80 /* Low byte is gap, high byte is GPIO */
81 u16 gpio_gap;
82
83 u8 hscfgcmd;
84 u8 sendcmdflag;
85};
86
87struct btmrvl_adapter {
88 void *hw_regs_buf;
89 u8 *hw_regs;
90 u32 int_count;
91 struct sk_buff_head tx_queue;
92 u8 psmode;
93 u8 ps_state;
94 u8 hs_state;
95 u8 wakeup_tries;
96 wait_queue_head_t cmd_wait_q;
97 wait_queue_head_t event_hs_wait_q;
98 u8 cmd_complete;
99 bool is_suspended;
100 bool is_suspending;
101};
102
103struct btmrvl_private {
104 struct btmrvl_device btmrvl_dev;
105 struct btmrvl_adapter *adapter;
106 struct btmrvl_thread main_thread;
107 int (*hw_host_to_card)(struct btmrvl_private *priv,
108 u8 *payload, u16 nb);
109 int (*hw_wakeup_firmware)(struct btmrvl_private *priv);
110 int (*hw_process_int_status)(struct btmrvl_private *priv);
111 spinlock_t driver_lock; /* spinlock used by driver */
112#ifdef CONFIG_DEBUG_FS
113 void *debugfs_data;
114#endif
115 bool surprise_removed;
116};
117
118#define MRVL_VENDOR_PKT 0xFE
119
120/* Vendor specific Bluetooth commands */
121#define BT_CMD_PSCAN_WIN_REPORT_ENABLE 0xFC03
122#define BT_CMD_ROUTE_SCO_TO_HOST 0xFC1D
123#define BT_CMD_SET_BDADDR 0xFC22
124#define BT_CMD_AUTO_SLEEP_MODE 0xFC23
125#define BT_CMD_HOST_SLEEP_CONFIG 0xFC59
126#define BT_CMD_HOST_SLEEP_ENABLE 0xFC5A
127#define BT_CMD_MODULE_CFG_REQ 0xFC5B
128#define BT_CMD_LOAD_CONFIG_DATA 0xFC61
129
130/* Sub-commands: Module Bringup/Shutdown Request/Response */
131#define MODULE_BRINGUP_REQ 0xF1
132#define MODULE_BROUGHT_UP 0x00
133#define MODULE_ALREADY_UP 0x0C
134
135#define MODULE_SHUTDOWN_REQ 0xF2
136
137/* Vendor specific Bluetooth events */
138#define BT_EVENT_AUTO_SLEEP_MODE 0x23
139#define BT_EVENT_HOST_SLEEP_CONFIG 0x59
140#define BT_EVENT_HOST_SLEEP_ENABLE 0x5A
141#define BT_EVENT_MODULE_CFG_REQ 0x5B
142#define BT_EVENT_POWER_STATE 0x20
143
144/* Bluetooth Power States */
145#define BT_PS_ENABLE 0x02
146#define BT_PS_DISABLE 0x03
147#define BT_PS_SLEEP 0x01
148
149/* Host Sleep states */
150#define HS_ACTIVATED 0x01
151#define HS_DEACTIVATED 0x00
152
153/* Power Save modes */
154#define PS_SLEEP 0x01
155#define PS_AWAKE 0x00
156
157#define BT_CAL_HDR_LEN 4
158#define BT_CAL_DATA_SIZE 28
159
160struct btmrvl_event {
161 u8 ec; /* event counter */
162 u8 length;
163 u8 data[4];
164} __packed;
165
166/* Prototype of global function */
167
168int btmrvl_register_hdev(struct btmrvl_private *priv);
169struct btmrvl_private *btmrvl_add_card(void *card);
170int btmrvl_remove_card(struct btmrvl_private *priv);
171
172void btmrvl_interrupt(struct btmrvl_private *priv);
173
174bool btmrvl_check_evtpkt(struct btmrvl_private *priv, struct sk_buff *skb);
175int btmrvl_process_event(struct btmrvl_private *priv, struct sk_buff *skb);
176
177int btmrvl_send_module_cfg_cmd(struct btmrvl_private *priv, u8 subcmd);
178int btmrvl_pscan_window_reporting(struct btmrvl_private *priv, u8 subcmd);
179int btmrvl_send_hscfg_cmd(struct btmrvl_private *priv);
180int btmrvl_enable_ps(struct btmrvl_private *priv);
181int btmrvl_prepare_command(struct btmrvl_private *priv);
182int btmrvl_enable_hs(struct btmrvl_private *priv);
183
184#ifdef CONFIG_DEBUG_FS
185void btmrvl_debugfs_init(struct hci_dev *hdev);
186void btmrvl_debugfs_remove(struct hci_dev *hdev);
187#endif
188