xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/rockchip_wlan/rtl8189es/include/rtl8192e_cmd.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /******************************************************************************
2  *
3  * Copyright(c) 2007 - 2011 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 __RTL8192E_CMD_H__
21 #define __RTL8192E_CMD_H__
22 
23 typedef enum _RTL8192E_H2C_CMD
24 {
25 	H2C_8192E_RSVDPAGE	= 0x00,
26 	H2C_8192E_MSRRPT	= 0x01,
27 	H2C_8192E_SCAN		= 0x02,
28 	H2C_8192E_KEEP_ALIVE_CTRL = 0x03,
29 	H2C_8192E_DISCONNECT_DECISION = 0x04,
30 	H2C_8192E_INIT_OFFLOAD = 0x06,
31 	H2C_8192E_AP_OFFLOAD = 0x08,
32 	H2C_8192E_BCN_RSVDPAGE = 0x09,
33 	H2C_8192E_PROBERSP_RSVDPAGE = 0x0a,
34 
35 	H2C_8192E_AP_WOW_GPIO_CTRL = 0x13,
36 
37 	H2C_8192E_SETPWRMODE = 0x20,
38 	H2C_8192E_PS_TUNING_PARA = 0x21,
39 	H2C_8192E_PS_TUNING_PARA2 = 0x22,
40 	H2C_8192E_PS_LPS_PARA = 0x23,
41 	H2C_8192E_P2P_PS_OFFLOAD = 0x24,
42 	H2C_8192E_SAP_PS = 0x26,
43 	H2C_8192E_RA_MASK = 0x40,
44 	H2C_8192E_RSSI_REPORT = 0x42,
45 	H2C_8192E_RA_PARA_ADJUST = 0x46,
46 
47 	H2C_8192E_WO_WLAN = 0x80,
48 	H2C_8192E_REMOTE_WAKE_CTRL = 0x81,
49 	H2C_8192E_AOAC_GLOBAL_INFO = 0x82,
50 	H2C_8192E_AOAC_RSVDPAGE = 0x83,
51 
52 	//Not defined in new 88E H2C CMD Format
53 	H2C_8192E_SELECTIVE_SUSPEND_ROF_CMD,
54 	H2C_8192E_P2P_PS_MODE,
55 	H2C_8192E_PSD_RESULT,
56 	MAX_8192E_H2CCMD
57 }RTL8192E_H2C_CMD;
58 
59 typedef enum _RTL8192E_C2H_EVT
60 {
61 	C2H_8192E_DBG = 0,
62 	C2H_8192E_LB = 1,
63 	C2H_8192E_TXBF = 2,
64 	C2H_8192E_TX_REPORT = 3,
65 	C2H_8192E_BT_INFO = 9,
66 	C2H_8192E_FW_SWCHNL = 0x10,
67 	C2H_8192E_BT_MP = 11,
68 	C2H_8192E_RA_RPT = 12,
69 	C2H_8192E_RA_PARA_RPT = 14,
70 	C2H_8192E_EXTEND = 0xff,
71 	MAX_8192E_C2HEVENT
72 }RTL8192E_C2H_EVT;
73 
74 typedef enum _RTL8192E_EXTEND_C2H_EVT {
75 	EXTEND_C2H_8192E_DBG_PRINT = 0
76 
77 } RTL8192E_EXTEND_C2H_EVT;
78 
79 struct cmd_msg_parm {
80 	u8 eid; //element id
81 	u8 sz; // sz
82 	u8 buf[6];
83 };
84 
85 enum{
86 	PWRS
87 };
88 
89 typedef struct _SETPWRMODE_PARM {
90 	u8 Mode;//0:Active,1:LPS,2:WMMPS
91 	//u8 RLBM:4;//0:Min,1:Max,2: User define
92 	u8 SmartPS_RLBM;//LPS=0:PS_Poll,1:PS_Poll,2:NullData,WMM=0:PS_Poll,1:NullData
93 	u8 AwakeInterval;	// unit: beacon interval
94 	u8 bAllQueueUAPSD;
95 	u8 PwrState;//AllON(0x0c),RFON(0x04),RFOFF(0x00)
96 } SETPWRMODE_PARM, *PSETPWRMODE_PARM;
97 
98 struct H2C_SS_RFOFF_PARAM{
99 	u8 ROFOn; // 1: on, 0:off
100 	u16 gpio_period; // unit: 1024 us
101 }__attribute__ ((packed));
102 
103 
104 typedef struct JOINBSSRPT_PARM_92E{
105 	u8 OpMode;	// RT_MEDIA_STATUS
106 #ifdef CONFIG_WOWLAN
107 	u8 MacID;       // MACID
108 #endif //CONFIG_WOWLAN
109 }JOINBSSRPT_PARM_92E, *PJOINBSSRPT_PARM_92E;
110 
111 /* move to hal_com_h2c.h
112 typedef struct _RSVDPAGE_LOC_92E {
113 	u8 LocProbeRsp;
114 	u8 LocPsPoll;
115 	u8 LocNullData;
116 	u8 LocQosNull;
117 	u8 LocBTQosNull;
118 } RSVDPAGE_LOC_92E, *PRSVDPAGE_LOC_92E;
119 */
120 
121 
122 //_SETPWRMODE_PARM
123 #define SET_8192E_H2CCMD_PWRMODE_PARM_MODE(__pH2CCmd, __Value)				SET_BITS_TO_LE_1BYTE_8BIT(__pH2CCmd, 0, 8, __Value)
124 #define SET_8192E_H2CCMD_PWRMODE_PARM_RLBM(__pH2CCmd, __Value)				SET_BITS_TO_LE_1BYTE((__pH2CCmd)+1, 0, 4, __Value)
125 #define SET_8192E_H2CCMD_PWRMODE_PARM_SMART_PS(__pH2CCmd, __Value)			SET_BITS_TO_LE_1BYTE((__pH2CCmd)+1, 4, 4, __Value)
126 #define SET_8192E_H2CCMD_PWRMODE_PARM_BCN_PASS_TIME(__pH2CCmd, __Value)		SET_BITS_TO_LE_1BYTE_8BIT((__pH2CCmd)+2, 0, 8, __Value)
127 #define SET_8192E_H2CCMD_PWRMODE_PARM_ALL_QUEUE_UAPSD(__pH2CCmd, __Value)	SET_BITS_TO_LE_1BYTE_8BIT((__pH2CCmd)+3, 0, 8, __Value)
128 #define SET_8192E_H2CCMD_PWRMODE_PARM_PWR_STATE(__pH2CCmd, __Value)			SET_BITS_TO_LE_1BYTE_8BIT((__pH2CCmd)+4, 0, 8, __Value)
129 #define SET_8192E_H2CCMD_PWRMODE_PARM_BYTE5(__pH2CCmd, __Value)				SET_BITS_TO_LE_1BYTE_8BIT((__pH2CCmd)+5, 0, 8, __Value)
130 #define GET_8192E_H2CCMD_PWRMODE_PARM_MODE(__pH2CCmd)						LE_BITS_TO_1BYTE(__pH2CCmd, 0, 8)
131 
132 //_P2P_PS_OFFLOAD
133 #define SET_8192E_H2CCMD_P2P_PS_OFFLOAD_ENABLE(__pH2CCmd, __Value)			SET_BITS_TO_LE_1BYTE(__pH2CCmd, 0, 1, __Value)
134 #define SET_8192E_H2CCMD_P2P_PS_OFFLOAD_ROLE(__pH2CCmd, __Value)				SET_BITS_TO_LE_1BYTE(__pH2CCmd, 1, 1, __Value)
135 #define SET_8192E_H2CCMD_P2P_PS_OFFLOAD_CTWINDOW_EN(__pH2CCmd, __Value)		SET_BITS_TO_LE_1BYTE(__pH2CCmd, 2, 1, __Value)
136 #define SET_8192E_H2CCMD_P2P_PS_OFFLOAD_NOA0_EN(__pH2CCmd, __Value)			SET_BITS_TO_LE_1BYTE(__pH2CCmd, 3, 1, __Value)
137 #define SET_8192E_H2CCMD_P2P_PS_OFFLOAD_NOA1_EN(__pH2CCmd, __Value)			SET_BITS_TO_LE_1BYTE(__pH2CCmd, 4, 1, __Value)
138 #define SET_8192E_H2CCMD_P2P_PS_OFFLOAD_ALLSTASLEEP(__pH2CCmd, __Value)		SET_BITS_TO_LE_1BYTE(__pH2CCmd, 5, 1, __Value)
139 
140 
141 // host message to firmware cmd
142 void rtl8192e_set_FwPwrMode_cmd(PADAPTER padapter, u8 Mode);
143 void rtl8192e_set_FwJoinBssReport_cmd(PADAPTER padapter, u8 mstatus);
144 u8 rtl8192e_set_rssi_cmd(PADAPTER padapter, u8 *param);
145 void rtl8192e_set_raid_cmd(PADAPTER padapter, u32 bitmap, u8* arg);
146 void rtl8192e_Add_RateATid(PADAPTER padapter, u64 rate_bitmap, u8 *arg, u8 rssi_level);
147 s32 FillH2CCmd_8192E(PADAPTER padapter, u8 ElementID, u32 CmdLen, u8 *pCmdBuffer);
148 u8 GetTxBufferRsvdPageNum8192E(_adapter *padapter, bool wowlan);
149 //u8 rtl8192c_set_FwSelectSuspend_cmd(PADAPTER padapter, u8 bfwpoll, u16 period);
150 s32 c2h_handler_8192e(PADAPTER padapter, u8 *buf);
151 #ifdef CONFIG_BT_COEXIST
152 void rtl8192e_download_BTCoex_AP_mode_rsvd_page(PADAPTER padapter);
153 #endif // CONFIG_BT_COEXIST
154 #ifdef CONFIG_P2P_PS
155 void rtl8192e_set_p2p_ps_offload_cmd(PADAPTER padapter, u8 p2p_ps_state);
156 #endif //CONFIG_P2P
157 
158 void CheckFwRsvdPageContent(PADAPTER padapter);
159 void rtl8192e_set_FwMediaStatus_cmd(PADAPTER padapter, u16 mstatus_rpt );
160 
161 #ifdef CONFIG_TSF_RESET_OFFLOAD
162 int reset_tsf(PADAPTER Adapter, u8 reset_port );
163 #endif	// CONFIG_TSF_RESET_OFFLOAD
164 
165 
166 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN)
167 void SetFwRelatedForWoWLAN8192E(_adapter* padapter, u8 bHostIsGoingtoSleep);
168 #endif
169 /// TX Feedback Content
170 #define 	USEC_UNIT_FOR_8192E_C2H_TX_RPT_QUEUE_TIME			256
171 
172 #define	GET_8192E_C2H_TX_RPT_QUEUE_SELECT(_Header)			LE_BITS_TO_1BYTE((_Header + 0), 0, 5)
173 #define	GET_8192E_C2H_TX_RPT_PKT_BROCAST(_Header)			LE_BITS_TO_1BYTE((_Header + 0), 5, 1)
174 #define	GET_8192E_C2H_TX_RPT_LIFE_TIME_OVER(_Header)			LE_BITS_TO_1BYTE((_Header + 0), 6, 1)
175 #define	GET_8192E_C2H_TX_RPT_RETRY_OVER(_Header)				LE_BITS_TO_1BYTE((_Header + 0), 7, 1)
176 #define	GET_8192E_C2H_TX_RPT_MAC_ID(_Header)					LE_BITS_TO_1BYTE((_Header + 1), 0, 8)
177 #define	GET_8192E_C2H_TX_RPT_DATA_RETRY_CNT(_Header)		LE_BITS_TO_1BYTE((_Header + 2), 0, 6)
178 #define	GET_8192E_C2H_TX_RPT_QUEUE_TIME(_Header)				LE_BITS_TO_2BYTE((_Header + 3), 0, 16)	// In unit of 256 microseconds.
179 #define	GET_8192E_C2H_TX_RPT_FINAL_DATA_RATE(_Header)		LE_BITS_TO_1BYTE((_Header + 5), 0, 8)
180 
181 
182 
183 void C2HContentParsing8192E(
184 	IN	PADAPTER		Adapter,
185 	IN	u1Byte			c2hCmdId,
186 	IN	u1Byte			c2hCmdLen,
187 	IN	pu1Byte 			tmpBuf
188 );
189 VOID
190 C2HPacketHandler_8192E(
191 	IN	PADAPTER		Adapter,
192 	IN	pu1Byte			Buffer,
193 	IN	u1Byte			Length
194 );
195 
196 #endif//__RTL8192E_CMD_H__