Back to home page

OSCL-LXR
 
 

     

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /* Copyright(c) 2009-2010  Realtek Corporation.*/
0003 
0004 #ifndef __RTL8821AE__FW__H__
0005 #define __RTL8821AE__FW__H__
0006 #include "def.h"
0007 
0008 #define FW_8821AE_SIZE                  0x8000
0009 #define FW_8821AE_START_ADDRESS         0x1000
0010 #define FW_8821AE_END_ADDRESS           0x5FFF
0011 #define FW_8821AE_PAGE_SIZE             4096
0012 #define FW_8821AE_POLLING_DELAY         5
0013 #define FW_8821AE_POLLING_TIMEOUT_COUNT 6000
0014 
0015 #define IS_FW_HEADER_EXIST_8812(_pfwhdr)    \
0016     ((le16_to_cpu(_pfwhdr->signature) & 0xFFF0) == 0x9500)
0017 
0018 #define IS_FW_HEADER_EXIST_8821(_pfwhdr)    \
0019     ((le16_to_cpu(_pfwhdr->signature) & 0xFFF0) == 0x2100)
0020 
0021 #define USE_OLD_WOWLAN_DEBUG_FW 0
0022 
0023 #define H2C_8821AE_RSVDPAGE_LOC_LEN     5
0024 #define H2C_8821AE_PWEMODE_LENGTH           7
0025 #define H2C_8821AE_JOINBSSRPT_LENGTH        1
0026 #define H2C_8821AE_AP_OFFLOAD_LENGTH        3
0027 #define H2C_8821AE_WOWLAN_LENGTH            3
0028 #define H2C_8821AE_KEEP_ALIVE_CTRL_LENGTH   3
0029 #if (USE_OLD_WOWLAN_DEBUG_FW == 0)
0030 #define H2C_8821AE_REMOTE_WAKE_CTRL_LEN 1
0031 #else
0032 #define H2C_8821AE_REMOTE_WAKE_CTRL_LEN 3
0033 #endif
0034 #define H2C_8821AE_AOAC_GLOBAL_INFO_LEN 2
0035 #define H2C_8821AE_AOAC_RSVDPAGE_LOC_LEN    7
0036 #define H2C_8821AE_DISCONNECT_DECISION_CTRL_LEN 3
0037 
0038 /* Fw PS state for RPWM.
0039 *BIT[2:0] = HW state
0040 
0041 *BIT[3] = Protocol PS state,
0042 1: register active state ,
0043 0: register sleep state
0044 
0045 *BIT[4] = sub-state
0046 */
0047 #define FW_PS_GO_ON         BIT(0)
0048 #define FW_PS_TX_NULL           BIT(1)
0049 #define FW_PS_RF_ON         BIT(2)
0050 #define FW_PS_REGISTER_ACTIVE   BIT(3)
0051 
0052 #define FW_PS_DPS       BIT(0)
0053 #define FW_PS_LCLK      (FW_PS_DPS)
0054 #define FW_PS_RF_OFF        BIT(1)
0055 #define FW_PS_ALL_ON        BIT(2)
0056 #define FW_PS_ST_ACTIVE     BIT(3)
0057 #define FW_PS_ISR_ENABLE    BIT(4)
0058 #define FW_PS_IMR_ENABLE    BIT(5)
0059 
0060 #define FW_PS_ACK       BIT(6)
0061 #define FW_PS_TOGGLE        BIT(7)
0062 
0063  /* 8821AE RPWM value*/
0064  /* BIT[0] = 1: 32k, 0: 40M*/
0065  /* 32k*/
0066 #define FW_PS_CLOCK_OFF     BIT(0)
0067 /*40M*/
0068 #define FW_PS_CLOCK_ON      0
0069 
0070 #define FW_PS_STATE_MASK        (0x0F)
0071 #define FW_PS_STATE_HW_MASK (0x07)
0072 /*ISR_ENABLE, IMR_ENABLE, and PS mode should be inherited.*/
0073 #define FW_PS_STATE_INT_MASK    (0x3F)
0074 
0075 #define FW_PS_STATE(x)          (FW_PS_STATE_MASK & (x))
0076 #define FW_PS_STATE_HW(x)       (FW_PS_STATE_HW_MASK & (x))
0077 #define FW_PS_STATE_INT(x)  (FW_PS_STATE_INT_MASK & (x))
0078 #define FW_PS_ISR_VAL(x)        ((x) & 0x70)
0079 #define FW_PS_IMR_MASK(x)   ((x) & 0xDF)
0080 #define FW_PS_KEEP_IMR(x)       ((x) & 0x20)
0081 
0082 #define FW_PS_STATE_S0      (FW_PS_DPS)
0083 #define FW_PS_STATE_S1      (FW_PS_LCLK)
0084 #define FW_PS_STATE_S2      (FW_PS_RF_OFF)
0085 #define FW_PS_STATE_S3      (FW_PS_ALL_ON)
0086 #define FW_PS_STATE_S4      ((FW_PS_ST_ACTIVE) | (FW_PS_ALL_ON))
0087  /* ((FW_PS_RF_ON) | (FW_PS_REGISTER_ACTIVE))*/
0088 #define FW_PS_STATE_ALL_ON_8821AE   (FW_PS_CLOCK_ON)
0089  /* (FW_PS_RF_ON)*/
0090 #define FW_PS_STATE_RF_ON_8821AE    (FW_PS_CLOCK_ON)
0091  /* 0x0*/
0092 #define FW_PS_STATE_RF_OFF_8821AE   (FW_PS_CLOCK_ON)
0093  /* (FW_PS_STATE_RF_OFF)*/
0094 #define FW_PS_STATE_RF_OFF_LOW_PWR_8821AE   (FW_PS_CLOCK_OFF)
0095 
0096 #define FW_PS_STATE_ALL_ON_92C  (FW_PS_STATE_S4)
0097 #define FW_PS_STATE_RF_ON_92C       (FW_PS_STATE_S3)
0098 #define FW_PS_STATE_RF_OFF_92C  (FW_PS_STATE_S2)
0099 #define FW_PS_STATE_RF_OFF_LOW_PWR_92C  (FW_PS_STATE_S1)
0100 
0101 /* For 8821AE H2C PwrMode Cmd ID 5.*/
0102 #define FW_PWR_STATE_ACTIVE ((FW_PS_RF_ON) | (FW_PS_REGISTER_ACTIVE))
0103 #define FW_PWR_STATE_RF_OFF 0
0104 
0105 #define FW_PS_IS_ACK(x)     ((x) & FW_PS_ACK)
0106 #define FW_PS_IS_CLK_ON(x)  ((x) & (FW_PS_RF_OFF | FW_PS_ALL_ON))
0107 #define FW_PS_IS_RF_ON(x)   ((x) & (FW_PS_ALL_ON))
0108 #define FW_PS_IS_ACTIVE(x)  ((x) & (FW_PS_ST_ACTIVE))
0109 #define FW_PS_IS_CPWM_INT(x)    ((x) & 0x40)
0110 
0111 #define FW_CLR_PS_STATE(x)  ((x) = ((x) & (0xF0)))
0112 
0113 #define IS_IN_LOW_POWER_STATE_8821AE(__state)       \
0114             (FW_PS_STATE(__state) == FW_PS_CLOCK_OFF)
0115 
0116 #define FW_PWR_STATE_ACTIVE ((FW_PS_RF_ON) | (FW_PS_REGISTER_ACTIVE))
0117 #define FW_PWR_STATE_RF_OFF 0
0118 
0119 enum rtl8821a_h2c_cmd {
0120     H2C_8821AE_RSVDPAGE = 0,
0121     H2C_8821AE_MSRRPT = 1,
0122     H2C_8821AE_SCAN = 2,
0123     H2C_8821AE_KEEP_ALIVE_CTRL = 3,
0124     H2C_8821AE_DISCONNECT_DECISION = 4,
0125     H2C_8821AE_INIT_OFFLOAD = 6,
0126     H2C_8821AE_AP_OFFLOAD = 8,
0127     H2C_8821AE_BCN_RSVDPAGE = 9,
0128     H2C_8821AE_PROBERSP_RSVDPAGE = 10,
0129 
0130     H2C_8821AE_SETPWRMODE = 0x20,
0131     H2C_8821AE_PS_TUNING_PARA = 0x21,
0132     H2C_8821AE_PS_TUNING_PARA2 = 0x22,
0133     H2C_8821AE_PS_LPS_PARA = 0x23,
0134     H2C_8821AE_P2P_PS_OFFLOAD = 024,
0135 
0136     H2C_8821AE_WO_WLAN = 0x80,
0137     H2C_8821AE_REMOTE_WAKE_CTRL = 0x81,
0138     H2C_8821AE_AOAC_GLOBAL_INFO = 0x82,
0139     H2C_8821AE_AOAC_RSVDPAGE = 0x83,
0140 
0141     H2C_RSSI_21AE_REPORT = 0x42,
0142     H2C_8821AE_RA_MASK = 0x40,
0143     H2C_8821AE_SELECTIVE_SUSPEND_ROF_CMD,
0144     H2C_8821AE_P2P_PS_MODE,
0145     H2C_8821AE_PSD_RESULT,
0146     /*Not defined CTW CMD for P2P yet*/
0147     H2C_8821AE_P2P_PS_CTW_CMD,
0148     MAX_8821AE_H2CCMD
0149 };
0150 
0151 #define pagenum_128(_len)   (u32)(((_len)>>7) + ((_len)&0x7F ? 1 : 0))
0152 
0153 #define SET_8812_H2CCMD_WOWLAN_FUNC_ENABLE(__cmd, __value)      \
0154     u8p_replace_bits(__cmd, __value, BIT(0))
0155 #define SET_8812_H2CCMD_WOWLAN_PATTERN_MATCH_ENABLE(__cmd, __value) \
0156     u8p_replace_bits(__cmd, __value, BIT(1))
0157 #define SET_8812_H2CCMD_WOWLAN_MAGIC_PKT_ENABLE(__cmd, __value) \
0158     u8p_replace_bits(__cmd, __value, BIT(2))
0159 #define SET_8812_H2CCMD_WOWLAN_UNICAST_PKT_ENABLE(__cmd, __value)   \
0160     u8p_replace_bits(__cmd, __value, BIT(3))
0161 #define SET_8812_H2CCMD_WOWLAN_ALL_PKT_DROP(__cmd, __value)     \
0162     u8p_replace_bits(__cmd, __value, BIT(4))
0163 #define SET_8812_H2CCMD_WOWLAN_GPIO_ACTIVE(__cmd, __value)      \
0164     u8p_replace_bits(__cmd, __value, BIT(5))
0165 #define SET_8812_H2CCMD_WOWLAN_REKEY_WAKE_UP(__cmd, __value)    \
0166     u8p_replace_bits(__cmd, __value, BIT(6))
0167 #define SET_8812_H2CCMD_WOWLAN_DISCONNECT_WAKE_UP(__cmd, __value)   \
0168     u8p_replace_bits(__cmd, __value, BIT(7))
0169 #define SET_8812_H2CCMD_WOWLAN_GPIONUM(__cmd, __value)      \
0170     *(u8 *)(__cmd + 1) = __value
0171 #define SET_8812_H2CCMD_WOWLAN_GPIO_DURATION(__cmd, __value)    \
0172     *(u8 *)(__cmd + 2) = __value
0173 
0174 #define SET_H2CCMD_PWRMODE_PARM_MODE(__ph2ccmd, __val)          \
0175     *(u8 *)__ph2ccmd = __val
0176 #define SET_H2CCMD_PWRMODE_PARM_RLBM(__cmd, __value)        \
0177     u8p_replace_bits(__cmd + 1, __value, GENMASK(3, 0))
0178 #define SET_H2CCMD_PWRMODE_PARM_SMART_PS(__cmd, __value)    \
0179     u8p_replace_bits(__cmd + 1, __value, GENMASK(7, 4))
0180 #define SET_H2CCMD_PWRMODE_PARM_AWAKE_INTERVAL(__cmd, __value)  \
0181     *(u8 *)(__cmd + 2) = __value
0182 #define SET_H2CCMD_PWRMODE_PARM_ALL_QUEUE_UAPSD(__cmd, __value)     \
0183     *(u8 *)(__cmd + 3) = __value
0184 #define SET_H2CCMD_PWRMODE_PARM_PWR_STATE(__cmd, __value)   \
0185     *(u8 *)(__cmd + 4) = __value
0186 #define SET_H2CCMD_PWRMODE_PARM_BYTE5(__cmd, __value)       \
0187     *(u8 *)(__cmd + 5) = __value
0188 
0189 #define SET_H2CCMD_RSVDPAGE_LOC_PSPOLL(__ph2ccmd, __val)        \
0190     *(u8 *)(__ph2ccmd + 1) = __val
0191 #define SET_H2CCMD_RSVDPAGE_LOC_NULL_DATA(__ph2ccmd, __val)     \
0192     *(u8 *)(__ph2ccmd + 2) = __val
0193 #define SET_H2CCMD_RSVDPAGE_LOC_QOS_NULL_DATA(__ph2ccmd, __val)     \
0194     *(u8 *)(__ph2ccmd + 3) = __val
0195 #define SET_H2CCMD_RSVDPAGE_LOC_BT_QOS_NULL_DATA(__ph2ccmd, __val)  \
0196     *(u8 *)(__ph2ccmd + 4) = __val
0197 
0198 /* _MEDIA_STATUS_RPT_PARM_CMD1 */
0199 #define SET_H2CCMD_MSRRPT_PARM_OPMODE(__cmd, __value)   \
0200     u8p_replace_bits(__cmd + 1, __value, BIT(0))
0201 #define SET_H2CCMD_MSRRPT_PARM_MACID_IND(__cmd, __value)    \
0202     u8p_replace_bits(__cmd + 1, __value, BIT(1))
0203 
0204 /* AP_OFFLOAD */
0205 #define SET_H2CCMD_AP_OFFLOAD_ON(__cmd, __value)    \
0206     *(u8 *)__cmd = __value
0207 #define SET_H2CCMD_AP_OFFLOAD_HIDDEN(__cmd, __value)    \
0208     *(u8 *)(__cmd + 1) = __value
0209 #define SET_H2CCMD_AP_OFFLOAD_DENYANY(__cmd, __value)   \
0210     *(u8 *)(__cmd + 2) = __value
0211 #define SET_H2CCMD_AP_OFFLOAD_WAKEUP_EVT_RPT(__cmd, __value) \
0212     *(u8 *)(__cmd + 3) = __value
0213 
0214 /* Keep Alive Control*/
0215 #define SET_8812_H2CCMD_KEEP_ALIVE_ENABLE(__cmd, __value)   \
0216     u8p_replace_bits(__cmd, __value, BIT(0))
0217 #define SET_8812_H2CCMD_KEEP_ALIVE_ACCPEPT_USER_DEFINED(__cmd, __value) \
0218     u8p_replace_bits(__cmd, __value, BIT(1))
0219 #define SET_8812_H2CCMD_KEEP_ALIVE_PERIOD(__cmd, __value)   \
0220     *(u8 *)(__cmd + 1) = __value
0221 
0222 /*REMOTE_WAKE_CTRL */
0223 #define SET_8812_H2CCMD_REMOTE_WAKECTRL_ENABLE(__cmd, __value)  \
0224     u8p_replace_bits(__cmd, __value, BIT(0))
0225 #define SET_8812_H2CCMD_REMOTE_WAKE_CTRL_ARP_OFFLOAD_EN(__cmd, __value)\
0226     u8p_replace_bits(__cmd, __value, BIT(1))
0227 #define SET_8812_H2CCMD_REMOTE_WAKE_CTRL_NDP_OFFLOAD_EN(__cmd, __value)\
0228     u8p_replace_bits(__cmd, __value, BIT(2))
0229 #define SET_8812_H2CCMD_REMOTE_WAKE_CTRL_GTK_OFFLOAD_EN(__cmd, __value)\
0230     u8p_replace_bits(__cmd, __value, BIT(3))
0231 #define SET_8812_H2CCMD_REMOTE_WAKE_CTRL_REALWOWV2_EN(__cmd, __value)\
0232     u8p_replace_bits(__cmd, __value, BIT(6))
0233 
0234 /* GTK_OFFLOAD */
0235 #define SET_8812_H2CCMD_AOAC_GLOBAL_INFO_PAIRWISE_ENC_ALG(__cmd, __value)\
0236     *(u8 *)__cmd = __value
0237 #define SET_8812_H2CCMD_AOAC_GLOBAL_INFO_GROUP_ENC_ALG(__cmd, __value)  \
0238     *(u8 *)(__cmd + 1) = __value
0239 
0240 /* AOAC_RSVDPAGE_LOC */
0241 #define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_REMOTE_WAKE_CTRL_INFO(__cmd, __value)   \
0242     *(u8 *)__cmd = __value
0243 #define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_ARP_RSP(__cmd, __value) \
0244     *(u8 *)(__cmd + 1) = __value
0245 #define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_NEIGHBOR_ADV(__cmd, __value)\
0246     *(u8 *)(__cmd + 2) = __value
0247 #define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_GTK_RSP(__cmd, __value) \
0248     *(u8 *)(__cmd + 3) = __value
0249 #define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_GTK_INFO(__cmd, __value)    \
0250     *(u8 *)(__cmd + 4) = __value
0251 #define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_GTK_EXT_MEM(__cmd, __value) \
0252     *(u8 *)(__cmd + 5) = __value
0253 
0254 /* Disconnect_Decision_Control */
0255 #define SET_8812_H2CCMD_DISCONNECT_DECISION_CTRL_ENABLE(__cmd, __value) \
0256     u8p_replace_bits(__cmd, __value, BIT(0))
0257 #define SET_8812_H2CCMD_DISCONNECT_DECISION_CTRL_USER_SETTING(__cmd, __value)\
0258     u8p_replace_bits(__cmd, __value, BIT(1))
0259 #define SET_8812_H2CCMD_DISCONNECT_DECISION_CTRL_CHECK_PERIOD(__cmd, __value)\
0260     *(u8 *)(__cmd + 1) = __value
0261 #define SET_8812_H2CCMD_DISCONNECT_DECISION_CTRL_TRYPKT_NUM(__cmd, __value)\
0262     *(u8 *)(__cmd + 2) = __value
0263 
0264 int rtl8821ae_download_fw(struct ieee80211_hw *hw, bool buse_wake_on_wlan_fw);
0265 #if (USE_SPECIFIC_FW_TO_SUPPORT_WOWLAN == 1)
0266 void rtl8821ae_set_fw_related_for_wowlan(struct ieee80211_hw *hw,
0267                      bool used_wowlan_fw);
0268 
0269 #endif
0270 void rtl8821ae_fill_h2c_cmd(struct ieee80211_hw *hw, u8 element_id,
0271                 u32 cmd_len, u8 *cmdbuffer);
0272 void rtl8821ae_firmware_selfreset(struct ieee80211_hw *hw);
0273 void rtl8821ae_set_fw_pwrmode_cmd(struct ieee80211_hw *hw, u8 mode);
0274 void rtl8821ae_set_fw_media_status_rpt_cmd(struct ieee80211_hw *hw,
0275                        u8 mstatus);
0276 void rtl8821ae_set_fw_ap_off_load_cmd(struct ieee80211_hw *hw,
0277                       u8 ap_offload_enable);
0278 void rtl8821ae_set_fw_rsvdpagepkt(struct ieee80211_hw *hw,
0279                   bool b_dl_finished, bool dl_whole_packet);
0280 void rtl8812ae_set_fw_rsvdpagepkt(struct ieee80211_hw *hw,
0281                   bool b_dl_finished, bool dl_whole_packet);
0282 void rtl8821ae_set_p2p_ps_offload_cmd(struct ieee80211_hw *hw,
0283                       u8 p2p_ps_state);
0284 void rtl8821ae_set_fw_wowlan_mode(struct ieee80211_hw *hw, bool func_en);
0285 void rtl8821ae_set_fw_remote_wake_ctrl_cmd(struct ieee80211_hw *hw,
0286                        u8 enable);
0287 void rtl8821ae_set_fw_keep_alive_cmd(struct ieee80211_hw *hw, bool func_en);
0288 void rtl8821ae_set_fw_disconnect_decision_ctrl_cmd(struct ieee80211_hw *hw,
0289                            bool enabled);
0290 void rtl8821ae_set_fw_global_info_cmd(struct ieee80211_hw *hw);
0291 void rtl8821ae_c2h_ra_report_handler(struct ieee80211_hw *hw,
0292                      u8 *cmd_buf, u8 cmd_len);
0293 #endif
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.1.0 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!