drivers/staging/rtl8188eu/hal/fw.c

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2009-2013  Realtek Corporation.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of version 2 of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  17  *
  18  * The full GNU General Public License is included in this distribution in the
  19  * file called LICENSE.
  20  *
  21  * Contact Information:
  22  * wlanfae <wlanfae@realtek.com>
  23  * Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
  24  * Hsinchu 300, Taiwan.
  25  *
  26  * Larry Finger <Larry.Finger@lwfinger.net>
  27  *
  28  *****************************************************************************/
  29
  30 #include "fw.h"
  31 #include "drv_types.h"
  32 #include "usb_ops_linux.h"
  33 #include "rtl8188e_spec.h"
  34 #include "rtl8188e_hal.h"
  35
  36 #include <linux/firmware.h>
  37 #include <linux/kmemleak.h>
  38
  39 static void _rtl88e_enable_fw_download(struct adapter *adapt, bool enable)
  40 {
  41         u8 tmp;
  42
  43         if (enable) {
  44                 tmp = usb_read8(adapt, REG_MCUFWDL);
  45                 usb_write8(adapt, REG_MCUFWDL, tmp | 0x01);
  46
  47                 tmp = usb_read8(adapt, REG_MCUFWDL + 2);
  48                 usb_write8(adapt, REG_MCUFWDL + 2, tmp & 0xf7);
  49         } else {
  50                 tmp = usb_read8(adapt, REG_MCUFWDL);
  51                 usb_write8(adapt, REG_MCUFWDL, tmp & 0xfe);
  52
  53                 usb_write8(adapt, REG_MCUFWDL + 1, 0x00);
  54         }
  55 }
  56
  57 static void _rtl88e_fw_block_write(struct adapter *adapt,
  58                                    const u8 *buffer, u32 size)
  59 {
  60         u32 blk_sz = sizeof(u32);
  61         u8 *buf_ptr = (u8 *)buffer;
  62         u32 *pu4BytePtr = (u32 *)buffer;
  63         u32 i, offset, blk_cnt, remain;
  64
  65         blk_cnt = size / blk_sz;
  66         remain = size % blk_sz;
  67
  68         offset = FW_8192C_START_ADDRESS;
  69
  70         for (i = 0; i < blk_cnt; i++) {
  71                 usb_write32(adapt, offset, pu4BytePtr[i]);
  72                 offset += blk_sz;
  73         }
  74
  75         if (remain) {
  76                 offset = blk_cnt * blk_sz;
  77                 buf_ptr += offset;
  78                 for (i = 0; i < remain; i++) {
  79                         usb_write8(adapt, (FW_8192C_START_ADDRESS +
  80                                                  offset + i), buf_ptr[i]);
  81                 }
  82         }
  83 }
  84
  85 static void _rtl88e_fill_dummy(u8 *pfwbuf, u32 *pfwlen)
  86 {
  87         u32 fwlen = *pfwlen;
  88         u8 remain = (u8)(fwlen % 4);
  89
  90         remain = (remain == 0) ? 0 : (4 - remain);
  91
  92         while (remain > 0) {
  93                 pfwbuf[fwlen] = 0;
  94                 fwlen++;
  95                 remain--;
  96         }
  97
  98         *pfwlen = fwlen;
  99 }
 100
 101 static void _rtl88e_fw_page_write(struct adapter *adapt,
 102                                   u32 page, const u8 *buffer, u32 size)
 103 {
 104         u8 value8;
 105         u8 u8page = (u8)(page & 0x07);
 106
 107         value8 = (usb_read8(adapt, REG_MCUFWDL + 2) & 0xF8) | u8page;
 108
 109         usb_write8(adapt, (REG_MCUFWDL + 2), value8);
 110         _rtl88e_fw_block_write(adapt, buffer, size);
 111 }
 112
 113 static void _rtl88e_write_fw(struct adapter *adapt, u8 *buffer, u32 size)
 114 {
 115         u8 *buf_ptr = buffer;
 116         u32 page_no, remain;
 117         u32 page, offset;
 118
 119         _rtl88e_fill_dummy(buf_ptr, &size);
 120
 121         page_no = size / FW_8192C_PAGE_SIZE;
 122         remain = size % FW_8192C_PAGE_SIZE;
 123
 124         for (page = 0; page < page_no; page++) {
 125                 offset = page * FW_8192C_PAGE_SIZE;
 126                 _rtl88e_fw_page_write(adapt, page, (buf_ptr + offset),
 127                                       FW_8192C_PAGE_SIZE);
 128         }
 129
 130         if (remain) {
 131                 offset = page_no * FW_8192C_PAGE_SIZE;
 132                 page = page_no;
 133                 _rtl88e_fw_page_write(adapt, page, (buf_ptr + offset), remain);
 134         }
 135 }
 136
 137 static void rtl88e_firmware_selfreset(struct adapter *adapt)
 138 {
 139         u8 u1b_tmp;
 140
 141         u1b_tmp = usb_read8(adapt, REG_SYS_FUNC_EN+1);
 142         usb_write8(adapt, REG_SYS_FUNC_EN+1, (u1b_tmp & (~BIT(2))));
 143         usb_write8(adapt, REG_SYS_FUNC_EN+1, (u1b_tmp | BIT(2)));
 144 }
 145
 146 static int _rtl88e_fw_free_to_go(struct adapter *adapt)
 147 {
 148         int err = -EIO;
 149         u32 counter = 0;
 150         u32 value32;
 151
 152         do {
 153                 value32 = usb_read32(adapt, REG_MCUFWDL);
 154                 if (value32 & FWDL_ChkSum_rpt)
 155                         break;
 156         } while (counter++ < POLLING_READY_TIMEOUT_COUNT);
 157
 158         if (counter >= POLLING_READY_TIMEOUT_COUNT)
 159                 goto exit;
 160
 161         value32 = usb_read32(adapt, REG_MCUFWDL);
 162         value32 |= MCUFWDL_RDY;
 163         value32 &= ~WINTINI_RDY;
 164         usb_write32(adapt, REG_MCUFWDL, value32);
 165
 166         rtl88e_firmware_selfreset(adapt);
 167         counter = 0;
 168
 169         do {
 170                 value32 = usb_read32(adapt, REG_MCUFWDL);
 171                 if (value32 & WINTINI_RDY) {
 172                         err = 0;
 173                         goto exit;
 174                 }
 175
 176                 udelay(FW_8192C_POLLING_DELAY);
 177
 178         } while (counter++ < POLLING_READY_TIMEOUT_COUNT);
 179
 180 exit:
 181         return err;
 182 }
 183
 184 int rtl88eu_download_fw(struct adapter *adapt)
 185 {
 186         struct hal_data_8188e *rtlhal = GET_HAL_DATA(adapt);
 187         struct dvobj_priv *dvobj = adapter_to_dvobj(adapt);
 188         struct device *device = dvobj_to_dev(dvobj);
 189         const struct firmware *fw;
 190         const char fw_name[] = "rtlwifi/rtl8188eufw.bin";
 191         struct rtl92c_firmware_header *pfwheader = NULL;
 192         u8 *pfwdata;
 193         u32 fwsize;
 194
 195         if (request_firmware(&fw, fw_name, device)) {
 196                 dev_err(device, "Firmware %s not available\n", fw_name);
 197                 return -ENOENT;
 198         }
 199
 200         if (fw->size > FW_8188E_SIZE) {
 201                 dev_err(device, "Firmware size exceed 0x%X. Check it.\n",
 202                          FW_8188E_SIZE);
 203                 return -1;
 204         }
 205
 206         pfwdata = kzalloc(FW_8188E_SIZE, GFP_KERNEL);
 207         if (!pfwdata)
 208                 return -ENOMEM;
 209
 210         rtlhal->pfirmware = pfwdata;
 211         memcpy(rtlhal->pfirmware, fw->data, fw->size);
 212         rtlhal->fwsize = fw->size;
 213         release_firmware(fw);
 214
 215         fwsize = rtlhal->fwsize;
 216         pfwheader = (struct rtl92c_firmware_header *)pfwdata;
 217
 218         if (IS_FW_HEADER_EXIST(pfwheader)) {
 219                 pfwdata = pfwdata + 32;
 220                 fwsize = fwsize - 32;
 221         }
 222
 223         if (usb_read8(adapt, REG_MCUFWDL) & RAM_DL_SEL) {
 224                 usb_write8(adapt, REG_MCUFWDL, 0);
 225                 rtl88e_firmware_selfreset(adapt);
 226         }
 227         _rtl88e_enable_fw_download(adapt, true);
 228         usb_write8(adapt, REG_MCUFWDL, usb_read8(adapt, REG_MCUFWDL) | FWDL_ChkSum_rpt);
 229         _rtl88e_write_fw(adapt, pfwdata, fwsize);
 230         _rtl88e_enable_fw_download(adapt, false);
 231
 232         return _rtl88e_fw_free_to_go(adapt);
 233 }