1 /******************************************************************************
2  *
3  * Copyright(c) 2009-2013  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 #include "../wifi.h"
27 #include "../core.h"
28 #include "../pci.h"
29 #include "reg.h"
30 #include "def.h"
31 #include "phy.h"
32 #include "dm.h"
33 #include "hw.h"
34 #include "sw.h"
35 #include "trx.h"
36 #include "led.h"
37 #include "table.h"
38 
39 #include <linux/vmalloc.h>
40 #include <linux/module.h>
41 
42 static void rtl88e_init_aspm_vars(struct ieee80211_hw *hw)
43 {
44 	struct rtl_pci *rtlpci = rtl_pcidev(rtl_pcipriv(hw));
45 
46 	/*close ASPM for AMD defaultly */
47 	rtlpci->const_amdpci_aspm = 0;
48 
49 	/* ASPM PS mode.
50 	 * 0 - Disable ASPM,
51 	 * 1 - Enable ASPM without Clock Req,
52 	 * 2 - Enable ASPM with Clock Req,
53 	 * 3 - Alwyas Enable ASPM with Clock Req,
54 	 * 4 - Always Enable ASPM without Clock Req.
55 	 * set defult to RTL8192CE:3 RTL8192E:2
56 	 */
57 	rtlpci->const_pci_aspm = 3;
58 
59 	/*Setting for PCI-E device */
60 	rtlpci->const_devicepci_aspm_setting = 0x03;
61 
62 	/*Setting for PCI-E bridge */
63 	rtlpci->const_hostpci_aspm_setting = 0x02;
64 
65 	/* In Hw/Sw Radio Off situation.
66 	 * 0 - Default,
67 	 * 1 - From ASPM setting without low Mac Pwr,
68 	 * 2 - From ASPM setting with low Mac Pwr,
69 	 * 3 - Bus D3
70 	 * set default to RTL8192CE:0 RTL8192SE:2
71 	 */
72 	rtlpci->const_hwsw_rfoff_d3 = 0;
73 
74 	/* This setting works for those device with
75 	 * backdoor ASPM setting such as EPHY setting.
76 	 * 0 - Not support ASPM,
77 	 * 1 - Support ASPM,
78 	 * 2 - According to chipset.
79 	 */
80 	rtlpci->const_support_pciaspm = 1;
81 }
82 
83 int rtl88e_init_sw_vars(struct ieee80211_hw *hw)
84 {
85 	int err = 0;
86 	struct rtl_priv *rtlpriv = rtl_priv(hw);
87 	struct rtl_pci *rtlpci = rtl_pcidev(rtl_pcipriv(hw));
88 	u8 tid;
89 
90 	rtl8188ee_bt_reg_init(hw);
91 	rtlpriv->dm.dm_initialgain_enable = 1;
92 	rtlpriv->dm.dm_flag = 0;
93 	rtlpriv->dm.disable_framebursting = 0;
94 	rtlpriv->dm.thermalvalue = 0;
95 	rtlpci->transmit_config = CFENDFORM | BIT(15);
96 
97 	/* compatible 5G band 88ce just 2.4G band & smsp */
98 	rtlpriv->rtlhal.current_bandtype = BAND_ON_2_4G;
99 	rtlpriv->rtlhal.bandset = BAND_ON_2_4G;
100 	rtlpriv->rtlhal.macphymode = SINGLEMAC_SINGLEPHY;
101 
102 	rtlpci->receive_config = (RCR_APPFCS |
103 				  RCR_APP_MIC |
104 				  RCR_APP_ICV |
105 				  RCR_APP_PHYST_RXFF |
106 				  RCR_HTC_LOC_CTRL |
107 				  RCR_AMF |
108 				  RCR_ACF |
109 				  RCR_ADF |
110 				  RCR_AICV |
111 				  RCR_ACRC32 |
112 				  RCR_AB |
113 				  RCR_AM |
114 				  RCR_APM |
115 				  0);
116 
117 	rtlpci->irq_mask[0] =
118 				(u32)(IMR_PSTIMEOUT	|
119 				IMR_HSISR_IND_ON_INT	|
120 				IMR_C2HCMD		|
121 				IMR_HIGHDOK		|
122 				IMR_MGNTDOK		|
123 				IMR_BKDOK		|
124 				IMR_BEDOK		|
125 				IMR_VIDOK		|
126 				IMR_VODOK		|
127 				IMR_RDU			|
128 				IMR_ROK			|
129 				0);
130 	rtlpci->irq_mask[1] = (u32) (IMR_RXFOVW | 0);
131 	rtlpci->sys_irq_mask = (u32) (HSIMR_PDN_INT_EN | HSIMR_RON_INT_EN);
132 
133 	/* for debug level */
134 	rtlpriv->dbg.global_debuglevel = rtlpriv->cfg->mod_params->debug;
135 	/* for LPS & IPS */
136 	rtlpriv->psc.inactiveps = rtlpriv->cfg->mod_params->inactiveps;
137 	rtlpriv->psc.swctrl_lps = rtlpriv->cfg->mod_params->swctrl_lps;
138 	rtlpriv->psc.fwctrl_lps = rtlpriv->cfg->mod_params->fwctrl_lps;
139 	rtlpci->msi_support = rtlpriv->cfg->mod_params->msi_support;
140 	rtlpriv->cfg->mod_params->sw_crypto =
141 		rtlpriv->cfg->mod_params->sw_crypto;
142 	rtlpriv->cfg->mod_params->disable_watchdog =
143 		rtlpriv->cfg->mod_params->disable_watchdog;
144 	if (rtlpriv->cfg->mod_params->disable_watchdog)
145 		pr_info("watchdog disabled\n");
146 	if (!rtlpriv->psc.inactiveps)
147 		pr_info("rtl8188ee: Power Save off (module option)\n");
148 	if (!rtlpriv->psc.fwctrl_lps)
149 		pr_info("rtl8188ee: FW Power Save off (module option)\n");
150 	rtlpriv->psc.reg_fwctrl_lps = 3;
151 	rtlpriv->psc.reg_max_lps_awakeintvl = 5;
152 	/* for ASPM, you can close aspm through
153 	 * set const_support_pciaspm = 0
154 	 */
155 	rtl88e_init_aspm_vars(hw);
156 
157 	if (rtlpriv->psc.reg_fwctrl_lps == 1)
158 		rtlpriv->psc.fwctrl_psmode = FW_PS_MIN_MODE;
159 	else if (rtlpriv->psc.reg_fwctrl_lps == 2)
160 		rtlpriv->psc.fwctrl_psmode = FW_PS_MAX_MODE;
161 	else if (rtlpriv->psc.reg_fwctrl_lps == 3)
162 		rtlpriv->psc.fwctrl_psmode = FW_PS_DTIM_MODE;
163 
164 	/* for firmware buf */
165 	rtlpriv->rtlhal.pfirmware = vzalloc(0x8000);
166 	if (!rtlpriv->rtlhal.pfirmware) {
167 		RT_TRACE(rtlpriv, COMP_ERR, DBG_EMERG,
168 			 "Can't alloc buffer for fw.\n");
169 		return 1;
170 	}
171 
172 	rtlpriv->cfg->fw_name = "rtlwifi/rtl8188efw.bin";
173 	rtlpriv->max_fw_size = 0x8000;
174 	pr_info("Using firmware %s\n", rtlpriv->cfg->fw_name);
175 	err = request_firmware_nowait(THIS_MODULE, 1, rtlpriv->cfg->fw_name,
176 				      rtlpriv->io.dev, GFP_KERNEL, hw,
177 				      rtl_fw_cb);
178 	if (err) {
179 		RT_TRACE(rtlpriv, COMP_ERR, DBG_EMERG,
180 			 "Failed to request firmware!\n");
181 		return 1;
182 	}
183 
184 	/* for early mode */
185 	rtlpriv->rtlhal.earlymode_enable = false;
186 	rtlpriv->rtlhal.max_earlymode_num = 10;
187 	for (tid = 0; tid < 8; tid++)
188 		skb_queue_head_init(&rtlpriv->mac80211.skb_waitq[tid]);
189 
190 	/*low power */
191 	rtlpriv->psc.low_power_enable = false;
192 	if (rtlpriv->psc.low_power_enable) {
193 		init_timer(&rtlpriv->works.fw_clockoff_timer);
194 		setup_timer(&rtlpriv->works.fw_clockoff_timer,
195 			    rtl88ee_fw_clk_off_timer_callback,
196 			    (unsigned long)hw);
197 	}
198 
199 	init_timer(&rtlpriv->works.fast_antenna_training_timer);
200 	setup_timer(&rtlpriv->works.fast_antenna_training_timer,
201 		    rtl88e_dm_fast_antenna_training_callback,
202 			(unsigned long)hw);
203 	return err;
204 }
205 
206 void rtl88e_deinit_sw_vars(struct ieee80211_hw *hw)
207 {
208 	struct rtl_priv *rtlpriv = rtl_priv(hw);
209 
210 	if (rtlpriv->rtlhal.pfirmware) {
211 		vfree(rtlpriv->rtlhal.pfirmware);
212 		rtlpriv->rtlhal.pfirmware = NULL;
213 	}
214 
215 	if (rtlpriv->psc.low_power_enable)
216 		del_timer_sync(&rtlpriv->works.fw_clockoff_timer);
217 
218 	del_timer_sync(&rtlpriv->works.fast_antenna_training_timer);
219 }
220 
221 /* get bt coexist status */
222 bool rtl88e_get_btc_status(void)
223 {
224 	return false;
225 }
226 
227 static struct rtl_hal_ops rtl8188ee_hal_ops = {
228 	.init_sw_vars = rtl88e_init_sw_vars,
229 	.deinit_sw_vars = rtl88e_deinit_sw_vars,
230 	.read_eeprom_info = rtl88ee_read_eeprom_info,
231 	.interrupt_recognized = rtl88ee_interrupt_recognized,/*need check*/
232 	.hw_init = rtl88ee_hw_init,
233 	.hw_disable = rtl88ee_card_disable,
234 	.hw_suspend = rtl88ee_suspend,
235 	.hw_resume = rtl88ee_resume,
236 	.enable_interrupt = rtl88ee_enable_interrupt,
237 	.disable_interrupt = rtl88ee_disable_interrupt,
238 	.set_network_type = rtl88ee_set_network_type,
239 	.set_chk_bssid = rtl88ee_set_check_bssid,
240 	.set_qos = rtl88ee_set_qos,
241 	.set_bcn_reg = rtl88ee_set_beacon_related_registers,
242 	.set_bcn_intv = rtl88ee_set_beacon_interval,
243 	.update_interrupt_mask = rtl88ee_update_interrupt_mask,
244 	.get_hw_reg = rtl88ee_get_hw_reg,
245 	.set_hw_reg = rtl88ee_set_hw_reg,
246 	.update_rate_tbl = rtl88ee_update_hal_rate_tbl,
247 	.fill_tx_desc = rtl88ee_tx_fill_desc,
248 	.fill_tx_cmddesc = rtl88ee_tx_fill_cmddesc,
249 	.query_rx_desc = rtl88ee_rx_query_desc,
250 	.set_channel_access = rtl88ee_update_channel_access_setting,
251 	.radio_onoff_checking = rtl88ee_gpio_radio_on_off_checking,
252 	.set_bw_mode = rtl88e_phy_set_bw_mode,
253 	.switch_channel = rtl88e_phy_sw_chnl,
254 	.dm_watchdog = rtl88e_dm_watchdog,
255 	.scan_operation_backup = rtl88e_phy_scan_operation_backup,
256 	.set_rf_power_state = rtl88e_phy_set_rf_power_state,
257 	.led_control = rtl88ee_led_control,
258 	.set_desc = rtl88ee_set_desc,
259 	.get_desc = rtl88ee_get_desc,
260 	.is_tx_desc_closed = rtl88ee_is_tx_desc_closed,
261 	.tx_polling = rtl88ee_tx_polling,
262 	.enable_hw_sec = rtl88ee_enable_hw_security_config,
263 	.set_key = rtl88ee_set_key,
264 	.init_sw_leds = rtl88ee_init_sw_leds,
265 	.get_bbreg = rtl88e_phy_query_bb_reg,
266 	.set_bbreg = rtl88e_phy_set_bb_reg,
267 	.get_rfreg = rtl88e_phy_query_rf_reg,
268 	.set_rfreg = rtl88e_phy_set_rf_reg,
269 	.get_btc_status = rtl88e_get_btc_status,
270 	.rx_command_packet = rtl88ee_rx_command_packet,
271 
272 };
273 
274 static struct rtl_mod_params rtl88ee_mod_params = {
275 	.sw_crypto = false,
276 	.inactiveps = false,
277 	.swctrl_lps = false,
278 	.fwctrl_lps = false,
279 	.msi_support = true,
280 	.debug = DBG_EMERG,
281 };
282 
283 static struct rtl_hal_cfg rtl88ee_hal_cfg = {
284 	.bar_id = 2,
285 	.write_readback = true,
286 	.name = "rtl88e_pci",
287 	.fw_name = "rtlwifi/rtl8188efw.bin",
288 	.ops = &rtl8188ee_hal_ops,
289 	.mod_params = &rtl88ee_mod_params,
290 
291 	.maps[SYS_ISO_CTRL] = REG_SYS_ISO_CTRL,
292 	.maps[SYS_FUNC_EN] = REG_SYS_FUNC_EN,
293 	.maps[SYS_CLK] = REG_SYS_CLKR,
294 	.maps[MAC_RCR_AM] = AM,
295 	.maps[MAC_RCR_AB] = AB,
296 	.maps[MAC_RCR_ACRC32] = ACRC32,
297 	.maps[MAC_RCR_ACF] = ACF,
298 	.maps[MAC_RCR_AAP] = AAP,
299 	.maps[MAC_HIMR] = REG_HIMR,
300 	.maps[MAC_HIMRE] = REG_HIMRE,
301 	.maps[MAC_HSISR] = REG_HSISR,
302 
303 	.maps[EFUSE_ACCESS] = REG_EFUSE_ACCESS,
304 
305 	.maps[EFUSE_TEST] = REG_EFUSE_TEST,
306 	.maps[EFUSE_CTRL] = REG_EFUSE_CTRL,
307 	.maps[EFUSE_CLK] = 0,
308 	.maps[EFUSE_CLK_CTRL] = REG_EFUSE_CTRL,
309 	.maps[EFUSE_PWC_EV12V] = PWC_EV12V,
310 	.maps[EFUSE_FEN_ELDR] = FEN_ELDR,
311 	.maps[EFUSE_LOADER_CLK_EN] = LOADER_CLK_EN,
312 	.maps[EFUSE_ANA8M] = ANA8M,
313 	.maps[EFUSE_HWSET_MAX_SIZE] = HWSET_MAX_SIZE,
314 	.maps[EFUSE_MAX_SECTION_MAP] = EFUSE_MAX_SECTION,
315 	.maps[EFUSE_REAL_CONTENT_SIZE] = EFUSE_REAL_CONTENT_LEN,
316 	.maps[EFUSE_OOB_PROTECT_BYTES_LEN] = EFUSE_OOB_PROTECT_BYTES,
317 
318 	.maps[RWCAM] = REG_CAMCMD,
319 	.maps[WCAMI] = REG_CAMWRITE,
320 	.maps[RCAMO] = REG_CAMREAD,
321 	.maps[CAMDBG] = REG_CAMDBG,
322 	.maps[SECR] = REG_SECCFG,
323 	.maps[SEC_CAM_NONE] = CAM_NONE,
324 	.maps[SEC_CAM_WEP40] = CAM_WEP40,
325 	.maps[SEC_CAM_TKIP] = CAM_TKIP,
326 	.maps[SEC_CAM_AES] = CAM_AES,
327 	.maps[SEC_CAM_WEP104] = CAM_WEP104,
328 
329 	.maps[RTL_IMR_BCNDMAINT6] = IMR_BCNDMAINT6,
330 	.maps[RTL_IMR_BCNDMAINT5] = IMR_BCNDMAINT5,
331 	.maps[RTL_IMR_BCNDMAINT4] = IMR_BCNDMAINT4,
332 	.maps[RTL_IMR_BCNDMAINT3] = IMR_BCNDMAINT3,
333 	.maps[RTL_IMR_BCNDMAINT2] = IMR_BCNDMAINT2,
334 	.maps[RTL_IMR_BCNDMAINT1] = IMR_BCNDMAINT1,
335 /*	.maps[RTL_IMR_BCNDOK8] = IMR_BCNDOK8,     */   /*need check*/
336 	.maps[RTL_IMR_BCNDOK7] = IMR_BCNDOK7,
337 	.maps[RTL_IMR_BCNDOK6] = IMR_BCNDOK6,
338 	.maps[RTL_IMR_BCNDOK5] = IMR_BCNDOK5,
339 	.maps[RTL_IMR_BCNDOK4] = IMR_BCNDOK4,
340 	.maps[RTL_IMR_BCNDOK3] = IMR_BCNDOK3,
341 	.maps[RTL_IMR_BCNDOK2] = IMR_BCNDOK2,
342 	.maps[RTL_IMR_BCNDOK1] = IMR_BCNDOK1,
343 /*	.maps[RTL_IMR_TIMEOUT2] = IMR_TIMEOUT2,*/
344 /*	.maps[RTL_IMR_TIMEOUT1] = IMR_TIMEOUT1,*/
345 
346 	.maps[RTL_IMR_TXFOVW] = IMR_TXFOVW,
347 	.maps[RTL_IMR_PSTIMEOUT] = IMR_PSTIMEOUT,
348 	.maps[RTL_IMR_BCNINT] = IMR_BCNDMAINT0,
349 	.maps[RTL_IMR_RXFOVW] = IMR_RXFOVW,
350 	.maps[RTL_IMR_RDU] = IMR_RDU,
351 	.maps[RTL_IMR_ATIMEND] = IMR_ATIMEND,
352 	.maps[RTL_IMR_BDOK] = IMR_BCNDOK0,
353 	.maps[RTL_IMR_MGNTDOK] = IMR_MGNTDOK,
354 	.maps[RTL_IMR_TBDER] = IMR_TBDER,
355 	.maps[RTL_IMR_HIGHDOK] = IMR_HIGHDOK,
356 	.maps[RTL_IMR_TBDOK] = IMR_TBDOK,
357 	.maps[RTL_IMR_BKDOK] = IMR_BKDOK,
358 	.maps[RTL_IMR_BEDOK] = IMR_BEDOK,
359 	.maps[RTL_IMR_VIDOK] = IMR_VIDOK,
360 	.maps[RTL_IMR_VODOK] = IMR_VODOK,
361 	.maps[RTL_IMR_ROK] = IMR_ROK,
362 	.maps[RTL_IMR_HSISR_IND] = IMR_HSISR_IND_ON_INT,
363 	.maps[RTL_IBSS_INT_MASKS] = (IMR_BCNDMAINT0 | IMR_TBDOK | IMR_TBDER),
364 
365 	.maps[RTL_RC_CCK_RATE1M] = DESC92C_RATE1M,
366 	.maps[RTL_RC_CCK_RATE2M] = DESC92C_RATE2M,
367 	.maps[RTL_RC_CCK_RATE5_5M] = DESC92C_RATE5_5M,
368 	.maps[RTL_RC_CCK_RATE11M] = DESC92C_RATE11M,
369 	.maps[RTL_RC_OFDM_RATE6M] = DESC92C_RATE6M,
370 	.maps[RTL_RC_OFDM_RATE9M] = DESC92C_RATE9M,
371 	.maps[RTL_RC_OFDM_RATE12M] = DESC92C_RATE12M,
372 	.maps[RTL_RC_OFDM_RATE18M] = DESC92C_RATE18M,
373 	.maps[RTL_RC_OFDM_RATE24M] = DESC92C_RATE24M,
374 	.maps[RTL_RC_OFDM_RATE36M] = DESC92C_RATE36M,
375 	.maps[RTL_RC_OFDM_RATE48M] = DESC92C_RATE48M,
376 	.maps[RTL_RC_OFDM_RATE54M] = DESC92C_RATE54M,
377 
378 	.maps[RTL_RC_HT_RATEMCS7] = DESC92C_RATEMCS7,
379 	.maps[RTL_RC_HT_RATEMCS15] = DESC92C_RATEMCS15,
380 };
381 
382 static struct pci_device_id rtl88ee_pci_ids[] = {
383 	{RTL_PCI_DEVICE(PCI_VENDOR_ID_REALTEK, 0x8179, rtl88ee_hal_cfg)},
384 	{},
385 };
386 
387 MODULE_DEVICE_TABLE(pci, rtl88ee_pci_ids);
388 
389 MODULE_AUTHOR("zhiyuan_yang	<zhiyuan_yang@realsil.com.cn>");
390 MODULE_AUTHOR("Realtek WlanFAE	<wlanfae@realtek.com>");
391 MODULE_AUTHOR("Larry Finger	<Larry.Finger@lwfinger.net>");
392 MODULE_LICENSE("GPL");
393 MODULE_DESCRIPTION("Realtek 8188E 802.11n PCI wireless");
394 MODULE_FIRMWARE("rtlwifi/rtl8188efw.bin");
395 
396 module_param_named(swenc, rtl88ee_mod_params.sw_crypto, bool, 0444);
397 module_param_named(debug, rtl88ee_mod_params.debug, int, 0444);
398 module_param_named(ips, rtl88ee_mod_params.inactiveps, bool, 0444);
399 module_param_named(swlps, rtl88ee_mod_params.swctrl_lps, bool, 0444);
400 module_param_named(fwlps, rtl88ee_mod_params.fwctrl_lps, bool, 0444);
401 module_param_named(msi, rtl88ee_mod_params.msi_support, bool, 0444);
402 module_param_named(disable_watchdog, rtl88ee_mod_params.disable_watchdog,
403 		   bool, 0444);
404 MODULE_PARM_DESC(swenc, "Set to 1 for software crypto (default 0)\n");
405 MODULE_PARM_DESC(ips, "Set to 0 to not use link power save (default 1)\n");
406 MODULE_PARM_DESC(swlps, "Set to 1 to use SW control power save (default 0)\n");
407 MODULE_PARM_DESC(fwlps, "Set to 1 to use FW control power save (default 1)\n");
408 MODULE_PARM_DESC(msi, "Set to 1 to use MSI interrupts mode (default 1)\n");
409 MODULE_PARM_DESC(debug, "Set debug level (0-5) (default 0)");
410 MODULE_PARM_DESC(disable_watchdog, "Set to 1 to disable the watchdog (default 0)\n");
411 
412 static SIMPLE_DEV_PM_OPS(rtlwifi_pm_ops, rtl_pci_suspend, rtl_pci_resume);
413 
414 static struct pci_driver rtl88ee_driver = {
415 	.name = KBUILD_MODNAME,
416 	.id_table = rtl88ee_pci_ids,
417 	.probe = rtl_pci_probe,
418 	.remove = rtl_pci_disconnect,
419 	.driver.pm = &rtlwifi_pm_ops,
420 };
421 
422 module_pci_driver(rtl88ee_driver);
423