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 27 #define BTM_HEADER_LEN 4 28 #define BTM_UPLD_SIZE 2312 29 30 /* Time to wait until Host Sleep state change in millisecond */ 31 #define WAIT_UNTIL_HS_STATE_CHANGED msecs_to_jiffies(5000) 32 /* Time to wait for command response in millisecond */ 33 #define WAIT_UNTIL_CMD_RESP msecs_to_jiffies(5000) 34 35 enum 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 46 struct 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 53 struct btmrvl_thread { 54 struct task_struct *task; 55 wait_queue_head_t wait_q; 56 void *priv; 57 }; 58 59 struct btmrvl_device { 60 void *card; 61 struct hci_dev *hcidev; 62 63 u8 dev_type; 64 65 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 79 struct btmrvl_adapter { 80 void *hw_regs_buf; 81 u8 *hw_regs; 82 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; 89 wait_queue_head_t event_hs_wait_q; 90 u8 cmd_complete; 91 bool is_suspended; 92 }; 93 94 struct 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); 101 int (*hw_process_int_status) (struct btmrvl_private *priv); 102 void (*firmware_dump)(struct btmrvl_private *priv); 103 spinlock_t driver_lock; /* spinlock used by driver */ 104 #ifdef CONFIG_DEBUG_FS 105 void *debugfs_data; 106 #endif 107 bool surprise_removed; 108 }; 109 110 #define MRVL_VENDOR_PKT 0xFE 111 112 /* Vendor specific Bluetooth commands */ 113 #define BT_CMD_PSCAN_WIN_REPORT_ENABLE 0xFC03 114 #define BT_CMD_SET_BDADDR 0xFC22 115 #define BT_CMD_AUTO_SLEEP_MODE 0xFC23 116 #define BT_CMD_HOST_SLEEP_CONFIG 0xFC59 117 #define BT_CMD_HOST_SLEEP_ENABLE 0xFC5A 118 #define BT_CMD_MODULE_CFG_REQ 0xFC5B 119 #define BT_CMD_LOAD_CONFIG_DATA 0xFC61 120 121 /* Sub-commands: Module Bringup/Shutdown Request/Response */ 122 #define MODULE_BRINGUP_REQ 0xF1 123 #define MODULE_BROUGHT_UP 0x00 124 #define MODULE_ALREADY_UP 0x0C 125 126 #define MODULE_SHUTDOWN_REQ 0xF2 127 128 /* Vendor specific Bluetooth events */ 129 #define BT_EVENT_AUTO_SLEEP_MODE 0x23 130 #define BT_EVENT_HOST_SLEEP_CONFIG 0x59 131 #define BT_EVENT_HOST_SLEEP_ENABLE 0x5A 132 #define BT_EVENT_MODULE_CFG_REQ 0x5B 133 #define BT_EVENT_POWER_STATE 0x20 134 135 /* Bluetooth Power States */ 136 #define BT_PS_ENABLE 0x02 137 #define BT_PS_DISABLE 0x03 138 #define BT_PS_SLEEP 0x01 139 140 /* Host Sleep states */ 141 #define HS_ACTIVATED 0x01 142 #define HS_DEACTIVATED 0x00 143 144 /* Power Save modes */ 145 #define PS_SLEEP 0x01 146 #define PS_AWAKE 0x00 147 148 #define BT_CAL_HDR_LEN 4 149 #define BT_CAL_DATA_SIZE 28 150 151 struct btmrvl_event { 152 u8 ec; /* event counter */ 153 u8 length; 154 u8 data[4]; 155 } __packed; 156 157 /* Prototype of global function */ 158 159 int btmrvl_register_hdev(struct btmrvl_private *priv); 160 struct btmrvl_private *btmrvl_add_card(void *card); 161 int btmrvl_remove_card(struct btmrvl_private *priv); 162 163 void btmrvl_interrupt(struct btmrvl_private *priv); 164 165 bool btmrvl_check_evtpkt(struct btmrvl_private *priv, struct sk_buff *skb); 166 int btmrvl_process_event(struct btmrvl_private *priv, struct sk_buff *skb); 167 168 int btmrvl_send_module_cfg_cmd(struct btmrvl_private *priv, u8 subcmd); 169 int btmrvl_pscan_window_reporting(struct btmrvl_private *priv, u8 subcmd); 170 int btmrvl_send_hscfg_cmd(struct btmrvl_private *priv); 171 int btmrvl_enable_ps(struct btmrvl_private *priv); 172 int btmrvl_prepare_command(struct btmrvl_private *priv); 173 int btmrvl_enable_hs(struct btmrvl_private *priv); 174 void btmrvl_firmware_dump(struct btmrvl_private *priv); 175 176 #ifdef CONFIG_DEBUG_FS 177 void btmrvl_debugfs_init(struct hci_dev *hdev); 178 void btmrvl_debugfs_remove(struct hci_dev *hdev); 179 #endif 180