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