1 /******************************************************************************
3 * Copyright(c) 2009-2012 Realtek Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of version 2 of the GNU General Public License as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * The full GNU General Public License is included in this distribution in the
15 * file called LICENSE.
17 * Contact Information:
18 * wlanfae <wlanfae@realtek.com>
19 * Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
20 * Hsinchu 300, Taiwan.
22 * Larry Finger <Larry.Finger@lwfinger.net>
24 *****************************************************************************/
25 #ifndef __HALBTC_OUT_SRC_H__
26 #define __HALBTC_OUT_SRC_H__
30 #define NORMAL_EXEC false
31 #define FORCE_EXEC true
33 #define BTC_RF_OFF 0x0
36 #define BTC_RF_A RF90_PATH_A
37 #define BTC_RF_B RF90_PATH_B
38 #define BTC_RF_C RF90_PATH_C
39 #define BTC_RF_D RF90_PATH_D
41 #define BTC_SMSP SINGLEMAC_SINGLEPHY
42 #define BTC_DMDP DUALMAC_DUALPHY
43 #define BTC_DMSP DUALMAC_SINGLEPHY
44 #define BTC_MP_UNKNOWN 0xff
49 #define BT_TMP_BUF_SIZE 100
51 #define BT_COEX_ANT_TYPE_PG 0
52 #define BT_COEX_ANT_TYPE_ANTDIV 1
53 #define BT_COEX_ANT_TYPE_DETECTED 2
55 #define BTC_MIMO_PS_STATIC 0
56 #define BTC_MIMO_PS_DYNAMIC 1
58 #define BTC_RATE_DISABLE 0
59 #define BTC_RATE_ENABLE 1
61 /* single Antenna definition */
62 #define BTC_ANT_PATH_WIFI 0
63 #define BTC_ANT_PATH_BT 1
64 #define BTC_ANT_PATH_PTA 2
65 /* dual Antenna definition */
66 #define BTC_ANT_WIFI_AT_MAIN 0
67 #define BTC_ANT_WIFI_AT_AUX 1
68 /* coupler Antenna definition */
69 #define BTC_ANT_WIFI_AT_CPL_MAIN 0
70 #define BTC_ANT_WIFI_AT_CPL_AUX 1
72 enum btc_bt_reg_type {
75 BTC_BT_REG_BLUEWIZE = 2,
76 BTC_BT_REG_VENDOR = 3,
81 enum btc_chip_interface {
94 BTC_CHIP_RTL8723A = 3,
96 BTC_CHIP_RTL8723B = 5,
101 BTC_MSG_INTERFACE = 0x0,
102 BTC_MSG_ALGORITHM = 0x1,
106 /* following is for BTC_MSG_INTERFACE */
107 #define INTF_INIT BIT0
108 #define INTF_NOTIFY BIT2
110 /* following is for BTC_ALGORITHM */
111 #define ALGO_BT_RSSI_STATE BIT0
112 #define ALGO_WIFI_RSSI_STATE BIT1
113 #define ALGO_BT_MONITOR BIT2
114 #define ALGO_TRACE BIT3
115 #define ALGO_TRACE_FW BIT4
116 #define ALGO_TRACE_FW_DETAIL BIT5
117 #define ALGO_TRACE_FW_EXEC BIT6
118 #define ALGO_TRACE_SW BIT7
119 #define ALGO_TRACE_SW_DETAIL BIT8
120 #define ALGO_TRACE_SW_EXEC BIT9
122 /* following is for wifi link status */
123 #define WIFI_STA_CONNECTED BIT0
124 #define WIFI_AP_CONNECTED BIT1
125 #define WIFI_HS_CONNECTED BIT2
126 #define WIFI_P2P_GO_CONNECTED BIT3
127 #define WIFI_P2P_GC_CONNECTED BIT4
129 #define BTC_RSSI_HIGH(_rssi_) \
130 ((_rssi_ == BTC_RSSI_STATE_HIGH || \
131 _rssi_ == BTC_RSSI_STATE_STAY_HIGH) ? true : false)
132 #define BTC_RSSI_MEDIUM(_rssi_) \
133 ((_rssi_ == BTC_RSSI_STATE_MEDIUM || \
134 _rssi_ == BTC_RSSI_STATE_STAY_MEDIUM) ? true : false)
135 #define BTC_RSSI_LOW(_rssi_) \
136 ((_rssi_ == BTC_RSSI_STATE_LOW || \
137 _rssi_ == BTC_RSSI_STATE_STAY_LOW) ? true : false)
139 enum btc_power_save_type {
140 BTC_PS_WIFI_NATIVE = 0,
146 struct btc_board_info {
147 /* The following is some board information */
149 u8 pg_ant_num; /* pg ant number */
150 u8 btdm_ant_num; /* ant number for btdm */
152 u8 single_ant_path; /* current used for 8723b only, 1=>s0, 0=>s1 */
156 enum btc_dbg_opcode {
157 BTC_DBG_SET_COEX_NORMAL = 0x0,
158 BTC_DBG_SET_COEX_WIFI_ONLY = 0x1,
159 BTC_DBG_SET_COEX_BT_ONLY = 0x2,
163 enum btc_rssi_state {
164 BTC_RSSI_STATE_HIGH = 0x0,
165 BTC_RSSI_STATE_MEDIUM = 0x1,
166 BTC_RSSI_STATE_LOW = 0x2,
167 BTC_RSSI_STATE_STAY_HIGH = 0x3,
168 BTC_RSSI_STATE_STAY_MEDIUM = 0x4,
169 BTC_RSSI_STATE_STAY_LOW = 0x5,
174 BTC_ROLE_STATION = 0x0,
177 BTC_ROLE_HS_MODE = 0x3,
181 enum btc_wireless_freq {
187 enum btc_wifi_bw_mode {
188 BTC_WIFI_BW_LEGACY = 0x0,
189 BTC_WIFI_BW_HT20 = 0x1,
190 BTC_WIFI_BW_HT40 = 0x2,
194 enum btc_wifi_traffic_dir {
195 BTC_WIFI_TRAFFIC_TX = 0x0,
196 BTC_WIFI_TRAFFIC_RX = 0x1,
201 BTC_WIFI_PNP_WAKE_UP = 0x0,
202 BTC_WIFI_PNP_SLEEP = 0x1,
207 BTC_IOT_PEER_UNKNOWN = 0,
208 BTC_IOT_PEER_REALTEK = 1,
209 BTC_IOT_PEER_REALTEK_92SE = 2,
210 BTC_IOT_PEER_BROADCOM = 3,
211 BTC_IOT_PEER_RALINK = 4,
212 BTC_IOT_PEER_ATHEROS = 5,
213 BTC_IOT_PEER_CISCO = 6,
214 BTC_IOT_PEER_MERU = 7,
215 BTC_IOT_PEER_MARVELL = 8,
216 BTC_IOT_PEER_REALTEK_SOFTAP = 9,
217 BTC_IOT_PEER_SELF_SOFTAP = 10, /* Self is SoftAP */
218 BTC_IOT_PEER_AIRGO = 11,
219 BTC_IOT_PEER_REALTEK_JAGUAR_BCUTAP = 12,
220 BTC_IOT_PEER_REALTEK_JAGUAR_CCUTAP = 13,
224 /* for 8723b-d cut large current issue */
225 enum bt_wifi_coex_state {
228 BTC_WIFI_STAT_NORMAL_OFF,
229 BTC_WIFI_STAT_MP_OFF,
230 BTC_WIFI_STAT_NORMAL,
231 BTC_WIFI_STAT_ANT_DIV,
246 BTC_GET_BL_HS_OPERATION,
247 BTC_GET_BL_HS_CONNECTING,
248 BTC_GET_BL_WIFI_CONNECTED,
249 BTC_GET_BL_WIFI_BUSY,
250 BTC_GET_BL_WIFI_SCAN,
251 BTC_GET_BL_WIFI_LINK,
252 BTC_GET_BL_WIFI_DHCP,
253 BTC_GET_BL_WIFI_SOFTAP_IDLE,
254 BTC_GET_BL_WIFI_SOFTAP_LINKING,
255 BTC_GET_BL_WIFI_IN_EARLY_SUSPEND,
256 BTC_GET_BL_WIFI_ROAM,
257 BTC_GET_BL_WIFI_4_WAY_PROGRESS,
258 BTC_GET_BL_WIFI_UNDER_5G,
259 BTC_GET_BL_WIFI_AP_MODE_ENABLE,
260 BTC_GET_BL_WIFI_ENABLE_ENCRYPTION,
261 BTC_GET_BL_WIFI_UNDER_B_MODE,
262 BTC_GET_BL_EXT_SWITCH,
263 BTC_GET_BL_WIFI_IS_IN_MP_MODE,
264 BTC_GET_BL_IS_ASUS_8723B,
266 BTC_GET_BL_RF4CE_CONNECTED,
269 BTC_GET_S4_WIFI_RSSI,
274 BTC_GET_U4_WIFI_TRAFFIC_DIRECTION,
275 BTC_GET_U4_WIFI_FW_VER,
276 BTC_GET_U4_WIFI_LINK_STATUS,
277 BTC_GET_U4_BT_PATCH_VER,
279 BTC_GET_U4_SUPPORTED_VERSION,
280 BTC_GET_U4_SUPPORTED_FEATURE,
281 BTC_GET_U4_WIFI_IQK_TOTAL,
282 BTC_GET_U4_WIFI_IQK_OK,
283 BTC_GET_U4_WIFI_IQK_FAIL,
286 BTC_GET_U1_WIFI_DOT11_CHNL,
287 BTC_GET_U1_WIFI_CENTRAL_CHNL,
288 BTC_GET_U1_WIFI_HS_CHNL,
289 BTC_GET_U1_MAC_PHY_MODE,
296 BTC_GET_BL_BT_SCO_BUSY,
299 BTC_GET_DRIVER_TEST_CFG,
311 BTC_SET_BL_BT_DISABLE,
312 BTC_SET_BL_BT_TRAFFIC_BUSY,
313 BTC_SET_BL_BT_LIMITED_DIG,
314 BTC_SET_BL_FORCE_TO_ROAM,
315 BTC_SET_BL_TO_REJ_AP_AGG_PKT,
316 BTC_SET_BL_BT_CTRL_AGG_SIZE,
317 BTC_SET_BL_INC_SCAN_DEV_NUM,
318 BTC_SET_BL_BT_TX_RX_MASK,
319 BTC_SET_BL_MIRACAST_PLUS_BT,
322 BTC_SET_U1_RSSI_ADJ_VAL_FOR_AGC_TABLE_ON,
323 BTC_SET_UI_SCAN_SIG_COMPENSATION,
324 BTC_SET_U1_AGG_BUF_SIZE,
326 /* type trigger some action */
327 BTC_SET_ACT_GET_BT_RSSI,
328 BTC_SET_ACT_AGGREGATE_CTRL,
329 BTC_SET_ACT_ANTPOSREGRISTRY_CTRL,
331 /********* for 1Ant **********/
333 BTC_SET_BL_BT_SCO_BUSY,
335 BTC_SET_U1_RSSI_ADJ_VAL_FOR_1ANT_COEX_TYPE,
339 BTC_SET_U1_1ANT_RPWM,
340 /* type trigger some action */
341 BTC_SET_ACT_LEAVE_LPS,
342 BTC_SET_ACT_ENTER_LPS,
343 BTC_SET_ACT_NORMAL_LPS,
344 BTC_SET_ACT_INC_FORCE_EXEC_PWR_CMD_CNT,
345 BTC_SET_ACT_DISABLE_LOW_POWER,
346 BTC_SET_ACT_UPDATE_RAMASK,
347 BTC_SET_ACT_SEND_MIMO_PS,
348 /* BT Coex related */
349 BTC_SET_ACT_CTRL_BT_INFO,
350 BTC_SET_ACT_CTRL_BT_COEX,
351 BTC_SET_ACT_CTRL_8723B_ANT,
352 /***************************/
356 enum btc_dbg_disp_type {
357 BTC_DBG_DISP_COEX_STATISTICS = 0x0,
358 BTC_DBG_DISP_BT_LINK_INFO = 0x1,
359 BTC_DBG_DISP_BT_FW_VER = 0x2,
360 BTC_DBG_DISP_FW_PWR_MODE_CMD = 0x3,
361 BTC_DBG_DISP_WIFI_STATUS = 0x04,
365 enum btc_notify_type_ips {
371 enum btc_notify_type_lps {
372 BTC_LPS_DISABLE = 0x0,
373 BTC_LPS_ENABLE = 0x1,
377 enum btc_notify_type_scan {
378 BTC_SCAN_FINISH = 0x0,
379 BTC_SCAN_START = 0x1,
383 enum btc_notify_type_associate {
384 BTC_ASSOCIATE_FINISH = 0x0,
385 BTC_ASSOCIATE_START = 0x1,
389 enum btc_notify_type_media_status {
390 BTC_MEDIA_DISCONNECT = 0x0,
391 BTC_MEDIA_CONNECT = 0x1,
395 enum btc_notify_type_special_packet {
396 BTC_PACKET_UNKNOWN = 0x0,
397 BTC_PACKET_DHCP = 0x1,
398 BTC_PACKET_ARP = 0x2,
399 BTC_PACKET_EAPOL = 0x3,
403 enum hci_ext_bt_operation {
404 HCI_BT_OP_NONE = 0x0,
405 HCI_BT_OP_INQUIRY_START = 0x1,
406 HCI_BT_OP_INQUIRY_FINISH = 0x2,
407 HCI_BT_OP_PAGING_START = 0x3,
408 HCI_BT_OP_PAGING_SUCCESS = 0x4,
409 HCI_BT_OP_PAGING_UNSUCCESS = 0x5,
410 HCI_BT_OP_PAIRING_START = 0x6,
411 HCI_BT_OP_PAIRING_FINISH = 0x7,
412 HCI_BT_OP_BT_DEV_ENABLE = 0x8,
413 HCI_BT_OP_BT_DEV_DISABLE = 0x9,
417 enum btc_notify_type_stack_operation {
418 BTC_STACK_OP_NONE = 0x0,
419 BTC_STACK_OP_INQ_PAGE_PAIR_START = 0x1,
420 BTC_STACK_OP_INQ_PAGE_PAIR_FINISH = 0x2,
426 u8 rssi_adjust_for_agc_table_on;
427 u8 rssi_adjust_for_1ant_coex_type;
428 bool pre_bt_ctrl_agg_buf_size;
433 bool pre_reject_agg_pkt;
435 bool bt_ctrl_buf_size;
436 bool increase_scan_dev_num;
437 bool miracast_plus_bt;
438 bool bt_ctrl_agg_buf_size;
444 bool bt_disable_low_pwr;
446 /* the following is for 1Ant solution */
448 bool bt_pwr_save_mode;
451 u8 force_exec_pwr_cmd_cnt;
457 struct btc_stack_info {
458 bool profile_notified;
459 u16 hci_version; /* stack hci version */
468 bool unknown_acl_exist;
472 struct btc_statistics {
474 u32 cnt_init_hw_config;
475 u32 cnt_init_coex_dm;
479 u32 cnt_connect_notify;
480 u32 cnt_media_status_notify;
481 u32 cnt_special_packet_notify;
482 u32 cnt_bt_info_notify;
484 u32 cnt_coex_dm_switch;
485 u32 cnt_stack_operation_notify;
487 u32 cnt_pre_load_firmware;
491 struct btc_bt_link_info {
493 bool bt_hi_pri_link_exist;
505 enum btc_antenna_pos {
506 BTC_ANTENNA_AT_MAIN_PORT = 0x1,
507 BTC_ANTENNA_AT_AUX_PORT = 0x2,
511 /* make sure only one adapter can bind the data context */
513 /* default adapter */
515 struct btc_board_info board_info;
516 /* some bt info referenced by non-bt module */
517 struct btc_bt_info bt_info;
518 struct btc_stack_info stack_info;
519 enum btc_chip_interface chip_interface;
520 struct btc_bt_link_info bt_link_info;
522 /* boolean variables to replace BT_AUTO_REPORT_ONLY_XXXXY_ZANT
523 * configuration parameters
525 bool auto_report_1ant;
526 bool auto_report_2ant;
530 struct btc_statistics statistics;
533 /* function pointers - io related */
534 u8 (*btc_read_1byte)(void *btc_context, u32 reg_addr);
535 void (*btc_write_1byte)(void *btc_context, u32 reg_addr, u32 data);
536 void (*btc_write_1byte_bitmask)(void *btc_context, u32 reg_addr,
537 u32 bit_mask, u8 data1b);
538 u16 (*btc_read_2byte)(void *btc_context, u32 reg_addr);
539 void (*btc_write_2byte)(void *btc_context, u32 reg_addr, u16 data);
540 u32 (*btc_read_4byte)(void *btc_context, u32 reg_addr);
541 void (*btc_write_4byte)(void *btc_context, u32 reg_addr, u32 data);
543 void (*btc_write_local_reg_1byte)(void *btc_context, u32 reg_addr,
545 void (*btc_set_bb_reg)(void *btc_context, u32 reg_addr,
546 u32 bit_mask, u32 data);
547 u32 (*btc_get_bb_reg)(void *btc_context, u32 reg_addr,
549 void (*btc_set_rf_reg)(void *btc_context, u8 rf_path, u32 reg_addr,
550 u32 bit_mask, u32 data);
551 u32 (*btc_get_rf_reg)(void *btc_context, u8 rf_path,
552 u32 reg_addr, u32 bit_mask);
554 void (*btc_fill_h2c)(void *btc_context, u8 element_id,
555 u32 cmd_len, u8 *cmd_buffer);
557 void (*btc_disp_dbg_msg)(void *btcoexist, u8 disp_type,
560 bool (*btc_get)(void *btcoexist, u8 get_type, void *out_buf);
561 bool (*btc_set)(void *btcoexist, u8 set_type, void *in_buf);
563 void (*btc_set_bt_reg)(void *btc_context, u8 reg_type, u32 offset,
567 bool halbtc_is_wifi_uplink(struct rtl_priv *adapter);
569 #define rtl_btc_coexist(rtlpriv) \
570 ((struct btc_coexist *)((rtlpriv)->btcoexist.btc_context))
572 bool exhalbtc_initlize_variables(struct rtl_priv *rtlpriv);
573 bool exhalbtc_bind_bt_coex_withadapter(void *adapter);
574 void exhalbtc_power_on_setting(struct btc_coexist *btcoexist);
575 void exhalbtc_init_hw_config(struct btc_coexist *btcoexist, bool wifi_only);
576 void exhalbtc_init_coex_dm(struct btc_coexist *btcoexist);
577 void exhalbtc_ips_notify(struct btc_coexist *btcoexist, u8 type);
578 void exhalbtc_lps_notify(struct btc_coexist *btcoexist, u8 type);
579 void exhalbtc_scan_notify(struct btc_coexist *btcoexist, u8 type);
580 void exhalbtc_connect_notify(struct btc_coexist *btcoexist, u8 action);
581 void exhalbtc_mediastatus_notify(struct btc_coexist *btcoexist,
582 enum rt_media_status media_status);
583 void exhalbtc_special_packet_notify(struct btc_coexist *btcoexist, u8 pkt_type);
584 void exhalbtc_bt_info_notify(struct btc_coexist *btcoexist, u8 *tmp_buf,
586 void exhalbtc_stack_operation_notify(struct btc_coexist *btcoexist, u8 type);
587 void exhalbtc_halt_notify(struct btc_coexist *btcoexist);
588 void exhalbtc_pnp_notify(struct btc_coexist *btcoexist, u8 pnp_state);
589 void exhalbtc_coex_dm_switch(struct btc_coexist *btcoexist);
590 void exhalbtc_periodical(struct btc_coexist *btcoexist);
591 void exhalbtc_dbg_control(struct btc_coexist *btcoexist, u8 code, u8 len,
593 void exhalbtc_stack_update_profile_info(void);
594 void exhalbtc_set_hci_version(struct btc_coexist *btcoexist, u16 hci_version);
595 void exhalbtc_set_bt_patch_version(struct btc_coexist *btcoexist,
596 u16 bt_hci_version, u16 bt_patch_version);
597 void exhalbtc_update_min_bt_rssi(struct btc_coexist *btcoexist, s8 bt_rssi);
598 void exhalbtc_set_bt_exist(struct btc_coexist *btcoexist, bool bt_exist);
599 void exhalbtc_set_chip_type(struct btc_coexist *btcoexist, u8 chip_type);
600 void exhalbtc_set_ant_num(struct rtl_priv *rtlpriv, u8 type, u8 ant_num);
601 void exhalbtc_display_bt_coex_info(struct btc_coexist *btcoexist,
603 void exhalbtc_signal_compensation(struct btc_coexist *btcoexist,
604 u8 *rssi_wifi, u8 *rssi_bt);
605 void exhalbtc_lps_leave(struct btc_coexist *btcoexist);
606 void exhalbtc_low_wifi_traffic_notify(struct btc_coexist *btcoexist);
607 void exhalbtc_set_single_ant_path(struct btc_coexist *btcoexist,