rtlwifi/rtl8188ee/fw.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /* Copyright(c) 2009-2013  Realtek Corporation.*/
0003
0004 #ifndef __RTL92C__FW__H__
0005 #define __RTL92C__FW__H__
0006
0007 #define FW_8192C_SIZE               0x8000
0008 #define FW_8192C_START_ADDRESS          0x1000
0009 #define FW_8192C_END_ADDRESS            0x5FFF
0010 #define FW_8192C_PAGE_SIZE          4096
0011 #define FW_8192C_POLLING_DELAY          5
0012 #define FW_8192C_POLLING_TIMEOUT_COUNT      3000
0013
0014 #define IS_FW_HEADER_EXIST(_pfwhdr)     \
0015     ((le16_to_cpu(_pfwhdr->signature) & 0xFFFF) == 0x88E1)
0016 #define USE_OLD_WOWLAN_DEBUG_FW         0
0017
0018 #define H2C_88E_RSVDPAGE_LOC_LEN        5
0019 #define H2C_88E_PWEMODE_LENGTH          5
0020 #define H2C_88E_JOINBSSRPT_LENGTH       1
0021 #define H2C_88E_AP_OFFLOAD_LENGTH       3
0022 #define H2C_88E_WOWLAN_LENGTH           3
0023 #define H2C_88E_KEEP_ALIVE_CTRL_LENGTH      3
0024 #if (USE_OLD_WOWLAN_DEBUG_FW == 0)
0025 #define H2C_88E_REMOTE_WAKE_CTRL_LEN        1
0026 #else
0027 #define H2C_88E_REMOTE_WAKE_CTRL_LEN        3
0028 #endif
0029 #define H2C_88E_AOAC_GLOBAL_INFO_LEN        2
0030 #define H2C_88E_AOAC_RSVDPAGE_LOC_LEN       7
0031
0032 /* Fw PS state for RPWM.
0033 *BIT[2:0] = HW state
0034 *BIT[3] = Protocol PS state,
0035 *1: register active state , 0: register sleep state
0036 *BIT[4] = sub-state
0037 */
0038 #define FW_PS_GO_ON         BIT(0)
0039 #define FW_PS_TX_NULL           BIT(1)
0040 #define FW_PS_RF_ON         BIT(2)
0041 #define FW_PS_REGISTER_ACTIVE       BIT(3)
0042
0043 #define FW_PS_DPS           BIT(0)
0044 #define FW_PS_LCLK          (FW_PS_DPS)
0045 #define FW_PS_RF_OFF            BIT(1)
0046 #define FW_PS_ALL_ON            BIT(2)
0047 #define FW_PS_ST_ACTIVE         BIT(3)
0048 #define FW_PS_ISR_ENABLE        BIT(4)
0049 #define FW_PS_IMR_ENABLE        BIT(5)
0050
0051
0052 #define FW_PS_ACK           BIT(6)
0053 #define FW_PS_TOGGLE            BIT(7)
0054
0055  /* 88E RPWM value*/
0056  /* BIT[0] = 1: 32k, 0: 40M*/
0057 #define FW_PS_CLOCK_OFF         BIT(0)      /* 32k*/
0058 #define FW_PS_CLOCK_ON          0       /*40M*/
0059
0060 #define FW_PS_STATE_MASK        (0x0F)
0061 #define FW_PS_STATE_HW_MASK     (0x07)
0062 /*ISR_ENABLE, IMR_ENABLE, and PS mode should be inherited.*/
0063 #define FW_PS_STATE_INT_MASK        (0x3F)
0064
0065 #define FW_PS_STATE(x)          (FW_PS_STATE_MASK & (x))
0066 #define FW_PS_STATE_HW(x)       (FW_PS_STATE_HW_MASK & (x))
0067 #define FW_PS_STATE_INT(x)      (FW_PS_STATE_INT_MASK & (x))
0068 #define FW_PS_ISR_VAL(x)        ((x) & 0x70)
0069 #define FW_PS_IMR_MASK(x)       ((x) & 0xDF)
0070 #define FW_PS_KEEP_IMR(x)       ((x) & 0x20)
0071
0072 #define FW_PS_STATE_S0          (FW_PS_DPS)
0073 #define FW_PS_STATE_S1          (FW_PS_LCLK)
0074 #define FW_PS_STATE_S2          (FW_PS_RF_OFF)
0075 #define FW_PS_STATE_S3          (FW_PS_ALL_ON)
0076 #define FW_PS_STATE_S4          ((FW_PS_ST_ACTIVE) | (FW_PS_ALL_ON))
0077 /* ((FW_PS_RF_ON) | (FW_PS_REGISTER_ACTIVE))*/
0078 #define FW_PS_STATE_ALL_ON_88E      (FW_PS_CLOCK_ON)
0079 /* (FW_PS_RF_ON)*/
0080 #define FW_PS_STATE_RF_ON_88E       (FW_PS_CLOCK_ON)
0081 /* 0x0*/
0082 #define FW_PS_STATE_RF_OFF_88E  (FW_PS_CLOCK_ON)
0083 /* (FW_PS_STATE_RF_OFF)*/
0084 #define FW_PS_STATE_RF_OFF_LOW_PWR_88E  (FW_PS_CLOCK_OFF)
0085
0086 #define FW_PS_STATE_ALL_ON_92C      (FW_PS_STATE_S4)
0087 #define FW_PS_STATE_RF_ON_92C       (FW_PS_STATE_S3)
0088 #define FW_PS_STATE_RF_OFF_92C      (FW_PS_STATE_S2)
0089 #define FW_PS_STATE_RF_OFF_LOW_PWR_92C  (FW_PS_STATE_S1)
0090
0091 /* For 88E H2C PwrMode Cmd ID 5.*/
0092 #define FW_PWR_STATE_ACTIVE ((FW_PS_RF_ON) | (FW_PS_REGISTER_ACTIVE))
0093 #define FW_PWR_STATE_RF_OFF     0
0094
0095 #define FW_PS_IS_ACK(x)         ((x) & FW_PS_ACK)
0096 #define FW_PS_IS_CLK_ON(x)      ((x) & (FW_PS_RF_OFF | FW_PS_ALL_ON))
0097 #define FW_PS_IS_RF_ON(x)       ((x) & (FW_PS_ALL_ON))
0098 #define FW_PS_IS_ACTIVE(x)      ((x) & (FW_PS_ST_ACTIVE))
0099 #define FW_PS_IS_CPWM_INT(x)        ((x) & 0x40)
0100
0101 #define FW_CLR_PS_STATE(x)      ((x) = ((x) & (0xF0)))
0102
0103 #define IS_IN_LOW_POWER_STATE_88E(fwpsstate)        \
0104     (FW_PS_STATE(fwpsstate) == FW_PS_CLOCK_OFF)
0105
0106 #define FW_PWR_STATE_ACTIVE ((FW_PS_RF_ON) | (FW_PS_REGISTER_ACTIVE))
0107 #define FW_PWR_STATE_RF_OFF     0
0108
0109 enum rtl8188e_h2c_cmd {
0110     H2C_88E_RSVDPAGE = 0,
0111     H2C_88E_JOINBSSRPT = 1,
0112     H2C_88E_SCAN = 2,
0113     H2C_88E_KEEP_ALIVE_CTRL = 3,
0114     H2C_88E_DISCONNECT_DECISION = 4,
0115 #if (USE_OLD_WOWLAN_DEBUG_FW == 1)
0116     H2C_88E_WO_WLAN = 5,
0117 #endif
0118     H2C_88E_INIT_OFFLOAD = 6,
0119 #if (USE_OLD_WOWLAN_DEBUG_FW == 1)
0120     H2C_88E_REMOTE_WAKE_CTRL = 7,
0121 #endif
0122     H2C_88E_AP_OFFLOAD = 8,
0123     H2C_88E_BCN_RSVDPAGE = 9,
0124     H2C_88E_PROBERSP_RSVDPAGE = 10,
0125
0126     H2C_88E_SETPWRMODE = 0x20,
0127     H2C_88E_PS_TUNING_PARA = 0x21,
0128     H2C_88E_PS_TUNING_PARA2 = 0x22,
0129     H2C_88E_PS_LPS_PARA = 0x23,
0130     H2C_88E_P2P_PS_OFFLOAD = 024,
0131
0132 #if (USE_OLD_WOWLAN_DEBUG_FW == 0)
0133     H2C_88E_WO_WLAN = 0x80,
0134     H2C_88E_REMOTE_WAKE_CTRL = 0x81,
0135     H2C_88E_AOAC_GLOBAL_INFO = 0x82,
0136     H2C_88E_AOAC_RSVDPAGE = 0x83,
0137 #endif
0138     /*Not defined in new 88E H2C CMD Format*/
0139     H2C_88E_RA_MASK,
0140     H2C_88E_SELECTIVE_SUSPEND_ROF_CMD,
0141     H2C_88E_P2P_PS_MODE,
0142     H2C_88E_PSD_RESULT,
0143     /*Not defined CTW CMD for P2P yet*/
0144     H2C_88E_P2P_PS_CTW_CMD,
0145     MAX_88E_H2CCMD
0146 };
0147
0148 #define pagenum_128(_len)   (u32)(((_len)>>7) + ((_len)&0x7F ? 1 : 0))
0149
0150 #define SET_88E_H2CCMD_WOWLAN_FUNC_ENABLE(__cmd, __value)       \
0151     SET_BITS_TO_LE_1BYTE(__cmd, 0, 1, __value)
0152 #define SET_88E_H2CCMD_WOWLAN_PATTERN_MATCH_ENABLE(__cmd, __value)  \
0153     SET_BITS_TO_LE_1BYTE(__cmd, 1, 1, __value)
0154 #define SET_88E_H2CCMD_WOWLAN_MAGIC_PKT_ENABLE(__cmd, __value)  \
0155     SET_BITS_TO_LE_1BYTE(__cmd, 2, 1, __value)
0156 #define SET_88E_H2CCMD_WOWLAN_UNICAST_PKT_ENABLE(__cmd, __value)    \
0157     SET_BITS_TO_LE_1BYTE(__cmd, 3, 1, __value)
0158 #define SET_88E_H2CCMD_WOWLAN_ALL_PKT_DROP(__cmd, __value)      \
0159     SET_BITS_TO_LE_1BYTE(__cmd, 4, 1, __value)
0160 #define SET_88E_H2CCMD_WOWLAN_GPIO_ACTIVE(__cmd, __value)       \
0161     SET_BITS_TO_LE_1BYTE(__cmd, 5, 1, __value)
0162 #define SET_88E_H2CCMD_WOWLAN_REKEY_WAKE_UP(__cmd, __value)     \
0163     SET_BITS_TO_LE_1BYTE(__cmd, 6, 1, __value)
0164 #define SET_88E_H2CCMD_WOWLAN_DISCONNECT_WAKE_UP(__cmd, __value)    \
0165     SET_BITS_TO_LE_1BYTE(__cmd, 7, 1, __value)
0166 #define SET_88E_H2CCMD_WOWLAN_GPIONUM(__cmd, __value)       \
0167     SET_BITS_TO_LE_1BYTE((__cmd)+1, 0, 8, __value)
0168 #define SET_88E_H2CCMD_WOWLAN_GPIO_DURATION(__cmd, __value)     \
0169     SET_BITS_TO_LE_1BYTE((__cmd)+2, 0, 8, __value)
0170
0171
0172 static inline void set_h2ccmd_pwrmode_parm_mode(u8 *__ph2ccmd, u8 __val)
0173 {
0174     *(u8 *)(__ph2ccmd) = __val;
0175 }
0176
0177 static inline void set_h2ccmd_pwrmode_parm_rlbm(u8 *__cmd, u8 __value)
0178 {
0179     u8p_replace_bits(__cmd + 1, __value, GENMASK(3, 0));
0180 }
0181
0182 static inline void set_h2ccmd_pwrmode_parm_smart_ps(u8 *__cmd, u8 __value)
0183 {
0184     u8p_replace_bits(__cmd + 1, __value, GENMASK(7, 4));
0185 }
0186
0187 static inline void set_h2ccmd_pwrmode_parm_awake_interval(u8 *__cmd, u8 __value)
0188 {
0189     *(u8 *)(__cmd + 2) = __value;
0190 }
0191
0192 static inline void set_h2ccmd_pwrmode_parm_all_queue_uapsd(u8 *__cmd,
0193                                u8 __value)
0194 {
0195     *(u8 *)(__cmd + 3) = __value;
0196 }
0197
0198 static inline void set_h2ccmd_pwrmode_parm_pwr_state(u8 *__cmd, u8 __value)
0199 {
0200     *(u8 *)(__cmd + 4) = __value;
0201 }
0202
0203 #define SET_H2CCMD_JOINBSSRPT_PARM_OPMODE(__ph2ccmd, __val)     \
0204     *(u8 *)(__ph2ccmd) = __val;
0205 #define SET_H2CCMD_RSVDPAGE_LOC_PROBE_RSP(__ph2ccmd, __val)     \
0206     *(u8 *)(__ph2ccmd) = __val;
0207 #define SET_H2CCMD_RSVDPAGE_LOC_PSPOLL(__ph2ccmd, __val)        \
0208     *(u8 *)(__ph2ccmd + 1) = __val;
0209 #define SET_H2CCMD_RSVDPAGE_LOC_NULL_DATA(__ph2ccmd, __val)     \
0210     *(u8 *)(__ph2ccmd + 2) = __val;
0211
0212 /* AP_OFFLOAD */
0213 #define SET_H2CCMD_AP_OFFLOAD_ON(__cmd, __value)            \
0214     *(u8 *)__cmd = __value;
0215 #define SET_H2CCMD_AP_OFFLOAD_HIDDEN(__cmd, __value)        \
0216     *(u8 *)(__cmd + 1) = __value;
0217 #define SET_H2CCMD_AP_OFFLOAD_DENYANY(__cmd, __value)       \
0218     *(u8 *)(__cmd + 2) = __value;
0219 #define SET_H2CCMD_AP_OFFLOAD_WAKEUP_EVT_RPT(__cmd, __value)    \
0220     *(u8 *)(__cmd + 3) = __value;
0221
0222 int rtl88e_download_fw(struct ieee80211_hw *hw,
0223                bool buse_wake_on_wlan_fw);
0224 void rtl88e_fill_h2c_cmd(struct ieee80211_hw *hw, u8 element_id,
0225              u32 cmd_len, u8 *cmdbuffer);
0226 void rtl88e_firmware_selfreset(struct ieee80211_hw *hw);
0227 void rtl88e_set_fw_pwrmode_cmd(struct ieee80211_hw *hw, u8 mode);
0228 void rtl88e_set_fw_joinbss_report_cmd(struct ieee80211_hw *hw, u8 mstatus);
0229 void rtl88e_set_fw_ap_off_load_cmd(struct ieee80211_hw *hw,
0230                    u8 ap_offload_enable);
0231 void rtl88e_set_fw_rsvdpagepkt(struct ieee80211_hw *hw, bool b_dl_finished);
0232 void rtl88e_set_p2p_ps_offload_cmd(struct ieee80211_hw *hw, u8 p2p_ps_state);
0233 #endif