OSDN Git Service

rtl8723au: Remove typedef for _pkt and replace with correct struct
[android-x86/external-modules-rtl8723au.git] / include / hal_intf.h
1 /******************************************************************************
2  *
3  * Copyright(c) 2007 - 2012 Realtek Corporation. All rights reserved.
4  *
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.
8  *
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
12  * more details.
13  *
14  * You should have received a copy of the GNU General Public License along with
15  * this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
17  *
18  *
19  ******************************************************************************/
20 #ifndef __HAL_INTF_H__
21 #define __HAL_INTF_H__
22
23 #include <drv_conf.h>
24 #include <osdep_service.h>
25 #include <drv_types.h>
26
27 enum RTL871X_HCI_TYPE {
28         RTW_PCIE        = BIT0,
29         RTW_USB         = BIT1,
30         RTW_SDIO        = BIT2,
31         RTW_GSPI        = BIT3,
32 };
33
34 enum _CHIP_TYPE {
35
36         NULL_CHIP_TYPE,
37         RTL8712_8188S_8191S_8192S,
38         RTL8188C_8192C,
39         RTL8192D,
40         RTL8723A,
41         RTL8188E,
42         MAX_CHIP_TYPE
43 };
44
45
46 typedef enum _HW_VARIABLES{
47         HW_VAR_MEDIA_STATUS,
48         HW_VAR_MEDIA_STATUS1,
49         HW_VAR_SET_OPMODE,
50         HW_VAR_MAC_ADDR,
51         HW_VAR_BSSID,
52         HW_VAR_INIT_RTS_RATE,
53         HW_VAR_BASIC_RATE,
54         HW_VAR_TXPAUSE,
55         HW_VAR_BCN_FUNC,
56         HW_VAR_CORRECT_TSF,
57         HW_VAR_CHECK_BSSID,
58         HW_VAR_MLME_DISCONNECT,
59         HW_VAR_MLME_SITESURVEY,
60         HW_VAR_MLME_JOIN,
61         HW_VAR_ON_RCR_AM,
62        HW_VAR_OFF_RCR_AM,
63         HW_VAR_BEACON_INTERVAL,
64         HW_VAR_SLOT_TIME,
65         HW_VAR_RESP_SIFS,
66         HW_VAR_ACK_PREAMBLE,
67         HW_VAR_SEC_CFG,
68         HW_VAR_BCN_VALID,
69         HW_VAR_RF_TYPE,
70         HW_VAR_DM_FLAG,
71         HW_VAR_DM_FUNC_OP,
72         HW_VAR_DM_FUNC_SET,
73         HW_VAR_DM_FUNC_CLR,
74         HW_VAR_CAM_EMPTY_ENTRY,
75         HW_VAR_CAM_INVALID_ALL,
76         HW_VAR_CAM_WRITE,
77         HW_VAR_CAM_READ,
78         HW_VAR_AC_PARAM_VO,
79         HW_VAR_AC_PARAM_VI,
80         HW_VAR_AC_PARAM_BE,
81         HW_VAR_AC_PARAM_BK,
82         HW_VAR_ACM_CTRL,
83         HW_VAR_AMPDU_MIN_SPACE,
84         HW_VAR_AMPDU_FACTOR,
85         HW_VAR_RXDMA_AGG_PG_TH,
86         HW_VAR_SET_RPWM,
87         HW_VAR_H2C_FW_PWRMODE,
88         HW_VAR_H2C_FW_JOINBSSRPT,
89         HW_VAR_FWLPS_RF_ON,
90         HW_VAR_H2C_FW_P2P_PS_OFFLOAD,
91         HW_VAR_TDLS_WRCR,
92         HW_VAR_TDLS_INIT_CH_SEN,
93         HW_VAR_TDLS_RS_RCR,
94         HW_VAR_TDLS_DONE_CH_SEN,
95         HW_VAR_INITIAL_GAIN,
96         HW_VAR_TRIGGER_GPIO_0,
97         HW_VAR_BT_SET_COEXIST,
98         HW_VAR_BT_ISSUE_DELBA,
99         HW_VAR_CURRENT_ANTENNA,
100         HW_VAR_ANTENNA_DIVERSITY_LINK,
101         HW_VAR_ANTENNA_DIVERSITY_SELECT,
102         HW_VAR_SWITCH_EPHY_WoWLAN,
103         HW_VAR_EFUSE_USAGE,
104         HW_VAR_EFUSE_BYTES,
105         HW_VAR_EFUSE_BT_USAGE,
106         HW_VAR_EFUSE_BT_BYTES,
107         HW_VAR_FIFO_CLEARN_UP,
108         HW_VAR_CHECK_TXBUF,
109         HW_VAR_APFM_ON_MAC, //Auto FSM to Turn On, include clock, isolation, power control for MAC only
110         // 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.
111         // Unit in microsecond. 0 means disable this function.
112 #ifdef CONFIG_WOWLAN
113         HW_VAR_WOWLAN,
114 #endif
115         HW_VAR_NAV_UPPER,
116         HW_VAR_RPT_TIMER_SETTING,
117         HW_VAR_TX_RPT_MAX_MACID,
118         HW_VAR_H2C_MEDIA_STATUS_RPT,
119         HW_VAR_CHK_HI_QUEUE_EMPTY,
120         HW_VAR_READ_LLT_TAB,
121 }HW_VARIABLES;
122
123 typedef enum _HAL_DEF_VARIABLE{
124         HAL_DEF_UNDERCORATEDSMOOTHEDPWDB,
125         HAL_DEF_IS_SUPPORT_ANT_DIV,
126         HAL_DEF_CURRENT_ANTENNA,
127         HAL_DEF_DRVINFO_SZ,
128         HAL_DEF_MAX_RECVBUF_SZ,
129         HAL_DEF_RX_PACKET_OFFSET,
130         HAL_DEF_DBG_DUMP_RXPKT,//for dbg
131         HAL_DEF_DBG_DM_FUNC,//for dbg
132         HAL_DEF_RA_DECISION_RATE,
133         HAL_DEF_RA_SGI,
134         HAL_DEF_PT_PWR_STATUS,
135         HW_VAR_MAX_RX_AMPDU_FACTOR,
136         HW_DEF_RA_INFO_DUMP,
137         HAL_DEF_DBG_DUMP_TXPKT,
138         HW_DEF_FA_CNT_DUMP,
139         HW_DEF_ODM_DBG_FLAG,
140 }HAL_DEF_VARIABLE;
141
142 typedef enum _HAL_ODM_VARIABLE{
143         HAL_ODM_STA_INFO,
144         HAL_ODM_P2P_STATE,
145         HAL_ODM_WIFI_DISPLAY_STATE,
146 }HAL_ODM_VARIABLE;
147
148 typedef enum _HAL_INTF_PS_FUNC{
149         HAL_USB_SELECT_SUSPEND,
150         HAL_MAX_ID,
151 }HAL_INTF_PS_FUNC;
152
153 typedef s32 (*c2h_id_filter)(u8 id);
154
155 struct hal_ops {
156         u32     (*hal_power_on)(_adapter *padapter);
157         u32     (*hal_init)(_adapter *padapter);
158         u32     (*hal_deinit)(_adapter *padapter);
159
160         void    (*free_hal_data)(_adapter *padapter);
161
162         u32     (*inirp_init)(_adapter *padapter);
163         u32     (*inirp_deinit)(_adapter *padapter);
164
165         s32     (*init_xmit_priv)(_adapter *padapter);
166         void    (*free_xmit_priv)(_adapter *padapter);
167
168         s32     (*init_recv_priv)(_adapter *padapter);
169         void    (*free_recv_priv)(_adapter *padapter);
170
171         void    (*InitSwLeds)(_adapter *padapter);
172         void    (*DeInitSwLeds)(_adapter *padapter);
173
174         void    (*dm_init)(_adapter *padapter);
175         void    (*dm_deinit)(_adapter *padapter);
176         void    (*read_chip_version)(_adapter *padapter);
177
178         void    (*init_default_value)(_adapter *padapter);
179
180         void    (*intf_chip_configure)(_adapter *padapter);
181
182         void    (*read_adapter_info)(_adapter *padapter);
183
184         void    (*enable_interrupt)(_adapter *padapter);
185         void    (*disable_interrupt)(_adapter *padapter);
186         s32     (*interrupt_handler)(_adapter *padapter);
187 #ifdef CONFIG_WOWLAN
188     void    (*clear_interrupt)(_adapter *padapter);
189 #endif
190         void    (*set_bwmode_handler)(_adapter *padapter, HT_CHANNEL_WIDTH Bandwidth, u8 Offset);
191         void    (*set_channel_handler)(_adapter *padapter, u8 channel);
192
193         void    (*hal_dm_watchdog)(_adapter *padapter);
194
195         void    (*SetHwRegHandler)(_adapter *padapter, u8       variable,u8* val);
196         void    (*GetHwRegHandler)(_adapter *padapter, u8       variable,u8* val);
197
198         u8      (*GetHalDefVarHandler)(_adapter *padapter, HAL_DEF_VARIABLE eVariable, void * pValue);
199         u8      (*SetHalDefVarHandler)(_adapter *padapter, HAL_DEF_VARIABLE eVariable, void * pValue);
200
201         void    (*GetHalODMVarHandler)(_adapter *padapter, HAL_ODM_VARIABLE eVariable, void * pValue1,bool bSet);
202         void    (*SetHalODMVarHandler)(_adapter *padapter, HAL_ODM_VARIABLE eVariable, void * pValue1,bool bSet);
203
204         void    (*UpdateRAMaskHandler)(_adapter *padapter, u32 mac_id, u8 rssi_level);
205         void    (*SetBeaconRelatedRegistersHandler)(_adapter *padapter);
206
207         void    (*Add_RateATid)(_adapter *padapter, u32 bitmap, u8 arg, u8 rssi_level);
208 #ifdef CONFIG_CONCURRENT_MODE
209         void    (*clone_haldata)(_adapter *dst_padapter, _adapter *src_padapter);
210 #endif
211         void    (*run_thread)(_adapter *padapter);
212         void    (*cancel_thread)(_adapter *padapter);
213
214 #ifdef CONFIG_ANTENNA_DIVERSITY
215         u8      (*AntDivBeforeLinkHandler)(_adapter *padapter);
216         void    (*AntDivCompareHandler)(_adapter *padapter, WLAN_BSSID_EX *dst, WLAN_BSSID_EX *src);
217 #endif
218         u8      (*interface_ps_func)(_adapter *padapter,HAL_INTF_PS_FUNC efunc_id, u8* val);
219
220         s32     (*hal_xmit)(_adapter *padapter, struct xmit_frame *pxmitframe);
221         s32 (*mgnt_xmit)(_adapter *padapter, struct xmit_frame *pmgntframe);
222         s32     (*hal_xmitframe_enqueue)(_adapter *padapter, struct xmit_frame *pxmitframe);
223
224         u32     (*read_bbreg)(_adapter *padapter, u32 RegAddr, u32 BitMask);
225         void    (*write_bbreg)(_adapter *padapter, u32 RegAddr, u32 BitMask, u32 Data);
226         u32     (*read_rfreg)(_adapter *padapter, u32 eRFPath, u32 RegAddr, u32 BitMask);
227         void    (*write_rfreg)(_adapter *padapter, u32 eRFPath, u32 RegAddr, u32 BitMask, u32 Data);
228
229 #ifdef CONFIG_HOSTAPD_MLME
230         s32     (*hostap_mgnt_xmit_entry)(_adapter *padapter, struct sk_buff *pkt);
231 #endif
232
233         void (*EfusePowerSwitch)(_adapter *padapter, u8 bWrite, u8 PwrState);
234         void (*ReadEFuse)(_adapter *padapter, u8 efuseType, u16 _offset, u16 _size_byte, u8 *pbuf, bool bPseudoTest);
235         void (*EFUSEGetEfuseDefinition)(_adapter *padapter, u8 efuseType, u8 type, void *pOut, bool bPseudoTest);
236         u16     (*EfuseGetCurrentSize)(_adapter *padapter, u8 efuseType, bool bPseudoTest);
237         int     (*Efuse_PgPacketRead)(_adapter *padapter, u8 offset, u8 *data, bool bPseudoTest);
238         int     (*Efuse_PgPacketWrite)(_adapter *padapter, u8 offset, u8 word_en, u8 *data, bool bPseudoTest);
239         u8      (*Efuse_WordEnableDataWrite)(_adapter *padapter, u16 efuse_addr, u8 word_en, u8 *data, bool bPseudoTest);
240         bool    (*Efuse_PgPacketWrite_BT)(_adapter *padapter, u8 offset, u8 word_en, u8 *data, bool bPseudoTest);
241
242 #ifdef DBG_CONFIG_ERROR_DETECT
243         void (*sreset_init_value)(_adapter *padapter);
244         void (*sreset_reset_value)(_adapter *padapter);
245         void (*silentreset)(_adapter *padapter);
246         void (*sreset_xmit_status_check)(_adapter *padapter);
247         void (*sreset_linked_status_check) (_adapter *padapter);
248         u8 (*sreset_get_wifi_status)(_adapter *padapter);
249         bool (*sreset_inprogress)(_adapter *padapter);
250 #endif
251
252 #ifdef CONFIG_IOL
253         int (*IOL_exec_cmds_sync)(_adapter *padapter, struct xmit_frame *xmit_frame, u32 max_wating_ms, u32 bndy_cnt);
254 #endif
255
256 #ifdef CONFIG_XMIT_THREAD_MODE
257         s32 (*xmit_thread_handler)(_adapter *padapter);
258 #endif
259         void (*hal_notch_filter)(_adapter * adapter, bool enable);
260         void (*hal_reset_security_engine)(_adapter * adapter);
261         s32 (*c2h_handler)(_adapter *padapter, struct c2h_evt_hdr *c2h_evt);
262         c2h_id_filter c2h_id_filter_ccx;
263 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST)
264         void (*hal_init_checkbthang_workqueue)(_adapter * padapter);
265         void (*hal_free_checkbthang_workqueue)(_adapter * padapter);
266         void (*hal_cancel_checkbthang_workqueue)(_adapter * padapter);
267         void (*hal_checke_bt_hang)(_adapter * padapter);
268 #endif
269 };
270
271 typedef enum _RT_EEPROM_TYPE{
272         EEPROM_93C46,
273         EEPROM_93C56,
274         EEPROM_BOOT_EFUSE,
275 }RT_EEPROM_TYPE,*PRT_EEPROM_TYPE;
276
277
278
279 #define RF_CHANGE_BY_INIT       0
280 #define RF_CHANGE_BY_IPS        BIT28
281 #define RF_CHANGE_BY_PS         BIT29
282 #define RF_CHANGE_BY_HW         BIT30
283 #define RF_CHANGE_BY_SW         BIT31
284
285 typedef enum _HARDWARE_TYPE{
286         HARDWARE_TYPE_RTL8180,
287         HARDWARE_TYPE_RTL8185,
288         HARDWARE_TYPE_RTL8187,
289         HARDWARE_TYPE_RTL8188,
290         HARDWARE_TYPE_RTL8190P,
291         HARDWARE_TYPE_RTL8192E,
292         HARDWARE_TYPE_RTL819xU,
293         HARDWARE_TYPE_RTL8192SE,
294         HARDWARE_TYPE_RTL8192SU,
295         HARDWARE_TYPE_RTL8192CE,
296         HARDWARE_TYPE_RTL8192CU,
297         HARDWARE_TYPE_RTL8192DE,
298         HARDWARE_TYPE_RTL8192DU,
299         HARDWARE_TYPE_RTL8723AE,
300         HARDWARE_TYPE_RTL8723AU,
301         HARDWARE_TYPE_RTL8723AS,
302         HARDWARE_TYPE_RTL8188EE,
303         HARDWARE_TYPE_RTL8188EU,
304         HARDWARE_TYPE_RTL8188ES,
305         HARDWARE_TYPE_MAX,
306 }HARDWARE_TYPE;
307
308 typedef struct eeprom_priv EEPROM_EFUSE_PRIV, *PEEPROM_EFUSE_PRIV;
309 #define GET_EEPROM_EFUSE_PRIV(adapter) (&adapter->eeprompriv)
310 #define is_boot_from_eeprom(adapter) (adapter->eeprompriv.EepromOrEfuse)
311
312 #ifdef CONFIG_WOWLAN
313 typedef enum _wowlan_subcode{
314         WOWLAN_PATTERN_MATCH    = 1,
315         WOWLAN_MAGIC_PACKET             = 2,
316         WOWLAN_UNICAST                  = 3,
317         WOWLAN_SET_PATTERN              = 4,
318         WOWLAN_DUMP_REG                 = 5,
319         WOWLAN_ENABLE                   = 6,
320         WOWLAN_DISABLE                  = 7,
321         WOWLAN_STATUS                   = 8,
322         WOWLAN_DEBUG_RELOAD_FW  = 9,
323         WOWLAN_DEBUG_1                  =10,
324         WOWLAN_DEBUG_2                  =11
325 }wowlan_subcode;
326
327 struct wowlan_ioctl_param{
328         unsigned int subcode;
329         unsigned int subcode_value;
330         unsigned int wakeup_reason;
331         unsigned int len;
332         unsigned char pattern[0];
333 };
334
335 #define Rx_Pairwisekey                  0x01
336 #define Rx_GTK                                  0x02
337 #define Rx_DisAssoc                             0x04
338 #define Rx_DeAuth                               0x08
339 #define FWDecisionDisconnect    0x10
340 #define Rx_MagicPkt                             0x21
341 #define Rx_UnicastPkt                   0x22
342 #define Rx_PatternPkt                   0x23
343 #endif // CONFIG_WOWLAN
344
345 void rtw_hal_def_value_init(_adapter *padapter);
346
347 void    rtw_hal_free_data(_adapter *padapter);
348
349 void rtw_hal_dm_init(_adapter *padapter);
350 void rtw_hal_dm_deinit(_adapter *padapter);
351 void rtw_hal_sw_led_init(_adapter *padapter);
352 void rtw_hal_sw_led_deinit(_adapter *padapter);
353
354 u32 rtw_hal_power_on(_adapter *padapter);
355 uint rtw_hal_init(_adapter *padapter);
356 uint rtw_hal_deinit(_adapter *padapter);
357 void rtw_hal_stop(_adapter *padapter);
358 void rtw_hal_set_hwreg(PADAPTER padapter, u8 variable, u8 *val);
359 void rtw_hal_get_hwreg(PADAPTER padapter, u8 variable, u8 *val);
360
361 void rtw_hal_chip_configure(_adapter *padapter);
362 void rtw_hal_read_chip_info(_adapter *padapter);
363 void rtw_hal_read_chip_version(_adapter *padapter);
364
365 u8 rtw_hal_set_def_var(_adapter *padapter, HAL_DEF_VARIABLE eVariable, void * pValue);
366 u8 rtw_hal_get_def_var(_adapter *padapter, HAL_DEF_VARIABLE eVariable, void * pValue);
367
368 void rtw_hal_set_odm_var(_adapter *padapter, HAL_ODM_VARIABLE eVariable, void * pValue1,bool bSet);
369 void    rtw_hal_get_odm_var(_adapter *padapter, HAL_ODM_VARIABLE eVariable, void * pValue1,bool bSet);
370
371 void rtw_hal_enable_interrupt(_adapter *padapter);
372 void rtw_hal_disable_interrupt(_adapter *padapter);
373
374 u32     rtw_hal_inirp_init(_adapter *padapter);
375 u32     rtw_hal_inirp_deinit(_adapter *padapter);
376
377 u8      rtw_hal_intf_ps_func(_adapter *padapter,HAL_INTF_PS_FUNC efunc_id, u8* val);
378
379 s32     rtw_hal_xmitframe_enqueue(_adapter *padapter, struct xmit_frame *pxmitframe);
380 s32     rtw_hal_xmit(_adapter *padapter, struct xmit_frame *pxmitframe);
381 s32     rtw_hal_mgnt_xmit(_adapter *padapter, struct xmit_frame *pmgntframe);
382
383 s32     rtw_hal_init_xmit_priv(_adapter *padapter);
384 void    rtw_hal_free_xmit_priv(_adapter *padapter);
385
386 s32     rtw_hal_init_recv_priv(_adapter *padapter);
387 void    rtw_hal_free_recv_priv(_adapter *padapter);
388
389 void rtw_hal_update_ra_mask(struct sta_info *psta, u8 rssi_level);
390 void    rtw_hal_add_ra_tid(_adapter *padapter, u32 bitmap, u8 arg, u8 rssi_level);
391 void    rtw_hal_clone_data(_adapter *dst_padapter, _adapter *src_padapter);
392 void    rtw_hal_start_thread(_adapter *padapter);
393 void    rtw_hal_stop_thread(_adapter *padapter);
394
395 void rtw_hal_bcn_related_reg_setting(_adapter *padapter);
396
397 u32     rtw_hal_read_bbreg(_adapter *padapter, u32 RegAddr, u32 BitMask);
398 void    rtw_hal_write_bbreg(_adapter *padapter, u32 RegAddr, u32 BitMask, u32 Data);
399 u32     rtw_hal_read_rfreg(_adapter *padapter, u32 eRFPath, u32 RegAddr, u32 BitMask);
400 void    rtw_hal_write_rfreg(_adapter *padapter, u32 eRFPath, u32 RegAddr, u32 BitMask, u32 Data);
401
402 s32     rtw_hal_interrupt_handler(_adapter *padapter);
403
404 void    rtw_hal_set_bwmode(_adapter *padapter, HT_CHANNEL_WIDTH Bandwidth, u8 Offset);
405 void    rtw_hal_set_chan(_adapter *padapter, u8 channel);
406 void    rtw_hal_dm_watchdog(_adapter *padapter);
407
408 #ifdef CONFIG_ANTENNA_DIVERSITY
409 u8      rtw_hal_antdiv_before_linked(_adapter *padapter);
410 void    rtw_hal_antdiv_rssi_compared(_adapter *padapter, WLAN_BSSID_EX *dst, WLAN_BSSID_EX *src);
411 #endif
412
413 #ifdef CONFIG_HOSTAPD_MLME
414 s32     rtw_hal_hostap_mgnt_xmit_entry(_adapter *padapter, struct sk_buff *pkt);
415 #endif
416
417 #ifdef DBG_CONFIG_ERROR_DETECT
418 void rtw_hal_sreset_init(_adapter *padapter);
419 void rtw_hal_sreset_reset(_adapter *padapter);
420 void rtw_hal_sreset_reset_value(_adapter *padapter);
421 void rtw_hal_sreset_xmit_status_check(_adapter *padapter);
422 void rtw_hal_sreset_linked_status_check (_adapter *padapter);
423 u8   rtw_hal_sreset_get_wifi_status(_adapter *padapter);
424 bool rtw_hal_sreset_inprogress(_adapter *padapter);
425 #endif
426
427 #ifdef CONFIG_IOL
428 int rtw_hal_iol_cmd(ADAPTER *adapter, struct xmit_frame *xmit_frame, u32 max_wating_ms, u32 bndy_cnt);
429 #endif
430
431 #ifdef CONFIG_XMIT_THREAD_MODE
432 s32 rtw_hal_xmit_thread_handler(_adapter *padapter);
433 #endif
434
435 void rtw_hal_notch_filter(_adapter * adapter, bool enable);
436 void rtw_hal_reset_security_engine(_adapter * adapter);
437
438 s32 rtw_hal_c2h_handler(_adapter *adapter, struct c2h_evt_hdr *c2h_evt);
439 c2h_id_filter rtw_hal_c2h_id_filter_ccx(_adapter *adapter);
440
441 #endif //__HAL_INTF_H__