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>
21 static void firmware_init_param(struct net_device *dev)
23 struct r8192_priv *priv = ieee80211_priv(dev);
24 rt_firmware *pfirmware = priv->pFirmware;
26 pfirmware->cmdpacket_frag_thresold = GET_COMMAND_PACKET_FRAG_THRESHOLD(MAX_TRANSMIT_BUFFER_SIZE);
30 * segment the img and use the ptr and length to remember info on each segment
33 static bool fw_download_code(struct net_device *dev, u8 *code_virtual_address,
36 struct r8192_priv *priv = ieee80211_priv(dev);
37 bool rt_status = true;
39 u16 frag_length, frag_offset = 0;
43 rt_firmware *pfirmware = priv->pFirmware;
45 unsigned char *seg_ptr;
49 firmware_init_param(dev);
50 //Fragmentation might be required
51 frag_threshold = pfirmware->cmdpacket_frag_thresold;
53 if ((buffer_len - frag_offset) > frag_threshold) {
54 frag_length = frag_threshold;
58 frag_length = buffer_len - frag_offset;
63 /* Allocate skb buffer to contain firmware info and tx descriptor info
64 * add 4 to avoid packet appending overflow.
66 skb = dev_alloc_skb(USB_HWDESC_HEADER_LEN + frag_length + 4);
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;
75 skb_reserve(skb, USB_HWDESC_HEADER_LEN);
78 * Transform from little endian to big endian
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;
87 tcb_desc->txbuf_size= (u16)i;
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);
96 priv->ieee80211->softmac_hard_start_xmit(skb, dev);
99 code_virtual_address += frag_length;
100 frag_offset += frag_length;
102 } while (frag_offset < buffer_len);
108 //-----------------------------------------------------------------------------
109 // Procedure: Check whether main code is download OK. If OK, turn on CPU
111 // Description: CPU register locates in different page against general register.
112 // Switch to CPU register in the begin and switch back before return
115 // Arguments: The pointer of the adapter
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)
123 bool rt_status = true;
124 int check_putcodeOK_time = 200000, check_bootOk_time = 200000;
127 /* Check whether put code OK */
129 read_nic_dword(dev, CPU_GEN, &CPU_status);
131 if (CPU_status&CPU_GEN_PUT_CODE_OK)
134 } while (check_putcodeOK_time--);
136 if (!(CPU_status&CPU_GEN_PUT_CODE_OK)) {
137 RT_TRACE(COMP_ERR, "Download Firmware: Put code fail!\n");
138 goto CPUCheckMainCodeOKAndTurnOnCPU_Fail;
140 RT_TRACE(COMP_FIRMWARE, "Download Firmware: Put code ok!\n");
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));
148 /* Check whether CPU boot OK */
150 read_nic_dword(dev, CPU_GEN, &CPU_status);
152 if (CPU_status&CPU_GEN_BOOT_RDY)
154 } while (check_bootOk_time--);
156 if (!(CPU_status&CPU_GEN_BOOT_RDY))
157 goto CPUCheckMainCodeOKAndTurnOnCPU_Fail;
159 RT_TRACE(COMP_FIRMWARE, "Download Firmware: Boot ready!\n");
163 CPUCheckMainCodeOKAndTurnOnCPU_Fail:
164 RT_TRACE(COMP_ERR, "ERR in %s()\n", __func__);
169 static bool CPUcheck_firmware_ready(struct net_device *dev)
172 bool rt_status = true;
173 int check_time = 200000;
176 /* Check Firmware Ready */
178 read_nic_dword(dev, CPU_GEN, &CPU_status);
180 if (CPU_status&CPU_GEN_FIRM_RDY)
183 } while (check_time--);
185 if (!(CPU_status&CPU_GEN_FIRM_RDY))
186 goto CPUCheckFirmwareReady_Fail;
188 RT_TRACE(COMP_FIRMWARE, "Download Firmware: Firmware ready!\n");
192 CPUCheckFirmwareReady_Fail:
193 RT_TRACE(COMP_ERR, "ERR in %s()\n", __func__);
199 bool init_firmware(struct net_device *dev)
201 struct r8192_priv *priv = ieee80211_priv(dev);
202 bool rt_status = TRUE;
205 u8 *mapped_file = NULL;
207 opt_rst_type_e rst_opt = OPT_SYSTEM_RESET;
208 firmware_init_step_e starting_state = FW_INIT_STEP0_BOOT;
210 rt_firmware *pfirmware = priv->pFirmware;
211 const struct firmware *fw_entry;
212 const char *fw_name[3] = { "RTL8192U/boot.img",
214 "RTL8192U/data.img"};
217 RT_TRACE(COMP_FIRMWARE, " PlatformInitFirmware()==>\n");
219 if (pfirmware->firmware_status == FW_STATUS_0_INIT) {
220 /* it is called by reset */
221 rst_opt = OPT_SYSTEM_RESET;
222 starting_state = FW_INIT_STEP0_BOOT;
223 // TODO: system reset
225 } else if (pfirmware->firmware_status == FW_STATUS_5_READY) {
226 /* it is called by Initialize */
227 rst_opt = OPT_FIRMWARE_RESET;
228 starting_state = FW_INIT_STEP2_DATA;
230 RT_TRACE(COMP_FIRMWARE, "PlatformInitFirmware: undefined firmware state\n");
234 * Download boot, main, and data image for System reset.
235 * Download data image for firmware reset
237 for (init_step = starting_state; init_step <= FW_INIT_STEP2_DATA; init_step++) {
239 * Open image file, and map file to continuous memory if open file success.
240 * or read image file from array. Default load from IMG file
242 if (rst_opt == OPT_SYSTEM_RESET) {
243 rc = request_firmware(&fw_entry, fw_name[init_step],&priv->udev->dev);
245 RT_TRACE(COMP_ERR, "request firmware fail!\n");
246 goto download_firmware_fail;
249 if (fw_entry->size > sizeof(pfirmware->firmware_buf)) {
250 RT_TRACE(COMP_ERR, "img file size exceed the container buffer fail!\n");
251 goto download_firmware_fail;
254 if (init_step != FW_INIT_STEP1_MAIN) {
255 memcpy(pfirmware->firmware_buf,fw_entry->data,fw_entry->size);
256 mapped_file = pfirmware->firmware_buf;
257 file_length = fw_entry->size;
259 memset(pfirmware->firmware_buf, 0, 128);
260 memcpy(&pfirmware->firmware_buf[128],fw_entry->data,fw_entry->size);
261 mapped_file = pfirmware->firmware_buf;
262 file_length = fw_entry->size + 128;
264 pfirmware->firmware_buf_size = file_length;
265 } else if (rst_opt == OPT_FIRMWARE_RESET) {
266 /* we only need to download data.img here */
267 mapped_file = pfirmware->firmware_buf;
268 file_length = pfirmware->firmware_buf_size;
271 /* Download image file */
272 /* The firmware download process is just as following,
273 * 1. that is each packet will be segmented and inserted to the wait queue.
274 * 2. each packet segment will be put in the skb_buff packet.
275 * 3. each skb_buff packet data content will already include the firmware info
276 * and Tx descriptor info
278 rt_status = fw_download_code(dev, mapped_file, file_length);
279 if (rst_opt == OPT_SYSTEM_RESET)
280 release_firmware(fw_entry);
282 if (rt_status != TRUE)
283 goto download_firmware_fail;
286 case FW_INIT_STEP0_BOOT:
288 * initialize command descriptor.
289 * will set polling bit when firmware code is also configured
291 pfirmware->firmware_status = FW_STATUS_1_MOVE_BOOT_CODE;
294 * To initialize IMEM, CPU move code from 0x80000080,
295 * hence, we send 0x80 byte packet
299 case FW_INIT_STEP1_MAIN:
300 /* Download firmware code. Wait until Boot Ready and Turn on CPU */
301 pfirmware->firmware_status = FW_STATUS_2_MOVE_MAIN_CODE;
303 /* Check Put Code OK and Turn On CPU */
304 rt_status = CPUcheck_maincodeok_turnonCPU(dev);
305 if (rt_status != TRUE) {
306 RT_TRACE(COMP_ERR, "CPUcheck_maincodeok_turnonCPU fail!\n");
307 goto download_firmware_fail;
310 pfirmware->firmware_status = FW_STATUS_3_TURNON_CPU;
313 case FW_INIT_STEP2_DATA:
314 /* download initial data code */
315 pfirmware->firmware_status = FW_STATUS_4_MOVE_DATA_CODE;
318 rt_status = CPUcheck_firmware_ready(dev);
319 if (rt_status != TRUE) {
320 RT_TRACE(COMP_ERR, "CPUcheck_firmware_ready fail(%d)!\n",rt_status);
321 goto download_firmware_fail;
324 /* wait until data code is initialized ready.*/
325 pfirmware->firmware_status = FW_STATUS_5_READY;
330 RT_TRACE(COMP_FIRMWARE, "Firmware Download Success\n");
331 //assert(pfirmware->firmware_status == FW_STATUS_5_READY, ("Firmware Download Fail\n"));
335 download_firmware_fail:
336 RT_TRACE(COMP_ERR, "ERR in %s()\n", __func__);
342 MODULE_FIRMWARE("RTL8192U/boot.img");
343 MODULE_FIRMWARE("RTL8192U/main.img");
344 MODULE_FIRMWARE("RTL8192U/data.img");