1 /******************************************************************************
2  *
3  * Copyright(c) 2009-2014  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  *
22  * Larry Finger <Larry.Finger@lwfinger.net>
23  *
24  *****************************************************************************/
25 
26 #ifndef __FW_COMMON_H__
27 #define __FW_COMMON_H__
28 
29 #define REG_SYS_FUNC_EN				0x0002
30 #define REG_MCUFWDL				0x0080
31 #define FW_8192C_START_ADDRESS			0x1000
32 #define FW_8192C_PAGE_SIZE			4096
33 #define FW_8723A_POLLING_TIMEOUT_COUNT		1000
34 #define FW_8723B_POLLING_TIMEOUT_COUNT		6000
35 #define FW_8192C_POLLING_DELAY			5
36 
37 #define MCUFWDL_RDY				BIT(1)
38 #define FWDL_CHKSUM_RPT				BIT(2)
39 #define WINTINI_RDY				BIT(6)
40 
41 #define REG_RSV_CTRL				0x001C
42 #define REG_HMETFR				0x01CC
43 
44 enum version_8723e {
45 	VERSION_TEST_UMC_CHIP_8723 = 0x0081,
46 	VERSION_NORMAL_UMC_CHIP_8723_1T1R_A_CUT = 0x0089,
47 	VERSION_NORMAL_UMC_CHIP_8723_1T1R_B_CUT = 0x1089,
48 	VERSION_TEST_CHIP_1T1R_8723B = 0x0106,
49 	VERSION_NORMAL_SMIC_CHIP_1T1R_8723B = 0x010E,
50 	VERSION_UNKNOWN = 0xFF,
51 };
52 
53 enum rtl8723be_cmd {
54 	H2C_8723BE_RSVDPAGE = 0,
55 	H2C_8723BE_JOINBSSRPT = 1,
56 	H2C_8723BE_SCAN = 2,
57 	H2C_8723BE_KEEP_ALIVE_CTRL = 3,
58 	H2C_8723BE_DISCONNECT_DECISION = 4,
59 	H2C_8723BE_INIT_OFFLOAD = 6,
60 	H2C_8723BE_AP_OFFLOAD = 8,
61 	H2C_8723BE_BCN_RSVDPAGE = 9,
62 	H2C_8723BE_PROBERSP_RSVDPAGE = 10,
63 
64 	H2C_8723BE_SETPWRMODE = 0x20,
65 	H2C_8723BE_PS_TUNING_PARA = 0x21,
66 	H2C_8723BE_PS_TUNING_PARA2 = 0x22,
67 	H2C_8723BE_PS_LPS_PARA = 0x23,
68 	H2C_8723BE_P2P_PS_OFFLOAD = 0x24,
69 
70 	H2C_8723BE_WO_WLAN = 0x80,
71 	H2C_8723BE_REMOTE_WAKE_CTRL = 0x81,
72 	H2C_8723BE_AOAC_GLOBAL_INFO = 0x82,
73 	H2C_8723BE_AOAC_RSVDPAGE = 0x83,
74 	H2C_8723BE_RSSI_REPORT = 0x42,
75 	H2C_8723BE_RA_MASK = 0x40,
76 	H2C_8723BE_SELECTIVE_SUSPEND_ROF_CMD,
77 	H2C_8723BE_P2P_PS_MODE,
78 	H2C_8723BE_PSD_RESULT,
79 	/*Not defined CTW CMD for P2P yet*/
80 	H2C_8723BE_P2P_PS_CTW_CMD,
81 	MAX_8723BE_H2CCMD
82 };
83 
84 void rtl8723ae_firmware_selfreset(struct ieee80211_hw *hw);
85 void rtl8723be_firmware_selfreset(struct ieee80211_hw *hw);
86 void rtl8723_enable_fw_download(struct ieee80211_hw *hw, bool enable);
87 void rtl8723_fw_block_write(struct ieee80211_hw *hw,
88 			    const u8 *buffer, u32 size);
89 void rtl8723_fw_page_write(struct ieee80211_hw *hw,
90 			   u32 page, const u8 *buffer, u32 size);
91 void rtl8723_write_fw(struct ieee80211_hw *hw,
92 		      enum version_8723e version,
93 		      u8 *buffer, u32 size, u8 max_page);
94 int rtl8723_fw_free_to_go(struct ieee80211_hw *hw, bool is_8723be, int count);
95 int rtl8723_download_fw(struct ieee80211_hw *hw, bool is_8723be, int count);
96 bool rtl8723_cmd_send_packet(struct ieee80211_hw *hw,
97 			     struct sk_buff *skb);
98 void rtl8723_fill_dummy(u8 *pfwbuf, u32 *pfwlen);
99 
100 #endif
101