1 /* 2 * Copyright (c) 2010-2011 Atheros Communications Inc. 3 * 4 * Permission to use, copy, modify, and/or distribute this software for any 5 * purpose with or without fee is hereby granted, provided that the above 6 * copyright notice and this permission notice appear in all copies. 7 * 8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15 */ 16 17 #ifndef AR9003_MCI_H 18 #define AR9003_MCI_H 19 20 #define MCI_FLAG_DISABLE_TIMESTAMP 0x00000001 /* Disable time stamp */ 21 22 /* Default remote BT device MCI COEX version */ 23 #define MCI_GPM_COEX_MAJOR_VERSION_DEFAULT 3 24 #define MCI_GPM_COEX_MINOR_VERSION_DEFAULT 0 25 26 /* Local WLAN MCI COEX version */ 27 #define MCI_GPM_COEX_MAJOR_VERSION_WLAN 3 28 #define MCI_GPM_COEX_MINOR_VERSION_WLAN 0 29 30 enum mci_gpm_coex_query_type { 31 MCI_GPM_COEX_QUERY_BT_ALL_INFO = BIT(0), 32 MCI_GPM_COEX_QUERY_BT_TOPOLOGY = BIT(1), 33 MCI_GPM_COEX_QUERY_BT_DEBUG = BIT(2), 34 }; 35 36 enum mci_gpm_coex_halt_bt_gpm { 37 MCI_GPM_COEX_BT_GPM_UNHALT, 38 MCI_GPM_COEX_BT_GPM_HALT 39 }; 40 41 enum mci_gpm_coex_bt_update_flags_op { 42 MCI_GPM_COEX_BT_FLAGS_READ, 43 MCI_GPM_COEX_BT_FLAGS_SET, 44 MCI_GPM_COEX_BT_FLAGS_CLEAR 45 }; 46 47 #define MCI_NUM_BT_CHANNELS 79 48 49 #define MCI_BT_MCI_FLAGS_UPDATE_CORR 0x00000002 50 #define MCI_BT_MCI_FLAGS_UPDATE_HDR 0x00000004 51 #define MCI_BT_MCI_FLAGS_UPDATE_PLD 0x00000008 52 #define MCI_BT_MCI_FLAGS_LNA_CTRL 0x00000010 53 #define MCI_BT_MCI_FLAGS_DEBUG 0x00000020 54 #define MCI_BT_MCI_FLAGS_SCHED_MSG 0x00000040 55 #define MCI_BT_MCI_FLAGS_CONT_MSG 0x00000080 56 #define MCI_BT_MCI_FLAGS_COEX_GPM 0x00000100 57 #define MCI_BT_MCI_FLAGS_CPU_INT_MSG 0x00000200 58 #define MCI_BT_MCI_FLAGS_MCI_MODE 0x00000400 59 #define MCI_BT_MCI_FLAGS_AR9462_MODE 0x00001000 60 #define MCI_BT_MCI_FLAGS_OTHER 0x00010000 61 62 #define MCI_DEFAULT_BT_MCI_FLAGS 0x00011dde 63 64 #define MCI_TOGGLE_BT_MCI_FLAGS (MCI_BT_MCI_FLAGS_UPDATE_CORR | \ 65 MCI_BT_MCI_FLAGS_UPDATE_HDR | \ 66 MCI_BT_MCI_FLAGS_UPDATE_PLD | \ 67 MCI_BT_MCI_FLAGS_MCI_MODE) 68 69 #define MCI_2G_FLAGS_CLEAR_MASK 0x00000000 70 #define MCI_2G_FLAGS_SET_MASK MCI_TOGGLE_BT_MCI_FLAGS 71 #define MCI_2G_FLAGS MCI_DEFAULT_BT_MCI_FLAGS 72 73 #define MCI_5G_FLAGS_CLEAR_MASK MCI_TOGGLE_BT_MCI_FLAGS 74 #define MCI_5G_FLAGS_SET_MASK 0x00000000 75 #define MCI_5G_FLAGS (MCI_DEFAULT_BT_MCI_FLAGS & \ 76 ~MCI_TOGGLE_BT_MCI_FLAGS) 77 78 /* 79 * Default value for AR9462 is 0x00002201 80 */ 81 #define ATH_MCI_CONFIG_CONCUR_TX 0x00000003 82 #define ATH_MCI_CONFIG_MCI_OBS_MCI 0x00000004 83 #define ATH_MCI_CONFIG_MCI_OBS_TXRX 0x00000008 84 #define ATH_MCI_CONFIG_MCI_OBS_BT 0x00000010 85 #define ATH_MCI_CONFIG_DISABLE_MCI_CAL 0x00000020 86 #define ATH_MCI_CONFIG_DISABLE_OSLA 0x00000040 87 #define ATH_MCI_CONFIG_DISABLE_FTP_STOMP 0x00000080 88 #define ATH_MCI_CONFIG_AGGR_THRESH 0x00000700 89 #define ATH_MCI_CONFIG_AGGR_THRESH_S 8 90 #define ATH_MCI_CONFIG_DISABLE_AGGR_THRESH 0x00000800 91 #define ATH_MCI_CONFIG_CLK_DIV 0x00003000 92 #define ATH_MCI_CONFIG_CLK_DIV_S 12 93 #define ATH_MCI_CONFIG_DISABLE_TUNING 0x00004000 94 #define ATH_MCI_CONFIG_MCI_WEIGHT_DBG 0x40000000 95 #define ATH_MCI_CONFIG_DISABLE_MCI 0x80000000 96 97 #define ATH_MCI_CONFIG_MCI_OBS_MASK (ATH_MCI_CONFIG_MCI_OBS_MCI | \ 98 ATH_MCI_CONFIG_MCI_OBS_TXRX | \ 99 ATH_MCI_CONFIG_MCI_OBS_BT) 100 #define ATH_MCI_CONFIG_MCI_OBS_GPIO 0x0000002F 101 102 enum mci_message_header { /* length of payload */ 103 MCI_LNA_CTRL = 0x10, /* len = 0 */ 104 MCI_CONT_NACK = 0x20, /* len = 0 */ 105 MCI_CONT_INFO = 0x30, /* len = 4 */ 106 MCI_CONT_RST = 0x40, /* len = 0 */ 107 MCI_SCHD_INFO = 0x50, /* len = 16 */ 108 MCI_CPU_INT = 0x60, /* len = 4 */ 109 MCI_SYS_WAKING = 0x70, /* len = 0 */ 110 MCI_GPM = 0x80, /* len = 16 */ 111 MCI_LNA_INFO = 0x90, /* len = 1 */ 112 MCI_LNA_STATE = 0x94, 113 MCI_LNA_TAKE = 0x98, 114 MCI_LNA_TRANS = 0x9c, 115 MCI_SYS_SLEEPING = 0xa0, /* len = 0 */ 116 MCI_REQ_WAKE = 0xc0, /* len = 0 */ 117 MCI_DEBUG_16 = 0xfe, /* len = 2 */ 118 MCI_REMOTE_RESET = 0xff /* len = 16 */ 119 }; 120 121 enum ath_mci_gpm_coex_profile_type { 122 MCI_GPM_COEX_PROFILE_UNKNOWN, 123 MCI_GPM_COEX_PROFILE_RFCOMM, 124 MCI_GPM_COEX_PROFILE_A2DP, 125 MCI_GPM_COEX_PROFILE_HID, 126 MCI_GPM_COEX_PROFILE_BNEP, 127 MCI_GPM_COEX_PROFILE_VOICE, 128 MCI_GPM_COEX_PROFILE_MAX 129 }; 130 131 /* MCI GPM/Coex opcode/type definitions */ 132 enum { 133 MCI_GPM_COEX_W_GPM_PAYLOAD = 1, 134 MCI_GPM_COEX_B_GPM_TYPE = 4, 135 MCI_GPM_COEX_B_GPM_OPCODE = 5, 136 /* MCI_GPM_WLAN_CAL_REQ, MCI_GPM_WLAN_CAL_DONE */ 137 MCI_GPM_WLAN_CAL_W_SEQUENCE = 2, 138 139 /* MCI_GPM_COEX_VERSION_QUERY */ 140 /* MCI_GPM_COEX_VERSION_RESPONSE */ 141 MCI_GPM_COEX_B_MAJOR_VERSION = 6, 142 MCI_GPM_COEX_B_MINOR_VERSION = 7, 143 /* MCI_GPM_COEX_STATUS_QUERY */ 144 MCI_GPM_COEX_B_BT_BITMAP = 6, 145 MCI_GPM_COEX_B_WLAN_BITMAP = 7, 146 /* MCI_GPM_COEX_HALT_BT_GPM */ 147 MCI_GPM_COEX_B_HALT_STATE = 6, 148 /* MCI_GPM_COEX_WLAN_CHANNELS */ 149 MCI_GPM_COEX_B_CHANNEL_MAP = 6, 150 /* MCI_GPM_COEX_BT_PROFILE_INFO */ 151 MCI_GPM_COEX_B_PROFILE_TYPE = 6, 152 MCI_GPM_COEX_B_PROFILE_LINKID = 7, 153 MCI_GPM_COEX_B_PROFILE_STATE = 8, 154 MCI_GPM_COEX_B_PROFILE_ROLE = 9, 155 MCI_GPM_COEX_B_PROFILE_RATE = 10, 156 MCI_GPM_COEX_B_PROFILE_VOTYPE = 11, 157 MCI_GPM_COEX_H_PROFILE_T = 12, 158 MCI_GPM_COEX_B_PROFILE_W = 14, 159 MCI_GPM_COEX_B_PROFILE_A = 15, 160 /* MCI_GPM_COEX_BT_STATUS_UPDATE */ 161 MCI_GPM_COEX_B_STATUS_TYPE = 6, 162 MCI_GPM_COEX_B_STATUS_LINKID = 7, 163 MCI_GPM_COEX_B_STATUS_STATE = 8, 164 /* MCI_GPM_COEX_BT_UPDATE_FLAGS */ 165 MCI_GPM_COEX_W_BT_FLAGS = 6, 166 MCI_GPM_COEX_B_BT_FLAGS_OP = 10 167 }; 168 169 enum mci_gpm_subtype { 170 MCI_GPM_BT_CAL_REQ = 0, 171 MCI_GPM_BT_CAL_GRANT = 1, 172 MCI_GPM_BT_CAL_DONE = 2, 173 MCI_GPM_WLAN_CAL_REQ = 3, 174 MCI_GPM_WLAN_CAL_GRANT = 4, 175 MCI_GPM_WLAN_CAL_DONE = 5, 176 MCI_GPM_COEX_AGENT = 0x0c, 177 MCI_GPM_RSVD_PATTERN = 0xfe, 178 MCI_GPM_RSVD_PATTERN32 = 0xfefefefe, 179 MCI_GPM_BT_DEBUG = 0xff 180 }; 181 182 enum mci_bt_state { 183 MCI_BT_SLEEP, 184 MCI_BT_AWAKE, 185 MCI_BT_CAL_START, 186 MCI_BT_CAL 187 }; 188 189 /* Type of state query */ 190 enum mci_state_type { 191 MCI_STATE_ENABLE, 192 MCI_STATE_SET_BT_AWAKE, 193 MCI_STATE_LAST_SCHD_MSG_OFFSET, 194 MCI_STATE_REMOTE_SLEEP, 195 MCI_STATE_RESET_REQ_WAKE, 196 MCI_STATE_SEND_WLAN_COEX_VERSION, 197 MCI_STATE_SEND_VERSION_QUERY, 198 MCI_STATE_SEND_STATUS_QUERY, 199 MCI_STATE_SET_CONCUR_TX_PRI, 200 MCI_STATE_RECOVER_RX, 201 MCI_STATE_NEED_FTP_STOMP, 202 MCI_STATE_DEBUG, 203 MCI_STATE_NEED_FLUSH_BT_INFO, 204 MCI_STATE_MAX 205 }; 206 207 enum mci_gpm_coex_opcode { 208 MCI_GPM_COEX_VERSION_QUERY, 209 MCI_GPM_COEX_VERSION_RESPONSE, 210 MCI_GPM_COEX_STATUS_QUERY, 211 MCI_GPM_COEX_HALT_BT_GPM, 212 MCI_GPM_COEX_WLAN_CHANNELS, 213 MCI_GPM_COEX_BT_PROFILE_INFO, 214 MCI_GPM_COEX_BT_STATUS_UPDATE, 215 MCI_GPM_COEX_BT_UPDATE_FLAGS, 216 MCI_GPM_COEX_NOOP, 217 }; 218 219 #define MCI_GPM_NOMORE 0 220 #define MCI_GPM_MORE 1 221 #define MCI_GPM_INVALID 0xffffffff 222 223 #define MCI_GPM_RECYCLE(_p_gpm) do { \ 224 *(((u32 *)_p_gpm) + MCI_GPM_COEX_W_GPM_PAYLOAD) = \ 225 MCI_GPM_RSVD_PATTERN32; \ 226 } while (0) 227 228 #define MCI_GPM_TYPE(_p_gpm) \ 229 (*(((u8 *)(_p_gpm)) + MCI_GPM_COEX_B_GPM_TYPE) & 0xff) 230 231 #define MCI_GPM_OPCODE(_p_gpm) \ 232 (*(((u8 *)(_p_gpm)) + MCI_GPM_COEX_B_GPM_OPCODE) & 0xff) 233 234 #define MCI_GPM_SET_CAL_TYPE(_p_gpm, _cal_type) do { \ 235 *(((u8 *)(_p_gpm)) + MCI_GPM_COEX_B_GPM_TYPE) = (_cal_type) & 0xff;\ 236 } while (0) 237 238 #define MCI_GPM_SET_TYPE_OPCODE(_p_gpm, _type, _opcode) do { \ 239 *(((u8 *)(_p_gpm)) + MCI_GPM_COEX_B_GPM_TYPE) = (_type) & 0xff; \ 240 *(((u8 *)(_p_gpm)) + MCI_GPM_COEX_B_GPM_OPCODE) = (_opcode) & 0xff;\ 241 } while (0) 242 243 #define MCI_GPM_IS_CAL_TYPE(_type) ((_type) <= MCI_GPM_WLAN_CAL_DONE) 244 245 /* 246 * Functions that are available to the MCI driver core. 247 */ 248 bool ar9003_mci_send_message(struct ath_hw *ah, u8 header, u32 flag, 249 u32 *payload, u8 len, bool wait_done, 250 bool check_bt); 251 u32 ar9003_mci_state(struct ath_hw *ah, u32 state_type); 252 int ar9003_mci_setup(struct ath_hw *ah, u32 gpm_addr, void *gpm_buf, 253 u16 len, u32 sched_addr); 254 void ar9003_mci_cleanup(struct ath_hw *ah); 255 void ar9003_mci_get_interrupt(struct ath_hw *ah, u32 *raw_intr, 256 u32 *rx_msg_intr); 257 u32 ar9003_mci_get_next_gpm_offset(struct ath_hw *ah, bool first, u32 *more); 258 void ar9003_mci_set_bt_version(struct ath_hw *ah, u8 major, u8 minor); 259 void ar9003_mci_send_wlan_channels(struct ath_hw *ah); 260 /* 261 * These functions are used by ath9k_hw. 262 */ 263 264 #ifdef CONFIG_ATH9K_BTCOEX_SUPPORT 265 266 void ar9003_mci_stop_bt(struct ath_hw *ah, bool save_fullsleep); 267 void ar9003_mci_init_cal_req(struct ath_hw *ah, bool *is_reusable); 268 void ar9003_mci_init_cal_done(struct ath_hw *ah); 269 void ar9003_mci_set_full_sleep(struct ath_hw *ah); 270 void ar9003_mci_2g5g_switch(struct ath_hw *ah, bool force); 271 void ar9003_mci_check_bt(struct ath_hw *ah); 272 bool ar9003_mci_start_reset(struct ath_hw *ah, struct ath9k_channel *chan); 273 int ar9003_mci_end_reset(struct ath_hw *ah, struct ath9k_channel *chan, 274 struct ath9k_hw_cal_data *caldata); 275 int ar9003_mci_reset(struct ath_hw *ah, bool en_int, bool is_2g, 276 bool is_full_sleep); 277 void ar9003_mci_get_isr(struct ath_hw *ah, enum ath9k_int *masked); 278 void ar9003_mci_bt_gain_ctrl(struct ath_hw *ah); 279 void ar9003_mci_set_power_awake(struct ath_hw *ah); 280 void ar9003_mci_check_gpm_offset(struct ath_hw *ah); 281 282 #else 283 284 static inline void ar9003_mci_stop_bt(struct ath_hw *ah, bool save_fullsleep) 285 { 286 } 287 static inline void ar9003_mci_init_cal_req(struct ath_hw *ah, bool *is_reusable) 288 { 289 } 290 static inline void ar9003_mci_init_cal_done(struct ath_hw *ah) 291 { 292 } 293 static inline void ar9003_mci_set_full_sleep(struct ath_hw *ah) 294 { 295 } 296 static inline void ar9003_mci_2g5g_switch(struct ath_hw *ah, bool wait_done) 297 { 298 } 299 static inline void ar9003_mci_check_bt(struct ath_hw *ah) 300 { 301 } 302 static inline bool ar9003_mci_start_reset(struct ath_hw *ah, struct ath9k_channel *chan) 303 { 304 return false; 305 } 306 static inline int ar9003_mci_end_reset(struct ath_hw *ah, struct ath9k_channel *chan, 307 struct ath9k_hw_cal_data *caldata) 308 { 309 return 0; 310 } 311 static inline void ar9003_mci_reset(struct ath_hw *ah, bool en_int, bool is_2g, 312 bool is_full_sleep) 313 { 314 } 315 static inline void ar9003_mci_get_isr(struct ath_hw *ah, enum ath9k_int *masked) 316 { 317 } 318 static inline void ar9003_mci_bt_gain_ctrl(struct ath_hw *ah) 319 { 320 } 321 static inline void ar9003_mci_set_power_awake(struct ath_hw *ah) 322 { 323 } 324 static inline void ar9003_mci_check_gpm_offset(struct ath_hw *ah) 325 { 326 } 327 #endif /* CONFIG_ATH9K_BTCOEX_SUPPORT */ 328 329 #endif 330