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