1 // SPDX-License-Identifier: GPL-2.0
2 /******************************************************************************
3 * hal_init.c
4 *
5 * Copyright(c) 2007 - 2010 Realtek Corporation. All rights reserved.
6 * Linux device driver for RTL8192SU
7 *
8 * Modifications for inclusion into the Linux staging tree are
9 * Copyright(c) 2010 Larry Finger. All rights reserved.
10 *
11 * Contact information:
12 * WLAN FAE <wlanfae@realtek.com>.
13 * Larry Finger <Larry.Finger@lwfinger.net>
14 *
15 ******************************************************************************/
16
17 #define _HAL_INIT_C_
18
19 #include <linux/usb.h>
20 #include <linux/device.h>
21 #include <linux/usb/ch9.h>
22 #include <linux/firmware.h>
23 #include <linux/module.h>
24
25 #include "osdep_service.h"
26 #include "drv_types.h"
27 #include "usb_osintf.h"
28
29 #define FWBUFF_ALIGN_SZ 512
30 #define MAX_DUMP_FWSZ (48 * 1024)
31
rtl871x_load_fw_fail(struct _adapter * adapter)32 static void rtl871x_load_fw_fail(struct _adapter *adapter)
33 {
34 struct usb_device *udev = adapter->dvobjpriv.pusbdev;
35 struct device *dev = &udev->dev;
36 struct device *parent = dev->parent;
37
38 complete(&adapter->rtl8712_fw_ready);
39
40 dev_err(&udev->dev, "r8712u: Firmware request failed\n");
41
42 if (parent)
43 device_lock(parent);
44
45 device_release_driver(dev);
46
47 if (parent)
48 device_unlock(parent);
49 }
50
rtl871x_load_fw_cb(const struct firmware * firmware,void * context)51 static void rtl871x_load_fw_cb(const struct firmware *firmware, void *context)
52 {
53 struct _adapter *adapter = context;
54
55 if (!firmware) {
56 rtl871x_load_fw_fail(adapter);
57 return;
58 }
59 adapter->fw = firmware;
60 /* firmware available - start netdev */
61 register_netdev(adapter->pnetdev);
62 complete(&adapter->rtl8712_fw_ready);
63 }
64
65 static const char firmware_file[] = "rtlwifi/rtl8712u.bin";
66
rtl871x_load_fw(struct _adapter * padapter)67 int rtl871x_load_fw(struct _adapter *padapter)
68 {
69 struct device *dev = &padapter->dvobjpriv.pusbdev->dev;
70 int rc;
71
72 init_completion(&padapter->rtl8712_fw_ready);
73 dev_info(dev, "r8712u: Loading firmware from \"%s\"\n", firmware_file);
74 rc = request_firmware_nowait(THIS_MODULE, 1, firmware_file, dev,
75 GFP_KERNEL, padapter, rtl871x_load_fw_cb);
76 if (rc)
77 dev_err(dev, "r8712u: Firmware request error %d\n", rc);
78 return rc;
79 }
80 MODULE_FIRMWARE("rtlwifi/rtl8712u.bin");
81
rtl871x_open_fw(struct _adapter * adapter,const u8 ** mappedfw)82 static u32 rtl871x_open_fw(struct _adapter *adapter, const u8 **mappedfw)
83 {
84 if (adapter->fw->size > 200000) {
85 dev_err(&adapter->pnetdev->dev, "r8712u: Bad fw->size of %zu\n",
86 adapter->fw->size);
87 return 0;
88 }
89 *mappedfw = adapter->fw->data;
90 return adapter->fw->size;
91 }
92
fill_fwpriv(struct _adapter * adapter,struct fw_priv * fwpriv)93 static void fill_fwpriv(struct _adapter *adapter, struct fw_priv *fwpriv)
94 {
95 struct dvobj_priv *dvobj = &adapter->dvobjpriv;
96 struct registry_priv *regpriv = &adapter->registrypriv;
97
98 memset(fwpriv, 0, sizeof(struct fw_priv));
99 /* todo: check if needs endian conversion */
100 fwpriv->hci_sel = RTL8712_HCI_TYPE_72USB;
101 fwpriv->usb_ep_num = (u8)dvobj->nr_endpoint;
102 fwpriv->bw_40MHz_en = regpriv->cbw40_enable;
103 switch (regpriv->rf_config) {
104 case RTL8712_RF_1T1R:
105 fwpriv->rf_config = RTL8712_RFC_1T1R;
106 break;
107 case RTL8712_RF_2T2R:
108 fwpriv->rf_config = RTL8712_RFC_2T2R;
109 break;
110 case RTL8712_RF_1T2R:
111 default:
112 fwpriv->rf_config = RTL8712_RFC_1T2R;
113 }
114 fwpriv->mp_mode = (regpriv->mp_mode == 1);
115 /* 0:off 1:on 2:auto */
116 fwpriv->vcs_type = regpriv->vrtl_carrier_sense;
117 fwpriv->vcs_mode = regpriv->vcs_type; /* 1:RTS/CTS 2:CTS to self */
118 /* default enable turbo_mode */
119 fwpriv->turbo_mode = (regpriv->wifi_test != 1);
120 fwpriv->low_power_mode = regpriv->low_power;
121 }
122
update_fwhdr(struct fw_hdr * pfwhdr,const u8 * pmappedfw)123 static void update_fwhdr(struct fw_hdr *pfwhdr, const u8 *pmappedfw)
124 {
125 pfwhdr->signature = le16_to_cpu(*(__le16 *)pmappedfw);
126 pfwhdr->version = le16_to_cpu(*(__le16 *)(pmappedfw + 2));
127 /* define the size of boot loader */
128 pfwhdr->dmem_size = le32_to_cpu(*(__le32 *)(pmappedfw + 4));
129 /* define the size of FW in IMEM */
130 pfwhdr->img_IMEM_size = le32_to_cpu(*(__le32 *)(pmappedfw + 8));
131 /* define the size of FW in SRAM */
132 pfwhdr->img_SRAM_size = le32_to_cpu(*(__le32 *)(pmappedfw + 12));
133 /* define the size of DMEM variable */
134 pfwhdr->fw_priv_sz = le32_to_cpu(*(__le32 *)(pmappedfw + 16));
135 }
136
chk_fwhdr(struct fw_hdr * pfwhdr,u32 ulfilelength)137 static u8 chk_fwhdr(struct fw_hdr *pfwhdr, u32 ulfilelength)
138 {
139 u32 fwhdrsz, fw_sz;
140
141 /* check signature */
142 if ((pfwhdr->signature != 0x8712) && (pfwhdr->signature != 0x8192))
143 return _FAIL;
144 /* check fw_priv_sze & sizeof(struct fw_priv) */
145 if (pfwhdr->fw_priv_sz != sizeof(struct fw_priv))
146 return _FAIL;
147 /* check fw_sz & image_fw_sz */
148 fwhdrsz = offsetof(struct fw_hdr, fwpriv) + pfwhdr->fw_priv_sz;
149 fw_sz = fwhdrsz + pfwhdr->img_IMEM_size + pfwhdr->img_SRAM_size +
150 pfwhdr->dmem_size;
151 if (fw_sz != ulfilelength)
152 return _FAIL;
153 return _SUCCESS;
154 }
155
rtl8712_dl_fw(struct _adapter * adapter)156 static u8 rtl8712_dl_fw(struct _adapter *adapter)
157 {
158 sint i;
159 u8 tmp8, tmp8_a;
160 u16 tmp16;
161 u32 maxlen = 0; /* for compare usage */
162 uint dump_imem_sz, imem_sz, dump_emem_sz, emem_sz; /* max = 49152; */
163 struct fw_hdr fwhdr;
164 u32 ulfilelength; /* FW file size */
165 const u8 *mappedfw = NULL;
166 u8 *tmpchar = NULL, *payload, *ptr;
167 struct tx_desc *txdesc;
168 u32 txdscp_sz = sizeof(struct tx_desc);
169 u8 ret = _FAIL;
170
171 ulfilelength = rtl871x_open_fw(adapter, &mappedfw);
172 if (mappedfw && (ulfilelength > 0)) {
173 update_fwhdr(&fwhdr, mappedfw);
174 if (chk_fwhdr(&fwhdr, ulfilelength) == _FAIL)
175 return ret;
176 fill_fwpriv(adapter, &fwhdr.fwpriv);
177 /* firmware check ok */
178 maxlen = (fwhdr.img_IMEM_size > fwhdr.img_SRAM_size) ?
179 fwhdr.img_IMEM_size : fwhdr.img_SRAM_size;
180 maxlen += txdscp_sz;
181 tmpchar = kmalloc(maxlen + FWBUFF_ALIGN_SZ, GFP_KERNEL);
182 if (!tmpchar)
183 return ret;
184
185 txdesc = (struct tx_desc *)(tmpchar + FWBUFF_ALIGN_SZ -
186 ((addr_t)(tmpchar) & (FWBUFF_ALIGN_SZ - 1)));
187 payload = (u8 *)(txdesc) + txdscp_sz;
188 ptr = (u8 *)mappedfw + offsetof(struct fw_hdr, fwpriv) +
189 fwhdr.fw_priv_sz;
190 /* Download FirmWare */
191 /* 1. determine IMEM code size and Load IMEM Code Section */
192 imem_sz = fwhdr.img_IMEM_size;
193 do {
194 memset(txdesc, 0, TXDESC_SIZE);
195 if (imem_sz > MAX_DUMP_FWSZ/*49152*/) {
196 dump_imem_sz = MAX_DUMP_FWSZ;
197 } else {
198 dump_imem_sz = imem_sz;
199 txdesc->txdw0 |= cpu_to_le32(BIT(28));
200 }
201 txdesc->txdw0 |= cpu_to_le32(dump_imem_sz &
202 0x0000ffff);
203 memcpy(payload, ptr, dump_imem_sz);
204 r8712_write_mem(adapter, RTL8712_DMA_VOQ,
205 dump_imem_sz + TXDESC_SIZE,
206 (u8 *)txdesc);
207 ptr += dump_imem_sz;
208 imem_sz -= dump_imem_sz;
209 } while (imem_sz > 0);
210 i = 10;
211 tmp16 = r8712_read16(adapter, TCR);
212 while (((tmp16 & _IMEM_CODE_DONE) == 0) && (i > 0)) {
213 usleep_range(10, 1000);
214 tmp16 = r8712_read16(adapter, TCR);
215 i--;
216 }
217 if (i == 0 || (tmp16 & _IMEM_CHK_RPT) == 0)
218 goto exit_fail;
219
220 /* 2.Download EMEM code size and Load EMEM Code Section */
221 emem_sz = fwhdr.img_SRAM_size;
222 do {
223 memset(txdesc, 0, TXDESC_SIZE);
224 if (emem_sz > MAX_DUMP_FWSZ) { /* max=48k */
225 dump_emem_sz = MAX_DUMP_FWSZ;
226 } else {
227 dump_emem_sz = emem_sz;
228 txdesc->txdw0 |= cpu_to_le32(BIT(28));
229 }
230 txdesc->txdw0 |= cpu_to_le32(dump_emem_sz &
231 0x0000ffff);
232 memcpy(payload, ptr, dump_emem_sz);
233 r8712_write_mem(adapter, RTL8712_DMA_VOQ,
234 dump_emem_sz + TXDESC_SIZE,
235 (u8 *)txdesc);
236 ptr += dump_emem_sz;
237 emem_sz -= dump_emem_sz;
238 } while (emem_sz > 0);
239 i = 5;
240 tmp16 = r8712_read16(adapter, TCR);
241 while (((tmp16 & _EMEM_CODE_DONE) == 0) && (i > 0)) {
242 usleep_range(10, 1000);
243 tmp16 = r8712_read16(adapter, TCR);
244 i--;
245 }
246 if (i == 0 || (tmp16 & _EMEM_CHK_RPT) == 0)
247 goto exit_fail;
248
249 /* 3.Enable CPU */
250 tmp8 = r8712_read8(adapter, SYS_CLKR);
251 r8712_write8(adapter, SYS_CLKR, tmp8 | BIT(2));
252 tmp8_a = r8712_read8(adapter, SYS_CLKR);
253 if (tmp8_a != (tmp8 | BIT(2)))
254 goto exit_fail;
255
256 tmp8 = r8712_read8(adapter, SYS_FUNC_EN + 1);
257 r8712_write8(adapter, SYS_FUNC_EN + 1, tmp8 | BIT(2));
258 tmp8_a = r8712_read8(adapter, SYS_FUNC_EN + 1);
259 if (tmp8_a != (tmp8 | BIT(2)))
260 goto exit_fail;
261
262 r8712_read32(adapter, TCR);
263
264 /* 4.polling IMEM Ready */
265 i = 100;
266 tmp16 = r8712_read16(adapter, TCR);
267 while (((tmp16 & _IMEM_RDY) == 0) && (i > 0)) {
268 msleep(20);
269 tmp16 = r8712_read16(adapter, TCR);
270 i--;
271 }
272 if (i == 0) {
273 r8712_write16(adapter, 0x10250348, 0xc000);
274 r8712_write16(adapter, 0x10250348, 0xc001);
275 r8712_write16(adapter, 0x10250348, 0x2000);
276 r8712_write16(adapter, 0x10250348, 0x2001);
277 r8712_write16(adapter, 0x10250348, 0x2002);
278 r8712_write16(adapter, 0x10250348, 0x2003);
279 goto exit_fail;
280 }
281 /* 5.Download DMEM code size and Load EMEM Code Section */
282 memset(txdesc, 0, TXDESC_SIZE);
283 txdesc->txdw0 |= cpu_to_le32(fwhdr.fw_priv_sz & 0x0000ffff);
284 txdesc->txdw0 |= cpu_to_le32(BIT(28));
285 memcpy(payload, &fwhdr.fwpriv, fwhdr.fw_priv_sz);
286 r8712_write_mem(adapter, RTL8712_DMA_VOQ,
287 fwhdr.fw_priv_sz + TXDESC_SIZE, (u8 *)txdesc);
288
289 /* polling dmem code done */
290 i = 100;
291 tmp16 = r8712_read16(adapter, TCR);
292 while (((tmp16 & _DMEM_CODE_DONE) == 0) && (i > 0)) {
293 msleep(20);
294 tmp16 = r8712_read16(adapter, TCR);
295 i--;
296 }
297 if (i == 0)
298 goto exit_fail;
299
300 tmp8 = r8712_read8(adapter, 0x1025000A);
301 if (tmp8 & BIT(4)) /* When boot from EEPROM,
302 * & FW need more time to read EEPROM
303 */
304 i = 60;
305 else /* boot from EFUSE */
306 i = 30;
307 tmp16 = r8712_read16(adapter, TCR);
308 while (((tmp16 & _FWRDY) == 0) && (i > 0)) {
309 msleep(100);
310 tmp16 = r8712_read16(adapter, TCR);
311 i--;
312 }
313 if (i == 0)
314 goto exit_fail;
315 } else {
316 goto exit_fail;
317 }
318 ret = _SUCCESS;
319
320 exit_fail:
321 kfree(tmpchar);
322 return ret;
323 }
324
rtl8712_hal_init(struct _adapter * padapter)325 uint rtl8712_hal_init(struct _adapter *padapter)
326 {
327 u32 val32;
328 int i;
329
330 /* r8712 firmware download */
331 if (rtl8712_dl_fw(padapter) != _SUCCESS)
332 return _FAIL;
333
334 netdev_info(padapter->pnetdev, "1 RCR=0x%x\n",
335 r8712_read32(padapter, RCR));
336 val32 = r8712_read32(padapter, RCR);
337 r8712_write32(padapter, RCR, (val32 | BIT(26))); /* Enable RX TCP
338 * Checksum offload
339 */
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 = r8712_read32(padapter, 0x10250040);
345 r8712_write32(padapter, 0x10250040, (val32 & 0x00FFFFFF));
346 /* for usb rx aggregation */
347 r8712_write8(padapter, 0x102500B5, r8712_read8(padapter, 0x102500B5) |
348 BIT(0)); /* page = 128bytes */
349 r8712_write8(padapter, 0x102500BD, r8712_read8(padapter, 0x102500BD) |
350 BIT(7)); /* enable usb rx aggregation */
351 r8712_write8(padapter, 0x102500D9, 1); /* TH=1 => means that invalidate
352 * usb rx aggregation
353 */
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 < ETH_ALEN; 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 */
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 */
385 return _SUCCESS;
386 }
387
rtl871x_hal_init(struct _adapter * padapter)388 uint rtl871x_hal_init(struct _adapter *padapter)
389 {
390 padapter->hw_init_completed = false;
391 if (!padapter->halpriv.hal_bus_init)
392 return _FAIL;
393 if (padapter->halpriv.hal_bus_init(padapter) != _SUCCESS)
394 return _FAIL;
395 if (rtl8712_hal_init(padapter) == _SUCCESS) {
396 padapter->hw_init_completed = true;
397 } else {
398 padapter->hw_init_completed = false;
399 return _FAIL;
400 }
401 return _SUCCESS;
402 }
403