1 /******************************************************************************
2 * hal_init.c
3 *
4 * Copyright(c) 2007 - 2010 Realtek Corporation. All rights reserved.
5 * Linux device driver for RTL8192SU
6 *
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.
10 *
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
14 * more details.
15 *
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
19 *
20 * Modifications for inclusion into the Linux staging tree are
21 * Copyright(c) 2010 Larry Finger. All rights reserved.
22 *
23 * Contact information:
24 * WLAN FAE <wlanfae@realtek.com>.
25 * Larry Finger <Larry.Finger@lwfinger.net>
26 *
27 ******************************************************************************/
28
29 #define _HAL_INIT_C_
30
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>
36
37 #include "osdep_service.h"
38 #include "drv_types.h"
39 #include "usb_osintf.h"
40
41 #define FWBUFF_ALIGN_SZ 512
42 #define MAX_DUMP_FWSZ 49152 /*default = 49152 (48k)*/
43
rtl871x_load_fw_cb(const struct firmware * firmware,void * context)44 static void rtl871x_load_fw_cb(const struct firmware *firmware, void *context)
45 {
46 struct _adapter *padapter = context;
47
48 complete(&padapter->rtl8712_fw_ready);
49 if (!firmware) {
50 struct usb_device *udev = padapter->dvobjpriv.pusbdev;
51 struct usb_interface *pusb_intf = padapter->pusb_intf;
52
53 dev_err(&udev->dev, "r8712u: Firmware request failed\n");
54 usb_put_dev(udev);
55 usb_set_intfdata(pusb_intf, NULL);
56 return;
57 }
58 padapter->fw = firmware;
59 /* firmware available - start netdev */
60 register_netdev(padapter->pnetdev);
61 }
62
63 static const char firmware_file[] = "rtlwifi/rtl8712u.bin";
64
rtl871x_load_fw(struct _adapter * padapter)65 int rtl871x_load_fw(struct _adapter *padapter)
66 {
67 struct device *dev = &padapter->dvobjpriv.pusbdev->dev;
68 int rc;
69
70 init_completion(&padapter->rtl8712_fw_ready);
71 dev_info(dev, "r8712u: Loading firmware from \"%s\"\n", firmware_file);
72 rc = request_firmware_nowait(THIS_MODULE, 1, firmware_file, dev,
73 GFP_KERNEL, padapter, rtl871x_load_fw_cb);
74 if (rc)
75 dev_err(dev, "r8712u: Firmware request error %d\n", rc);
76 return rc;
77 }
78 MODULE_FIRMWARE("rtlwifi/rtl8712u.bin");
79
rtl871x_open_fw(struct _adapter * padapter,const u8 ** ppmappedfw)80 static u32 rtl871x_open_fw(struct _adapter *padapter, const u8 **ppmappedfw)
81 {
82 const struct firmware **praw = &padapter->fw;
83
84 if (padapter->fw->size > 200000) {
85 dev_err(&padapter->pnetdev->dev, "r8172u: Badfw->size of %d\n",
86 (int)padapter->fw->size);
87 return 0;
88 }
89 *ppmappedfw = (u8 *)((*praw)->data);
90 return (*praw)->size;
91 }
92
fill_fwpriv(struct _adapter * padapter,struct fw_priv * pfwpriv)93 static void fill_fwpriv(struct _adapter *padapter, struct fw_priv *pfwpriv)
94 {
95 struct dvobj_priv *pdvobj = (struct dvobj_priv *)&padapter->dvobjpriv;
96 struct registry_priv *pregpriv = &padapter->registrypriv;
97
98 memset(pfwpriv, 0, sizeof(struct fw_priv));
99 /* todo: check if needs endian conversion */
100 pfwpriv->hci_sel = RTL8712_HCI_TYPE_72USB;
101 pfwpriv->usb_ep_num = (u8)pdvobj->nr_endpoint;
102 pfwpriv->bw_40MHz_en = pregpriv->cbw40_enable;
103 switch (pregpriv->rf_config) {
104 case RTL8712_RF_1T1R:
105 pfwpriv->rf_config = RTL8712_RFC_1T1R;
106 break;
107 case RTL8712_RF_2T2R:
108 pfwpriv->rf_config = RTL8712_RFC_2T2R;
109 break;
110 case RTL8712_RF_1T2R:
111 default:
112 pfwpriv->rf_config = RTL8712_RFC_1T2R;
113 }
114 pfwpriv->mp_mode = (pregpriv->mp_mode == 1) ? 1 : 0;
115 pfwpriv->vcsType = pregpriv->vrtl_carrier_sense; /* 0:off 1:on 2:auto */
116 pfwpriv->vcsMode = pregpriv->vcs_type; /* 1:RTS/CTS 2:CTS to self */
117 /* default enable turboMode */
118 pfwpriv->turboMode = ((pregpriv->wifi_test == 1) ? 0 : 1);
119 pfwpriv->lowPowerMode = pregpriv->low_power;
120 }
121
update_fwhdr(struct fw_hdr * pfwhdr,const u8 * pmappedfw)122 static void update_fwhdr(struct fw_hdr *pfwhdr, const u8 *pmappedfw)
123 {
124 pfwhdr->signature = le16_to_cpu(*(u16 *)pmappedfw);
125 pfwhdr->version = le16_to_cpu(*(u16 *)(pmappedfw+2));
126 /* define the size of boot loader */
127 pfwhdr->dmem_size = le32_to_cpu(*(uint *)(pmappedfw+4));
128 /* define the size of FW in IMEM */
129 pfwhdr->img_IMEM_size = le32_to_cpu(*(uint *)(pmappedfw+8));
130 /* define the size of FW in SRAM */
131 pfwhdr->img_SRAM_size = le32_to_cpu(*(uint *)(pmappedfw+12));
132 /* define the size of DMEM variable */
133 pfwhdr->fw_priv_sz = le32_to_cpu(*(uint *)(pmappedfw+16));
134 }
135
chk_fwhdr(struct fw_hdr * pfwhdr,u32 ulfilelength)136 static u8 chk_fwhdr(struct fw_hdr *pfwhdr, u32 ulfilelength)
137 {
138 u32 fwhdrsz, fw_sz;
139 u8 intf, rfconf;
140
141 /* check signature */
142 if ((pfwhdr->signature != 0x8712) && (pfwhdr->signature != 0x8192))
143 return _FAIL;
144 /* check interface */
145 intf = (u8)((pfwhdr->version&0x3000) >> 12);
146 /* check rf_conf */
147 rfconf = (u8)((pfwhdr->version&0xC000) >> 14);
148 /* check fw_priv_sze & sizeof(struct fw_priv) */
149 if (pfwhdr->fw_priv_sz != sizeof(struct fw_priv))
150 return _FAIL;
151 /* check fw_sz & image_fw_sz */
152 fwhdrsz = FIELD_OFFSET(struct fw_hdr, fwpriv) + pfwhdr->fw_priv_sz;
153 fw_sz = fwhdrsz + pfwhdr->img_IMEM_size + pfwhdr->img_SRAM_size +
154 pfwhdr->dmem_size;
155 if (fw_sz != ulfilelength)
156 return _FAIL;
157 return _SUCCESS;
158 }
159
rtl8712_dl_fw(struct _adapter * padapter)160 static u8 rtl8712_dl_fw(struct _adapter *padapter)
161 {
162 sint i;
163 u8 tmp8, tmp8_a;
164 u16 tmp16;
165 u32 maxlen = 0, tmp32; /* for compare usage */
166 uint dump_imem_sz, imem_sz, dump_emem_sz, emem_sz; /* max = 49152; */
167 struct fw_hdr fwhdr;
168 u32 ulfilelength; /* FW file size */
169 const u8 *pmappedfw = NULL;
170 u8 *ptmpchar = NULL, *ppayload, *ptr;
171 struct tx_desc *ptx_desc;
172 u32 txdscp_sz = sizeof(struct tx_desc);
173 u8 ret = _FAIL;
174
175 ulfilelength = rtl871x_open_fw(padapter, &pmappedfw);
176 if (pmappedfw && (ulfilelength > 0)) {
177 update_fwhdr(&fwhdr, pmappedfw);
178 if (chk_fwhdr(&fwhdr, ulfilelength) == _FAIL)
179 return ret;
180 fill_fwpriv(padapter, &fwhdr.fwpriv);
181 /* firmware check ok */
182 maxlen = (fwhdr.img_IMEM_size > fwhdr.img_SRAM_size) ?
183 fwhdr.img_IMEM_size : fwhdr.img_SRAM_size;
184 maxlen += txdscp_sz;
185 ptmpchar = kmalloc(maxlen + FWBUFF_ALIGN_SZ, GFP_ATOMIC);
186 if (ptmpchar == NULL)
187 return ret;
188
189 ptx_desc = (struct tx_desc *)(ptmpchar + FWBUFF_ALIGN_SZ -
190 ((addr_t)(ptmpchar) & (FWBUFF_ALIGN_SZ - 1)));
191 ppayload = (u8 *)(ptx_desc) + txdscp_sz;
192 ptr = (u8 *)pmappedfw + FIELD_OFFSET(struct fw_hdr, fwpriv) +
193 fwhdr.fw_priv_sz;
194 /* Download FirmWare */
195 /* 1. determine IMEM code size and Load IMEM Code Section */
196 imem_sz = fwhdr.img_IMEM_size;
197 do {
198 memset(ptx_desc, 0, TXDESC_SIZE);
199 if (imem_sz > MAX_DUMP_FWSZ/*49152*/)
200 dump_imem_sz = MAX_DUMP_FWSZ;
201 else {
202 dump_imem_sz = imem_sz;
203 ptx_desc->txdw0 |= cpu_to_le32(BIT(28));
204 }
205 ptx_desc->txdw0 |= cpu_to_le32(dump_imem_sz &
206 0x0000ffff);
207 memcpy(ppayload, ptr, dump_imem_sz);
208 r8712_write_mem(padapter, RTL8712_DMA_VOQ,
209 dump_imem_sz + TXDESC_SIZE,
210 (u8 *)ptx_desc);
211 ptr += dump_imem_sz;
212 imem_sz -= dump_imem_sz;
213 } while (imem_sz > 0);
214 i = 10;
215 tmp16 = r8712_read16(padapter, TCR);
216 while (((tmp16 & _IMEM_CODE_DONE) == 0) && (i > 0)) {
217 udelay(10);
218 tmp16 = r8712_read16(padapter, TCR);
219 i--;
220 }
221 if (i == 0 || (tmp16 & _IMEM_CHK_RPT) == 0)
222 goto exit_fail;
223
224 /* 2.Download EMEM code size and Load EMEM Code Section */
225 emem_sz = fwhdr.img_SRAM_size;
226 do {
227 memset(ptx_desc, 0, TXDESC_SIZE);
228 if (emem_sz > MAX_DUMP_FWSZ) /* max=48k */
229 dump_emem_sz = MAX_DUMP_FWSZ;
230 else {
231 dump_emem_sz = emem_sz;
232 ptx_desc->txdw0 |= cpu_to_le32(BIT(28));
233 }
234 ptx_desc->txdw0 |= cpu_to_le32(dump_emem_sz &
235 0x0000ffff);
236 memcpy(ppayload, ptr, dump_emem_sz);
237 r8712_write_mem(padapter, RTL8712_DMA_VOQ,
238 dump_emem_sz+TXDESC_SIZE, (u8 *)ptx_desc);
239 ptr += dump_emem_sz;
240 emem_sz -= dump_emem_sz;
241 } while (emem_sz > 0);
242 i = 5;
243 tmp16 = r8712_read16(padapter, TCR);
244 while (((tmp16 & _EMEM_CODE_DONE) == 0) && (i > 0)) {
245 udelay(10);
246 tmp16 = r8712_read16(padapter, TCR);
247 i--;
248 }
249 if (i == 0 || (tmp16 & _EMEM_CHK_RPT) == 0)
250 goto exit_fail;
251
252 /* 3.Enable CPU */
253 tmp8 = r8712_read8(padapter, SYS_CLKR);
254 r8712_write8(padapter, SYS_CLKR, tmp8|BIT(2));
255 tmp8_a = r8712_read8(padapter, SYS_CLKR);
256 if (tmp8_a != (tmp8|BIT(2)))
257 goto exit_fail;
258
259 tmp8 = r8712_read8(padapter, SYS_FUNC_EN + 1);
260 r8712_write8(padapter, SYS_FUNC_EN+1, tmp8|BIT(2));
261 tmp8_a = r8712_read8(padapter, SYS_FUNC_EN + 1);
262 if (tmp8_a != (tmp8|BIT(2)))
263 goto exit_fail;
264
265 tmp32 = r8712_read32(padapter, TCR);
266
267 /* 4.polling IMEM Ready */
268 i = 100;
269 tmp16 = r8712_read16(padapter, TCR);
270 while (((tmp16 & _IMEM_RDY) == 0) && (i > 0)) {
271 msleep(20);
272 tmp16 = r8712_read16(padapter, TCR);
273 i--;
274 }
275 if (i == 0) {
276 r8712_write16(padapter, 0x10250348, 0xc000);
277 r8712_write16(padapter, 0x10250348, 0xc001);
278 r8712_write16(padapter, 0x10250348, 0x2000);
279 r8712_write16(padapter, 0x10250348, 0x2001);
280 r8712_write16(padapter, 0x10250348, 0x2002);
281 r8712_write16(padapter, 0x10250348, 0x2003);
282 goto exit_fail;
283 }
284 /* 5.Download DMEM code size and Load EMEM Code Section */
285 memset(ptx_desc, 0, TXDESC_SIZE);
286 ptx_desc->txdw0 |= cpu_to_le32(fwhdr.fw_priv_sz&0x0000ffff);
287 ptx_desc->txdw0 |= cpu_to_le32(BIT(28));
288 memcpy(ppayload, &fwhdr.fwpriv, fwhdr.fw_priv_sz);
289 r8712_write_mem(padapter, RTL8712_DMA_VOQ,
290 fwhdr.fw_priv_sz + TXDESC_SIZE, (u8 *)ptx_desc);
291
292 /* polling dmem code done */
293 i = 100;
294 tmp16 = r8712_read16(padapter, TCR);
295 while (((tmp16 & _DMEM_CODE_DONE) == 0) && (i > 0)) {
296 msleep(20);
297 tmp16 = r8712_read16(padapter, TCR);
298 i--;
299 }
300 if (i == 0)
301 goto exit_fail;
302
303 tmp8 = r8712_read8(padapter, 0x1025000A);
304 if (tmp8 & BIT(4)) /* When boot from EEPROM,
305 & FW need more time to read EEPROM */
306 i = 60;
307 else /* boot from EFUSE */
308 i = 30;
309 tmp16 = r8712_read16(padapter, TCR);
310 while (((tmp16 & _FWRDY) == 0) && (i > 0)) {
311 msleep(100);
312 tmp16 = r8712_read16(padapter, TCR);
313 i--;
314 }
315 if (i == 0)
316 goto exit_fail;
317 } else
318 goto exit_fail;
319 ret = _SUCCESS;
320
321 exit_fail:
322 kfree(ptmpchar);
323 return ret;
324 }
325
rtl8712_hal_init(struct _adapter * padapter)326 uint rtl8712_hal_init(struct _adapter *padapter)
327 {
328 u32 val32;
329 int i;
330
331 /* r8712 firmware download */
332 if (rtl8712_dl_fw(padapter) != _SUCCESS)
333 return _FAIL;
334
335 netdev_info(padapter->pnetdev, "1 RCR=0x%x\n",
336 r8712_read32(padapter, RCR));
337 val32 = r8712_read32(padapter, RCR);
338 r8712_write32(padapter, RCR, (val32 | BIT(26))); /* Enable RX TCP
339 Checksum offload */
340 netdev_info(padapter->pnetdev, "2 RCR=0x%x\n",
341 r8712_read32(padapter, RCR));
342 val32 = r8712_read32(padapter, RCR);
343 r8712_write32(padapter, RCR, (val32|BIT(25))); /* Append PHY status */
344 val32 = 0;
345 val32 = r8712_read32(padapter, 0x10250040);
346 r8712_write32(padapter, 0x10250040, (val32&0x00FFFFFF));
347 /* for usb rx aggregation */
348 r8712_write8(padapter, 0x102500B5, r8712_read8(padapter, 0x102500B5) |
349 BIT(0)); /* page = 128bytes */
350 r8712_write8(padapter, 0x102500BD, r8712_read8(padapter, 0x102500BD) |
351 BIT(7)); /* enable usb rx aggregation */
352 r8712_write8(padapter, 0x102500D9, 1); /* TH=1 => means that invalidate
353 * usb rx aggregation */
354 r8712_write8(padapter, 0x1025FE5B, 0x04); /* 1.7ms/4 */
355 /* Fix the RX FIFO issue(USB error) */
356 r8712_write8(padapter, 0x1025fe5C, r8712_read8(padapter, 0x1025fe5C)
357 | BIT(7));
358 for (i = 0; i < 6; i++)
359 padapter->eeprompriv.mac_addr[i] = r8712_read8(padapter,
360 MACID + i);
361 return _SUCCESS;
362 }
363
rtl8712_hal_deinit(struct _adapter * padapter)364 uint rtl8712_hal_deinit(struct _adapter *padapter)
365 {
366 r8712_write8(padapter, RF_CTRL, 0x00);
367 /* Turn off BB */
368 msleep(20);
369 /* Turn off MAC */
370 r8712_write8(padapter, SYS_CLKR+1, 0x38); /* Switch Control Path */
371 r8712_write8(padapter, SYS_FUNC_EN+1, 0x70);
372 r8712_write8(padapter, PMC_FSM, 0x06); /* Enable Loader Data Keep */
373 r8712_write8(padapter, SYS_ISO_CTRL, 0xF9); /* Isolation signals from
374 * CORE, PLL */
375 r8712_write8(padapter, SYS_ISO_CTRL+1, 0xe8); /* Enable EFUSE 1.2V */
376 r8712_write8(padapter, AFE_PLL_CTRL, 0x00); /* Disable AFE PLL. */
377 r8712_write8(padapter, LDOA15_CTRL, 0x54); /* Disable A15V */
378 r8712_write8(padapter, SYS_FUNC_EN+1, 0x50); /* Disable E-Fuse 1.2V */
379 r8712_write8(padapter, LDOV12D_CTRL, 0x24); /* Disable LDO12(for CE) */
380 r8712_write8(padapter, AFE_MISC, 0x30); /* Disable AFE BG&MB */
381 /* Option for Disable 1.6V LDO. */
382 r8712_write8(padapter, SPS0_CTRL, 0x56); /* Disable 1.6V LDO */
383 r8712_write8(padapter, SPS0_CTRL+1, 0x43); /* Set SW PFM */
384 return _SUCCESS;
385 }
386
rtl871x_hal_init(struct _adapter * padapter)387 uint rtl871x_hal_init(struct _adapter *padapter)
388 {
389 padapter->hw_init_completed = false;
390 if (padapter->halpriv.hal_bus_init == NULL)
391 return _FAIL;
392 if (padapter->halpriv.hal_bus_init(padapter) != _SUCCESS)
393 return _FAIL;
394 if (rtl8712_hal_init(padapter) == _SUCCESS)
395 padapter->hw_init_completed = true;
396 else {
397 padapter->hw_init_completed = false;
398 return _FAIL;
399 }
400 return _SUCCESS;
401 }
402