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