1 /**************************************************************************************************
2 * Procedure: Init boot code/firmware code/data session
4 * Description: This routine will intialize 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.
8 * Arguments: The pointer of the adapter
11 * NDIS_STATUS_FAILURE - the following initialization process should be terminated
12 * NDIS_STATUS_SUCCESS - if firmware initialization process success
13 **************************************************************************************************/
15 #include "r8192S_firmware.h"
16 #include <linux/unistd.h>
18 #include "r8192S_hw.h"
19 #include "r8192SU_HWImg.h"
20 //#include "r8192S_FwImgDTM.h"
22 #include <linux/firmware.h>
24 #define byte(x,n) ( (x >> (8 * n)) & 0xff )
27 // Description: This routine will intialize firmware. If any error occurs during the initialization
28 // process, the routine shall terminate immediately and return fail.
30 // Arguments: The pointer of the adapter
31 // Code address (Virtual address, should fill descriptor with physical address)
33 // Created by Roger, 2008.04.10.
35 bool FirmwareDownloadCode(struct net_device *dev, u8 * code_virtual_address,u32 buffer_len)
37 struct r8192_priv *priv = ieee80211_priv(dev);
38 bool rt_status = true;
39 u16 frag_threshold = MAX_FIRMWARE_CODE_SIZE; //Fragmentation might be required in 90/92 but not in 92S
40 u16 frag_length, frag_offset = 0;
42 unsigned char *seg_ptr;
45 u16 ExtraDescOffset = 0;
48 RT_TRACE(COMP_FIRMWARE, "--->FirmwareDownloadCode()\n" );
50 //MAX_TRANSMIT_BUFFER_SIZE
51 if(buffer_len >= MAX_FIRMWARE_CODE_SIZE-USB_HWDESC_HEADER_LEN)
53 RT_TRACE(COMP_ERR, "Size over MAX_FIRMWARE_CODE_SIZE! \n");
54 goto cmdsend_downloadcode_fail;
57 ExtraDescOffset = USB_HWDESC_HEADER_LEN;
60 if((buffer_len-frag_offset) > frag_threshold)
62 frag_length = frag_threshold + ExtraDescOffset;
66 frag_length = (u16)(buffer_len - frag_offset + ExtraDescOffset);
70 /* Allocate skb buffer to contain firmware info and tx descriptor info. */
71 skb = dev_alloc_skb(frag_length);
72 memcpy((unsigned char *)(skb->cb),&dev,sizeof(dev));
74 tcb_desc = (cb_desc*)(skb->cb + MAX_DEV_ADDR_SIZE);
75 tcb_desc->queue_index = TXCMD_QUEUE;
76 tcb_desc->bCmdOrInit = DESC_PACKET_TYPE_INIT;
77 tcb_desc->bLastIniPkt = bLastIniPkt;
79 skb_reserve(skb, ExtraDescOffset);
80 seg_ptr = (u8 *)skb_put(skb, (u32)(frag_length-ExtraDescOffset));
81 memcpy(seg_ptr, code_virtual_address+frag_offset, (u32)(frag_length-ExtraDescOffset));
83 tcb_desc->txbuf_size= frag_length;
85 if(!priv->ieee80211->check_nic_enough_desc(dev,tcb_desc->queue_index)||
86 (!skb_queue_empty(&priv->ieee80211->skb_waitQ[tcb_desc->queue_index]))||\
87 (priv->ieee80211->queue_stop) )
89 RT_TRACE(COMP_FIRMWARE,"=====================================================> tx full!\n");
90 skb_queue_tail(&priv->ieee80211->skb_waitQ[tcb_desc->queue_index], skb);
94 priv->ieee80211->softmac_hard_start_xmit(skb,dev);
97 frag_offset += (frag_length - ExtraDescOffset);
99 }while(frag_offset < buffer_len);
104 cmdsend_downloadcode_fail:
106 RT_TRACE(COMP_ERR, "CmdSendDownloadCode fail !!\n");
113 FirmwareEnableCPU(struct net_device *dev)
116 RT_STATUS rtStatus = RT_STATUS_SUCCESS;
117 u8 tmpU1b, CPUStatus = 0;
119 u32 iCheckTime = 200;
121 RT_TRACE(COMP_FIRMWARE, "-->FirmwareEnableCPU()\n" );
123 tmpU1b = read_nic_byte(dev, SYS_CLKR);
124 write_nic_byte(dev, SYS_CLKR, (tmpU1b|SYS_CPU_CLKSEL)); //AFE source
126 tmpU2b = read_nic_word(dev, SYS_FUNC_EN);
127 write_nic_word(dev, SYS_FUNC_EN, (tmpU2b|FEN_CPUEN));
129 //Polling IMEM Ready after CPU has refilled.
132 CPUStatus = read_nic_byte(dev, TCR);
133 if(CPUStatus& IMEM_RDY)
135 RT_TRACE(COMP_FIRMWARE, "IMEM Ready after CPU has refilled.\n");
141 }while(iCheckTime--);
143 if(!(CPUStatus & IMEM_RDY))
144 return RT_STATUS_FAILURE;
146 RT_TRACE(COMP_FIRMWARE, "<--FirmwareEnableCPU(): rtStatus(%#x)\n", rtStatus);
150 FIRMWARE_8192S_STATUS
151 FirmwareGetNextStatus(FIRMWARE_8192S_STATUS FWCurrentStatus)
153 FIRMWARE_8192S_STATUS NextFWStatus = 0;
155 switch(FWCurrentStatus)
158 NextFWStatus = FW_STATUS_LOAD_IMEM;
161 case FW_STATUS_LOAD_IMEM:
162 NextFWStatus = FW_STATUS_LOAD_EMEM;
165 case FW_STATUS_LOAD_EMEM:
166 NextFWStatus = FW_STATUS_LOAD_DMEM;
169 case FW_STATUS_LOAD_DMEM:
170 NextFWStatus = FW_STATUS_READY;
174 RT_TRACE(COMP_ERR,"Invalid FW Status(%#x)!!\n", FWCurrentStatus);
181 FirmwareCheckReady(struct net_device *dev, u8 LoadFWStatus)
183 struct r8192_priv *priv = ieee80211_priv(dev);
184 RT_STATUS rtStatus = RT_STATUS_SUCCESS;
185 rt_firmware *pFirmware = priv->pFirmware;
186 int PollingCnt = 1000;
187 //u8 tmpU1b, CPUStatus = 0;
190 //bool bOrgIMREnable;
192 RT_TRACE(COMP_FIRMWARE, "--->FirmwareCheckReady(): LoadStaus(%d),", LoadFWStatus);
194 pFirmware->FWStatus = (FIRMWARE_8192S_STATUS)LoadFWStatus;
195 if( LoadFWStatus == FW_STATUS_LOAD_IMEM)
198 {//Polling IMEM code done.
199 CPUStatus = read_nic_byte(dev, TCR);
200 if(CPUStatus& IMEM_CODE_DONE)
204 }while(PollingCnt--);
205 if(!(CPUStatus & IMEM_CHK_RPT) || PollingCnt <= 0)
207 RT_TRACE(COMP_ERR, "FW_STATUS_LOAD_IMEM FAIL CPU, Status=%x\r\n", CPUStatus);
211 else if( LoadFWStatus == FW_STATUS_LOAD_EMEM)
212 {//Check Put Code OK and Turn On CPU
214 {//Polling EMEM code done.
215 CPUStatus = read_nic_byte(dev, TCR);
216 if(CPUStatus& EMEM_CODE_DONE)
220 }while(PollingCnt--);
221 if(!(CPUStatus & EMEM_CHK_RPT))
223 RT_TRACE(COMP_ERR, "FW_STATUS_LOAD_EMEM FAIL CPU, Status=%x\r\n", CPUStatus);
228 rtStatus = FirmwareEnableCPU(dev);
229 if(rtStatus != RT_STATUS_SUCCESS)
231 RT_TRACE(COMP_ERR, "Enable CPU fail ! \n" );
235 else if( LoadFWStatus == FW_STATUS_LOAD_DMEM)
238 {//Polling DMEM code done
239 CPUStatus = read_nic_byte(dev, TCR);
240 if(CPUStatus& DMEM_CODE_DONE)
244 }while(PollingCnt--);
246 if(!(CPUStatus & DMEM_CODE_DONE))
248 RT_TRACE(COMP_ERR, "Polling DMEM code done fail ! CPUStatus(%#x)\n", CPUStatus);
252 RT_TRACE(COMP_FIRMWARE, "DMEM code download success, CPUStatus(%#x)\n", CPUStatus);
254 // PollingCnt = 100; // Set polling cycle to 10ms.
255 PollingCnt = 10000; // Set polling cycle to 10ms.
258 {//Polling Load Firmware ready
259 CPUStatus = read_nic_byte(dev, TCR);
260 if(CPUStatus & FWRDY)
264 }while(PollingCnt--);
266 RT_TRACE(COMP_FIRMWARE, "Polling Load Firmware ready, CPUStatus(%x)\n", CPUStatus);
268 //if(!(CPUStatus & LOAD_FW_READY))
269 //if((CPUStatus & LOAD_FW_READY) != 0xff)
270 if((CPUStatus & LOAD_FW_READY) != LOAD_FW_READY)
272 RT_TRACE(COMP_ERR, "Polling Load Firmware ready fail ! CPUStatus(%x)\n", CPUStatus);
277 // <Roger_Notes> USB interface will update reserved followings parameters later!!
282 // <Roger_Notes> If right here, we can set TCR/RCR to desired value
283 // and config MAC lookback mode to normal mode. 2008.08.28.
285 tmpU4b = read_nic_dword(dev,TCR);
286 write_nic_dword(dev, TCR, (tmpU4b&(~TCR_ICV)));
288 tmpU4b = read_nic_dword(dev, RCR);
289 write_nic_dword(dev, RCR,
290 (tmpU4b|RCR_APPFCS|RCR_APP_ICV|RCR_APP_MIC));
292 RT_TRACE(COMP_FIRMWARE, "FirmwareCheckReady(): Current RCR settings(%#x)\n", tmpU4b);
294 #ifdef NOT_YET //YJ,TMP
295 priv->TransmitConfig = read_nic_dword(dev, TCR);
296 RT_TRACE(COMP_FIRMWARE, "FirmwareCheckReady(): Current TCR settings(%x)\n", priv->TransmitConfig);
297 pHalData->FwRsvdTxPageCfg = read_nic_byte(dev, FW_RSVD_PG_CRTL);
300 // Set to normal mode.
301 write_nic_byte(dev, LBKMD_SEL, LBK_NORMAL);
305 RT_TRACE(COMP_FIRMWARE, "<---FirmwareCheckReady(): LoadFWStatus(%d), rtStatus(%x)\n", LoadFWStatus, rtStatus);
306 return (rtStatus == RT_STATUS_SUCCESS) ? true:false;
310 // Description: This routine is to update the RF types in FW header partially.
312 // Created by Roger, 2008.12.24.
314 u8 FirmwareHeaderMapRfType(struct net_device *dev)
316 struct r8192_priv *priv = ieee80211_priv(dev);
317 switch(priv->rf_type)
319 case RF_1T1R: return 0x11;
320 case RF_1T2R: return 0x12;
321 case RF_2T2R: return 0x22;
322 case RF_2T2R_GREEN: return 0x92;
324 RT_TRACE(COMP_INIT, "Unknown RF type(%x)\n",priv->rf_type);
332 // Description: This routine is to update the private parts in FW header partially.
334 // Created by Roger, 2008.12.18.
336 void FirmwareHeaderPriveUpdate(struct net_device *dev, PRT_8192S_FIRMWARE_PRIV pFwPriv)
338 struct r8192_priv *priv = ieee80211_priv(dev);
339 // Update USB endpoint number for RQPN settings.
340 pFwPriv->usb_ep_num = priv->EEPROMUsbEndPointNumber; // endpoint number: 4, 6 and 11.
341 RT_TRACE(COMP_INIT, "FirmwarePriveUpdate(): usb_ep_num(%#x)\n", pFwPriv->usb_ep_num);
343 // Update RF types for RATR settings.
344 pFwPriv->rf_config = FirmwareHeaderMapRfType(dev);
349 bool FirmwareDownload92S(struct net_device *dev)
351 struct r8192_priv *priv = ieee80211_priv(dev);
352 bool rtStatus = true;
353 const char *pFwImageFileName[1] = {"RTL8192SU/rtl8192sfw.bin"};
354 u8 *pucMappedFile = NULL;
355 u32 ulFileLength, ulInitStep = 0;
356 u8 FwHdrSize = RT_8192S_FIRMWARE_HDR_SIZE;
357 rt_firmware *pFirmware = priv->pFirmware;
358 u8 FwStatus = FW_STATUS_INIT;
359 PRT_8192S_FIRMWARE_HDR pFwHdr = NULL;
360 PRT_8192S_FIRMWARE_PRIV pFwPriv = NULL;
362 const struct firmware *fw_entry;
365 pFirmware->FWStatus = FW_STATUS_INIT;
367 RT_TRACE(COMP_FIRMWARE, " --->FirmwareDownload92S()\n");
370 //3 //<1> Open Image file, and map file to contineous memory if open file success.
371 //3 // or read image file from array. Default load from BIN file
373 priv->firmware_source = FW_SOURCE_IMG_FILE;// We should decided by Reg.
375 switch( priv->firmware_source )
377 case FW_SOURCE_IMG_FILE:
378 if(pFirmware->szFwTmpBufferLen == 0)
381 rc = request_firmware(&fw_entry, pFwImageFileName[ulInitStep],&priv->udev->dev);//===>1
383 RT_TRACE(COMP_ERR, "request firmware fail!\n");
384 goto DownloadFirmware_Fail;
387 if(fw_entry->size > sizeof(pFirmware->szFwTmpBuffer))
389 RT_TRACE(COMP_ERR, "img file size exceed the container buffer fail!\n");
390 release_firmware(fw_entry);
391 goto DownloadFirmware_Fail;
394 memcpy(pFirmware->szFwTmpBuffer,fw_entry->data,fw_entry->size);
395 pFirmware->szFwTmpBufferLen = fw_entry->size;
396 release_firmware(fw_entry);
398 pucMappedFile = pFirmware->szFwTmpBuffer;
399 file_length = pFirmware->szFwTmpBufferLen;
401 //Retrieve FW header.
402 pFirmware->pFwHeader = (PRT_8192S_FIRMWARE_HDR) pucMappedFile;
403 pFwHdr = pFirmware->pFwHeader;
404 RT_TRACE(COMP_FIRMWARE,"signature:%x, version:%x, size:%x, imemsize:%x, sram size:%x\n", \
405 pFwHdr->Signature, pFwHdr->Version, pFwHdr->DMEMSize, \
406 pFwHdr->IMG_IMEM_SIZE, pFwHdr->IMG_SRAM_SIZE);
407 pFirmware->FirmwareVersion = byte(pFwHdr->Version ,0);
408 if ((pFwHdr->IMG_IMEM_SIZE==0) || (pFwHdr->IMG_IMEM_SIZE > sizeof(pFirmware->FwIMEM)))
410 RT_TRACE(COMP_ERR, "%s: memory for data image is less than IMEM required\n",\
412 goto DownloadFirmware_Fail;
414 pucMappedFile+=FwHdrSize;
416 //Retrieve IMEM image.
417 memcpy(pFirmware->FwIMEM, pucMappedFile, pFwHdr->IMG_IMEM_SIZE);
418 pFirmware->FwIMEMLen = pFwHdr->IMG_IMEM_SIZE;
421 if (pFwHdr->IMG_SRAM_SIZE > sizeof(pFirmware->FwEMEM))
423 RT_TRACE(COMP_ERR, "%s: memory for data image is less than EMEM required\n",\
425 goto DownloadFirmware_Fail;
427 pucMappedFile += pFirmware->FwIMEMLen;
429 /* Retriecve EMEM image */
430 memcpy(pFirmware->FwEMEM, pucMappedFile, pFwHdr->IMG_SRAM_SIZE);//===>6
431 pFirmware->FwEMEMLen = pFwHdr->IMG_SRAM_SIZE;
438 case FW_SOURCE_HEADER_FILE:
440 #define Rtl819XFwImageArray Rtl8192SUFwImgArray
441 //2008.11.10 Add by tynli.
442 pucMappedFile = Rtl819XFwImageArray;
443 ulFileLength = ImgArrayLength;
445 RT_TRACE(COMP_INIT,"Fw download from header.\n");
446 /* Retrieve FW header*/
447 pFirmware->pFwHeader = (PRT_8192S_FIRMWARE_HDR) pucMappedFile;
448 pFwHdr = pFirmware->pFwHeader;
449 RT_TRACE(COMP_FIRMWARE,"signature:%x, version:%x, size:%x, imemsize:%x, sram size:%x\n", \
450 pFwHdr->Signature, pFwHdr->Version, pFwHdr->DMEMSize, \
451 pFwHdr->IMG_IMEM_SIZE, pFwHdr->IMG_SRAM_SIZE);
452 pFirmware->FirmwareVersion = byte(pFwHdr->Version ,0);
454 if ((pFwHdr->IMG_IMEM_SIZE==0) || (pFwHdr->IMG_IMEM_SIZE > sizeof(pFirmware->FwIMEM)))
456 printk("FirmwareDownload92S(): memory for data image is less than IMEM required\n");
457 goto DownloadFirmware_Fail;
459 pucMappedFile+=FwHdrSize;
460 //Retrieve IMEM image.
461 memcpy(pFirmware->FwIMEM, pucMappedFile, pFwHdr->IMG_IMEM_SIZE);
462 pFirmware->FwIMEMLen = pFwHdr->IMG_IMEM_SIZE;
465 if (pFwHdr->IMG_SRAM_SIZE > sizeof(pFirmware->FwEMEM))
467 printk(" FirmwareDownload92S(): memory for data image is less than EMEM required\n");
468 goto DownloadFirmware_Fail;
470 pucMappedFile+= pFirmware->FwIMEMLen;
472 //Retriecve EMEM image.
473 memcpy(pFirmware->FwEMEM, pucMappedFile, pFwHdr->IMG_SRAM_SIZE);
474 pFirmware->FwEMEMLen = pFwHdr->IMG_SRAM_SIZE;
482 FwStatus = FirmwareGetNextStatus(pFirmware->FWStatus);
483 while(FwStatus!= FW_STATUS_READY)
485 // Image buffer redirection.
488 case FW_STATUS_LOAD_IMEM:
489 pucMappedFile = pFirmware->FwIMEM;
490 ulFileLength = pFirmware->FwIMEMLen;
493 case FW_STATUS_LOAD_EMEM:
494 pucMappedFile = pFirmware->FwEMEM;
495 ulFileLength = pFirmware->FwEMEMLen;
498 case FW_STATUS_LOAD_DMEM:
499 /* <Roger_Notes> Partial update the content of header private. 2008.12.18 */
500 pFwHdr = pFirmware->pFwHeader;
501 pFwPriv = (PRT_8192S_FIRMWARE_PRIV)&pFwHdr->FWPriv;
502 FirmwareHeaderPriveUpdate(dev, pFwPriv);
503 pucMappedFile = (u8*)(pFirmware->pFwHeader)+RT_8192S_FIRMWARE_HDR_EXCLUDE_PRI_SIZE;
504 ulFileLength = FwHdrSize-RT_8192S_FIRMWARE_HDR_EXCLUDE_PRI_SIZE;
508 RT_TRACE(COMP_ERR, "Unexpected Download step!!\n");
509 goto DownloadFirmware_Fail;
514 //3// <2> Download image file
516 rtStatus = FirmwareDownloadCode(dev, pucMappedFile, ulFileLength);
520 RT_TRACE(COMP_ERR, "FirmwareDownloadCode() fail ! \n" );
521 goto DownloadFirmware_Fail;
525 //3// <3> Check whether load FW process is ready
527 rtStatus = FirmwareCheckReady(dev, FwStatus);
531 RT_TRACE(COMP_ERR, "FirmwareDownloadCode() fail ! \n");
532 goto DownloadFirmware_Fail;
535 FwStatus = FirmwareGetNextStatus(pFirmware->FWStatus);
538 RT_TRACE(COMP_FIRMWARE, "Firmware Download Success!!\n");
541 DownloadFirmware_Fail:
542 RT_TRACE(COMP_ERR, "Firmware Download Fail!!%x\n",read_nic_word(dev, TCR));