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 extern u32 btc_dbg_type[];
108 /* following is for BTC_MSG_INTERFACE */
109 #define INTF_INIT BIT0
110 #define INTF_NOTIFY BIT2
112 /* following is for BTC_ALGORITHM */
113 #define ALGO_BT_RSSI_STATE BIT0
114 #define ALGO_WIFI_RSSI_STATE BIT1
115 #define ALGO_BT_MONITOR BIT2
116 #define ALGO_TRACE BIT3
117 #define ALGO_TRACE_FW BIT4
118 #define ALGO_TRACE_FW_DETAIL BIT5
119 #define ALGO_TRACE_FW_EXEC BIT6
120 #define ALGO_TRACE_SW BIT7
121 #define ALGO_TRACE_SW_DETAIL BIT8
122 #define ALGO_TRACE_SW_EXEC BIT9
124 /* following is for wifi link status */
125 #define WIFI_STA_CONNECTED BIT0
126 #define WIFI_AP_CONNECTED BIT1
127 #define WIFI_HS_CONNECTED BIT2
128 #define WIFI_P2P_GO_CONNECTED BIT3
129 #define WIFI_P2P_GC_CONNECTED BIT4
131 #define BTC_RSSI_HIGH(_rssi_) \
132 ((_rssi_ == BTC_RSSI_STATE_HIGH || \
133 _rssi_ == BTC_RSSI_STATE_STAY_HIGH) ? true : false)
134 #define BTC_RSSI_MEDIUM(_rssi_) \
135 ((_rssi_ == BTC_RSSI_STATE_MEDIUM || \
136 _rssi_ == BTC_RSSI_STATE_STAY_MEDIUM) ? true : false)
137 #define BTC_RSSI_LOW(_rssi_) \
138 ((_rssi_ == BTC_RSSI_STATE_LOW || \
139 _rssi_ == BTC_RSSI_STATE_STAY_LOW) ? true : false)
141 enum btc_power_save_type {
142 BTC_PS_WIFI_NATIVE = 0,
148 struct btc_board_info {
149 /* The following is some board information */
151 u8 pg_ant_num; /* pg ant number */
152 u8 btdm_ant_num; /* ant number for btdm */
154 u8 single_ant_path; /* current used for 8723b only, 1=>s0, 0=>s1 */
159 enum btc_dbg_opcode {
160 BTC_DBG_SET_COEX_NORMAL = 0x0,
161 BTC_DBG_SET_COEX_WIFI_ONLY = 0x1,
162 BTC_DBG_SET_COEX_BT_ONLY = 0x2,
166 enum btc_rssi_state {
167 BTC_RSSI_STATE_HIGH = 0x0,
168 BTC_RSSI_STATE_MEDIUM = 0x1,
169 BTC_RSSI_STATE_LOW = 0x2,
170 BTC_RSSI_STATE_STAY_HIGH = 0x3,
171 BTC_RSSI_STATE_STAY_MEDIUM = 0x4,
172 BTC_RSSI_STATE_STAY_LOW = 0x5,
177 BTC_ROLE_STATION = 0x0,
180 BTC_ROLE_HS_MODE = 0x3,
184 enum btc_wifi_bw_mode {
185 BTC_WIFI_BW_LEGACY = 0x0,
186 BTC_WIFI_BW_HT20 = 0x1,
187 BTC_WIFI_BW_HT40 = 0x2,
191 enum btc_wifi_traffic_dir {
192 BTC_WIFI_TRAFFIC_TX = 0x0,
193 BTC_WIFI_TRAFFIC_RX = 0x1,
198 BTC_WIFI_PNP_WAKE_UP = 0x0,
199 BTC_WIFI_PNP_SLEEP = 0x1,
204 BTC_IOT_PEER_UNKNOWN = 0,
205 BTC_IOT_PEER_REALTEK = 1,
206 BTC_IOT_PEER_REALTEK_92SE = 2,
207 BTC_IOT_PEER_BROADCOM = 3,
208 BTC_IOT_PEER_RALINK = 4,
209 BTC_IOT_PEER_ATHEROS = 5,
210 BTC_IOT_PEER_CISCO = 6,
211 BTC_IOT_PEER_MERU = 7,
212 BTC_IOT_PEER_MARVELL = 8,
213 BTC_IOT_PEER_REALTEK_SOFTAP = 9,
214 BTC_IOT_PEER_SELF_SOFTAP = 10, /* Self is SoftAP */
215 BTC_IOT_PEER_AIRGO = 11,
216 BTC_IOT_PEER_REALTEK_JAGUAR_BCUTAP = 12,
217 BTC_IOT_PEER_REALTEK_JAGUAR_CCUTAP = 13,
221 /* for 8723b-d cut large current issue */
222 enum bt_wifi_coex_state {
225 BTC_WIFI_STAT_NORMAL_OFF,
226 BTC_WIFI_STAT_MP_OFF,
227 BTC_WIFI_STAT_NORMAL,
228 BTC_WIFI_STAT_ANT_DIV,
243 BTC_GET_BL_HS_OPERATION,
244 BTC_GET_BL_HS_CONNECTING,
245 BTC_GET_BL_WIFI_CONNECTED,
246 BTC_GET_BL_WIFI_BUSY,
247 BTC_GET_BL_WIFI_SCAN,
248 BTC_GET_BL_WIFI_LINK,
249 BTC_GET_BL_WIFI_DHCP,
250 BTC_GET_BL_WIFI_SOFTAP_IDLE,
251 BTC_GET_BL_WIFI_SOFTAP_LINKING,
252 BTC_GET_BL_WIFI_IN_EARLY_SUSPEND,
253 BTC_GET_BL_WIFI_ROAM,
254 BTC_GET_BL_WIFI_4_WAY_PROGRESS,
255 BTC_GET_BL_WIFI_UNDER_5G,
256 BTC_GET_BL_WIFI_AP_MODE_ENABLE,
257 BTC_GET_BL_WIFI_ENABLE_ENCRYPTION,
258 BTC_GET_BL_WIFI_UNDER_B_MODE,
259 BTC_GET_BL_EXT_SWITCH,
260 BTC_GET_BL_WIFI_IS_IN_MP_MODE,
261 BTC_GET_BL_IS_ASUS_8723B,
263 BTC_GET_BL_RF4CE_CONNECTED,
266 BTC_GET_S4_WIFI_RSSI,
271 BTC_GET_U4_WIFI_TRAFFIC_DIRECTION,
272 BTC_GET_U4_WIFI_FW_VER,
273 BTC_GET_U4_WIFI_LINK_STATUS,
274 BTC_GET_U4_BT_PATCH_VER,
276 BTC_GET_U4_SUPPORTED_VERSION,
277 BTC_GET_U4_SUPPORTED_FEATURE,
278 BTC_GET_U4_WIFI_IQK_TOTAL,
279 BTC_GET_U4_WIFI_IQK_OK,
280 BTC_GET_U4_WIFI_IQK_FAIL,
283 BTC_GET_U1_WIFI_DOT11_CHNL,
284 BTC_GET_U1_WIFI_CENTRAL_CHNL,
285 BTC_GET_U1_WIFI_HS_CHNL,
286 BTC_GET_U1_MAC_PHY_MODE,
293 BTC_GET_BL_BT_SCO_BUSY,
296 BTC_GET_DRIVER_TEST_CFG,
308 BTC_SET_BL_BT_DISABLE,
309 BTC_SET_BL_BT_TRAFFIC_BUSY,
310 BTC_SET_BL_BT_LIMITED_DIG,
311 BTC_SET_BL_FORCE_TO_ROAM,
312 BTC_SET_BL_TO_REJ_AP_AGG_PKT,
313 BTC_SET_BL_BT_CTRL_AGG_SIZE,
314 BTC_SET_BL_INC_SCAN_DEV_NUM,
315 BTC_SET_BL_BT_TX_RX_MASK,
316 BTC_SET_BL_MIRACAST_PLUS_BT,
319 BTC_SET_U1_RSSI_ADJ_VAL_FOR_AGC_TABLE_ON,
320 BTC_SET_UI_SCAN_SIG_COMPENSATION,
321 BTC_SET_U1_AGG_BUF_SIZE,
323 /* type trigger some action */
324 BTC_SET_ACT_GET_BT_RSSI,
325 BTC_SET_ACT_AGGREGATE_CTRL,
326 BTC_SET_ACT_ANTPOSREGRISTRY_CTRL,
328 /********* for 1Ant **********/
330 BTC_SET_BL_BT_SCO_BUSY,
332 BTC_SET_U1_RSSI_ADJ_VAL_FOR_1ANT_COEX_TYPE,
336 BTC_SET_U1_1ANT_RPWM,
337 /* type trigger some action */
338 BTC_SET_ACT_LEAVE_LPS,
339 BTC_SET_ACT_ENTER_LPS,
340 BTC_SET_ACT_NORMAL_LPS,
341 BTC_SET_ACT_INC_FORCE_EXEC_PWR_CMD_CNT,
342 BTC_SET_ACT_DISABLE_LOW_POWER,
343 BTC_SET_ACT_UPDATE_RAMASK,
344 BTC_SET_ACT_SEND_MIMO_PS,
345 /* BT Coex related */
346 BTC_SET_ACT_CTRL_BT_INFO,
347 BTC_SET_ACT_CTRL_BT_COEX,
348 BTC_SET_ACT_CTRL_8723B_ANT,
349 /***************************/
353 enum btc_dbg_disp_type {
354 BTC_DBG_DISP_COEX_STATISTICS = 0x0,
355 BTC_DBG_DISP_BT_LINK_INFO = 0x1,
356 BTC_DBG_DISP_BT_FW_VER = 0x2,
357 BTC_DBG_DISP_FW_PWR_MODE_CMD = 0x3,
361 enum btc_notify_type_ips {
367 enum btc_notify_type_lps {
368 BTC_LPS_DISABLE = 0x0,
369 BTC_LPS_ENABLE = 0x1,
373 enum btc_notify_type_scan {
374 BTC_SCAN_FINISH = 0x0,
375 BTC_SCAN_START = 0x1,
379 enum btc_notify_type_associate {
380 BTC_ASSOCIATE_FINISH = 0x0,
381 BTC_ASSOCIATE_START = 0x1,
385 enum btc_notify_type_media_status {
386 BTC_MEDIA_DISCONNECT = 0x0,
387 BTC_MEDIA_CONNECT = 0x1,
391 enum btc_notify_type_special_packet {
392 BTC_PACKET_UNKNOWN = 0x0,
393 BTC_PACKET_DHCP = 0x1,
394 BTC_PACKET_ARP = 0x2,
395 BTC_PACKET_EAPOL = 0x3,
399 enum hci_ext_bt_operation {
400 HCI_BT_OP_NONE = 0x0,
401 HCI_BT_OP_INQUIRY_START = 0x1,
402 HCI_BT_OP_INQUIRY_FINISH = 0x2,
403 HCI_BT_OP_PAGING_START = 0x3,
404 HCI_BT_OP_PAGING_SUCCESS = 0x4,
405 HCI_BT_OP_PAGING_UNSUCCESS = 0x5,
406 HCI_BT_OP_PAIRING_START = 0x6,
407 HCI_BT_OP_PAIRING_FINISH = 0x7,
408 HCI_BT_OP_BT_DEV_ENABLE = 0x8,
409 HCI_BT_OP_BT_DEV_DISABLE = 0x9,
413 enum btc_notify_type_stack_operation {
414 BTC_STACK_OP_NONE = 0x0,
415 BTC_STACK_OP_INQ_PAGE_PAIR_START = 0x1,
416 BTC_STACK_OP_INQ_PAGE_PAIR_FINISH = 0x2,
420 typedef u8 (*bfp_btc_r1)(void *btc_context, u32 reg_addr);
422 typedef u16 (*bfp_btc_r2)(void *btc_context, u32 reg_addr);
424 typedef u32 (*bfp_btc_r4)(void *btc_context, u32 reg_addr);
426 typedef void (*bfp_btc_w1)(void *btc_context, u32 reg_addr, u32 data);
428 typedef void (*bfp_btc_w1_bit_mak)(void *btc_context, u32 reg_addr,
429 u32 bit_mask, u8 data1b);
431 typedef void (*bfp_btc_w2)(void *btc_context, u32 reg_addr, u16 data);
433 typedef void (*bfp_btc_w4)(void *btc_context, u32 reg_addr, u32 data);
435 typedef void (*bfp_btc_local_reg_w1)(void *btc_context, u32 reg_addr, u8 data);
436 typedef void (*bfp_btc_wr_1byte_bit_mask)(void *btc_context, u32 reg_addr,
437 u8 bit_mask, u8 data);
439 typedef void (*bfp_btc_set_bb_reg)(void *btc_context, u32 reg_addr,
440 u32 bit_mask, u32 data);
442 typedef u32 (*bfp_btc_get_bb_reg)(void *btc_context, u32 reg_addr,
445 typedef void (*bfp_btc_set_rf_reg)(void *btc_context, u8 rf_path, u32 reg_addr,
446 u32 bit_mask, u32 data);
448 typedef u32 (*bfp_btc_get_rf_reg)(void *btc_context, u8 rf_path,
449 u32 reg_addr, u32 bit_mask);
451 typedef void (*bfp_btc_fill_h2c)(void *btc_context, u8 element_id,
452 u32 cmd_len, u8 *cmd_buffer);
454 typedef bool (*bfp_btc_get)(void *btcoexist, u8 get_type, void *out_buf);
456 typedef bool (*bfp_btc_set)(void *btcoexist, u8 set_type, void *in_buf);
458 typedef void (*bfp_btc_set_bt_reg)(void *btc_context, u8 reg_type, u32 offset,
461 typedef void (*bfp_btc_disp_dbg_msg)(void *btcoexist, u8 disp_type);
465 u8 rssi_adjust_for_agc_table_on;
466 u8 rssi_adjust_for_1ant_coex_type;
467 bool pre_bt_ctrl_agg_buf_size;
472 bool pre_reject_agg_pkt;
474 bool bt_ctrl_buf_size;
475 bool increase_scan_dev_num;
476 bool miracast_plus_bt;
477 bool bt_ctrl_agg_buf_size;
483 bool bt_disable_low_pwr;
485 /* the following is for 1Ant solution */
487 bool bt_pwr_save_mode;
490 u8 force_exec_pwr_cmd_cnt;
496 struct btc_stack_info {
497 bool profile_notified;
498 u16 hci_version; /* stack hci version */
507 bool unknown_acl_exist;
511 struct btc_statistics {
513 u32 cnt_init_hw_config;
514 u32 cnt_init_coex_dm;
518 u32 cnt_connect_notify;
519 u32 cnt_media_status_notify;
520 u32 cnt_special_packet_notify;
521 u32 cnt_bt_info_notify;
523 u32 cnt_coex_dm_switch;
524 u32 cnt_stack_operation_notify;
526 u32 cnt_pre_load_firmware;
530 struct btc_bt_link_info {
532 bool bt_hi_pri_link_exist;
544 enum btc_antenna_pos {
545 BTC_ANTENNA_AT_MAIN_PORT = 0x1,
546 BTC_ANTENNA_AT_AUX_PORT = 0x2,
550 /* make sure only one adapter can bind the data context */
552 /* default adapter */
554 struct btc_board_info board_info;
555 /* some bt info referenced by non-bt module */
556 struct btc_bt_info bt_info;
557 struct btc_stack_info stack_info;
558 enum btc_chip_interface chip_interface;
559 struct btc_bt_link_info bt_link_info;
561 /* boolean variables to replace BT_AUTO_REPORT_ONLY_XXXXY_ZANT
562 * configuration parameters
564 bool auto_report_1ant;
565 bool auto_report_2ant;
569 struct btc_statistics statistics;
572 /* function pointers - io related */
573 bfp_btc_r1 btc_read_1byte;
574 bfp_btc_w1 btc_write_1byte;
575 bfp_btc_w1_bit_mak btc_write_1byte_bitmask;
576 bfp_btc_r2 btc_read_2byte;
577 bfp_btc_w2 btc_write_2byte;
578 bfp_btc_r4 btc_read_4byte;
579 bfp_btc_w4 btc_write_4byte;
580 bfp_btc_local_reg_w1 btc_write_local_reg_1byte;
582 bfp_btc_set_bb_reg btc_set_bb_reg;
583 bfp_btc_get_bb_reg btc_get_bb_reg;
585 bfp_btc_set_rf_reg btc_set_rf_reg;
586 bfp_btc_get_rf_reg btc_get_rf_reg;
588 bfp_btc_fill_h2c btc_fill_h2c;
590 bfp_btc_disp_dbg_msg btc_disp_dbg_msg;
595 bfp_btc_set_bt_reg btc_set_bt_reg;
598 bool halbtc_is_wifi_uplink(struct rtl_priv *adapter);
600 extern struct btc_coexist gl_bt_coexist;
602 bool exhalbtc_initlize_variables(void);
603 bool exhalbtc_bind_bt_coex_withadapter(void *adapter);
604 void exhalbtc_power_on_setting(struct btc_coexist *btcoexist);
605 void exhalbtc_init_hw_config(struct btc_coexist *btcoexist, bool wifi_only);
606 void exhalbtc_init_coex_dm(struct btc_coexist *btcoexist);
607 void exhalbtc_ips_notify(struct btc_coexist *btcoexist, u8 type);
608 void exhalbtc_lps_notify(struct btc_coexist *btcoexist, u8 type);
609 void exhalbtc_scan_notify(struct btc_coexist *btcoexist, u8 type);
610 void exhalbtc_connect_notify(struct btc_coexist *btcoexist, u8 action);
611 void exhalbtc_mediastatus_notify(struct btc_coexist *btcoexist,
612 enum rt_media_status media_status);
613 void exhalbtc_special_packet_notify(struct btc_coexist *btcoexist, u8 pkt_type);
614 void exhalbtc_bt_info_notify(struct btc_coexist *btcoexist, u8 *tmp_buf,
616 void exhalbtc_stack_operation_notify(struct btc_coexist *btcoexist, u8 type);
617 void exhalbtc_halt_notify(struct btc_coexist *btcoexist);
618 void exhalbtc_pnp_notify(struct btc_coexist *btcoexist, u8 pnp_state);
619 void exhalbtc_coex_dm_switch(struct btc_coexist *btcoexist);
620 void exhalbtc_periodical(struct btc_coexist *btcoexist);
621 void exhalbtc_dbg_control(struct btc_coexist *btcoexist, u8 code, u8 len,
623 void exhalbtc_stack_update_profile_info(void);
624 void exhalbtc_set_hci_version(u16 hci_version);
625 void exhalbtc_set_bt_patch_version(u16 bt_hci_version, u16 bt_patch_version);
626 void exhalbtc_update_min_bt_rssi(s8 bt_rssi);
627 void exhalbtc_set_bt_exist(bool bt_exist);
628 void exhalbtc_set_chip_type(u8 chip_type);
629 void exhalbtc_set_ant_num(struct rtl_priv *rtlpriv, u8 type, u8 ant_num);
630 void exhalbtc_display_bt_coex_info(struct btc_coexist *btcoexist);
631 void exhalbtc_signal_compensation(struct btc_coexist *btcoexist,
632 u8 *rssi_wifi, u8 *rssi_bt);
633 void exhalbtc_lps_leave(struct btc_coexist *btcoexist);
634 void exhalbtc_low_wifi_traffic_notify(struct btc_coexist *btcoexist);
635 void exhalbtc_set_single_ant_path(u8 single_ant_path);