drivers/staging/rtl8192u/r819xU_firmware.c

   1 /**************************************************************************************************
   2  * Procedure:    Init boot code/firmware code/data session
   3  *
   4  * Description: This routine will initialize firmware. If any error occurs during the initialization
   5  *              process, the routine shall terminate immediately and return fail.
   6  *              NIC driver should call NdisOpenFile only from MiniportInitialize.
   7  *
   8  * Arguments:   The pointer of the adapter
   9
  10  * Returns:
  11  *        NDIS_STATUS_FAILURE - the following initialization process should be terminated
  12  *        NDIS_STATUS_SUCCESS - if firmware initialization process success
  13 **************************************************************************************************/
  14
  15 #include "r8192U.h"
  16 #include "r8192U_hw.h"
  17 #include "r819xU_firmware_img.h"
  18 #include "r819xU_firmware.h"
  19 #include <linux/firmware.h>
  20
  21 static void firmware_init_param(struct net_device *dev)
  22 {
  23         struct r8192_priv       *priv = ieee80211_priv(dev);
  24         rt_firmware             *pfirmware = priv->pFirmware;
  25
  26         pfirmware->cmdpacket_frag_thresold = GET_COMMAND_PACKET_FRAG_THRESHOLD(MAX_TRANSMIT_BUFFER_SIZE);
  27 }
  28
  29 /*
  30  * segment the img and use the ptr and length to remember info on each segment
  31  *
  32  */
  33 static bool fw_download_code(struct net_device *dev, u8 *code_virtual_address,
  34                              u32 buffer_len)
  35 {
  36         struct r8192_priv   *priv = ieee80211_priv(dev);
  37         bool                rt_status = true;
  38         u16                 frag_threshold;
  39         u16                 frag_length, frag_offset = 0;
  40         //u16               total_size;
  41         int                 i;
  42
  43         rt_firmware         *pfirmware = priv->pFirmware;
  44         struct sk_buff      *skb;
  45         unsigned char       *seg_ptr;
  46         cb_desc             *tcb_desc;
  47         u8                  bLastIniPkt;
  48
  49         firmware_init_param(dev);
  50         //Fragmentation might be required
  51         frag_threshold = pfirmware->cmdpacket_frag_thresold;
  52         do {
  53                 if ((buffer_len - frag_offset) > frag_threshold) {
  54                         frag_length = frag_threshold ;
  55                         bLastIniPkt = 0;
  56
  57                 } else {
  58                         frag_length = buffer_len - frag_offset;
  59                         bLastIniPkt = 1;
  60
  61                 }
  62
  63                 /* Allocate skb buffer to contain firmware info and tx descriptor info
  64                  * add 4 to avoid packet appending overflow.
  65                  * */
  66                 skb  = dev_alloc_skb(USB_HWDESC_HEADER_LEN + frag_length + 4);
  67                 if (!skb)
  68                         return false;
  69                 memcpy((unsigned char *)(skb->cb),&dev,sizeof(dev));
  70                 tcb_desc = (cb_desc *)(skb->cb + MAX_DEV_ADDR_SIZE);
  71                 tcb_desc->queue_index = TXCMD_QUEUE;
  72                 tcb_desc->bCmdOrInit = DESC_PACKET_TYPE_INIT;
  73                 tcb_desc->bLastIniPkt = bLastIniPkt;
  74
  75                 skb_reserve(skb, USB_HWDESC_HEADER_LEN);
  76                 seg_ptr = skb->data;
  77                 /*
  78                  * Transform from little endian to big endian
  79                  * and pending  zero
  80                  */
  81                 for(i=0 ; i < frag_length; i+=4) {
  82                         *seg_ptr++ = ((i+0)<frag_length)?code_virtual_address[i+3]:0;
  83                         *seg_ptr++ = ((i+1)<frag_length)?code_virtual_address[i+2]:0;
  84                         *seg_ptr++ = ((i+2)<frag_length)?code_virtual_address[i+1]:0;
  85                         *seg_ptr++ = ((i+3)<frag_length)?code_virtual_address[i+0]:0;
  86                 }
  87                 tcb_desc->txbuf_size= (u16)i;
  88                 skb_put(skb, i);
  89
  90                 if (!priv->ieee80211->check_nic_enough_desc(dev,tcb_desc->queue_index)||
  91                         (!skb_queue_empty(&priv->ieee80211->skb_waitQ[tcb_desc->queue_index]))||\
  92                         (priv->ieee80211->queue_stop) ) {
  93                         RT_TRACE(COMP_FIRMWARE,"=====================================================> tx full!\n");
  94                         skb_queue_tail(&priv->ieee80211->skb_waitQ[tcb_desc->queue_index], skb);
  95                 } else {
  96                         priv->ieee80211->softmac_hard_start_xmit(skb,dev);
  97                 }
  98
  99                 code_virtual_address += frag_length;
 100                 frag_offset += frag_length;
 101
 102         }while(frag_offset < buffer_len);
 103
 104         return rt_status;
 105
 106 }
 107
 108 //-----------------------------------------------------------------------------
 109 // Procedure:    Check whether main code is download OK. If OK, turn on CPU
 110 //
 111 // Description:   CPU register locates in different page against general register.
 112 //                          Switch to CPU register in the begin and switch back before return
 113 //
 114 //
 115 // Arguments:   The pointer of the adapter
 116 //
 117 // Returns:
 118 //        NDIS_STATUS_FAILURE - the following initialization process should be terminated
 119 //        NDIS_STATUS_SUCCESS - if firmware initialization process success
 120 //-----------------------------------------------------------------------------
 121 static bool CPUcheck_maincodeok_turnonCPU(struct net_device *dev)
 122 {
 123         bool            rt_status = true;
 124         int             check_putcodeOK_time = 200000, check_bootOk_time = 200000;
 125         u32             CPU_status = 0;
 126
 127         /* Check whether put code OK */
 128         do {
 129                 read_nic_dword(dev, CPU_GEN, &CPU_status);
 130
 131                 if (CPU_status&CPU_GEN_PUT_CODE_OK)
 132                         break;
 133
 134         }while(check_putcodeOK_time--);
 135
 136         if (!(CPU_status&CPU_GEN_PUT_CODE_OK)) {
 137                 RT_TRACE(COMP_ERR, "Download Firmware: Put code fail!\n");
 138                 goto CPUCheckMainCodeOKAndTurnOnCPU_Fail;
 139         } else {
 140                 RT_TRACE(COMP_FIRMWARE, "Download Firmware: Put code ok!\n");
 141         }
 142
 143         /* Turn On CPU */
 144         read_nic_dword(dev, CPU_GEN, &CPU_status);
 145         write_nic_byte(dev, CPU_GEN, (u8)((CPU_status|CPU_GEN_PWR_STB_CPU)&0xff));
 146         mdelay(1000);
 147
 148         /* Check whether CPU boot OK */
 149         do {
 150                 read_nic_dword(dev, CPU_GEN, &CPU_status);
 151
 152                 if (CPU_status&CPU_GEN_BOOT_RDY)
 153                         break;
 154         }while(check_bootOk_time--);
 155
 156         if (!(CPU_status&CPU_GEN_BOOT_RDY)) {
 157                 goto CPUCheckMainCodeOKAndTurnOnCPU_Fail;
 158         } else {
 159                 RT_TRACE(COMP_FIRMWARE, "Download Firmware: Boot ready!\n");
 160         }
 161
 162         return rt_status;
 163
 164 CPUCheckMainCodeOKAndTurnOnCPU_Fail:
 165         RT_TRACE(COMP_ERR, "ERR in %s()\n", __FUNCTION__);
 166         rt_status = FALSE;
 167         return rt_status;
 168 }
 169
 170 static bool CPUcheck_firmware_ready(struct net_device *dev)
 171 {
 172
 173         bool            rt_status = true;
 174         int             check_time = 200000;
 175         u32             CPU_status = 0;
 176
 177         /* Check Firmware Ready */
 178         do {
 179                 read_nic_dword(dev, CPU_GEN, &CPU_status);
 180
 181                 if (CPU_status&CPU_GEN_FIRM_RDY)
 182                         break;
 183
 184         }while(check_time--);
 185
 186         if (!(CPU_status&CPU_GEN_FIRM_RDY))
 187                 goto CPUCheckFirmwareReady_Fail;
 188         else
 189                 RT_TRACE(COMP_FIRMWARE, "Download Firmware: Firmware ready!\n");
 190
 191         return rt_status;
 192
 193 CPUCheckFirmwareReady_Fail:
 194         RT_TRACE(COMP_ERR, "ERR in %s()\n", __FUNCTION__);
 195         rt_status = false;
 196         return rt_status;
 197
 198 }
 199
 200 bool init_firmware(struct net_device *dev)
 201 {
 202         struct r8192_priv       *priv = ieee80211_priv(dev);
 203         bool                    rt_status = TRUE;
 204
 205         u32                     file_length = 0;
 206         u8                      *mapped_file = NULL;
 207         u32                     init_step = 0;
 208         opt_rst_type_e  rst_opt = OPT_SYSTEM_RESET;
 209         firmware_init_step_e    starting_state = FW_INIT_STEP0_BOOT;
 210
 211         rt_firmware             *pfirmware = priv->pFirmware;
 212         const struct firmware   *fw_entry;
 213         const char *fw_name[3] = { "RTL8192U/boot.img",
 214                            "RTL8192U/main.img",
 215                            "RTL8192U/data.img"};
 216         int rc;
 217
 218         RT_TRACE(COMP_FIRMWARE, " PlatformInitFirmware()==>\n");
 219
 220         if (pfirmware->firmware_status == FW_STATUS_0_INIT ) {
 221                 /* it is called by reset */
 222                 rst_opt = OPT_SYSTEM_RESET;
 223                 starting_state = FW_INIT_STEP0_BOOT;
 224                 // TODO: system reset
 225
 226         }else if (pfirmware->firmware_status == FW_STATUS_5_READY) {
 227                 /* it is called by Initialize */
 228                 rst_opt = OPT_FIRMWARE_RESET;
 229                 starting_state = FW_INIT_STEP2_DATA;
 230         }else {
 231                  RT_TRACE(COMP_FIRMWARE, "PlatformInitFirmware: undefined firmware state\n");
 232         }
 233
 234         /*
 235          * Download boot, main, and data image for System reset.
 236          * Download data image for firmware reset
 237          */
 238         for(init_step = starting_state; init_step <= FW_INIT_STEP2_DATA; init_step++) {
 239                 /*
 240                  * Open image file, and map file to continuous memory if open file success.
 241                  * or read image file from array. Default load from IMG file
 242                  */
 243                 if (rst_opt == OPT_SYSTEM_RESET) {
 244                         rc = request_firmware(&fw_entry, fw_name[init_step],&priv->udev->dev);
 245                         if (rc < 0 ) {
 246                                 RT_TRACE(COMP_ERR, "request firmware fail!\n");
 247                                 goto download_firmware_fail;
 248                         }
 249
 250                         if (fw_entry->size > sizeof(pfirmware->firmware_buf)) {
 251                                 RT_TRACE(COMP_ERR, "img file size exceed the container buffer fail!\n");
 252                                 goto download_firmware_fail;
 253                         }
 254
 255                         if (init_step != FW_INIT_STEP1_MAIN) {
 256                                 memcpy(pfirmware->firmware_buf,fw_entry->data,fw_entry->size);
 257                                 mapped_file = pfirmware->firmware_buf;
 258                                 file_length = fw_entry->size;
 259                         } else {
 260                                 memset(pfirmware->firmware_buf,0,128);
 261                                 memcpy(&pfirmware->firmware_buf[128],fw_entry->data,fw_entry->size);
 262                                 mapped_file = pfirmware->firmware_buf;
 263                                 file_length = fw_entry->size + 128;
 264                         }
 265                         pfirmware->firmware_buf_size = file_length;
 266                 }else if (rst_opt == OPT_FIRMWARE_RESET ) {
 267                         /* we only need to download data.img here */
 268                         mapped_file = pfirmware->firmware_buf;
 269                         file_length = pfirmware->firmware_buf_size;
 270                 }
 271
 272                 /* Download image file */
 273                 /* The firmware download process is just as following,
 274                  * 1. that is each packet will be segmented and inserted to the wait queue.
 275                  * 2. each packet segment will be put in the skb_buff packet.
 276                  * 3. each skb_buff packet data content will already include the firmware info
 277                  *   and Tx descriptor info
 278                  * */
 279                 rt_status = fw_download_code(dev,mapped_file,file_length);
 280                 if (rst_opt == OPT_SYSTEM_RESET) {
 281                         release_firmware(fw_entry);
 282                 }
 283
 284                 if (rt_status != TRUE) {
 285                         goto download_firmware_fail;
 286                 }
 287
 288                 switch (init_step) {
 289                 case FW_INIT_STEP0_BOOT:
 290                         /* Download boot
 291                          * initialize command descriptor.
 292                          * will set polling bit when firmware code is also configured
 293                          */
 294                         pfirmware->firmware_status = FW_STATUS_1_MOVE_BOOT_CODE;
 295                         //mdelay(1000);
 296                         /*
 297                          * To initialize IMEM, CPU move code  from 0x80000080,
 298                          * hence, we send 0x80 byte packet
 299                          */
 300                         break;
 301
 302                 case FW_INIT_STEP1_MAIN:
 303                         /* Download firmware code. Wait until Boot Ready and Turn on CPU */
 304                         pfirmware->firmware_status = FW_STATUS_2_MOVE_MAIN_CODE;
 305
 306                         /* Check Put Code OK and Turn On CPU */
 307                         rt_status = CPUcheck_maincodeok_turnonCPU(dev);
 308                         if (rt_status != TRUE) {
 309                                 RT_TRACE(COMP_ERR, "CPUcheck_maincodeok_turnonCPU fail!\n");
 310                                 goto download_firmware_fail;
 311                         }
 312
 313                         pfirmware->firmware_status = FW_STATUS_3_TURNON_CPU;
 314                         break;
 315
 316                 case FW_INIT_STEP2_DATA:
 317                         /* download initial data code */
 318                         pfirmware->firmware_status = FW_STATUS_4_MOVE_DATA_CODE;
 319                         mdelay(1);
 320
 321                         rt_status = CPUcheck_firmware_ready(dev);
 322                         if (rt_status != TRUE) {
 323                                 RT_TRACE(COMP_ERR, "CPUcheck_firmware_ready fail(%d)!\n",rt_status);
 324                                 goto download_firmware_fail;
 325                         }
 326
 327                         /* wait until data code is initialized ready.*/
 328                         pfirmware->firmware_status = FW_STATUS_5_READY;
 329                         break;
 330                 }
 331         }
 332
 333         RT_TRACE(COMP_FIRMWARE, "Firmware Download Success\n");
 334         //assert(pfirmware->firmware_status == FW_STATUS_5_READY, ("Firmware Download Fail\n"));
 335
 336         return rt_status;
 337
 338 download_firmware_fail:
 339         RT_TRACE(COMP_ERR, "ERR in %s()\n", __FUNCTION__);
 340         rt_status = FALSE;
 341         return rt_status;
 342
 343 }
 344
 345 MODULE_FIRMWARE("RTL8192U/boot.img");
 346 MODULE_FIRMWARE("RTL8192U/main.img");
 347 MODULE_FIRMWARE("RTL8192U/data.img");