drivers/staging/rtl8712/hal_init.c

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