1 /******************************************************************************
2  *
3  * Copyright(c) 2009-2012  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 "../base.h"
29 #include "../pci.h"
30 #include "reg.h"
31 #include "def.h"
32 #include "phy.h"
33 #include "dm.h"
34 #include "fw.h"
35 #include "hw.h"
36 #include "sw.h"
37 #include "trx.h"
38 #include "led.h"
39 
40 #include <linux/module.h>
41 
42 static void rtl92s_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 = 2;
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 = 2;
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 = 2;
81 }
82 
83 static void rtl92se_fw_cb(const struct firmware *firmware, void *context)
84 {
85 	struct ieee80211_hw *hw = context;
86 	struct rtl_priv *rtlpriv = rtl_priv(hw);
87 	struct rt_firmware *pfirmware = NULL;
88 	char *fw_name = "rtlwifi/rtl8192sefw.bin";
89 
90 	RT_TRACE(rtlpriv, COMP_ERR, DBG_LOUD,
91 			 "Firmware callback routine entered!\n");
92 	complete(&rtlpriv->firmware_loading_complete);
93 	if (!firmware) {
94 		pr_err("Firmware %s not available\n", fw_name);
95 		rtlpriv->max_fw_size = 0;
96 		return;
97 	}
98 	if (firmware->size > rtlpriv->max_fw_size) {
99 		RT_TRACE(rtlpriv, COMP_ERR, DBG_EMERG,
100 			 "Firmware is too big!\n");
101 		rtlpriv->max_fw_size = 0;
102 		release_firmware(firmware);
103 		return;
104 	}
105 	pfirmware = (struct rt_firmware *)rtlpriv->rtlhal.pfirmware;
106 	memcpy(pfirmware->sz_fw_tmpbuffer, firmware->data, firmware->size);
107 	pfirmware->sz_fw_tmpbufferlen = firmware->size;
108 	release_firmware(firmware);
109 }
110 
111 static int rtl92s_init_sw_vars(struct ieee80211_hw *hw)
112 {
113 	struct rtl_priv *rtlpriv = rtl_priv(hw);
114 	struct rtl_pci *rtlpci = rtl_pcidev(rtl_pcipriv(hw));
115 	int err = 0;
116 	u16 earlyrxthreshold = 7;
117 	char *fw_name = "rtlwifi/rtl8192sefw.bin";
118 
119 	rtlpriv->dm.dm_initialgain_enable = true;
120 	rtlpriv->dm.dm_flag = 0;
121 	rtlpriv->dm.disable_framebursting = false;
122 	rtlpriv->dm.thermalvalue = 0;
123 	rtlpriv->dm.useramask = true;
124 
125 	/* compatible 5G band 91se just 2.4G band & smsp */
126 	rtlpriv->rtlhal.current_bandtype = BAND_ON_2_4G;
127 	rtlpriv->rtlhal.bandset = BAND_ON_2_4G;
128 	rtlpriv->rtlhal.macphymode = SINGLEMAC_SINGLEPHY;
129 
130 	rtlpci->transmit_config = 0;
131 
132 	rtlpci->receive_config =
133 			RCR_APPFCS |
134 			RCR_APWRMGT |
135 			/*RCR_ADD3 |*/
136 			RCR_AMF	|
137 			RCR_ADF |
138 			RCR_APP_MIC |
139 			RCR_APP_ICV |
140 			RCR_AICV |
141 			/* Accept ICV error, CRC32 Error */
142 			RCR_ACRC32 |
143 			RCR_AB |
144 			/* Accept Broadcast, Multicast */
145 			RCR_AM	|
146 			/* Accept Physical match */
147 			RCR_APM |
148 			/* Accept Destination Address packets */
149 			/*RCR_AAP |*/
150 			RCR_APP_PHYST_STAFF |
151 			/* Accept PHY status */
152 			RCR_APP_PHYST_RXFF |
153 			(earlyrxthreshold << RCR_FIFO_OFFSET);
154 
155 	rtlpci->irq_mask[0] = (u32)
156 			(IMR_ROK |
157 			IMR_VODOK |
158 			IMR_VIDOK |
159 			IMR_BEDOK |
160 			IMR_BKDOK |
161 			IMR_HCCADOK |
162 			IMR_MGNTDOK |
163 			IMR_COMDOK |
164 			IMR_HIGHDOK |
165 			IMR_BDOK |
166 			IMR_RXCMDOK |
167 			/*IMR_TIMEOUT0 |*/
168 			IMR_RDU |
169 			IMR_RXFOVW	|
170 			IMR_BCNINT
171 			/*| IMR_TXFOVW*/
172 			/*| IMR_TBDOK |
173 			IMR_TBDER*/);
174 
175 	rtlpci->irq_mask[1] = (u32) 0;
176 
177 	rtlpci->shortretry_limit = 0x30;
178 	rtlpci->longretry_limit = 0x30;
179 
180 	rtlpci->first_init = true;
181 
182 	/* for debug level */
183 	rtlpriv->dbg.global_debuglevel = rtlpriv->cfg->mod_params->debug;
184 	/* for LPS & IPS */
185 	rtlpriv->psc.inactiveps = rtlpriv->cfg->mod_params->inactiveps;
186 	rtlpriv->psc.swctrl_lps = rtlpriv->cfg->mod_params->swctrl_lps;
187 	rtlpriv->psc.fwctrl_lps = rtlpriv->cfg->mod_params->fwctrl_lps;
188 	rtlpriv->cfg->mod_params->sw_crypto =
189 		rtlpriv->cfg->mod_params->sw_crypto;
190 	if (!rtlpriv->psc.inactiveps)
191 		pr_info("Power Save off (module option)\n");
192 	if (!rtlpriv->psc.fwctrl_lps)
193 		pr_info("FW Power Save off (module option)\n");
194 	rtlpriv->psc.reg_fwctrl_lps = 3;
195 	rtlpriv->psc.reg_max_lps_awakeintvl = 5;
196 	/* for ASPM, you can close aspm through
197 	 * set const_support_pciaspm = 0 */
198 	rtl92s_init_aspm_vars(hw);
199 
200 	if (rtlpriv->psc.reg_fwctrl_lps == 1)
201 		rtlpriv->psc.fwctrl_psmode = FW_PS_MIN_MODE;
202 	else if (rtlpriv->psc.reg_fwctrl_lps == 2)
203 		rtlpriv->psc.fwctrl_psmode = FW_PS_MAX_MODE;
204 	else if (rtlpriv->psc.reg_fwctrl_lps == 3)
205 		rtlpriv->psc.fwctrl_psmode = FW_PS_DTIM_MODE;
206 
207 	/* for firmware buf */
208 	rtlpriv->rtlhal.pfirmware = vzalloc(sizeof(struct rt_firmware));
209 	if (!rtlpriv->rtlhal.pfirmware)
210 		return 1;
211 
212 	rtlpriv->max_fw_size = RTL8190_MAX_FIRMWARE_CODE_SIZE*2 +
213 			       sizeof(struct fw_hdr);
214 	pr_info("Driver for Realtek RTL8192SE/RTL8191SE\n"
215 		"Loading firmware %s\n", fw_name);
216 	/* request fw */
217 	err = request_firmware_nowait(THIS_MODULE, 1, fw_name,
218 				      rtlpriv->io.dev, GFP_KERNEL, hw,
219 				      rtl92se_fw_cb);
220 	if (err) {
221 		RT_TRACE(rtlpriv, COMP_ERR, DBG_EMERG,
222 			 "Failed to request firmware!\n");
223 		return 1;
224 	}
225 
226 	return err;
227 }
228 
229 static void rtl92s_deinit_sw_vars(struct ieee80211_hw *hw)
230 {
231 	struct rtl_priv *rtlpriv = rtl_priv(hw);
232 
233 	if (rtlpriv->rtlhal.pfirmware) {
234 		vfree(rtlpriv->rtlhal.pfirmware);
235 		rtlpriv->rtlhal.pfirmware = NULL;
236 	}
237 }
238 
239 static bool rtl92se_is_tx_desc_closed(struct ieee80211_hw *hw, u8 hw_queue,
240 				      u16 index)
241 {
242 	struct rtl_pci *rtlpci = rtl_pcidev(rtl_pcipriv(hw));
243 	struct rtl8192_tx_ring *ring = &rtlpci->tx_ring[hw_queue];
244 	u8 *entry = (u8 *)(&ring->desc[ring->idx]);
245 	u8 own = (u8)rtl92se_get_desc(entry, true, HW_DESC_OWN);
246 
247 	if (own)
248 		return false;
249 	return true;
250 }
251 
252 static struct rtl_hal_ops rtl8192se_hal_ops = {
253 	.init_sw_vars = rtl92s_init_sw_vars,
254 	.deinit_sw_vars = rtl92s_deinit_sw_vars,
255 	.read_eeprom_info = rtl92se_read_eeprom_info,
256 	.interrupt_recognized = rtl92se_interrupt_recognized,
257 	.hw_init = rtl92se_hw_init,
258 	.hw_disable = rtl92se_card_disable,
259 	.hw_suspend = rtl92se_suspend,
260 	.hw_resume = rtl92se_resume,
261 	.enable_interrupt = rtl92se_enable_interrupt,
262 	.disable_interrupt = rtl92se_disable_interrupt,
263 	.set_network_type = rtl92se_set_network_type,
264 	.set_chk_bssid = rtl92se_set_check_bssid,
265 	.set_qos = rtl92se_set_qos,
266 	.set_bcn_reg = rtl92se_set_beacon_related_registers,
267 	.set_bcn_intv = rtl92se_set_beacon_interval,
268 	.update_interrupt_mask = rtl92se_update_interrupt_mask,
269 	.get_hw_reg = rtl92se_get_hw_reg,
270 	.set_hw_reg = rtl92se_set_hw_reg,
271 	.update_rate_tbl = rtl92se_update_hal_rate_tbl,
272 	.fill_tx_desc = rtl92se_tx_fill_desc,
273 	.fill_tx_cmddesc = rtl92se_tx_fill_cmddesc,
274 	.query_rx_desc = rtl92se_rx_query_desc,
275 	.set_channel_access = rtl92se_update_channel_access_setting,
276 	.radio_onoff_checking = rtl92se_gpio_radio_on_off_checking,
277 	.set_bw_mode = rtl92s_phy_set_bw_mode,
278 	.switch_channel = rtl92s_phy_sw_chnl,
279 	.dm_watchdog = rtl92s_dm_watchdog,
280 	.scan_operation_backup = rtl92s_phy_scan_operation_backup,
281 	.set_rf_power_state = rtl92s_phy_set_rf_power_state,
282 	.led_control = rtl92se_led_control,
283 	.set_desc = rtl92se_set_desc,
284 	.get_desc = rtl92se_get_desc,
285 	.is_tx_desc_closed = rtl92se_is_tx_desc_closed,
286 	.tx_polling = rtl92se_tx_polling,
287 	.enable_hw_sec = rtl92se_enable_hw_security_config,
288 	.set_key = rtl92se_set_key,
289 	.init_sw_leds = rtl92se_init_sw_leds,
290 	.get_bbreg = rtl92s_phy_query_bb_reg,
291 	.set_bbreg = rtl92s_phy_set_bb_reg,
292 	.get_rfreg = rtl92s_phy_query_rf_reg,
293 	.set_rfreg = rtl92s_phy_set_rf_reg,
294 	.get_btc_status = rtl_btc_status_false,
295 };
296 
297 static struct rtl_mod_params rtl92se_mod_params = {
298 	.sw_crypto = false,
299 	.inactiveps = true,
300 	.swctrl_lps = true,
301 	.fwctrl_lps = false,
302 	.debug = DBG_EMERG,
303 };
304 
305 /* Because memory R/W bursting will cause system hang/crash
306  * for 92se, so we don't read back after every write action */
307 static const struct rtl_hal_cfg rtl92se_hal_cfg = {
308 	.bar_id = 1,
309 	.write_readback = false,
310 	.name = "rtl92s_pci",
311 	.ops = &rtl8192se_hal_ops,
312 	.mod_params = &rtl92se_mod_params,
313 
314 	.maps[SYS_ISO_CTRL] = REG_SYS_ISO_CTRL,
315 	.maps[SYS_FUNC_EN] = REG_SYS_FUNC_EN,
316 	.maps[SYS_CLK] = SYS_CLKR,
317 	.maps[MAC_RCR_AM] = RCR_AM,
318 	.maps[MAC_RCR_AB] = RCR_AB,
319 	.maps[MAC_RCR_ACRC32] = RCR_ACRC32,
320 	.maps[MAC_RCR_ACF] = RCR_ACF,
321 	.maps[MAC_RCR_AAP] = RCR_AAP,
322 	.maps[MAC_HIMR] = INTA_MASK,
323 	.maps[MAC_HIMRE] = INTA_MASK + 4,
324 
325 	.maps[EFUSE_TEST] = REG_EFUSE_TEST,
326 	.maps[EFUSE_CTRL] = REG_EFUSE_CTRL,
327 	.maps[EFUSE_CLK] = REG_EFUSE_CLK,
328 	.maps[EFUSE_CLK_CTRL] = REG_EFUSE_CTRL,
329 	.maps[EFUSE_PWC_EV12V] = 0, /* nouse for 8192se */
330 	.maps[EFUSE_FEN_ELDR] = 0, /* nouse for 8192se */
331 	.maps[EFUSE_LOADER_CLK_EN] = 0,/* nouse for 8192se */
332 	.maps[EFUSE_ANA8M] = EFUSE_ANA8M,
333 	.maps[EFUSE_HWSET_MAX_SIZE] = HWSET_MAX_SIZE_92S,
334 	.maps[EFUSE_MAX_SECTION_MAP] = EFUSE_MAX_SECTION,
335 	.maps[EFUSE_REAL_CONTENT_SIZE] = EFUSE_REAL_CONTENT_LEN,
336 	.maps[EFUSE_OOB_PROTECT_BYTES_LEN] = EFUSE_OOB_PROTECT_BYTES,
337 
338 	.maps[RWCAM] = REG_RWCAM,
339 	.maps[WCAMI] = REG_WCAMI,
340 	.maps[RCAMO] = REG_RCAMO,
341 	.maps[CAMDBG] = REG_CAMDBG,
342 	.maps[SECR] = REG_SECR,
343 	.maps[SEC_CAM_NONE] = CAM_NONE,
344 	.maps[SEC_CAM_WEP40] = CAM_WEP40,
345 	.maps[SEC_CAM_TKIP] = CAM_TKIP,
346 	.maps[SEC_CAM_AES] = CAM_AES,
347 	.maps[SEC_CAM_WEP104] = CAM_WEP104,
348 
349 	.maps[RTL_IMR_BCNDMAINT6] = IMR_BCNDMAINT6,
350 	.maps[RTL_IMR_BCNDMAINT5] = IMR_BCNDMAINT5,
351 	.maps[RTL_IMR_BCNDMAINT4] = IMR_BCNDMAINT4,
352 	.maps[RTL_IMR_BCNDMAINT3] = IMR_BCNDMAINT3,
353 	.maps[RTL_IMR_BCNDMAINT2] = IMR_BCNDMAINT2,
354 	.maps[RTL_IMR_BCNDMAINT1] = IMR_BCNDMAINT1,
355 	.maps[RTL_IMR_BCNDOK8] = IMR_BCNDOK8,
356 	.maps[RTL_IMR_BCNDOK7] = IMR_BCNDOK7,
357 	.maps[RTL_IMR_BCNDOK6] = IMR_BCNDOK6,
358 	.maps[RTL_IMR_BCNDOK5] = IMR_BCNDOK5,
359 	.maps[RTL_IMR_BCNDOK4] = IMR_BCNDOK4,
360 	.maps[RTL_IMR_BCNDOK3] = IMR_BCNDOK3,
361 	.maps[RTL_IMR_BCNDOK2] = IMR_BCNDOK2,
362 	.maps[RTL_IMR_BCNDOK1] = IMR_BCNDOK1,
363 	.maps[RTL_IMR_TIMEOUT2] = IMR_TIMEOUT2,
364 	.maps[RTL_IMR_TIMEOUT1] = IMR_TIMEOUT1,
365 
366 	.maps[RTL_IMR_TXFOVW] = IMR_TXFOVW,
367 	.maps[RTL_IMR_PSTIMEOUT] = IMR_PSTIMEOUT,
368 	.maps[RTL_IMR_BCNINT] = IMR_BCNINT,
369 	.maps[RTL_IMR_RXFOVW] = IMR_RXFOVW,
370 	.maps[RTL_IMR_RDU] = IMR_RDU,
371 	.maps[RTL_IMR_ATIMEND] = IMR_ATIMEND,
372 	.maps[RTL_IMR_BDOK] = IMR_BDOK,
373 	.maps[RTL_IMR_MGNTDOK] = IMR_MGNTDOK,
374 	.maps[RTL_IMR_TBDER] = IMR_TBDER,
375 	.maps[RTL_IMR_HIGHDOK] = IMR_HIGHDOK,
376 	.maps[RTL_IMR_COMDOK] = IMR_COMDOK,
377 	.maps[RTL_IMR_TBDOK] = IMR_TBDOK,
378 	.maps[RTL_IMR_BKDOK] = IMR_BKDOK,
379 	.maps[RTL_IMR_BEDOK] = IMR_BEDOK,
380 	.maps[RTL_IMR_VIDOK] = IMR_VIDOK,
381 	.maps[RTL_IMR_VODOK] = IMR_VODOK,
382 	.maps[RTL_IMR_ROK] = IMR_ROK,
383 	.maps[RTL_IBSS_INT_MASKS] = (IMR_BCNINT | IMR_TBDOK | IMR_TBDER),
384 
385 	.maps[RTL_RC_CCK_RATE1M] = DESC_RATE1M,
386 	.maps[RTL_RC_CCK_RATE2M] = DESC_RATE2M,
387 	.maps[RTL_RC_CCK_RATE5_5M] = DESC_RATE5_5M,
388 	.maps[RTL_RC_CCK_RATE11M] = DESC_RATE11M,
389 	.maps[RTL_RC_OFDM_RATE6M] = DESC_RATE6M,
390 	.maps[RTL_RC_OFDM_RATE9M] = DESC_RATE9M,
391 	.maps[RTL_RC_OFDM_RATE12M] = DESC_RATE12M,
392 	.maps[RTL_RC_OFDM_RATE18M] = DESC_RATE18M,
393 	.maps[RTL_RC_OFDM_RATE24M] = DESC_RATE24M,
394 	.maps[RTL_RC_OFDM_RATE36M] = DESC_RATE36M,
395 	.maps[RTL_RC_OFDM_RATE48M] = DESC_RATE48M,
396 	.maps[RTL_RC_OFDM_RATE54M] = DESC_RATE54M,
397 
398 	.maps[RTL_RC_HT_RATEMCS7] = DESC_RATEMCS7,
399 	.maps[RTL_RC_HT_RATEMCS15] = DESC_RATEMCS15,
400 };
401 
402 static struct pci_device_id rtl92se_pci_ids[] = {
403 	{RTL_PCI_DEVICE(PCI_VENDOR_ID_REALTEK, 0x8192, rtl92se_hal_cfg)},
404 	{RTL_PCI_DEVICE(PCI_VENDOR_ID_REALTEK, 0x8171, rtl92se_hal_cfg)},
405 	{RTL_PCI_DEVICE(PCI_VENDOR_ID_REALTEK, 0x8172, rtl92se_hal_cfg)},
406 	{RTL_PCI_DEVICE(PCI_VENDOR_ID_REALTEK, 0x8173, rtl92se_hal_cfg)},
407 	{RTL_PCI_DEVICE(PCI_VENDOR_ID_REALTEK, 0x8174, rtl92se_hal_cfg)},
408 	{},
409 };
410 
411 MODULE_DEVICE_TABLE(pci, rtl92se_pci_ids);
412 
413 MODULE_AUTHOR("lizhaoming	<chaoming_li@realsil.com.cn>");
414 MODULE_AUTHOR("Realtek WlanFAE	<wlanfae@realtek.com>");
415 MODULE_AUTHOR("Larry Finger	<Larry.Finger@lwfinger.net>");
416 MODULE_LICENSE("GPL");
417 MODULE_DESCRIPTION("Realtek 8192S/8191S 802.11n PCI wireless");
418 MODULE_FIRMWARE("rtlwifi/rtl8192sefw.bin");
419 
420 module_param_named(swenc, rtl92se_mod_params.sw_crypto, bool, 0444);
421 module_param_named(debug, rtl92se_mod_params.debug, int, 0444);
422 module_param_named(ips, rtl92se_mod_params.inactiveps, bool, 0444);
423 module_param_named(swlps, rtl92se_mod_params.swctrl_lps, bool, 0444);
424 module_param_named(fwlps, rtl92se_mod_params.fwctrl_lps, bool, 0444);
425 MODULE_PARM_DESC(swenc, "Set to 1 for software crypto (default 0)\n");
426 MODULE_PARM_DESC(ips, "Set to 0 to not use link power save (default 1)\n");
427 MODULE_PARM_DESC(swlps, "Set to 1 to use SW control power save (default 1)\n");
428 MODULE_PARM_DESC(fwlps, "Set to 1 to use FW control power save (default 0)\n");
429 MODULE_PARM_DESC(debug, "Set debug level (0-5) (default 0)");
430 
431 static SIMPLE_DEV_PM_OPS(rtlwifi_pm_ops, rtl_pci_suspend, rtl_pci_resume);
432 
433 static struct pci_driver rtl92se_driver = {
434 	.name = KBUILD_MODNAME,
435 	.id_table = rtl92se_pci_ids,
436 	.probe = rtl_pci_probe,
437 	.remove = rtl_pci_disconnect,
438 	.driver.pm = &rtlwifi_pm_ops,
439 };
440 
441 module_pci_driver(rtl92se_driver);
442