drivers/net/wireless/rtl8723au/include/rtl8188e_cmd.h

   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 __RTL8188E_CMD_H__
  21 #define __RTL8188E_CMD_H__
  22
  23 #if 0
  24 enum cmd_msg_element_id
  25 {
  26         NONE_CMDMSG_EID,
  27         AP_OFFLOAD_EID = 0,
  28         SET_PWRMODE_EID = 1,
  29         JOINBSS_RPT_EID = 2,
  30         RSVD_PAGE_EID = 3,
  31         RSSI_4_EID = 4,
  32         RSSI_SETTING_EID = 5,
  33         MACID_CONFIG_EID = 6,
  34         MACID_PS_MODE_EID = 7,
  35         P2P_PS_OFFLOAD_EID = 8,
  36         SELECTIVE_SUSPEND_ROF_CMD = 9,
  37         P2P_PS_CTW_CMD_EID = 32,
  38         MAX_CMDMSG_EID
  39 };
  40 #else
  41 typedef enum _RTL8188E_H2C_CMD_ID
  42 {
  43         //Class Common
  44         H2C_COM_RSVD_PAGE                       =0x00,
  45         H2C_COM_MEDIA_STATUS_RPT        =0x01,
  46         H2C_COM_SCAN                                    =0x02,
  47         H2C_COM_KEEP_ALIVE                      =0x03,
  48         H2C_COM_DISCNT_DECISION         =0x04,
  49 #ifndef CONFIG_WOWLAN
  50         H2C_COM_WWLAN                           =0x05,
  51 #endif
  52         H2C_COM_INIT_OFFLOAD                    =0x06,
  53         H2C_COM_REMOTE_WAKE_CTL =0x07,
  54         H2C_COM_AP_OFFLOAD                      =0x08,
  55         H2C_COM_BCN_RSVD_PAGE           =0x09,
  56         H2C_COM_PROB_RSP_RSVD_PAGE      =0x0A,
  57
  58         //Class PS
  59         H2C_PS_PWR_MODE                         =0x20,
  60         H2C_PS_TUNE_PARA                                =0x21,
  61         H2C_PS_TUNE_PARA_2                      =0x22,
  62         H2C_PS_LPS_PARA                         =0x23,
  63         H2C_PS_P2P_OFFLOAD                      =0x24,
  64
  65         //Class DM
  66         H2C_DM_MACID_CFG                                =0x40,
  67         H2C_DM_TXBF                                     =0x41,
  68
  69         //Class BT
  70         H2C_BT_COEX_MASK                                =0x60,
  71         H2C_BT_COEX_GPIO_MODE           =0x61,
  72         H2C_BT_DAC_SWING_VAL                    =0x62,
  73         H2C_BT_PSD_RST                          =0x63,
  74
  75         //Class Remote WakeUp
  76 #ifdef CONFIG_WOWLAN
  77         H2C_COM_WWLAN                           =0x80,
  78         H2C_COM_REMOTE_WAKE_CTRL        =0x81,
  79         H2C_COM_AOAC_GLOBAL_INFO        =0x82,
  80         H2C_COM_AOAC_RSVD_PAGE          =0x83,
  81 #endif
  82
  83         //Class
  84          H2C_RESET_TSF                          =0xc0,
  85 }RTL8188E_H2C_CMD_ID;
  86
  87 #endif
  88
  89
  90 struct cmd_msg_parm {
  91         u8 eid; //element id
  92         u8 sz; // sz
  93         u8 buf[6];
  94 };
  95
  96 enum{
  97         PWRS
  98 };
  99
 100 typedef struct _SETPWRMODE_PARM {
 101         u8 Mode;//0:Active,1:LPS,2:WMMPS
 102         //u8 RLBM:4;//0:Min,1:Max,2: User define
 103         u8 SmartPS_RLBM;//LPS=0:PS_Poll,1:PS_Poll,2:NullData,WMM=0:PS_Poll,1:NullData
 104         u8 AwakeInterval;       // unit: beacon interval
 105         u8 bAllQueueUAPSD;
 106         u8 PwrState;//AllON(0x0c),RFON(0x04),RFOFF(0x00)
 107 } SETPWRMODE_PARM, *PSETPWRMODE_PARM;
 108
 109 struct H2C_SS_RFOFF_PARAM{
 110         u8 ROFOn; // 1: on, 0:off
 111         u16 gpio_period; // unit: 1024 us
 112 }__attribute__ ((packed));
 113
 114
 115 typedef struct JOINBSSRPT_PARM{
 116         u8 OpMode;      // RT_MEDIA_STATUS
 117 #ifdef CONFIG_WOWLAN
 118         u8 MacID;       // MACID
 119 #endif //CONFIG_WOWLAN
 120 }JOINBSSRPT_PARM, *PJOINBSSRPT_PARM;
 121
 122 typedef struct _RSVDPAGE_LOC {
 123         u8 LocProbeRsp;
 124         u8 LocPsPoll;
 125         u8 LocNullData;
 126         u8 LocQosNull;
 127         u8 LocBTQosNull;
 128 #ifdef CONFIG_WOWLAN
 129         u8 LocRemoteCtrlInfo;
 130         u8 LocArpRsp;
 131         u8 LocNbrAdv;
 132         u8 LocGTKRsp;
 133         u8 LocGTKInfo;
 134         u8 LocProbeReq;
 135         u8 LocNetList;
 136 #endif //CONFIG_WOWLAN
 137 } RSVDPAGE_LOC, *PRSVDPAGE_LOC;
 138
 139 struct P2P_PS_Offload_t {
 140         u8 Offload_En:1;
 141         u8 role:1; // 1: Owner, 0: Client
 142         u8 CTWindow_En:1;
 143         u8 NoA0_En:1;
 144         u8 NoA1_En:1;
 145         u8 AllStaSleep:1; // Only valid in Owner
 146         u8 discovery:1;
 147         u8 rsvd:1;
 148 };
 149
 150 struct P2P_PS_CTWPeriod_t {
 151         u8 CTWPeriod;   //TU
 152 };
 153
 154
 155 // host message to firmware cmd
 156 void rtl8188e_set_FwPwrMode_cmd(PADAPTER padapter, u8 Mode);
 157 void rtl8188e_set_FwJoinBssReport_cmd(PADAPTER padapter, u8 mstatus);
 158 u8 rtl8188e_set_rssi_cmd(PADAPTER padapter, u8 *param);
 159 u8 rtl8188e_set_raid_cmd(PADAPTER padapter, u32 mask);
 160 void rtl8188e_Add_RateATid(PADAPTER padapter, u32 bitmap, u8 arg, u8 rssi_level);
 161 //u8 rtl8192c_set_FwSelectSuspend_cmd(PADAPTER padapter, u8 bfwpoll, u16 period);
 162
 163
 164 #ifdef CONFIG_P2P
 165 void rtl8188e_set_p2p_ps_offload_cmd(PADAPTER padapter, u8 p2p_ps_state);
 166 #endif //CONFIG_P2P
 167
 168 void CheckFwRsvdPageContent(PADAPTER padapter);
 169 void rtl8188e_set_FwMediaStatus_cmd(PADAPTER padapter, u16 mstatus_rpt );
 170
 171 #ifdef CONFIG_TSF_RESET_OFFLOAD
 172 //u8 rtl8188e_reset_tsf(_adapter *padapter, u8 reset_port);
 173 int reset_tsf(PADAPTER Adapter, u8 reset_port );
 174 #endif  // CONFIG_TSF_RESET_OFFLOAD
 175
 176 #define H2C_8188E_RSVDPAGE_LOC_LEN      5
 177 #define H2C_8188E_AOAC_RSVDPAGE_LOC_LEN 7
 178
 179 #ifdef CONFIG_WOWLAN
 180 typedef struct _SETWOWLAN_PARM{
 181         u8              mode;
 182         u8              gpio_index;
 183         u8              gpio_duration;
 184         u8              second_mode;
 185         u8              reserve;
 186 }SETWOWLAN_PARM, *PSETWOWLAN_PARM;
 187
 188 typedef struct _SETAOAC_GLOBAL_INFO{
 189         u8              pairwiseEncAlg;
 190         u8              groupEncAlg;
 191 }SETAOAC_GLOBAL_INFO, *PSETAOAC_GLOBAL_INFO;
 192
 193 #define eqMacAddr(a,b)          ( ((a)[0]==(b)[0] && (a)[1]==(b)[1] && (a)[2]==(b)[2] && (a)[3]==(b)[3] && (a)[4]==(b)[4] && (a)[5]==(b)[5]) ? 1:0 )
 194 #define cpMacAddr(des,src)      ((des)[0]=(src)[0],(des)[1]=(src)[1],(des)[2]=(src)[2],(des)[3]=(src)[3],(des)[4]=(src)[4],(des)[5]=(src)[5])
 195 #define cpIpAddr(des,src)       ((des)[0]=(src)[0],(des)[1]=(src)[1],(des)[2]=(src)[2],(des)[3]=(src)[3])
 196
 197 //
 198 // ARP packet
 199 //
 200 // LLC Header
 201 #define GET_ARP_PKT_LLC_TYPE(__pHeader)                                         ReadEF2Byte( ((u8*)(__pHeader)) + 6)
 202
 203 //ARP element
 204 #define GET_ARP_PKT_OPERATION(__pHeader)                                        ReadEF2Byte( ((u8*)(__pHeader)) + 6)
 205 #define GET_ARP_PKT_SENDER_MAC_ADDR(__pHeader, _val)            cpMacAddr((u8*)(_val), ((u8*)(__pHeader))+8)
 206 #define GET_ARP_PKT_SENDER_IP_ADDR(__pHeader, _val)                     cpIpAddr((u8*)(_val), ((u8*)(__pHeader))+14)
 207 #define GET_ARP_PKT_TARGET_MAC_ADDR(__pHeader, _val)            cpMacAddr((u8*)(_val), ((u8*)(__pHeader))+18)
 208 #define SET_ARP_PKT_HW(__pHeader, __Value)                                      WriteEF2Byte( ((u8*)(__pHeader)) + 0, __Value)
 209 #define SET_ARP_PKT_PROTOCOL(__pHeader, __Value)                        WriteEF2Byte( ((u8*)(__pHeader)) + 2, __Value)
 210 #define SET_ARP_PKT_HW_ADDR_LEN(__pHeader, __Value)                     WriteEF1Byte( ((u8*)(__pHeader)) + 4, __Value)
 211 #define SET_ARP_PKT_PROTOCOL_ADDR_LEN(__pHeader, __Value)       WriteEF1Byte( ((u8*)(__pHeader)) + 5, __Value)
 212 #define SET_ARP_PKT_OPERATION(__pHeader, __Value)                       WriteEF2Byte( ((u8*)(__pHeader)) + 6, __Value)
 213 #define SET_ARP_PKT_SENDER_MAC_ADDR(__pHeader, _val)            cpMacAddr(((u8*)(__pHeader))+8, (u8*)(_val))
 214 #define SET_ARP_PKT_SENDER_IP_ADDR(__pHeader, _val)             cpIpAddr(((u8*)(__pHeader))+14, (u8*)(_val))
 215 #define SET_ARP_PKT_TARGET_MAC_ADDR(__pHeader, _val)            cpMacAddr(((u8*)(__pHeader))+18, (u8*)(_val))
 216 #define SET_ARP_PKT_TARGET_IP_ADDR(__pHeader, _val)             cpIpAddr(((u8*)(__pHeader))+24, (u8*)(_val))
 217
 218 #define FW_WOWLAN_FUN_EN                                BIT(0)
 219 #define FW_WOWLAN_PATTERN_MATCH                 BIT(1)
 220 #define FW_WOWLAN_MAGIC_PKT                             BIT(2)
 221 #define FW_WOWLAN_UNICAST                               BIT(3)
 222 #define FW_WOWLAN_ALL_PKT_DROP                  BIT(4)
 223 #define FW_WOWLAN_GPIO_ACTIVE                   BIT(5)
 224 #define FW_WOWLAN_REKEY_WAKEUP                  BIT(6)
 225 #define FW_WOWLAN_DEAUTH_WAKEUP                 BIT(7)
 226
 227 #define FW_WOWLAN_GPIO_WAKEUP_EN                BIT(0)
 228 #define FW_FW_PARSE_MAGIC_PKT                   BIT(1)
 229
 230 #define FW_WOWLAN_KEEP_ALIVE_EN                 BIT(0)
 231 #define FW_WOWLAN_KEEP_ALIVE_PKT_TYPE   BIT(2)
 232
 233 #define FW_REMOTE_WAKE_CTRL_EN                  BIT(0)
 234 #define FW_ARP_EN                                               BIT(1)
 235 #define FW_REALWOWLAN_EN                                BIT(5)
 236 #define FW_WOW_FW_UNICAST_EN                    BIT(7)
 237
 238 #define FW_ADOPT_USER                                   BIT(1)
 239 void rtl8188es_set_wowlan_cmd(_adapter* padapter, u8 enable);
 240 void SetFwRelatedForWoWLAN8188ES(_adapter* padapter, u8 bHostIsGoingtoSleep);
 241 #endif//CONFIG_WOWLAN
 242
 243 //---------------------------------------------------------------------------------------------------------//
 244 //----------------------------------    H2C CMD CONTENT    --------------------------------------------------//
 245 //---------------------------------------------------------------------------------------------------------//
 246 //_RSVDPAGE_LOC_CMD_0x00
 247 #define SET_8188E_H2CCMD_RSVDPAGE_LOC_PROBE_RSP(__pH2CCmd, __Value)             SET_BITS_TO_LE_1BYTE(__pH2CCmd, 0, 8, __Value)
 248 #define SET_8188E_H2CCMD_RSVDPAGE_LOC_PSPOLL(__pH2CCmd, __Value)                SET_BITS_TO_LE_1BYTE((__pH2CCmd)+1, 0, 8, __Value)
 249 #define SET_8188E_H2CCMD_RSVDPAGE_LOC_NULL_DATA(__pH2CCmd, __Value)             SET_BITS_TO_LE_1BYTE((__pH2CCmd)+2, 0, 8, __Value)
 250 #define SET_8188E_H2CCMD_RSVDPAGE_LOC_QOS_NULL_DATA(__pH2CCmd, __Value) SET_BITS_TO_LE_1BYTE((__pH2CCmd)+3, 0, 8, __Value)
 251
 252 // AOAC_RSVDPAGE_LOC_0x83
 253 #define SET_8188E_H2CCMD_AOAC_RSVDPAGE_LOC_REMOTE_WAKE_CTRL_INFO(__pH2CCmd, __Value)    SET_BITS_TO_LE_1BYTE((__pH2CCmd), 0, 8, __Value)
 254 #define SET_8188E_H2CCMD_AOAC_RSVDPAGE_LOC_ARP_RSP(__pH2CCmd, __Value)                                  SET_BITS_TO_LE_1BYTE((__pH2CCmd)+1, 0, 8, __Value)
 255
 256 #endif//__RTL8188E_CMD_H__
 257
 258