drivers/staging/rtl8723bs/include/rtl8723b_hal.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /******************************************************************************
   3  *
   4  * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
   5  *
   6  ******************************************************************************/
   7 #ifndef __RTL8723B_HAL_H__
   8 #define __RTL8723B_HAL_H__
   9
  10 #include "hal_data.h"
  11
  12 #include "rtl8723b_spec.h"
  13 #include "rtl8723b_rf.h"
  14 #include "rtl8723b_dm.h"
  15 #include "rtl8723b_recv.h"
  16 #include "rtl8723b_xmit.h"
  17 #include "rtl8723b_cmd.h"
  18 #include "rtw_mp.h"
  19 #include "hal_pwr_seq.h"
  20 #include "hal_phy_reg_8723b.h"
  21 #include "hal_phy_cfg.h"
  22
  23 /*  */
  24 /* RTL8723B From header */
  25 /*  */
  26
  27 #define FW_8723B_SIZE          0x8000
  28 #define FW_8723B_START_ADDRESS 0x1000
  29 #define FW_8723B_END_ADDRESS   0x1FFF /* 0x5FFF */
  30
  31 #define IS_FW_HEADER_EXIST_8723B(fw_hdr) \
  32         ((le16_to_cpu(fw_hdr->signature) & 0xFFF0) == 0x5300)
  33
  34 struct rt_firmware {
  35         u32 fw_length;
  36         u8 *fw_buffer_sz;
  37 };
  38
  39 /* This structure must be carefully byte-ordered. */
  40 struct rt_firmware_hdr {
  41         /*  8-byte alinment required */
  42
  43         /*  LONG WORD 0 ---- */
  44         __le16 signature;  /* 92C0: test chip; 92C, 88C0: test chip;
  45                             * 88C1: MP A-cut; 92C1: MP A-cut */
  46         u8 category;       /* AP/NIC and USB/PCI */
  47         u8 function;       /* Reserved for different FW function indications,
  48                             * for further use when driver needs to download
  49                             * different FW in different conditions. */
  50         __le16 version;    /* FW Version */
  51         __le16 subversion; /* FW Subversion, default 0x00 */
  52
  53         /*  LONG WORD 1 ---- */
  54         u8 month;  /* Release time Month field */
  55         u8 date;   /* Release time Date field */
  56         u8 hour;   /* Release time Hour field */
  57         u8 minute; /* Release time Minute field */
  58
  59         __le16 ram_code_size; /* The size of RAM code */
  60         __le16 rsvd2;
  61
  62         /*  LONG WORD 2 ---- */
  63         __le32 svn_idx; /* The SVN entry index */
  64         __le32 rsvd3;
  65
  66         /*  LONG WORD 3 ---- */
  67         __le32 rsvd4;
  68         __le32 rsvd5;
  69 };
  70
  71 #define DRIVER_EARLY_INT_TIME_8723B  0x05
  72 #define BCN_DMA_ATIME_INT_TIME_8723B 0x02
  73
  74 /* for 8723B */
  75 /* TX 32K, RX 16K, Page size 128B for TX, 8B for RX */
  76 #define PAGE_SIZE_TX_8723B 128
  77 #define PAGE_SIZE_RX_8723B 8
  78
  79 #define RX_DMA_SIZE_8723B          0x4000 /* 16K */
  80 #define RX_DMA_RESERVED_SIZE_8723B 0x80   /* 128B, reserved for tx report */
  81 #define RX_DMA_BOUNDARY_8723B \
  82         (RX_DMA_SIZE_8723B - RX_DMA_RESERVED_SIZE_8723B - 1)
  83
  84 /* Note: We will divide number of pages equally for each queue other than the
  85  * public queue!
  86  */
  87
  88 /* For General Reserved Page Number(Beacon Queue is reserved page) */
  89 /* Beacon:2, PS-Poll:1, Null Data:1, Qos Null Data:1, BT Qos Null Data:1 */
  90 #define BCNQ_PAGE_NUM_8723B  0x08
  91 #define BCNQ1_PAGE_NUM_8723B 0x00
  92
  93 #ifdef CONFIG_PNO_SUPPORT
  94 #undef BCNQ1_PAGE_NUM_8723B
  95 #define BCNQ1_PAGE_NUM_8723B 0x00 /* 0x04 */
  96 #endif
  97
  98 #define MAX_RX_DMA_BUFFER_SIZE_8723B 0x2800 /* RX 10K */
  99
 100 /* For WoWLan, more reserved page */
 101 /* ARP Rsp:1, RWC:1, GTK Info:1, GTK RSP:2, GTK EXT MEM:2, PNO: 6 */
 102 #ifdef CONFIG_WOWLAN
 103 #define WOWLAN_PAGE_NUM_8723B 0x07
 104 #else
 105 #define WOWLAN_PAGE_NUM_8723B 0x00
 106 #endif
 107
 108 #ifdef CONFIG_PNO_SUPPORT
 109 #undef WOWLAN_PAGE_NUM_8723B
 110 #define WOWLAN_PAGE_NUM_8723B 0x0d
 111 #endif
 112
 113 #ifdef CONFIG_AP_WOWLAN
 114 #define AP_WOWLAN_PAGE_NUM_8723B 0x02
 115 #endif
 116
 117 #define TX_TOTAL_PAGE_NUMBER_8723B     \
 118         (0xFF - BCNQ_PAGE_NUM_8723B  - \
 119                 BCNQ1_PAGE_NUM_8723B - \
 120                 WOWLAN_PAGE_NUM_8723B)
 121 #define TX_PAGE_BOUNDARY_8723B (TX_TOTAL_PAGE_NUMBER_8723B + 1)
 122
 123 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723B TX_TOTAL_PAGE_NUMBER_8723B
 124 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8723B \
 125         (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723B + 1)
 126
 127 /* For Normal Chip Setting */
 128 /* (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8723B */
 129 #define NORMAL_PAGE_NUM_HPQ_8723B 0x0C
 130 #define NORMAL_PAGE_NUM_LPQ_8723B 0x02
 131 #define NORMAL_PAGE_NUM_NPQ_8723B 0x02
 132
 133 /*  Note: For Normal Chip Setting, modify later */
 134 #define WMM_NORMAL_PAGE_NUM_HPQ_8723B 0x30
 135 #define WMM_NORMAL_PAGE_NUM_LPQ_8723B 0x20
 136 #define WMM_NORMAL_PAGE_NUM_NPQ_8723B 0x20
 137
 138
 139 #include "HalVerDef.h"
 140 #include "hal_com.h"
 141
 142 #define EFUSE_OOB_PROTECT_BYTES 15
 143
 144 #define HAL_EFUSE_MEMORY
 145
 146 #define HWSET_MAX_SIZE_8723B         512
 147 #define EFUSE_REAL_CONTENT_LEN_8723B 512
 148 #define EFUSE_MAP_LEN_8723B          512
 149 #define EFUSE_MAX_SECTION_8723B      64
 150
 151 #define EFUSE_IC_ID_OFFSET 506 /* For some inferiority IC purpose.
 152                                 * Added by Roger, 2009.09.02. */
 153 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN_8723B)
 154
 155 #define EFUSE_ACCESS_ON  0x69 /* For RTL8723 only. */
 156 #define EFUSE_ACCESS_OFF 0x00 /* For RTL8723 only. */
 157
 158 /*  */
 159 /* EFUSE for BT definition */
 160 /*  */
 161 #define EFUSE_BT_REAL_BANK_CONTENT_LEN 512
 162 #define EFUSE_BT_REAL_CONTENT_LEN      1536 /* 512*3 */
 163 #define EFUSE_BT_MAP_LEN               1024 /* 1k bytes */
 164 #define EFUSE_BT_MAX_SECTION           128  /* 1024/8 */
 165
 166 #define EFUSE_PROTECT_BYTES_BANK 16
 167
 168 /* Description: Determine the types of C2H events that are the same in driver
 169  * and FW; First constructed by tynli. 2009.10.09.
 170  */
 171 typedef enum _C2H_EVT {
 172         C2H_DBG = 0,
 173         C2H_TSF = 1,
 174         C2H_AP_RPT_RSP = 2,
 175         C2H_CCX_TX_RPT = 3, /* The FW notify the report
 176                              * of the specific tx packet. */
 177         C2H_BT_RSSI = 4,
 178         C2H_BT_OP_MODE = 5,
 179         C2H_EXT_RA_RPT = 6,
 180         C2H_8723B_BT_INFO = 9,
 181         C2H_HW_INFO_EXCH = 10,
 182         C2H_8723B_BT_MP_INFO = 11,
 183         MAX_C2HEVENT
 184 } C2H_EVT;
 185
 186 typedef struct _C2H_EVT_HDR {
 187         u8 CmdID;
 188         u8 CmdLen;
 189         u8 CmdSeq;
 190 } __attribute__((__packed__)) C2H_EVT_HDR, *PC2H_EVT_HDR;
 191
 192 typedef enum tag_Package_Definition {
 193         PACKAGE_DEFAULT,
 194         PACKAGE_QFN68,
 195         PACKAGE_TFBGA90,
 196         PACKAGE_TFBGA80,
 197         PACKAGE_TFBGA79
 198 } PACKAGE_TYPE_E;
 199
 200 #define INCLUDE_MULTI_FUNC_BT(_Adapter)  \
 201         (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT)
 202 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) \
 203         (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS)
 204
 205 /*  rtl8723a_hal_init.c */
 206 s32 rtl8723b_FirmwareDownload(struct adapter *padapter, bool  bUsedWoWLANFw);
 207 void rtl8723b_FirmwareSelfReset(struct adapter *padapter);
 208 void rtl8723b_InitializeFirmwareVars(struct adapter *padapter);
 209
 210 void rtl8723b_InitAntenna_Selection(struct adapter *padapter);
 211 void rtl8723b_init_default_value(struct adapter *padapter);
 212
 213 s32 rtl8723b_InitLLTTable(struct adapter *padapter);
 214
 215 /*  EFuse */
 216 u8 GetEEPROMSize8723B(struct adapter *padapter);
 217 void Hal_InitPGData(struct adapter *padapter, u8 *PROMContent);
 218 void Hal_EfuseParseIDCode(struct adapter *padapter, u8 *hwinfo);
 219 void Hal_EfuseParseTxPowerInfo_8723B(struct adapter *padapter, u8 *PROMContent,
 220                                      bool AutoLoadFail);
 221 void Hal_EfuseParseBTCoexistInfo_8723B(struct adapter *padapter, u8 *hwinfo,
 222                                        bool AutoLoadFail);
 223 void Hal_EfuseParseEEPROMVer_8723B(struct adapter *padapter, u8 *hwinfo,
 224                                    bool AutoLoadFail);
 225 void Hal_EfuseParseChnlPlan_8723B(struct adapter *padapter, u8 *hwinfo,
 226                                   bool AutoLoadFail);
 227 void Hal_EfuseParseCustomerID_8723B(struct adapter *padapter, u8 *hwinfo,
 228                                     bool AutoLoadFail);
 229 void Hal_EfuseParseAntennaDiversity_8723B(struct adapter *padapter, u8 *hwinfo,
 230                                           bool AutoLoadFail);
 231 void Hal_EfuseParseXtal_8723B(struct adapter *padapter, u8 *hwinfo,
 232                               bool AutoLoadFail);
 233 void Hal_EfuseParseThermalMeter_8723B(struct adapter *padapter, u8 *hwinfo,
 234                                       u8 AutoLoadFail);
 235 void Hal_EfuseParsePackageType_8723B(struct adapter *padapter, u8 *hwinfo,
 236                                      bool AutoLoadFail);
 237 void Hal_EfuseParseVoltage_8723B(struct adapter *padapter, u8 *hwinfo,
 238                                  bool AutoLoadFail);
 239
 240 void C2HPacketHandler_8723B(struct adapter *padapter, u8 *pbuffer, u16 length);
 241
 242 void rtl8723b_set_hal_ops(struct hal_ops *pHalFunc);
 243 void SetHwReg8723B(struct adapter *padapter, u8 variable, u8 *val);
 244 void GetHwReg8723B(struct adapter *padapter, u8 variable, u8 *val);
 245 u8 SetHalDefVar8723B(struct adapter *padapter, enum HAL_DEF_VARIABLE variable,
 246                      void *pval);
 247 u8 GetHalDefVar8723B(struct adapter *padapter, enum HAL_DEF_VARIABLE variable,
 248                      void *pval);
 249
 250 /*  register */
 251 void rtl8723b_InitBeaconParameters(struct adapter *padapter);
 252 void _InitBurstPktLen_8723BS(struct adapter *adapter);
 253 void _8051Reset8723(struct adapter *padapter);
 254 #ifdef CONFIG_WOWLAN
 255 void Hal_DetectWoWMode(struct adapter *padapter);
 256 #endif /* CONFIG_WOWLAN */
 257
 258 void rtl8723b_start_thread(struct adapter *padapter);
 259 void rtl8723b_stop_thread(struct adapter *padapter);
 260
 261 #if defined(CONFIG_CHECK_BT_HANG)
 262 void rtl8723bs_init_checkbthang_workqueue(struct adapter *adapter);
 263 void rtl8723bs_free_checkbthang_workqueue(struct adapter *adapter);
 264 void rtl8723bs_cancle_checkbthang_workqueue(struct adapter *adapter);
 265 void rtl8723bs_hal_check_bt_hang(struct adapter *adapter);
 266 #endif
 267
 268 #ifdef CONFIG_GPIO_WAKEUP
 269 void HalSetOutPutGPIO(struct adapter *padapter, u8 index, u8 OutPutValue);
 270 #endif
 271
 272 int FirmwareDownloadBT(struct adapter *adapter, struct rt_firmware *firmware);
 273
 274 void CCX_FwC2HTxRpt_8723b(struct adapter *padapter, u8 *pdata, u8 len);
 275 s32 c2h_id_filter_ccx_8723b(u8 *buf);
 276 s32 c2h_handler_8723b(struct adapter *padapter, u8 *pC2hEvent);
 277 u8 MRateToHwRate8723B(u8 rate);
 278 u8 HwRateToMRate8723B(u8 rate);
 279
 280 void Hal_ReadRFGainOffset(struct adapter *padapter, u8 *hwinfo,
 281                           bool AutoLoadFail);
 282
 283 #endif