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