1 /******************************************************************************
4 * Copyright(c) 2007 - 2010 Realtek Corporation. All rights reserved.
5 * Linux device driver for RTL8192SU
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of version 2 of the GNU General Public License as
9 * published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 * You should have received a copy of the GNU General Public License along with
17 * this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
20 * Modifications for inclusion into the Linux staging tree are
21 * Copyright(c) 2010 Larry Finger. All rights reserved.
23 * Contact information:
24 * WLAN FAE <wlanfae@realtek.com>.
25 * Larry Finger <Larry.Finger@lwfinger.net>
27 ******************************************************************************/
31 #include <linux/usb.h>
32 #include <linux/device.h>
33 #include <linux/usb/ch9.h>
34 #include <linux/firmware.h>
35 #include <linux/module.h>
37 #include "osdep_service.h"
38 #include "drv_types.h"
39 #include "rtl871x_byteorder.h"
40 #include "usb_osintf.h"
42 #define FWBUFF_ALIGN_SZ 512
43 #define MAX_DUMP_FWSZ 49152 /*default = 49152 (48k)*/
45 static void rtl871x_load_fw_cb(const struct firmware *firmware, void *context)
47 struct _adapter *padapter = context;
49 complete(&padapter->rtl8712_fw_ready);
51 struct usb_device *udev = padapter->dvobjpriv.pusbdev;
52 struct usb_interface *pusb_intf = padapter->pusb_intf;
53 printk(KERN_ERR "r8712u: Firmware request failed\n");
54 padapter->fw_found = false;
56 usb_set_intfdata(pusb_intf, NULL);
59 padapter->fw = firmware;
60 padapter->fw_found = true;
61 /* firmware available - start netdev */
62 register_netdev(padapter->pnetdev);
65 static const char firmware_file[] = "rtlwifi/rtl8712u.bin";
67 int rtl871x_load_fw(struct _adapter *padapter)
69 struct device *dev = &padapter->dvobjpriv.pusbdev->dev;
72 init_completion(&padapter->rtl8712_fw_ready);
73 printk(KERN_INFO "r8712u: Loading firmware from \"%s\"\n",
75 rc = request_firmware_nowait(THIS_MODULE, 1, firmware_file, dev,
76 GFP_KERNEL, padapter, rtl871x_load_fw_cb);
78 printk(KERN_ERR "r8712u: Firmware request error %d\n", rc);
81 MODULE_FIRMWARE("rtlwifi/rtl8712u.bin");
83 static u32 rtl871x_open_fw(struct _adapter *padapter, const u8 **ppmappedfw)
85 const struct firmware **praw = &padapter->fw;
87 if (padapter->fw->size > 200000) {
88 printk(KERN_ERR "r8172u: Badfw->size of %d\n",
89 (int)padapter->fw->size);
92 *ppmappedfw = (u8 *)((*praw)->data);
96 static void fill_fwpriv(struct _adapter *padapter, struct fw_priv *pfwpriv)
98 struct dvobj_priv *pdvobj = (struct dvobj_priv *)&padapter->dvobjpriv;
99 struct registry_priv *pregpriv = &padapter->registrypriv;
101 memset(pfwpriv, 0, sizeof(struct fw_priv));
102 /* todo: check if needs endian conversion */
103 pfwpriv->hci_sel = RTL8712_HCI_TYPE_72USB;
104 pfwpriv->usb_ep_num = (u8)pdvobj->nr_endpoint;
105 pfwpriv->bw_40MHz_en = pregpriv->cbw40_enable;
106 switch (pregpriv->rf_config) {
107 case RTL8712_RF_1T1R:
108 pfwpriv->rf_config = RTL8712_RFC_1T1R;
110 case RTL8712_RF_2T2R:
111 pfwpriv->rf_config = RTL8712_RFC_2T2R;
113 case RTL8712_RF_1T2R:
115 pfwpriv->rf_config = RTL8712_RFC_1T2R;
117 pfwpriv->mp_mode = (pregpriv->mp_mode == 1) ? 1 : 0;
118 pfwpriv->vcsType = pregpriv->vrtl_carrier_sense; /* 0:off 1:on 2:auto */
119 pfwpriv->vcsMode = pregpriv->vcs_type; /* 1:RTS/CTS 2:CTS to self */
120 /* default enable turboMode */
121 pfwpriv->turboMode = ((pregpriv->wifi_test == 1) ? 0 : 1);
122 pfwpriv->lowPowerMode = pregpriv->low_power;
125 static void update_fwhdr(struct fw_hdr *pfwhdr, const u8 *pmappedfw)
127 pfwhdr->signature = le16_to_cpu(*(u16 *)pmappedfw);
128 pfwhdr->version = le16_to_cpu(*(u16 *)(pmappedfw+2));
129 /* define the size of boot loader */
130 pfwhdr->dmem_size = le32_to_cpu(*(uint *)(pmappedfw+4));
131 /* define the size of FW in IMEM */
132 pfwhdr->img_IMEM_size = le32_to_cpu(*(uint *)(pmappedfw+8));
133 /* define the size of FW in SRAM */
134 pfwhdr->img_SRAM_size = le32_to_cpu(*(uint *)(pmappedfw+12));
135 /* define the size of DMEM variable */
136 pfwhdr->fw_priv_sz = le32_to_cpu(*(uint *)(pmappedfw+16));
139 static u8 chk_fwhdr(struct fw_hdr *pfwhdr, u32 ulfilelength)
144 /* check signature */
145 if ((pfwhdr->signature != 0x8712) && (pfwhdr->signature != 0x8192))
147 /* check interface */
148 intf = (u8)((pfwhdr->version&0x3000) >> 12);
150 rfconf = (u8)((pfwhdr->version&0xC000) >> 14);
151 /* check fw_priv_sze & sizeof(struct fw_priv) */
152 if (pfwhdr->fw_priv_sz != sizeof(struct fw_priv))
154 /* check fw_sz & image_fw_sz */
155 fwhdrsz = FIELD_OFFSET(struct fw_hdr, fwpriv) + pfwhdr->fw_priv_sz;
156 fw_sz = fwhdrsz + pfwhdr->img_IMEM_size + pfwhdr->img_SRAM_size +
158 if (fw_sz != ulfilelength)
163 static u8 rtl8712_dl_fw(struct _adapter *padapter)
168 u32 maxlen = 0, tmp32; /* for compare usage */
169 uint dump_imem_sz, imem_sz, dump_emem_sz, emem_sz; /* max = 49152; */
171 u32 ulfilelength; /* FW file size */
172 const u8 *pmappedfw = NULL;
173 u8 *ptmpchar = NULL, *ppayload, *ptr;
174 struct tx_desc *ptx_desc;
175 u32 txdscp_sz = sizeof(struct tx_desc);
178 ulfilelength = rtl871x_open_fw(padapter, &pmappedfw);
179 if (pmappedfw && (ulfilelength > 0)) {
180 update_fwhdr(&fwhdr, pmappedfw);
181 if (chk_fwhdr(&fwhdr, ulfilelength) == _FAIL)
183 fill_fwpriv(padapter, &fwhdr.fwpriv);
184 /* firmware check ok */
185 maxlen = (fwhdr.img_IMEM_size > fwhdr.img_SRAM_size) ?
186 fwhdr.img_IMEM_size : fwhdr.img_SRAM_size;
188 ptmpchar = _malloc(maxlen + FWBUFF_ALIGN_SZ);
189 if (ptmpchar == NULL)
192 ptx_desc = (struct tx_desc *)(ptmpchar + FWBUFF_ALIGN_SZ -
193 ((addr_t)(ptmpchar) & (FWBUFF_ALIGN_SZ - 1)));
194 ppayload = (u8 *)(ptx_desc) + txdscp_sz;
195 ptr = (u8 *)pmappedfw + FIELD_OFFSET(struct fw_hdr, fwpriv) +
197 /* Download FirmWare */
198 /* 1. determine IMEM code size and Load IMEM Code Section */
199 imem_sz = fwhdr.img_IMEM_size;
201 memset(ptx_desc, 0, TXDESC_SIZE);
202 if (imem_sz > MAX_DUMP_FWSZ/*49152*/)
203 dump_imem_sz = MAX_DUMP_FWSZ;
205 dump_imem_sz = imem_sz;
206 ptx_desc->txdw0 |= cpu_to_le32(BIT(28));
208 ptx_desc->txdw0 |= cpu_to_le32(dump_imem_sz &
210 memcpy(ppayload, ptr, dump_imem_sz);
211 r8712_write_mem(padapter, RTL8712_DMA_VOQ,
212 dump_imem_sz + TXDESC_SIZE,
215 imem_sz -= dump_imem_sz;
216 } while (imem_sz > 0);
218 tmp16 = r8712_read16(padapter, TCR);
219 while (((tmp16 & _IMEM_CODE_DONE) == 0) && (i > 0)) {
221 tmp16 = r8712_read16(padapter, TCR);
224 if (i == 0 || (tmp16 & _IMEM_CHK_RPT) == 0)
227 /* 2.Download EMEM code size and Load EMEM Code Section */
228 emem_sz = fwhdr.img_SRAM_size;
230 memset(ptx_desc, 0, TXDESC_SIZE);
231 if (emem_sz > MAX_DUMP_FWSZ) /* max=48k */
232 dump_emem_sz = MAX_DUMP_FWSZ;
234 dump_emem_sz = emem_sz;
235 ptx_desc->txdw0 |= cpu_to_le32(BIT(28));
237 ptx_desc->txdw0 |= cpu_to_le32(dump_emem_sz &
239 memcpy(ppayload, ptr, dump_emem_sz);
240 r8712_write_mem(padapter, RTL8712_DMA_VOQ,
241 dump_emem_sz+TXDESC_SIZE, (u8 *)ptx_desc);
243 emem_sz -= dump_emem_sz;
244 } while (emem_sz > 0);
246 tmp16 = r8712_read16(padapter, TCR);
247 while (((tmp16 & _EMEM_CODE_DONE) == 0) && (i > 0)) {
249 tmp16 = r8712_read16(padapter, TCR);
252 if (i == 0 || (tmp16 & _EMEM_CHK_RPT) == 0)
256 tmp8 = r8712_read8(padapter, SYS_CLKR);
257 r8712_write8(padapter, SYS_CLKR, tmp8|BIT(2));
258 tmp8_a = r8712_read8(padapter, SYS_CLKR);
259 if (tmp8_a != (tmp8|BIT(2)))
262 tmp8 = r8712_read8(padapter, SYS_FUNC_EN + 1);
263 r8712_write8(padapter, SYS_FUNC_EN+1, tmp8|BIT(2));
264 tmp8_a = r8712_read8(padapter, SYS_FUNC_EN + 1);
265 if (tmp8_a != (tmp8|BIT(2)))
268 tmp32 = r8712_read32(padapter, TCR);
270 /* 4.polling IMEM Ready */
272 tmp16 = r8712_read16(padapter, TCR);
273 while (((tmp16 & _IMEM_RDY) == 0) && (i > 0)) {
275 tmp16 = r8712_read16(padapter, TCR);
279 r8712_write16(padapter, 0x10250348, 0xc000);
280 r8712_write16(padapter, 0x10250348, 0xc001);
281 r8712_write16(padapter, 0x10250348, 0x2000);
282 r8712_write16(padapter, 0x10250348, 0x2001);
283 r8712_write16(padapter, 0x10250348, 0x2002);
284 r8712_write16(padapter, 0x10250348, 0x2003);
287 /* 5.Download DMEM code size and Load EMEM Code Section */
288 memset(ptx_desc, 0, TXDESC_SIZE);
289 ptx_desc->txdw0 |= cpu_to_le32(fwhdr.fw_priv_sz&0x0000ffff);
290 ptx_desc->txdw0 |= cpu_to_le32(BIT(28));
291 memcpy(ppayload, &fwhdr.fwpriv, fwhdr.fw_priv_sz);
292 r8712_write_mem(padapter, RTL8712_DMA_VOQ,
293 fwhdr.fw_priv_sz + TXDESC_SIZE, (u8 *)ptx_desc);
295 /* polling dmem code done */
297 tmp16 = r8712_read16(padapter, TCR);
298 while (((tmp16 & _DMEM_CODE_DONE) == 0) && (i > 0)) {
300 tmp16 = r8712_read16(padapter, TCR);
306 tmp8 = r8712_read8(padapter, 0x1025000A);
307 if (tmp8 & BIT(4)) /* When boot from EEPROM,
308 & FW need more time to read EEPROM */
310 else /* boot from EFUSE */
312 tmp16 = r8712_read16(padapter, TCR);
313 while (((tmp16 & _FWRDY) == 0) && (i > 0)) {
315 tmp16 = r8712_read16(padapter, TCR);
329 uint rtl8712_hal_init(struct _adapter *padapter)
334 /* r8712 firmware download */
335 if (rtl8712_dl_fw(padapter) != _SUCCESS)
338 printk(KERN_INFO "r8712u: 1 RCR=0x%x\n", r8712_read32(padapter, RCR));
339 val32 = r8712_read32(padapter, RCR);
340 r8712_write32(padapter, RCR, (val32 | BIT(26))); /* Enable RX TCP
342 printk(KERN_INFO "r8712u: 2 RCR=0x%x\n", r8712_read32(padapter, RCR));
343 val32 = r8712_read32(padapter, RCR);
344 r8712_write32(padapter, RCR, (val32|BIT(25))); /* Append PHY status */
346 val32 = r8712_read32(padapter, 0x10250040);
347 r8712_write32(padapter, 0x10250040, (val32&0x00FFFFFF));
348 /* for usb rx aggregation */
349 r8712_write8(padapter, 0x102500B5, r8712_read8(padapter, 0x102500B5) |
350 BIT(0)); /* page = 128bytes */
351 r8712_write8(padapter, 0x102500BD, r8712_read8(padapter, 0x102500BD) |
352 BIT(7)); /* enable usb rx aggregation */
353 r8712_write8(padapter, 0x102500D9, 1); /* TH=1 => means that invalidate
354 * usb rx aggregation */
355 r8712_write8(padapter, 0x1025FE5B, 0x04); /* 1.7ms/4 */
356 /* Fix the RX FIFO issue(USB error) */
357 r8712_write8(padapter, 0x1025fe5C, r8712_read8(padapter, 0x1025fe5C)
359 for (i = 0; i < 6; i++)
360 padapter->eeprompriv.mac_addr[i] = r8712_read8(padapter,
365 uint rtl8712_hal_deinit(struct _adapter *padapter)
367 r8712_write8(padapter, RF_CTRL, 0x00);
371 r8712_write8(padapter, SYS_CLKR+1, 0x38); /* Switch Control Path */
372 r8712_write8(padapter, SYS_FUNC_EN+1, 0x70);
373 r8712_write8(padapter, PMC_FSM, 0x06); /* Enable Loader Data Keep */
374 r8712_write8(padapter, SYS_ISO_CTRL, 0xF9); /* Isolation signals from
376 r8712_write8(padapter, SYS_ISO_CTRL+1, 0xe8); /* Enable EFUSE 1.2V */
377 r8712_write8(padapter, AFE_PLL_CTRL, 0x00); /* Disable AFE PLL. */
378 r8712_write8(padapter, LDOA15_CTRL, 0x54); /* Disable A15V */
379 r8712_write8(padapter, SYS_FUNC_EN+1, 0x50); /* Disable E-Fuse 1.2V */
380 r8712_write8(padapter, LDOV12D_CTRL, 0x24); /* Disable LDO12(for CE) */
381 r8712_write8(padapter, AFE_MISC, 0x30); /* Disable AFE BG&MB */
382 /* Option for Disable 1.6V LDO. */
383 r8712_write8(padapter, SPS0_CTRL, 0x56); /* Disable 1.6V LDO */
384 r8712_write8(padapter, SPS0_CTRL+1, 0x43); /* Set SW PFM */
388 uint rtl871x_hal_init(struct _adapter *padapter)
390 padapter->hw_init_completed = false;
391 if (padapter->halpriv.hal_bus_init == NULL)
394 if (padapter->halpriv.hal_bus_init(padapter) != _SUCCESS)
397 if (rtl8712_hal_init(padapter) == _SUCCESS)
398 padapter->hw_init_completed = true;
400 padapter->hw_init_completed = false;