1 /**************************************************************************************************
2 * Procedure: Init boot code/firmware code/data session
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.
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 **************************************************************************************************/
16 #include "r8192U_hw.h"
17 #include "r819xU_firmware_img.h"
18 #include "r819xU_firmware.h"
19 #include <linux/firmware.h>
20 void firmware_init_param(struct net_device *dev)
22 struct r8192_priv *priv = ieee80211_priv(dev);
23 rt_firmware *pfirmware = priv->pFirmware;
25 pfirmware->cmdpacket_frag_thresold = GET_COMMAND_PACKET_FRAG_THRESHOLD(MAX_TRANSMIT_BUFFER_SIZE);
29 * segment the img and use the ptr and length to remember info on each segment
32 bool fw_download_code(struct net_device *dev, u8 *code_virtual_address, u32 buffer_len)
34 struct r8192_priv *priv = ieee80211_priv(dev);
35 bool rt_status = true;
37 u16 frag_length, frag_offset = 0;
41 rt_firmware *pfirmware = priv->pFirmware;
43 unsigned char *seg_ptr;
47 firmware_init_param(dev);
48 //Fragmentation might be required
49 frag_threshold = pfirmware->cmdpacket_frag_thresold;
51 if ((buffer_len - frag_offset) > frag_threshold) {
52 frag_length = frag_threshold ;
56 frag_length = buffer_len - frag_offset;
61 /* Allocate skb buffer to contain firmware info and tx descriptor info
62 * add 4 to avoid packet appending overflow.
64 skb = dev_alloc_skb(USB_HWDESC_HEADER_LEN + frag_length + 4);
67 memcpy((unsigned char *)(skb->cb),&dev,sizeof(dev));
68 tcb_desc = (cb_desc *)(skb->cb + MAX_DEV_ADDR_SIZE);
69 tcb_desc->queue_index = TXCMD_QUEUE;
70 tcb_desc->bCmdOrInit = DESC_PACKET_TYPE_INIT;
71 tcb_desc->bLastIniPkt = bLastIniPkt;
73 skb_reserve(skb, USB_HWDESC_HEADER_LEN);
76 * Transform from little endian to big endian
79 for(i=0 ; i < frag_length; i+=4) {
80 *seg_ptr++ = ((i+0)<frag_length)?code_virtual_address[i+3]:0;
81 *seg_ptr++ = ((i+1)<frag_length)?code_virtual_address[i+2]:0;
82 *seg_ptr++ = ((i+2)<frag_length)?code_virtual_address[i+1]:0;
83 *seg_ptr++ = ((i+3)<frag_length)?code_virtual_address[i+0]:0;
85 tcb_desc->txbuf_size= (u16)i;
88 if (!priv->ieee80211->check_nic_enough_desc(dev,tcb_desc->queue_index)||
89 (!skb_queue_empty(&priv->ieee80211->skb_waitQ[tcb_desc->queue_index]))||\
90 (priv->ieee80211->queue_stop) ) {
91 RT_TRACE(COMP_FIRMWARE,"=====================================================> tx full!\n");
92 skb_queue_tail(&priv->ieee80211->skb_waitQ[tcb_desc->queue_index], skb);
94 priv->ieee80211->softmac_hard_start_xmit(skb,dev);
97 code_virtual_address += frag_length;
98 frag_offset += frag_length;
100 }while(frag_offset < buffer_len);
108 struct net_device *dev,
112 bool rtStatus = true;
113 struct r8192_priv *priv = ieee80211_priv(dev);
116 unsigned char *ptr_buf;
117 bool bLastInitPacket = false;
119 //PlatformAcquireSpinLock(Adapter, RT_TX_SPINLOCK);
121 //Get TCB and local buffer from common pool. (It is shared by CmdQ, MgntQ, and USB coalesce DataQ)
122 skb = dev_alloc_skb(Length+ 4);
123 memcpy((unsigned char *)(skb->cb),&dev,sizeof(dev));
124 tcb_desc = (cb_desc *)(skb->cb + MAX_DEV_ADDR_SIZE);
125 tcb_desc->queue_index = TXCMD_QUEUE;
126 tcb_desc->bCmdOrInit = DESC_PACKET_TYPE_INIT;
127 tcb_desc->bLastIniPkt = bLastInitPacket;
128 ptr_buf = skb_put(skb, Length);
129 memset(ptr_buf,0,Length);
130 tcb_desc->txbuf_size= (u16)Length;
132 if (!priv->ieee80211->check_nic_enough_desc(dev,tcb_desc->queue_index)||
133 (!skb_queue_empty(&priv->ieee80211->skb_waitQ[tcb_desc->queue_index]))||\
134 (priv->ieee80211->queue_stop) ) {
135 RT_TRACE(COMP_FIRMWARE,"===================NULL packet==================================> tx full!\n");
136 skb_queue_tail(&priv->ieee80211->skb_waitQ[tcb_desc->queue_index], skb);
138 priv->ieee80211->softmac_hard_start_xmit(skb,dev);
141 //PlatformReleaseSpinLock(Adapter, RT_TX_SPINLOCK);
146 //-----------------------------------------------------------------------------
147 // Procedure: Check whether main code is download OK. If OK, turn on CPU
149 // Description: CPU register locates in different page against general register.
150 // Switch to CPU register in the begin and switch back before return
153 // Arguments: The pointer of the adapter
156 // NDIS_STATUS_FAILURE - the following initialization process should be terminated
157 // NDIS_STATUS_SUCCESS - if firmware initialization process success
158 //-----------------------------------------------------------------------------
159 bool CPUcheck_maincodeok_turnonCPU(struct net_device *dev)
161 bool rt_status = true;
162 int check_putcodeOK_time = 200000, check_bootOk_time = 200000;
165 /* Check whether put code OK */
167 read_nic_dword(dev, CPU_GEN, &CPU_status);
169 if (CPU_status&CPU_GEN_PUT_CODE_OK)
172 }while(check_putcodeOK_time--);
174 if (!(CPU_status&CPU_GEN_PUT_CODE_OK)) {
175 RT_TRACE(COMP_ERR, "Download Firmware: Put code fail!\n");
176 goto CPUCheckMainCodeOKAndTurnOnCPU_Fail;
178 RT_TRACE(COMP_FIRMWARE, "Download Firmware: Put code ok!\n");
182 read_nic_dword(dev, CPU_GEN, &CPU_status);
183 write_nic_byte(dev, CPU_GEN, (u8)((CPU_status|CPU_GEN_PWR_STB_CPU)&0xff));
186 /* Check whether CPU boot OK */
188 read_nic_dword(dev, CPU_GEN, &CPU_status);
190 if (CPU_status&CPU_GEN_BOOT_RDY)
192 }while(check_bootOk_time--);
194 if (!(CPU_status&CPU_GEN_BOOT_RDY)) {
195 goto CPUCheckMainCodeOKAndTurnOnCPU_Fail;
197 RT_TRACE(COMP_FIRMWARE, "Download Firmware: Boot ready!\n");
202 CPUCheckMainCodeOKAndTurnOnCPU_Fail:
203 RT_TRACE(COMP_ERR, "ERR in %s()\n", __FUNCTION__);
208 bool CPUcheck_firmware_ready(struct net_device *dev)
211 bool rt_status = true;
212 int check_time = 200000;
215 /* Check Firmware Ready */
217 read_nic_dword(dev, CPU_GEN, &CPU_status);
219 if (CPU_status&CPU_GEN_FIRM_RDY)
222 }while(check_time--);
224 if (!(CPU_status&CPU_GEN_FIRM_RDY))
225 goto CPUCheckFirmwareReady_Fail;
227 RT_TRACE(COMP_FIRMWARE, "Download Firmware: Firmware ready!\n");
231 CPUCheckFirmwareReady_Fail:
232 RT_TRACE(COMP_ERR, "ERR in %s()\n", __FUNCTION__);
238 bool init_firmware(struct net_device *dev)
240 struct r8192_priv *priv = ieee80211_priv(dev);
241 bool rt_status = TRUE;
244 u8 *mapped_file = NULL;
246 opt_rst_type_e rst_opt = OPT_SYSTEM_RESET;
247 firmware_init_step_e starting_state = FW_INIT_STEP0_BOOT;
249 rt_firmware *pfirmware = priv->pFirmware;
250 const struct firmware *fw_entry;
251 const char *fw_name[3] = { "RTL8192U/boot.img",
253 "RTL8192U/data.img"};
256 RT_TRACE(COMP_FIRMWARE, " PlatformInitFirmware()==>\n");
258 if (pfirmware->firmware_status == FW_STATUS_0_INIT ) {
259 /* it is called by reset */
260 rst_opt = OPT_SYSTEM_RESET;
261 starting_state = FW_INIT_STEP0_BOOT;
262 // TODO: system reset
264 }else if (pfirmware->firmware_status == FW_STATUS_5_READY) {
265 /* it is called by Initialize */
266 rst_opt = OPT_FIRMWARE_RESET;
267 starting_state = FW_INIT_STEP2_DATA;
269 RT_TRACE(COMP_FIRMWARE, "PlatformInitFirmware: undefined firmware state\n");
273 * Download boot, main, and data image for System reset.
274 * Download data image for firmware reset
276 for(init_step = starting_state; init_step <= FW_INIT_STEP2_DATA; init_step++) {
278 * Open image file, and map file to continuous memory if open file success.
279 * or read image file from array. Default load from IMG file
281 if (rst_opt == OPT_SYSTEM_RESET) {
282 rc = request_firmware(&fw_entry, fw_name[init_step],&priv->udev->dev);
284 RT_TRACE(COMP_ERR, "request firmware fail!\n");
285 goto download_firmware_fail;
288 if (fw_entry->size > sizeof(pfirmware->firmware_buf)) {
289 RT_TRACE(COMP_ERR, "img file size exceed the container buffer fail!\n");
290 goto download_firmware_fail;
293 if (init_step != FW_INIT_STEP1_MAIN) {
294 memcpy(pfirmware->firmware_buf,fw_entry->data,fw_entry->size);
295 mapped_file = pfirmware->firmware_buf;
296 file_length = fw_entry->size;
298 memset(pfirmware->firmware_buf,0,128);
299 memcpy(&pfirmware->firmware_buf[128],fw_entry->data,fw_entry->size);
300 mapped_file = pfirmware->firmware_buf;
301 file_length = fw_entry->size + 128;
303 pfirmware->firmware_buf_size = file_length;
304 }else if (rst_opt == OPT_FIRMWARE_RESET ) {
305 /* we only need to download data.img here */
306 mapped_file = pfirmware->firmware_buf;
307 file_length = pfirmware->firmware_buf_size;
310 /* Download image file */
311 /* The firmware download process is just as following,
312 * 1. that is each packet will be segmented and inserted to the wait queue.
313 * 2. each packet segment will be put in the skb_buff packet.
314 * 3. each skb_buff packet data content will already include the firmware info
315 * and Tx descriptor info
317 rt_status = fw_download_code(dev,mapped_file,file_length);
318 if (rst_opt == OPT_SYSTEM_RESET) {
319 release_firmware(fw_entry);
322 if (rt_status != TRUE) {
323 goto download_firmware_fail;
327 case FW_INIT_STEP0_BOOT:
329 * initialize command descriptor.
330 * will set polling bit when firmware code is also configured
332 pfirmware->firmware_status = FW_STATUS_1_MOVE_BOOT_CODE;
335 * To initialize IMEM, CPU move code from 0x80000080,
336 * hence, we send 0x80 byte packet
340 case FW_INIT_STEP1_MAIN:
341 /* Download firmware code. Wait until Boot Ready and Turn on CPU */
342 pfirmware->firmware_status = FW_STATUS_2_MOVE_MAIN_CODE;
344 /* Check Put Code OK and Turn On CPU */
345 rt_status = CPUcheck_maincodeok_turnonCPU(dev);
346 if (rt_status != TRUE) {
347 RT_TRACE(COMP_ERR, "CPUcheck_maincodeok_turnonCPU fail!\n");
348 goto download_firmware_fail;
351 pfirmware->firmware_status = FW_STATUS_3_TURNON_CPU;
354 case FW_INIT_STEP2_DATA:
355 /* download initial data code */
356 pfirmware->firmware_status = FW_STATUS_4_MOVE_DATA_CODE;
359 rt_status = CPUcheck_firmware_ready(dev);
360 if (rt_status != TRUE) {
361 RT_TRACE(COMP_ERR, "CPUcheck_firmware_ready fail(%d)!\n",rt_status);
362 goto download_firmware_fail;
365 /* wait until data code is initialized ready.*/
366 pfirmware->firmware_status = FW_STATUS_5_READY;
371 RT_TRACE(COMP_FIRMWARE, "Firmware Download Success\n");
372 //assert(pfirmware->firmware_status == FW_STATUS_5_READY, ("Firmware Download Fail\n"));
376 download_firmware_fail:
377 RT_TRACE(COMP_ERR, "ERR in %s()\n", __FUNCTION__);
383 MODULE_FIRMWARE("RTL8192U/boot.img");
384 MODULE_FIRMWARE("RTL8192U/main.img");
385 MODULE_FIRMWARE("RTL8192U/data.img");