fw.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  1. /******************************************************************************
  2. *
  3. * Copyright(c) 2009-2010 Realtek Corporation.
  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. * The full GNU General Public License is included in this distribution in the
  15. * file called LICENSE.
  16. *
  17. * Contact Information:
  18. * wlanfae <wlanfae@realtek.com>
  19. * Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
  20. * Hsinchu 300, Taiwan.
  21. * Larry Finger <Larry.Finger@lwfinger.net>
  22. *
  23. *****************************************************************************/
  24. #ifndef __RTL8821AE__FW__H__
  25. #define __RTL8821AE__FW__H__
  26. #include "def.h"
  27. #define FW_8821AE_SIZE 0x8000
  28. #define FW_8821AE_START_ADDRESS 0x1000
  29. #define FW_8821AE_END_ADDRESS 0x5FFF
  30. #define FW_8821AE_PAGE_SIZE 4096
  31. #define FW_8821AE_POLLING_DELAY 5
  32. #define FW_8821AE_POLLING_TIMEOUT_COUNT 6000
  33. #define IS_FW_HEADER_EXIST_8812(_pfwhdr) \
  34. ((le16_to_cpu(_pfwhdr->signature) & 0xFFF0) == 0x9500)
  35. #define IS_FW_HEADER_EXIST_8821(_pfwhdr) \
  36. ((le16_to_cpu(_pfwhdr->signature) & 0xFFF0) == 0x2100)
  37. #define USE_OLD_WOWLAN_DEBUG_FW 0
  38. #define H2C_8821AE_RSVDPAGE_LOC_LEN 5
  39. #define H2C_8821AE_PWEMODE_LENGTH 7
  40. #define H2C_8821AE_JOINBSSRPT_LENGTH 1
  41. #define H2C_8821AE_AP_OFFLOAD_LENGTH 3
  42. #define H2C_8821AE_WOWLAN_LENGTH 3
  43. #define H2C_8821AE_KEEP_ALIVE_CTRL_LENGTH 3
  44. #if (USE_OLD_WOWLAN_DEBUG_FW == 0)
  45. #define H2C_8821AE_REMOTE_WAKE_CTRL_LEN 1
  46. #else
  47. #define H2C_8821AE_REMOTE_WAKE_CTRL_LEN 3
  48. #endif
  49. #define H2C_8821AE_AOAC_GLOBAL_INFO_LEN 2
  50. #define H2C_8821AE_AOAC_RSVDPAGE_LOC_LEN 7
  51. #define H2C_8821AE_DISCONNECT_DECISION_CTRL_LEN 3
  52. /* Fw PS state for RPWM.
  53. *BIT[2:0] = HW state
  54. *BIT[3] = Protocol PS state,
  55. 1: register active state ,
  56. 0: register sleep state
  57. *BIT[4] = sub-state
  58. */
  59. #define FW_PS_GO_ON BIT(0)
  60. #define FW_PS_TX_NULL BIT(1)
  61. #define FW_PS_RF_ON BIT(2)
  62. #define FW_PS_REGISTER_ACTIVE BIT(3)
  63. #define FW_PS_DPS BIT(0)
  64. #define FW_PS_LCLK (FW_PS_DPS)
  65. #define FW_PS_RF_OFF BIT(1)
  66. #define FW_PS_ALL_ON BIT(2)
  67. #define FW_PS_ST_ACTIVE BIT(3)
  68. #define FW_PS_ISR_ENABLE BIT(4)
  69. #define FW_PS_IMR_ENABLE BIT(5)
  70. #define FW_PS_ACK BIT(6)
  71. #define FW_PS_TOGGLE BIT(7)
  72. /* 8821AE RPWM value*/
  73. /* BIT[0] = 1: 32k, 0: 40M*/
  74. /* 32k*/
  75. #define FW_PS_CLOCK_OFF BIT(0)
  76. /*40M*/
  77. #define FW_PS_CLOCK_ON 0
  78. #define FW_PS_STATE_MASK (0x0F)
  79. #define FW_PS_STATE_HW_MASK (0x07)
  80. /*ISR_ENABLE, IMR_ENABLE, and PS mode should be inherited.*/
  81. #define FW_PS_STATE_INT_MASK (0x3F)
  82. #define FW_PS_STATE(x) (FW_PS_STATE_MASK & (x))
  83. #define FW_PS_STATE_HW(x) (FW_PS_STATE_HW_MASK & (x))
  84. #define FW_PS_STATE_INT(x) (FW_PS_STATE_INT_MASK & (x))
  85. #define FW_PS_ISR_VAL(x) ((x) & 0x70)
  86. #define FW_PS_IMR_MASK(x) ((x) & 0xDF)
  87. #define FW_PS_KEEP_IMR(x) ((x) & 0x20)
  88. #define FW_PS_STATE_S0 (FW_PS_DPS)
  89. #define FW_PS_STATE_S1 (FW_PS_LCLK)
  90. #define FW_PS_STATE_S2 (FW_PS_RF_OFF)
  91. #define FW_PS_STATE_S3 (FW_PS_ALL_ON)
  92. #define FW_PS_STATE_S4 ((FW_PS_ST_ACTIVE) | (FW_PS_ALL_ON))
  93. /* ((FW_PS_RF_ON) | (FW_PS_REGISTER_ACTIVE))*/
  94. #define FW_PS_STATE_ALL_ON_8821AE (FW_PS_CLOCK_ON)
  95. /* (FW_PS_RF_ON)*/
  96. #define FW_PS_STATE_RF_ON_8821AE (FW_PS_CLOCK_ON)
  97. /* 0x0*/
  98. #define FW_PS_STATE_RF_OFF_8821AE (FW_PS_CLOCK_ON)
  99. /* (FW_PS_STATE_RF_OFF)*/
  100. #define FW_PS_STATE_RF_OFF_LOW_PWR_8821AE (FW_PS_CLOCK_OFF)
  101. #define FW_PS_STATE_ALL_ON_92C (FW_PS_STATE_S4)
  102. #define FW_PS_STATE_RF_ON_92C (FW_PS_STATE_S3)
  103. #define FW_PS_STATE_RF_OFF_92C (FW_PS_STATE_S2)
  104. #define FW_PS_STATE_RF_OFF_LOW_PWR_92C (FW_PS_STATE_S1)
  105. /* For 8821AE H2C PwrMode Cmd ID 5.*/
  106. #define FW_PWR_STATE_ACTIVE ((FW_PS_RF_ON) | (FW_PS_REGISTER_ACTIVE))
  107. #define FW_PWR_STATE_RF_OFF 0
  108. #define FW_PS_IS_ACK(x) ((x) & FW_PS_ACK)
  109. #define FW_PS_IS_CLK_ON(x) ((x) & (FW_PS_RF_OFF | FW_PS_ALL_ON))
  110. #define FW_PS_IS_RF_ON(x) ((x) & (FW_PS_ALL_ON))
  111. #define FW_PS_IS_ACTIVE(x) ((x) & (FW_PS_ST_ACTIVE))
  112. #define FW_PS_IS_CPWM_INT(x) ((x) & 0x40)
  113. #define FW_CLR_PS_STATE(x) ((x) = ((x) & (0xF0)))
  114. #define IS_IN_LOW_POWER_STATE_8821AE(__state) \
  115. (FW_PS_STATE(__state) == FW_PS_CLOCK_OFF)
  116. #define FW_PWR_STATE_ACTIVE ((FW_PS_RF_ON) | (FW_PS_REGISTER_ACTIVE))
  117. #define FW_PWR_STATE_RF_OFF 0
  118. enum rtl8821a_h2c_cmd {
  119. H2C_8821AE_RSVDPAGE = 0,
  120. H2C_8821AE_MSRRPT = 1,
  121. H2C_8821AE_SCAN = 2,
  122. H2C_8821AE_KEEP_ALIVE_CTRL = 3,
  123. H2C_8821AE_DISCONNECT_DECISION = 4,
  124. H2C_8821AE_INIT_OFFLOAD = 6,
  125. H2C_8821AE_AP_OFFLOAD = 8,
  126. H2C_8821AE_BCN_RSVDPAGE = 9,
  127. H2C_8821AE_PROBERSP_RSVDPAGE = 10,
  128. H2C_8821AE_SETPWRMODE = 0x20,
  129. H2C_8821AE_PS_TUNING_PARA = 0x21,
  130. H2C_8821AE_PS_TUNING_PARA2 = 0x22,
  131. H2C_8821AE_PS_LPS_PARA = 0x23,
  132. H2C_8821AE_P2P_PS_OFFLOAD = 024,
  133. H2C_8821AE_WO_WLAN = 0x80,
  134. H2C_8821AE_REMOTE_WAKE_CTRL = 0x81,
  135. H2C_8821AE_AOAC_GLOBAL_INFO = 0x82,
  136. H2C_8821AE_AOAC_RSVDPAGE = 0x83,
  137. H2C_RSSI_21AE_REPORT = 0x42,
  138. H2C_8821AE_RA_MASK = 0x40,
  139. H2C_8821AE_SELECTIVE_SUSPEND_ROF_CMD,
  140. H2C_8821AE_P2P_PS_MODE,
  141. H2C_8821AE_PSD_RESULT,
  142. /*Not defined CTW CMD for P2P yet*/
  143. H2C_8821AE_P2P_PS_CTW_CMD,
  144. MAX_8821AE_H2CCMD
  145. };
  146. #define pagenum_128(_len) (u32)(((_len)>>7) + ((_len)&0x7F ? 1 : 0))
  147. #define SET_8812_H2CCMD_WOWLAN_FUNC_ENABLE(__cmd, __value) \
  148. SET_BITS_TO_LE_1BYTE(__cmd, 0, 1, __value)
  149. #define SET_8812_H2CCMD_WOWLAN_PATTERN_MATCH_ENABLE(__cmd, __value) \
  150. SET_BITS_TO_LE_1BYTE(__cmd, 1, 1, __value)
  151. #define SET_8812_H2CCMD_WOWLAN_MAGIC_PKT_ENABLE(__cmd, __value) \
  152. SET_BITS_TO_LE_1BYTE(__cmd, 2, 1, __value)
  153. #define SET_8812_H2CCMD_WOWLAN_UNICAST_PKT_ENABLE(__cmd, __value) \
  154. SET_BITS_TO_LE_1BYTE(__cmd, 3, 1, __value)
  155. #define SET_8812_H2CCMD_WOWLAN_ALL_PKT_DROP(__cmd, __value) \
  156. SET_BITS_TO_LE_1BYTE(__cmd, 4, 1, __value)
  157. #define SET_8812_H2CCMD_WOWLAN_GPIO_ACTIVE(__cmd, __value) \
  158. SET_BITS_TO_LE_1BYTE(__cmd, 5, 1, __value)
  159. #define SET_8812_H2CCMD_WOWLAN_REKEY_WAKE_UP(__cmd, __value) \
  160. SET_BITS_TO_LE_1BYTE(__cmd, 6, 1, __value)
  161. #define SET_8812_H2CCMD_WOWLAN_DISCONNECT_WAKE_UP(__cmd, __value) \
  162. SET_BITS_TO_LE_1BYTE(__cmd, 7, 1, __value)
  163. #define SET_8812_H2CCMD_WOWLAN_GPIONUM(__cmd, __value) \
  164. SET_BITS_TO_LE_1BYTE((__cmd) + 1, 0, 8, __value)
  165. #define SET_8812_H2CCMD_WOWLAN_GPIO_DURATION(__cmd, __value) \
  166. SET_BITS_TO_LE_1BYTE((__cmd) + 2, 0, 8, __value)
  167. #define SET_H2CCMD_PWRMODE_PARM_MODE(__ph2ccmd, __val) \
  168. SET_BITS_TO_LE_1BYTE(__ph2ccmd, 0, 8, __val)
  169. #define SET_H2CCMD_PWRMODE_PARM_RLBM(__cmd, __value) \
  170. SET_BITS_TO_LE_1BYTE((__cmd)+1, 0, 4, __value)
  171. #define SET_H2CCMD_PWRMODE_PARM_SMART_PS(__cmd, __value) \
  172. SET_BITS_TO_LE_1BYTE((__cmd)+1, 4, 4, __value)
  173. #define SET_H2CCMD_PWRMODE_PARM_AWAKE_INTERVAL(__cmd, __value) \
  174. SET_BITS_TO_LE_1BYTE((__cmd)+2, 0, 8, __value)
  175. #define SET_H2CCMD_PWRMODE_PARM_ALL_QUEUE_UAPSD(__cmd, __value) \
  176. SET_BITS_TO_LE_1BYTE((__cmd)+3, 0, 8, __value)
  177. #define SET_H2CCMD_PWRMODE_PARM_PWR_STATE(__cmd, __value) \
  178. SET_BITS_TO_LE_1BYTE((__cmd)+4, 0, 8, __value)
  179. #define SET_H2CCMD_PWRMODE_PARM_BYTE5(__cmd, __value) \
  180. SET_BITS_TO_LE_1BYTE((__cmd) + 5, 0, 8, __value)
  181. #define GET_8821AE_H2CCMD_PWRMODE_PARM_MODE(__cmd) \
  182. LE_BITS_TO_1BYTE(__cmd, 0, 8)
  183. #define SET_H2CCMD_JOINBSSRPT_PARM_OPMODE(__ph2ccmd, __val) \
  184. SET_BITS_TO_LE_1BYTE(__ph2ccmd, 0, 8, __val)
  185. #define SET_H2CCMD_RSVDPAGE_LOC_PSPOLL(__ph2ccmd, __val) \
  186. SET_BITS_TO_LE_1BYTE((__ph2ccmd)+1, 0, 8, __val)
  187. #define SET_H2CCMD_RSVDPAGE_LOC_NULL_DATA(__ph2ccmd, __val) \
  188. SET_BITS_TO_LE_1BYTE((__ph2ccmd)+2, 0, 8, __val)
  189. #define SET_H2CCMD_RSVDPAGE_LOC_QOS_NULL_DATA(__ph2ccmd, __val) \
  190. SET_BITS_TO_LE_1BYTE((__ph2ccmd)+3, 0, 8, __val)
  191. #define SET_H2CCMD_RSVDPAGE_LOC_BT_QOS_NULL_DATA(__ph2ccmd, __val) \
  192. SET_BITS_TO_LE_1BYTE((__ph2ccmd) + 4, 0, 8, __val)
  193. /* _MEDIA_STATUS_RPT_PARM_CMD1 */
  194. #define SET_H2CCMD_MSRRPT_PARM_OPMODE(__cmd, __value) \
  195. SET_BITS_TO_LE_1BYTE(__cmd, 0, 1, __value)
  196. #define SET_H2CCMD_MSRRPT_PARM_MACID_IND(__cmd, __value) \
  197. SET_BITS_TO_LE_1BYTE(__cmd, 1, 1, __value)
  198. #define SET_H2CCMD_MSRRPT_PARM_MACID(__cmd, __value) \
  199. SET_BITS_TO_LE_1BYTE(__cmd+1, 0, 8, __value)
  200. #define SET_H2CCMD_MSRRPT_PARM_MACID_END(__cmd, __value) \
  201. SET_BITS_TO_LE_1BYTE(__cmd+2, 0, 8, __value)
  202. /* AP_OFFLOAD */
  203. #define SET_H2CCMD_AP_OFFLOAD_ON(__cmd, __value) \
  204. SET_BITS_TO_LE_1BYTE(__cmd, 0, 8, __value)
  205. #define SET_H2CCMD_AP_OFFLOAD_HIDDEN(__cmd, __value) \
  206. SET_BITS_TO_LE_1BYTE((__cmd)+1, 0, 8, __value)
  207. #define SET_H2CCMD_AP_OFFLOAD_DENYANY(__cmd, __value) \
  208. SET_BITS_TO_LE_1BYTE((__cmd)+2, 0, 8, __value)
  209. #define SET_H2CCMD_AP_OFFLOAD_WAKEUP_EVT_RPT(__cmd, __value) \
  210. SET_BITS_TO_LE_1BYTE((__cmd)+3, 0, 8, __value)
  211. /* Keep Alive Control*/
  212. #define SET_8812_H2CCMD_KEEP_ALIVE_ENABLE(__cmd, __value) \
  213. SET_BITS_TO_LE_1BYTE(__cmd, 0, 1, __value)
  214. #define SET_8812_H2CCMD_KEEP_ALIVE_ACCPEPT_USER_DEFINED(__cmd, __value) \
  215. SET_BITS_TO_LE_1BYTE(__cmd, 1, 1, __value)
  216. #define SET_8812_H2CCMD_KEEP_ALIVE_PERIOD(__cmd, __value) \
  217. SET_BITS_TO_LE_1BYTE((__cmd)+1, 0, 8, __value)
  218. /*REMOTE_WAKE_CTRL */
  219. #define SET_8812_H2CCMD_REMOTE_WAKECTRL_ENABLE(__cmd, __value) \
  220. SET_BITS_TO_LE_1BYTE(__cmd, 0, 1, __value)
  221. #define SET_8812_H2CCMD_REMOTE_WAKE_CTRL_ARP_OFFLOAD_EN(__cmd, __value)\
  222. SET_BITS_TO_LE_1BYTE(__cmd, 1, 1, __value)
  223. #define SET_8812_H2CCMD_REMOTE_WAKE_CTRL_NDP_OFFLOAD_EN(__cmd, __value)\
  224. SET_BITS_TO_LE_1BYTE(__cmd, 2, 1, __value)
  225. #define SET_8812_H2CCMD_REMOTE_WAKE_CTRL_GTK_OFFLOAD_EN(__cmd, __value)\
  226. SET_BITS_TO_LE_1BYTE(__cmd, 3, 1, __value)
  227. #define SET_8812_H2CCMD_REMOTE_WAKE_CTRL_REALWOWV2_EN(__cmd, __value)\
  228. SET_BITS_TO_LE_1BYTE(__cmd, 6, 1, __value)
  229. /* GTK_OFFLOAD */
  230. #define SET_8812_H2CCMD_AOAC_GLOBAL_INFO_PAIRWISE_ENC_ALG(__cmd, __value)\
  231. SET_BITS_TO_LE_1BYTE(__cmd, 0, 8, __value)
  232. #define SET_8812_H2CCMD_AOAC_GLOBAL_INFO_GROUP_ENC_ALG(__cmd, __value) \
  233. SET_BITS_TO_LE_1BYTE((__cmd)+1, 0, 8, __value)
  234. /* AOAC_RSVDPAGE_LOC */
  235. #define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_REMOTE_WAKE_CTRL_INFO(__cmd, __value) \
  236. SET_BITS_TO_LE_1BYTE((__cmd), 0, 8, __value)
  237. #define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_ARP_RSP(__cmd, __value) \
  238. SET_BITS_TO_LE_1BYTE((__cmd)+1, 0, 8, __value)
  239. #define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_NEIGHBOR_ADV(__cmd, __value)\
  240. SET_BITS_TO_LE_1BYTE((__cmd)+2, 0, 8, __value)
  241. #define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_GTK_RSP(__cmd, __value) \
  242. SET_BITS_TO_LE_1BYTE((__cmd)+3, 0, 8, __value)
  243. #define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_GTK_INFO(__cmd, __value) \
  244. SET_BITS_TO_LE_1BYTE((__cmd)+4, 0, 8, __value)
  245. #define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_GTK_EXT_MEM(__cmd, __value) \
  246. SET_BITS_TO_LE_1BYTE((__cmd)+5, 0, 8, __value)
  247. /* Disconnect_Decision_Control */
  248. #define SET_8812_H2CCMD_DISCONNECT_DECISION_CTRL_ENABLE(__cmd, __value) \
  249. SET_BITS_TO_LE_1BYTE(__cmd, 0, 1, __value)
  250. #define SET_8812_H2CCMD_DISCONNECT_DECISION_CTRL_USER_SETTING(__cmd, __value)\
  251. SET_BITS_TO_LE_1BYTE(__cmd, 1, 1, __value)
  252. #define SET_8812_H2CCMD_DISCONNECT_DECISION_CTRL_CHECK_PERIOD(__cmd, __value)\
  253. SET_BITS_TO_LE_1BYTE((__cmd)+1, 0, 8, __value) /* unit: beacon period */
  254. #define SET_8812_H2CCMD_DISCONNECT_DECISION_CTRL_TRYPKT_NUM(__cmd, __value)\
  255. SET_BITS_TO_LE_1BYTE((__cmd)+2, 0, 8, __value)
  256. int rtl8821ae_download_fw(struct ieee80211_hw *hw, bool buse_wake_on_wlan_fw);
  257. #if (USE_SPECIFIC_FW_TO_SUPPORT_WOWLAN == 1)
  258. void rtl8821ae_set_fw_related_for_wowlan(struct ieee80211_hw *hw,
  259. bool used_wowlan_fw);
  260. #endif
  261. void rtl8821ae_fill_h2c_cmd(struct ieee80211_hw *hw, u8 element_id,
  262. u32 cmd_len, u8 *cmdbuffer);
  263. void rtl8821ae_firmware_selfreset(struct ieee80211_hw *hw);
  264. void rtl8821ae_set_fw_pwrmode_cmd(struct ieee80211_hw *hw, u8 mode);
  265. void rtl8821ae_set_fw_media_status_rpt_cmd(struct ieee80211_hw *hw,
  266. u8 mstatus);
  267. void rtl8821ae_set_fw_ap_off_load_cmd(struct ieee80211_hw *hw,
  268. u8 ap_offload_enable);
  269. void rtl8821ae_set_fw_rsvdpagepkt(struct ieee80211_hw *hw,
  270. bool b_dl_finished, bool dl_whole_packet);
  271. void rtl8812ae_set_fw_rsvdpagepkt(struct ieee80211_hw *hw,
  272. bool b_dl_finished, bool dl_whole_packet);
  273. void rtl8821ae_set_p2p_ps_offload_cmd(struct ieee80211_hw *hw,
  274. u8 p2p_ps_state);
  275. void rtl8821ae_set_fw_wowlan_mode(struct ieee80211_hw *hw, bool func_en);
  276. void rtl8821ae_set_fw_remote_wake_ctrl_cmd(struct ieee80211_hw *hw,
  277. u8 enable);
  278. void rtl8821ae_set_fw_keep_alive_cmd(struct ieee80211_hw *hw, bool func_en);
  279. void rtl8821ae_set_fw_disconnect_decision_ctrl_cmd(struct ieee80211_hw *hw,
  280. bool enabled);
  281. void rtl8821ae_set_fw_global_info_cmd(struct ieee80211_hw *hw);
  282. void rtl8821ae_c2h_ra_report_handler(struct ieee80211_hw *hw,
  283. u8 *cmd_buf, u8 cmd_len);
  284. #endif