drivers/staging/rtl8723bs/hal/HalBtcOutSrc.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /******************************************************************************
   3  *
   4  * Copyright(c) 2007 - 2012 Realtek Corporation. All rights reserved.
   5  *
   6  ******************************************************************************/
   7 #ifndef __HALBTC_OUT_SRC_H__
   8 #define __HALBTC_OUT_SRC_H__
   9
  10 #define NORMAL_EXEC             false
  11 #define FORCE_EXEC              true
  12
  13 #define BTC_RF_OFF              0x0
  14 #define BTC_RF_ON               0x1
  15
  16 #define BTC_RF_A                0x0
  17 #define BTC_RF_B                0x1
  18 #define BTC_RF_C                0x2
  19 #define BTC_RF_D                0x3
  20
  21 #define BTC_SMSP                SINGLEMAC_SINGLEPHY
  22 #define BTC_DMDP                DUALMAC_DUALPHY
  23 #define BTC_DMSP                DUALMAC_SINGLEPHY
  24 #define BTC_MP_UNKNOWN          0xff
  25
  26 #define BT_COEX_ANT_TYPE_PG     0
  27 #define BT_COEX_ANT_TYPE_ANTDIV         1
  28 #define BT_COEX_ANT_TYPE_DETECTED       2
  29
  30 #define BTC_MIMO_PS_STATIC      0       /*  1ss */
  31 #define BTC_MIMO_PS_DYNAMIC     1       /*  2ss */
  32
  33 #define BTC_RATE_DISABLE        0
  34 #define BTC_RATE_ENABLE         1
  35
  36 /*  single Antenna definition */
  37 #define BTC_ANT_PATH_WIFI       0
  38 #define BTC_ANT_PATH_BT         1
  39 #define BTC_ANT_PATH_PTA        2
  40 /*  dual Antenna definition */
  41 #define BTC_ANT_WIFI_AT_MAIN    0
  42 #define BTC_ANT_WIFI_AT_AUX     1
  43 /*  coupler Antenna definition */
  44 #define BTC_ANT_WIFI_AT_CPL_MAIN        0
  45 #define BTC_ANT_WIFI_AT_CPL_AUX         1
  46
  47 enum {
  48         BTC_PS_WIFI_NATIVE      = 0,    /*  wifi original power save behavior */
  49         BTC_PS_LPS_ON           = 1,
  50         BTC_PS_LPS_OFF          = 2,
  51         BTC_PS_MAX
  52 };
  53
  54 enum {
  55         BTC_BT_REG_RF           = 0,
  56         BTC_BT_REG_MODEM        = 1,
  57         BTC_BT_REG_BLUEWIZE     = 2,
  58         BTC_BT_REG_VENDOR       = 3,
  59         BTC_BT_REG_LE           = 4,
  60         BTC_BT_REG_MAX
  61 };
  62
  63 enum btc_chip_interface {
  64         BTC_INTF_UNKNOWN        = 0,
  65         BTC_INTF_PCI            = 1,
  66         BTC_INTF_USB            = 2,
  67         BTC_INTF_SDIO           = 3,
  68         BTC_INTF_MAX
  69 };
  70
  71 enum {
  72         BTC_CHIP_UNDEF          = 0,
  73         BTC_CHIP_CSR_BC4        = 1,
  74         BTC_CHIP_CSR_BC8        = 2,
  75         BTC_CHIP_RTL8723A       = 3,
  76         BTC_CHIP_RTL8821        = 4,
  77         BTC_CHIP_RTL8723B       = 5,
  78         BTC_CHIP_MAX
  79 };
  80
  81 /*  following is for wifi link status */
  82 #define WIFI_STA_CONNECTED                              BIT0
  83 #define WIFI_AP_CONNECTED                               BIT1
  84 #define WIFI_HS_CONNECTED                               BIT2
  85 #define WIFI_P2P_GO_CONNECTED                   BIT3
  86 #define WIFI_P2P_GC_CONNECTED                   BIT4
  87
  88 /*  following is for command line utility */
  89 #define CL_SPRINTF      snprintf
  90 #define CL_PRINTF       DCMD_Printf
  91
  92 struct btc_board_info {
  93         /*  The following is some board information */
  94         u8 btChipType;
  95         u8 pgAntNum;    /*  pg ant number */
  96         u8 btdmAntNum;  /*  ant number for btdm */
  97         u8 btdmAntPos;          /* Bryant Add to indicate Antenna Position for (pgAntNum = 2) && (btdmAntNum = 1)  (DPDT+1Ant case) */
  98         u8 singleAntPath;       /*  current used for 8723b only, 1 =>s0,  0 =>s1 */
  99         /* bool                         bBtExist; */
 100 };
 101
 102 enum {
 103         BTC_RSSI_STATE_HIGH                         = 0x0,
 104         BTC_RSSI_STATE_MEDIUM                   = 0x1,
 105         BTC_RSSI_STATE_LOW                          = 0x2,
 106         BTC_RSSI_STATE_STAY_HIGH                = 0x3,
 107         BTC_RSSI_STATE_STAY_MEDIUM              = 0x4,
 108         BTC_RSSI_STATE_STAY_LOW                 = 0x5,
 109         BTC_RSSI_MAX
 110 };
 111 #define BTC_RSSI_HIGH(_rssi_)   ((_rssi_ == BTC_RSSI_STATE_HIGH || _rssi_ == BTC_RSSI_STATE_STAY_HIGH) ? true : false)
 112 #define BTC_RSSI_MEDIUM(_rssi_) ((_rssi_ == BTC_RSSI_STATE_MEDIUM || _rssi_ == BTC_RSSI_STATE_STAY_MEDIUM) ? true : false)
 113 #define BTC_RSSI_LOW(_rssi_)    ((_rssi_ == BTC_RSSI_STATE_LOW || _rssi_ == BTC_RSSI_STATE_STAY_LOW) ? true : false)
 114
 115 enum {
 116         BTC_WIFI_BW_LEGACY                      = 0x0,
 117         BTC_WIFI_BW_HT20                        = 0x1,
 118         BTC_WIFI_BW_HT40                        = 0x2,
 119         BTC_WIFI_BW_MAX
 120 };
 121
 122 enum {
 123         BTC_WIFI_TRAFFIC_TX                     = 0x0,
 124         BTC_WIFI_TRAFFIC_RX                     = 0x1,
 125         BTC_WIFI_TRAFFIC_MAX
 126 };
 127
 128 enum {
 129         BTC_WIFI_PNP_WAKE_UP            = 0x0,
 130         BTC_WIFI_PNP_SLEEP                      = 0x1,
 131         BTC_WIFI_PNP_MAX
 132 };
 133
 134 /*  defined for BFP_BTC_GET */
 135 enum {
 136         /*  type bool */
 137         BTC_GET_BL_HS_OPERATION,
 138         BTC_GET_BL_HS_CONNECTING,
 139         BTC_GET_BL_WIFI_CONNECTED,
 140         BTC_GET_BL_WIFI_BUSY,
 141         BTC_GET_BL_WIFI_SCAN,
 142         BTC_GET_BL_WIFI_LINK,
 143         BTC_GET_BL_WIFI_ROAM,
 144         BTC_GET_BL_WIFI_4_WAY_PROGRESS,
 145         BTC_GET_BL_WIFI_AP_MODE_ENABLE,
 146         BTC_GET_BL_WIFI_ENABLE_ENCRYPTION,
 147         BTC_GET_BL_WIFI_UNDER_B_MODE,
 148         BTC_GET_BL_EXT_SWITCH,
 149         BTC_GET_BL_WIFI_IS_IN_MP_MODE,
 150
 151         /*  type s32 */
 152         BTC_GET_S4_WIFI_RSSI,
 153         BTC_GET_S4_HS_RSSI,
 154
 155         /*  type u32 */
 156         BTC_GET_U4_WIFI_BW,
 157         BTC_GET_U4_WIFI_TRAFFIC_DIRECTION,
 158         BTC_GET_U4_WIFI_FW_VER,
 159         BTC_GET_U4_WIFI_LINK_STATUS,
 160         BTC_GET_U4_BT_PATCH_VER,
 161
 162         /*  type u8 */
 163         BTC_GET_U1_WIFI_DOT11_CHNL,
 164         BTC_GET_U1_WIFI_CENTRAL_CHNL,
 165         BTC_GET_U1_WIFI_HS_CHNL,
 166         BTC_GET_U1_MAC_PHY_MODE,
 167         BTC_GET_U1_AP_NUM,
 168
 169         /*  for 1Ant ====== */
 170         BTC_GET_U1_LPS_MODE,
 171
 172         BTC_GET_MAX
 173 };
 174
 175 /*  defined for BFP_BTC_SET */
 176 enum {
 177         /*  type bool */
 178         BTC_SET_BL_BT_DISABLE,
 179         BTC_SET_BL_BT_TRAFFIC_BUSY,
 180         BTC_SET_BL_BT_LIMITED_DIG,
 181         BTC_SET_BL_FORCE_TO_ROAM,
 182         BTC_SET_BL_TO_REJ_AP_AGG_PKT,
 183         BTC_SET_BL_BT_CTRL_AGG_SIZE,
 184         BTC_SET_BL_INC_SCAN_DEV_NUM,
 185         BTC_SET_BL_BT_TX_RX_MASK,
 186
 187         /*  type u8 */
 188         BTC_SET_U1_RSSI_ADJ_VAL_FOR_AGC_TABLE_ON,
 189         BTC_SET_U1_AGG_BUF_SIZE,
 190
 191         /*  type trigger some action */
 192         BTC_SET_ACT_GET_BT_RSSI,
 193         BTC_SET_ACT_AGGREGATE_CTRL,
 194         /*  for 1Ant ====== */
 195         /*  type bool */
 196
 197         /*  type u8 */
 198         BTC_SET_U1_RSSI_ADJ_VAL_FOR_1ANT_COEX_TYPE,
 199         BTC_SET_U1_LPS_VAL,
 200         BTC_SET_U1_RPWM_VAL,
 201         /*  type trigger some action */
 202         BTC_SET_ACT_LEAVE_LPS,
 203         BTC_SET_ACT_ENTER_LPS,
 204         BTC_SET_ACT_NORMAL_LPS,
 205         BTC_SET_ACT_DISABLE_LOW_POWER,
 206         BTC_SET_ACT_UPDATE_RAMASK,
 207         BTC_SET_ACT_SEND_MIMO_PS,
 208         /*  BT Coex related */
 209         BTC_SET_ACT_CTRL_BT_INFO,
 210         BTC_SET_ACT_CTRL_BT_COEX,
 211         BTC_SET_ACT_CTRL_8723B_ANT,
 212         /*  */
 213         BTC_SET_MAX
 214 };
 215
 216 enum {
 217         BTC_DBG_DISP_COEX_STATISTICS            = 0x0,
 218         BTC_DBG_DISP_BT_LINK_INFO                       = 0x1,
 219         BTC_DBG_DISP_FW_PWR_MODE_CMD            = 0x2,
 220         BTC_DBG_DISP_MAX
 221 };
 222
 223 enum {
 224         BTC_IPS_LEAVE                                           = 0x0,
 225         BTC_IPS_ENTER                                           = 0x1,
 226         BTC_IPS_MAX
 227 };
 228
 229 enum {
 230         BTC_LPS_DISABLE                                         = 0x0,
 231         BTC_LPS_ENABLE                                          = 0x1,
 232         BTC_LPS_MAX
 233 };
 234
 235 enum {
 236         BTC_SCAN_FINISH                                         = 0x0,
 237         BTC_SCAN_START                                          = 0x1,
 238         BTC_SCAN_MAX
 239 };
 240
 241 enum {
 242         BTC_ASSOCIATE_FINISH                            = 0x0,
 243         BTC_ASSOCIATE_START                                     = 0x1,
 244         BTC_ASSOCIATE_MAX
 245 };
 246
 247 enum {
 248         BTC_MEDIA_DISCONNECT                            = 0x0,
 249         BTC_MEDIA_CONNECT                                       = 0x1,
 250         BTC_MEDIA_MAX
 251 };
 252
 253 enum {
 254         BTC_PACKET_UNKNOWN                                      = 0x0,
 255         BTC_PACKET_DHCP                                         = 0x1,
 256         BTC_PACKET_ARP                                          = 0x2,
 257         BTC_PACKET_EAPOL                                        = 0x3,
 258         BTC_PACKET_MAX
 259 };
 260
 261 /* Bryant Add */
 262 enum {
 263         BTC_ANTENNA_AT_MAIN_PORT = 0x1,
 264         BTC_ANTENNA_AT_AUX_PORT  = 0x2,
 265 };
 266
 267 typedef u8 (*BFP_BTC_R1)(void *pBtcContext, u32 RegAddr);
 268 typedef u16(*BFP_BTC_R2)(void *pBtcContext, u32 RegAddr);
 269 typedef u32 (*BFP_BTC_R4)(void *pBtcContext, u32 RegAddr);
 270 typedef void (*BFP_BTC_W1)(void *pBtcContext, u32 RegAddr, u8 Data);
 271 typedef void(*BFP_BTC_W1_BIT_MASK)(
 272         void *pBtcContext, u32 regAddr, u8 bitMask, u8 data1b
 273 );
 274 typedef void (*BFP_BTC_W2)(void *pBtcContext, u32 RegAddr, u16 Data);
 275 typedef void (*BFP_BTC_W4)(void *pBtcContext, u32 RegAddr, u32 Data);
 276 typedef void (*BFP_BTC_LOCAL_REG_W1)(void *pBtcContext, u32 RegAddr, u8 Data);
 277 typedef void (*BFP_BTC_SET_BB_REG)(
 278         void *pBtcContext, u32 RegAddr, u32 BitMask, u32 Data
 279 );
 280 typedef u32 (*BFP_BTC_GET_BB_REG)(void *pBtcContext, u32 RegAddr, u32 BitMask);
 281 typedef void (*BFP_BTC_SET_RF_REG)(
 282         void *pBtcContext, u8 eRFPath, u32 RegAddr, u32 BitMask, u32 Data
 283 );
 284 typedef u32 (*BFP_BTC_GET_RF_REG)(
 285         void *pBtcContext, u8 eRFPath, u32 RegAddr, u32 BitMask
 286 );
 287 typedef void (*BFP_BTC_FILL_H2C)(
 288         void *pBtcContext, u8 elementId, u32 cmdLen, u8 *pCmdBuffer
 289 );
 290
 291 typedef u8 (*BFP_BTC_GET)(void *pBtCoexist, u8 getType, void *pOutBuf);
 292
 293 typedef u8 (*BFP_BTC_SET)(void *pBtCoexist, u8 setType, void *pInBuf);
 294 typedef void (*BFP_BTC_SET_BT_REG)(
 295         void *pBtcContext, u8 regType, u32 offset, u32 value
 296 );
 297 typedef u32 (*BFP_BTC_GET_BT_REG)(void *pBtcContext, u8 regType, u32 offset);
 298 typedef void (*BFP_BTC_DISP_DBG_MSG)(void *pBtCoexist, u8 dispType);
 299
 300 struct btc_bt_info {
 301         bool bBtDisabled;
 302         u8 rssiAdjustForAgcTableOn;
 303         u8 rssiAdjustFor1AntCoexType;
 304         bool bPreBtCtrlAggBufSize;
 305         bool bBtCtrlAggBufSize;
 306         bool bRejectAggPkt;
 307         bool bIncreaseScanDevNum;
 308         bool bBtTxRxMask;
 309         u8 preAggBufSize;
 310         u8 aggBufSize;
 311         bool bBtBusy;
 312         bool bLimitedDig;
 313         u16 btHciVer;
 314         u16 btRealFwVer;
 315         u8 btFwVer;
 316         u32 getBtFwVerCnt;
 317
 318         bool bBtDisableLowPwr;
 319
 320         bool bBtCtrlLps;
 321         bool bBtLpsOn;
 322         bool bForceToRoam;      /*  for 1Ant solution */
 323         u8 lpsVal;
 324         u8 rpwmVal;
 325         u32 raMask;
 326 };
 327
 328 struct btc_stack_info {
 329         bool bProfileNotified;
 330         u16 hciVersion; /*  stack hci version */
 331         u8 numOfLink;
 332         bool bBtLinkExist;
 333         bool bScoExist;
 334         bool bAclExist;
 335         bool bA2dpExist;
 336         bool bHidExist;
 337         u8 numOfHid;
 338         bool bPanExist;
 339         bool bUnknownAclExist;
 340         s8 minBtRssi;
 341 };
 342
 343 struct btc_bt_link_info {
 344         bool bBtLinkExist;
 345         bool bScoExist;
 346         bool bScoOnly;
 347         bool bA2dpExist;
 348         bool bA2dpOnly;
 349         bool bHidExist;
 350         bool bHidOnly;
 351         bool bPanExist;
 352         bool bPanOnly;
 353         bool bSlaveRole;
 354 };
 355
 356 struct btc_statistics {
 357         u32 cntBind;
 358         u32 cntPowerOn;
 359         u32 cntInitHwConfig;
 360         u32 cntInitCoexDm;
 361         u32 cntIpsNotify;
 362         u32 cntLpsNotify;
 363         u32 cntScanNotify;
 364         u32 cntConnectNotify;
 365         u32 cntMediaStatusNotify;
 366         u32 cntSpecialPacketNotify;
 367         u32 cntBtInfoNotify;
 368         u32 cntRfStatusNotify;
 369         u32 cntPeriodical;
 370         u32 cntCoexDmSwitch;
 371         u32 cntStackOperationNotify;
 372         u32 cntDbgCtrl;
 373 };
 374
 375 struct btc_coexist {
 376         bool bBinded;           /*  make sure only one adapter can bind the data context */
 377         void *Adapter;          /*  default adapter */
 378         struct btc_board_info boardInfo;
 379         struct btc_bt_info btInfo;              /*  some bt info referenced by non-bt module */
 380         struct btc_stack_info stackInfo;
 381         struct btc_bt_link_info btLinkInfo;
 382         enum btc_chip_interface chipInterface;
 383
 384         bool bInitilized;
 385         bool bStopCoexDm;
 386         bool bManualControl;
 387         u8 *cliBuf;
 388         struct btc_statistics statistics;
 389         u8 pwrModeVal[10];
 390
 391         /*  function pointers */
 392         /*  io related */
 393         BFP_BTC_R1 fBtcRead1Byte;
 394         BFP_BTC_W1 fBtcWrite1Byte;
 395         BFP_BTC_W1_BIT_MASK fBtcWrite1ByteBitMask;
 396         BFP_BTC_R2 fBtcRead2Byte;
 397         BFP_BTC_W2 fBtcWrite2Byte;
 398         BFP_BTC_R4 fBtcRead4Byte;
 399         BFP_BTC_W4 fBtcWrite4Byte;
 400         BFP_BTC_LOCAL_REG_W1 fBtcWriteLocalReg1Byte;
 401         /*  read/write bb related */
 402         BFP_BTC_SET_BB_REG fBtcSetBbReg;
 403         BFP_BTC_GET_BB_REG fBtcGetBbReg;
 404
 405         /*  read/write rf related */
 406         BFP_BTC_SET_RF_REG fBtcSetRfReg;
 407         BFP_BTC_GET_RF_REG fBtcGetRfReg;
 408
 409         /*  fill h2c related */
 410         BFP_BTC_FILL_H2C fBtcFillH2c;
 411         /*  other */
 412         BFP_BTC_DISP_DBG_MSG fBtcDispDbgMsg;
 413         /*  normal get/set related */
 414         BFP_BTC_GET fBtcGet;
 415         BFP_BTC_SET fBtcSet;
 416
 417         BFP_BTC_GET_BT_REG fBtcGetBtReg;
 418         BFP_BTC_SET_BT_REG fBtcSetBtReg;
 419 };
 420
 421 extern struct btc_coexist GLBtCoexist;
 422
 423 void EXhalbtcoutsrc_PowerOnSetting(struct btc_coexist *pBtCoexist);
 424 void EXhalbtcoutsrc_InitHwConfig(struct btc_coexist *pBtCoexist, u8 bWifiOnly);
 425 void EXhalbtcoutsrc_InitCoexDm(struct btc_coexist *pBtCoexist);
 426 void EXhalbtcoutsrc_IpsNotify(struct btc_coexist *pBtCoexist, u8 type);
 427 void EXhalbtcoutsrc_LpsNotify(struct btc_coexist *pBtCoexist, u8 type);
 428 void EXhalbtcoutsrc_ScanNotify(struct btc_coexist *pBtCoexist, u8 type);
 429 void EXhalbtcoutsrc_ConnectNotify(struct btc_coexist *pBtCoexist, u8 action);
 430 void EXhalbtcoutsrc_MediaStatusNotify(
 431         struct btc_coexist *pBtCoexist, enum rt_media_status mediaStatus
 432 );
 433 void EXhalbtcoutsrc_SpecialPacketNotify(struct btc_coexist *pBtCoexist, u8 pktType);
 434 void EXhalbtcoutsrc_BtInfoNotify(
 435         struct btc_coexist *pBtCoexist, u8 *tmpBuf, u8 length
 436 );
 437 void EXhalbtcoutsrc_HaltNotify(struct btc_coexist *pBtCoexist);
 438 void EXhalbtcoutsrc_PnpNotify(struct btc_coexist *pBtCoexist, u8 pnpState);
 439 void EXhalbtcoutsrc_Periodical(struct btc_coexist *pBtCoexist);
 440 void EXhalbtcoutsrc_SetChipType(u8 chipType);
 441 void EXhalbtcoutsrc_SetAntNum(u8 type, u8 antNum);
 442 void EXhalbtcoutsrc_SetSingleAntPath(u8 singleAntPath);
 443 void EXhalbtcoutsrc_DisplayBtCoexInfo(struct btc_coexist *pBtCoexist);
 444
 445 #endif