blob: 086f0ec89580627d4c95516c0ef912265445afef [file] [log] [blame]
Bing Zhao132ff4e2009-06-02 14:29:35 -07001/*
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
Bing Zhao132ff4e2009-06-02 14:29:35 -070022#include <linux/kthread.h>
23#include <linux/bitops.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090024#include <linux/slab.h>
Bing Zhao132ff4e2009-06-02 14:29:35 -070025#include <net/bluetooth/bluetooth.h>
26
27#define BTM_HEADER_LEN 4
Bing Zhao132ff4e2009-06-02 14:29:35 -070028#define BTM_UPLD_SIZE 2312
29
30/* Time to wait until Host Sleep state change in millisecond */
Amitkumar Karwar0333d6d2015-01-06 21:36:55 -080031#define WAIT_UNTIL_HS_STATE_CHANGED msecs_to_jiffies(5000)
Bing Zhao132ff4e2009-06-02 14:29:35 -070032/* Time to wait for command response in millisecond */
Amitkumar Karwar0333d6d2015-01-06 21:36:55 -080033#define WAIT_UNTIL_CMD_RESP msecs_to_jiffies(5000)
Bing Zhao132ff4e2009-06-02 14:29:35 -070034
Xinming Hudc759612014-11-24 02:40:53 -080035enum rdwr_status {
36 RDWR_STATUS_SUCCESS = 0,
37 RDWR_STATUS_FAILURE = 1,
38 RDWR_STATUS_DONE = 2
39};
40
41#define FW_DUMP_MAX_NAME_LEN 8
42#define FW_DUMP_HOST_READY 0xEE
43#define FW_DUMP_DONE 0xFF
44#define FW_DUMP_READ_DONE 0xFE
45
46struct memory_type_mapping {
47 u8 mem_name[FW_DUMP_MAX_NAME_LEN];
48 u8 *mem_ptr;
49 u32 mem_size;
50 u8 done_flag;
51};
52
Bing Zhao132ff4e2009-06-02 14:29:35 -070053struct btmrvl_thread {
54 struct task_struct *task;
55 wait_queue_head_t wait_q;
56 void *priv;
57};
58
59struct btmrvl_device {
Bing Zhao132ff4e2009-06-02 14:29:35 -070060 void *card;
61 struct hci_dev *hcidev;
62
Bing Zhaof120c6b2010-03-03 14:37:37 -080063 u8 dev_type;
64
Bing Zhao132ff4e2009-06-02 14:29:35 -070065 u8 tx_dnld_rdy;
66
67 u8 psmode;
68 u8 pscmd;
69 u8 hsmode;
70 u8 hscmd;
71
72 /* Low byte is gap, high byte is GPIO */
73 u16 gpio_gap;
74
75 u8 hscfgcmd;
76 u8 sendcmdflag;
77};
78
79struct btmrvl_adapter {
Bing Zhao0d367402014-03-28 14:54:39 -070080 void *hw_regs_buf;
81 u8 *hw_regs;
Bing Zhao132ff4e2009-06-02 14:29:35 -070082 u32 int_count;
83 struct sk_buff_head tx_queue;
84 u8 psmode;
85 u8 ps_state;
86 u8 hs_state;
87 u8 wakeup_tries;
88 wait_queue_head_t cmd_wait_q;
Chin-Ran Lo396e04f2014-07-01 14:00:14 -070089 wait_queue_head_t event_hs_wait_q;
Bing Zhao132ff4e2009-06-02 14:29:35 -070090 u8 cmd_complete;
Amitkumar Karwarba54a162012-04-25 11:43:54 -070091 bool is_suspended;
Bing Zhao132ff4e2009-06-02 14:29:35 -070092};
93
94struct btmrvl_private {
95 struct btmrvl_device btmrvl_dev;
96 struct btmrvl_adapter *adapter;
97 struct btmrvl_thread main_thread;
98 int (*hw_host_to_card) (struct btmrvl_private *priv,
99 u8 *payload, u16 nb);
100 int (*hw_wakeup_firmware) (struct btmrvl_private *priv);
Amitkumar Karward1d10d72010-05-27 16:38:37 -0700101 int (*hw_process_int_status) (struct btmrvl_private *priv);
Xinming Hudc759612014-11-24 02:40:53 -0800102 void (*firmware_dump)(struct btmrvl_private *priv);
Bing Zhao132ff4e2009-06-02 14:29:35 -0700103 spinlock_t driver_lock; /* spinlock used by driver */
Bing Zhaofb784f02009-06-02 14:29:37 -0700104#ifdef CONFIG_DEBUG_FS
105 void *debugfs_data;
106#endif
Amitkumar Karwar7b4b8742015-01-01 00:13:41 -0800107 bool surprise_removed;
Bing Zhao132ff4e2009-06-02 14:29:35 -0700108};
109
110#define MRVL_VENDOR_PKT 0xFE
111
Bing Zhao3e4543a2013-10-31 15:08:31 -0700112/* Vendor specific Bluetooth commands */
Bing Zhao4df82b52014-03-31 14:41:44 -0700113#define BT_CMD_PSCAN_WIN_REPORT_ENABLE 0xFC03
Amitkumar Karwara715d112015-02-10 05:49:41 -0800114#define BT_CMD_ROUTE_SCO_TO_HOST 0xFC1D
Amitkumar Karwar27b869f2014-07-18 14:47:07 -0700115#define BT_CMD_SET_BDADDR 0xFC22
Bing Zhao3e4543a2013-10-31 15:08:31 -0700116#define BT_CMD_AUTO_SLEEP_MODE 0xFC23
117#define BT_CMD_HOST_SLEEP_CONFIG 0xFC59
118#define BT_CMD_HOST_SLEEP_ENABLE 0xFC5A
119#define BT_CMD_MODULE_CFG_REQ 0xFC5B
120#define BT_CMD_LOAD_CONFIG_DATA 0xFC61
Bing Zhao132ff4e2009-06-02 14:29:35 -0700121
Bing Zhao903c8432010-03-03 14:37:35 -0800122/* Sub-commands: Module Bringup/Shutdown Request/Response */
Bing Zhao132ff4e2009-06-02 14:29:35 -0700123#define MODULE_BRINGUP_REQ 0xF1
Bing Zhao903c8432010-03-03 14:37:35 -0800124#define MODULE_BROUGHT_UP 0x00
125#define MODULE_ALREADY_UP 0x0C
126
Bing Zhao132ff4e2009-06-02 14:29:35 -0700127#define MODULE_SHUTDOWN_REQ 0xF2
128
Bing Zhao3e4543a2013-10-31 15:08:31 -0700129/* Vendor specific Bluetooth events */
130#define BT_EVENT_AUTO_SLEEP_MODE 0x23
131#define BT_EVENT_HOST_SLEEP_CONFIG 0x59
132#define BT_EVENT_HOST_SLEEP_ENABLE 0x5A
133#define BT_EVENT_MODULE_CFG_REQ 0x5B
Bing Zhao132ff4e2009-06-02 14:29:35 -0700134#define BT_EVENT_POWER_STATE 0x20
135
136/* Bluetooth Power States */
137#define BT_PS_ENABLE 0x02
138#define BT_PS_DISABLE 0x03
139#define BT_PS_SLEEP 0x01
140
Bing Zhao132ff4e2009-06-02 14:29:35 -0700141/* Host Sleep states */
142#define HS_ACTIVATED 0x01
143#define HS_DEACTIVATED 0x00
144
145/* Power Save modes */
146#define PS_SLEEP 0x01
147#define PS_AWAKE 0x00
148
Bing Zhao8a4934f2013-11-01 15:28:25 -0700149#define BT_CAL_HDR_LEN 4
Amitkumar Karwar2cc86892013-10-01 12:19:15 -0700150#define BT_CAL_DATA_SIZE 28
151
Bing Zhao132ff4e2009-06-02 14:29:35 -0700152struct btmrvl_event {
153 u8 ec; /* event counter */
154 u8 length;
155 u8 data[4];
Gustavo F. Padovan81ca4052010-07-19 13:54:05 -0300156} __packed;
Bing Zhao132ff4e2009-06-02 14:29:35 -0700157
158/* Prototype of global function */
159
Bing Zhao64061602010-03-03 14:37:36 -0800160int btmrvl_register_hdev(struct btmrvl_private *priv);
Bing Zhao132ff4e2009-06-02 14:29:35 -0700161struct btmrvl_private *btmrvl_add_card(void *card);
162int btmrvl_remove_card(struct btmrvl_private *priv);
163
164void btmrvl_interrupt(struct btmrvl_private *priv);
165
Andrei Emeltchenkoea1e76a2012-06-13 13:35:44 +0300166bool btmrvl_check_evtpkt(struct btmrvl_private *priv, struct sk_buff *skb);
Bing Zhao132ff4e2009-06-02 14:29:35 -0700167int btmrvl_process_event(struct btmrvl_private *priv, struct sk_buff *skb);
168
Petri Gynther7125df52014-04-15 13:00:00 -0700169int btmrvl_send_module_cfg_cmd(struct btmrvl_private *priv, u8 subcmd);
Johan Hedbergaf963242014-07-02 16:45:39 +0300170int btmrvl_pscan_window_reporting(struct btmrvl_private *priv, u8 subcmd);
Amitkumar Karwar2a8ff612012-04-24 16:31:40 -0700171int btmrvl_send_hscfg_cmd(struct btmrvl_private *priv);
Amitkumar Karwar32fd6392009-09-30 11:18:30 -0700172int btmrvl_enable_ps(struct btmrvl_private *priv);
Bing Zhao132ff4e2009-06-02 14:29:35 -0700173int btmrvl_prepare_command(struct btmrvl_private *priv);
Amitkumar Karwarba54a162012-04-25 11:43:54 -0700174int btmrvl_enable_hs(struct btmrvl_private *priv);
Xinming Hudc759612014-11-24 02:40:53 -0800175void btmrvl_firmware_dump(struct btmrvl_private *priv);
Bing Zhao132ff4e2009-06-02 14:29:35 -0700176
Bing Zhaofb784f02009-06-02 14:29:37 -0700177#ifdef CONFIG_DEBUG_FS
178void btmrvl_debugfs_init(struct hci_dev *hdev);
179void btmrvl_debugfs_remove(struct hci_dev *hdev);
180#endif