git.ipfire.org Git - thirdparty/kernel/linux.git/blob

1 /* SPDX-License-Identifier: GPL-2.0 */

2 /******************************************************************************

3 *

5 *

6 ******************************************************************************/

7 #ifndef __HAL_INTF_H__

8 #define __HAL_INTF_H__

11 enum {

12 RTW_PCIE = BIT0,

13 RTW_USB = BIT1,

14 RTW_SDIO = BIT2,

15 RTW_GSPI = BIT3,

16 };

18 enum {

19 HW_VAR_MEDIA_STATUS,

20 HW_VAR_MEDIA_STATUS1,

21 HW_VAR_SET_OPMODE,

22 HW_VAR_MAC_ADDR,

23 HW_VAR_BSSID,

24 HW_VAR_INIT_RTS_RATE,

25 HW_VAR_BASIC_RATE,

26 HW_VAR_TXPAUSE,

27 HW_VAR_BCN_FUNC,

28 HW_VAR_CORRECT_TSF,

29 HW_VAR_CHECK_BSSID,

30 HW_VAR_MLME_DISCONNECT,

31 HW_VAR_MLME_SITESURVEY,

32 HW_VAR_MLME_JOIN,

33 HW_VAR_ON_RCR_AM,

34 HW_VAR_OFF_RCR_AM,

35 HW_VAR_BEACON_INTERVAL,

36 HW_VAR_SLOT_TIME,

37 HW_VAR_RESP_SIFS,

38 HW_VAR_ACK_PREAMBLE,

39 HW_VAR_SEC_CFG,

40 HW_VAR_SEC_DK_CFG,

41 HW_VAR_BCN_VALID,

42 HW_VAR_RF_TYPE,

43 HW_VAR_DM_FLAG,

44 HW_VAR_DM_FUNC_OP,

45 HW_VAR_DM_FUNC_SET,

46 HW_VAR_DM_FUNC_CLR,

47 HW_VAR_CAM_EMPTY_ENTRY,

48 HW_VAR_CAM_INVALID_ALL,

49 HW_VAR_CAM_WRITE,

50 HW_VAR_CAM_READ,

51 HW_VAR_AC_PARAM_VO,

52 HW_VAR_AC_PARAM_VI,

53 HW_VAR_AC_PARAM_BE,

54 HW_VAR_AC_PARAM_BK,

55 HW_VAR_ACM_CTRL,

56 HW_VAR_AMPDU_MIN_SPACE,

57 HW_VAR_AMPDU_FACTOR,

58 HW_VAR_RXDMA_AGG_PG_TH,

59 HW_VAR_SET_RPWM,

60 HW_VAR_CPWM,

61 HW_VAR_H2C_FW_PWRMODE,

62 HW_VAR_H2C_PS_TUNE_PARAM,

63 HW_VAR_H2C_FW_JOINBSSRPT,

64 HW_VAR_FWLPS_RF_ON,

65 HW_VAR_H2C_FW_P2P_PS_OFFLOAD,

66 HW_VAR_TDLS_WRCR,

67 HW_VAR_TDLS_INIT_CH_SEN,

68 HW_VAR_TDLS_RS_RCR,

69 HW_VAR_TDLS_DONE_CH_SEN,

70 HW_VAR_INITIAL_GAIN,

71 HW_VAR_TRIGGER_GPIO_0,

72 HW_VAR_BT_SET_COEXIST,

73 HW_VAR_BT_ISSUE_DELBA,

74 HW_VAR_CURRENT_ANTENNA,

75 HW_VAR_ANTENNA_DIVERSITY_LINK,

76 HW_VAR_ANTENNA_DIVERSITY_SELECT,

77 HW_VAR_SWITCH_EPHY_WoWLAN,

78 HW_VAR_EFUSE_USAGE,

79 HW_VAR_EFUSE_BYTES,

80 HW_VAR_EFUSE_BT_USAGE,

81 HW_VAR_EFUSE_BT_BYTES,

82 HW_VAR_FIFO_CLEARN_UP,

83 HW_VAR_CHECK_TXBUF,

84 HW_VAR_PCIE_STOP_TX_DMA,

85 HW_VAR_APFM_ON_MAC, /* Auto FSM to Turn On, include clock, isolation, power control for MAC only */

86 /* The valid upper nav range for the HW updating, if the true value is larger than the upper range, the HW won't update it. */

87 /* Unit in microsecond. 0 means disable this function. */

88 HW_VAR_SYS_CLKR,

89 HW_VAR_NAV_UPPER,

90 HW_VAR_C2H_HANDLE,

91 HW_VAR_RPT_TIMER_SETTING,

92 HW_VAR_TX_RPT_MAX_MACID,

93 HW_VAR_H2C_MEDIA_STATUS_RPT,

94 HW_VAR_CHK_HI_QUEUE_EMPTY,

95 HW_VAR_DL_BCN_SEL,

96 HW_VAR_AMPDU_MAX_TIME,

97 HW_VAR_WIRELESS_MODE,

98 HW_VAR_USB_MODE,

99 HW_VAR_PORT_SWITCH,

100 HW_VAR_DO_IQK,

101 HW_VAR_DM_IN_LPS,

102 HW_VAR_SET_REQ_FW_PS,

103 HW_VAR_FW_PS_STATE,

104 HW_VAR_SOUNDING_ENTER,

105 HW_VAR_SOUNDING_LEAVE,

106 HW_VAR_SOUNDING_RATE,

107 HW_VAR_SOUNDING_STATUS,

108 HW_VAR_SOUNDING_FW_NDPA,

109 HW_VAR_SOUNDING_CLK,

110 HW_VAR_DL_RSVD_PAGE,

111 HW_VAR_MACID_SLEEP,

112 HW_VAR_MACID_WAKEUP,

113 };

114

115 enum hal_def_variable {

116 HAL_DEF_UNDERCORATEDSMOOTHEDPWDB,

117 HAL_DEF_IS_SUPPORT_ANT_DIV,

118 HAL_DEF_CURRENT_ANTENNA,

119 HAL_DEF_DRVINFO_SZ,

120 HAL_DEF_MAX_RECVBUF_SZ,

121 HAL_DEF_RX_PACKET_OFFSET,

122 HAL_DEF_DBG_DUMP_RXPKT,/* for dbg */

123 HAL_DEF_DBG_DM_FUNC,/* for dbg */

124 HAL_DEF_RA_DECISION_RATE,

125 HAL_DEF_RA_SGI,

126 HAL_DEF_PT_PWR_STATUS,

127 HAL_DEF_TX_LDPC, /* LDPC support */

128 HAL_DEF_RX_LDPC, /* LDPC support */

129 HAL_DEF_TX_STBC, /* TX STBC support */

130 HAL_DEF_RX_STBC, /* RX STBC support */

131 HAL_DEF_EXPLICIT_BEAMFORMER,/* Explicit Compressed Steering Capable */

132 HAL_DEF_EXPLICIT_BEAMFORMEE,/* Explicit Compressed Beamforming Feedback Capable */

133 HW_VAR_MAX_RX_AMPDU_FACTOR,

134 HW_DEF_RA_INFO_DUMP,

135 HAL_DEF_DBG_DUMP_TXPKT,

136 HW_DEF_FA_CNT_DUMP,

137 HW_DEF_ODM_DBG_FLAG,

138 HW_DEF_ODM_DBG_LEVEL,

139 HAL_DEF_TX_PAGE_SIZE,

140 HAL_DEF_TX_PAGE_BOUNDARY,

141 HAL_DEF_TX_PAGE_BOUNDARY_WOWLAN,

142 HAL_DEF_ANT_DETECT,/* to do for 8723a */

143 HAL_DEF_PCI_SUUPORT_L1_BACKDOOR, /* Determine if the L1 Backdoor setting is turned on. */

144 HAL_DEF_PCI_AMD_L1_SUPPORT,

145 HAL_DEF_PCI_ASPM_OSC, /* Support for ASPM OSC, added by Roger, 2013.03.27. */

146 HAL_DEF_MACID_SLEEP, /* Support for MACID sleep */

147 };

148

149 enum hal_odm_variable {

150 HAL_ODM_STA_INFO,

151 HAL_ODM_P2P_STATE,

152 HAL_ODM_WIFI_DISPLAY_STATE,

153 HAL_ODM_NOISE_MONITOR,

154 };

155

156 enum hal_intf_ps_func {

157 HAL_USB_SELECT_SUSPEND,

158 HAL_MAX_ID,

159 };

160

161 typedef s32 (*c2h_id_filter)(u8 *c2h_evt);

162

163 struct hal_ops {

164 void (*SetHalODMVarHandler)(struct adapter *padapter, enum hal_odm_variable eVariable, void *pValue1, bool bSet);

165 s32 (*xmit_thread_handler)(struct adapter *padapter);

166 void (*hal_notch_filter)(struct adapter *adapter, bool enable);

167 void (*hal_reset_security_engine)(struct adapter *adapter);

168 s32 (*c2h_handler)(struct adapter *padapter, u8 *c2h_evt);

169 c2h_id_filter c2h_id_filter_ccx;

170

171 s32 (*fill_h2c_cmd)(struct adapter *, u8 ElementID, u32 CmdLen, u8 *pCmdBuffer);

172 };

173

174 #define RF_CHANGE_BY_INIT 0

175 #define RF_CHANGE_BY_IPS BIT28

176 #define RF_CHANGE_BY_PS BIT29

177 #define RF_CHANGE_BY_HW BIT30

178 #define RF_CHANGE_BY_SW BIT31

179

180 #define GET_EEPROM_EFUSE_PRIV(adapter) (&adapter->eeprompriv)

181 #define is_boot_from_eeprom(adapter) (adapter->eeprompriv.EepromOrEfuse)

182

183 #define Rx_Pairwisekey 0x01

184 #define Rx_GTK 0x02

185 #define Rx_DisAssoc 0x04

186 #define Rx_DeAuth 0x08

187 #define Rx_ARPReq 0x09

188 #define FWDecisionDisconnect 0x10

189 #define Rx_MagicPkt 0x21

190 #define Rx_UnicastPkt 0x22

191 #define Rx_PatternPkt 0x23

192 #define RX_PNOWakeUp 0x55

193 #define AP_WakeUp 0x66

194

195 void rtw_hal_def_value_init(struct adapter *padapter);

196

197 void rtw_hal_free_data(struct adapter *padapter);

198

199 void rtw_hal_dm_init(struct adapter *padapter);

200

201 uint rtw_hal_init(struct adapter *padapter);

202 uint rtw_hal_deinit(struct adapter *padapter);

203 void rtw_hal_stop(struct adapter *padapter);

204 void rtw_hal_set_hwreg(struct adapter *padapter, u8 variable, u8 *val);

205 void rtw_hal_get_hwreg(struct adapter *padapter, u8 variable, u8 *val);

206

207 void rtw_hal_set_hwreg_with_buf(struct adapter *padapter, u8 variable, u8 *pbuf, int len);

208

209 void rtw_hal_chip_configure(struct adapter *padapter);

210 void rtw_hal_read_chip_info(struct adapter *padapter);

211 void rtw_hal_read_chip_version(struct adapter *padapter);

212

213 u8 rtw_hal_set_def_var(struct adapter *padapter, enum hal_def_variable eVariable, void *pValue);

214 u8 rtw_hal_get_def_var(struct adapter *padapter, enum hal_def_variable eVariable, void *pValue);

215

216 void rtw_hal_set_odm_var(struct adapter *padapter, enum hal_odm_variable eVariable, void *pValue1, bool bSet);

217

218 void rtw_hal_enable_interrupt(struct adapter *padapter);

219 void rtw_hal_disable_interrupt(struct adapter *padapter);

220

221 u8 rtw_hal_check_ips_status(struct adapter *padapter);

222

223 s32 rtw_hal_xmitframe_enqueue(struct adapter *padapter, struct xmit_frame *pxmitframe);

224 s32 rtw_hal_xmit(struct adapter *padapter, struct xmit_frame *pxmitframe);

225 s32 rtw_hal_mgnt_xmit(struct adapter *padapter, struct xmit_frame *pmgntframe);

226

227 s32 rtw_hal_init_xmit_priv(struct adapter *padapter);

228 void rtw_hal_free_xmit_priv(struct adapter *padapter);

229

230 s32 rtw_hal_init_recv_priv(struct adapter *padapter);

231 void rtw_hal_free_recv_priv(struct adapter *padapter);

232

233 void rtw_hal_update_ra_mask(struct sta_info *psta, u8 rssi_level);

234 void rtw_hal_add_ra_tid(struct adapter *padapter, u32 bitmap, u8 *arg, u8 rssi_level);

235

236 void rtw_hal_start_thread(struct adapter *padapter);

237 void rtw_hal_stop_thread(struct adapter *padapter);

238

239 void beacon_timing_control(struct adapter *padapter);

240

241 u32 rtw_hal_read_bbreg(struct adapter *padapter, u32 RegAddr, u32 BitMask);

242 void rtw_hal_write_bbreg(struct adapter *padapter, u32 RegAddr, u32 BitMask, u32 Data);

243 u32 rtw_hal_read_rfreg(struct adapter *padapter, u32 eRFPath, u32 RegAddr, u32 BitMask);

244 void rtw_hal_write_rfreg(struct adapter *padapter, u32 eRFPath, u32 RegAddr, u32 BitMask, u32 Data);

245

246 #define PHY_QueryBBReg(Adapter, RegAddr, BitMask) rtw_hal_read_bbreg((Adapter), (RegAddr), (BitMask))

247 #define PHY_SetBBReg(Adapter, RegAddr, BitMask, Data) rtw_hal_write_bbreg((Adapter), (RegAddr), (BitMask), (Data))

248 #define PHY_QueryRFReg(Adapter, eRFPath, RegAddr, BitMask) rtw_hal_read_rfreg((Adapter), (eRFPath), (RegAddr), (BitMask))

249 #define PHY_SetRFReg(Adapter, eRFPath, RegAddr, BitMask, Data) rtw_hal_write_rfreg((Adapter), (eRFPath), (RegAddr), (BitMask), (Data))

250

251 #define PHY_SetMacReg PHY_SetBBReg

252 #define PHY_QueryMacReg PHY_QueryBBReg

253

254 void rtw_hal_set_chan(struct adapter *padapter, u8 channel);

255 void rtw_hal_set_chnl_bw(struct adapter *padapter, u8 channel, enum channel_width Bandwidth, u8 Offset40, u8 Offset80);

256 void rtw_hal_dm_watchdog(struct adapter *padapter);

257 void rtw_hal_dm_watchdog_in_lps(struct adapter *padapter);

258

259 s32 rtw_hal_xmit_thread_handler(struct adapter *padapter);

260

261 void rtw_hal_notch_filter(struct adapter *adapter, bool enable);

262 void rtw_hal_reset_security_engine(struct adapter *adapter);

263

264 bool rtw_hal_c2h_valid(struct adapter *adapter, u8 *buf);

265 s32 rtw_hal_c2h_handler(struct adapter *adapter, u8 *c2h_evt);

266 c2h_id_filter rtw_hal_c2h_id_filter_ccx(struct adapter *adapter);

267

268 s32 rtw_hal_macid_sleep(struct adapter *padapter, u32 macid);

269 s32 rtw_hal_macid_wakeup(struct adapter *padapter, u32 macid);

270

271 s32 rtw_hal_fill_h2c_cmd(struct adapter *, u8 ElementID, u32 CmdLen, u8 *pCmdBuffer);

272

273 void SetHwReg8723BS(struct adapter *padapter, u8 variable, u8 *val);

274 void GetHwReg8723BS(struct adapter *padapter, u8 variable, u8 *val);

275 void SetHwRegWithBuf8723B(struct adapter *padapter, u8 variable, u8 *pbuf, int len);

276 u8 GetHalDefVar8723BSDIO(struct adapter *Adapter, enum hal_def_variable eVariable, void *pValue);

277 u8 SetHalDefVar8723BSDIO(struct adapter *Adapter, enum hal_def_variable eVariable, void *pValue);

278 void UpdateHalRAMask8723B(struct adapter *padapter, u32 mac_id, u8 rssi_level);

279 void rtl8723b_SetBeaconRelatedRegisters(struct adapter *padapter);

280 void Hal_EfusePowerSwitch(struct adapter *padapter, u8 bWrite, u8 PwrState);

281 void Hal_ReadEFuse(struct adapter *padapter, u8 efuseType, u16 _offset,

282 u16 _size_byte, u8 *pbuf, bool bPseudoTest);

283 void Hal_GetEfuseDefinition(struct adapter *padapter, u8 efuseType, u8 type,

284 void *pOut, bool bPseudoTest);

285 u16 Hal_EfuseGetCurrentSize(struct adapter *padapter, u8 efuseType, bool bPseudoTest);

286 #endif /* __HAL_INTF_H__ */