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;
50 firmware_init_param(dev);
51 //Fragmentation might be required
52 frag_threshold = pfirmware->cmdpacket_frag_thresold;
54 if ((buffer_len - frag_offset) > frag_threshold) {
55 frag_length = frag_threshold;
59 frag_length = buffer_len - frag_offset;
64 /* Allocate skb buffer to contain firmware info and tx descriptor info
65 * add 4 to avoid packet appending overflow.
67 skb = dev_alloc_skb(USB_HWDESC_HEADER_LEN + frag_length + 4);
70 memcpy((unsigned char *)(skb->cb),&dev,sizeof(dev));
71 tcb_desc = (cb_desc *)(skb->cb + MAX_DEV_ADDR_SIZE);
72 tcb_desc->queue_index = TXCMD_QUEUE;
73 tcb_desc->bCmdOrInit = DESC_PACKET_TYPE_INIT;
74 tcb_desc->bLastIniPkt = bLastIniPkt;
76 skb_reserve(skb, USB_HWDESC_HEADER_LEN);
79 * Transform from little endian to big endian
82 for (i = 0; i < frag_length; i += 4) {
83 *seg_ptr++ = ((i+0) < frag_length)?code_virtual_address[i+3] : 0;
84 *seg_ptr++ = ((i+1) < frag_length)?code_virtual_address[i+2] : 0;
85 *seg_ptr++ = ((i+2) < frag_length)?code_virtual_address[i+1] : 0;
86 *seg_ptr++ = ((i+3) < frag_length)?code_virtual_address[i+0] : 0;
88 tcb_desc->txbuf_size = (u16)i;
91 index = tcb_desc->queue_index;
92 if (!priv->ieee80211->check_nic_enough_desc(dev, index) ||
93 (!skb_queue_empty(&priv->ieee80211->skb_waitQ[index])) ||
94 (priv->ieee80211->queue_stop)) {
95 RT_TRACE(COMP_FIRMWARE,"=====================================================> tx full!\n");
96 skb_queue_tail(&priv->ieee80211->skb_waitQ[tcb_desc->queue_index], skb);
98 priv->ieee80211->softmac_hard_start_xmit(skb, dev);
101 code_virtual_address += frag_length;
102 frag_offset += frag_length;
104 } while (frag_offset < buffer_len);
110 //-----------------------------------------------------------------------------
111 // Procedure: Check whether main code is download OK. If OK, turn on CPU
113 // Description: CPU register locates in different page against general register.
114 // Switch to CPU register in the begin and switch back before return
117 // Arguments: The pointer of the adapter
120 // NDIS_STATUS_FAILURE - the following initialization process should be terminated
121 // NDIS_STATUS_SUCCESS - if firmware initialization process success
122 //-----------------------------------------------------------------------------
123 static bool CPUcheck_maincodeok_turnonCPU(struct net_device *dev)
125 bool rt_status = true;
126 int check_putcodeOK_time = 200000, check_bootOk_time = 200000;
129 /* Check whether put code OK */
131 read_nic_dword(dev, CPU_GEN, &CPU_status);
133 if (CPU_status&CPU_GEN_PUT_CODE_OK)
136 } while (check_putcodeOK_time--);
138 if (!(CPU_status&CPU_GEN_PUT_CODE_OK)) {
139 RT_TRACE(COMP_ERR, "Download Firmware: Put code fail!\n");
140 goto CPUCheckMainCodeOKAndTurnOnCPU_Fail;
142 RT_TRACE(COMP_FIRMWARE, "Download Firmware: Put code ok!\n");
146 read_nic_dword(dev, CPU_GEN, &CPU_status);
147 write_nic_byte(dev, CPU_GEN, (u8)((CPU_status|CPU_GEN_PWR_STB_CPU)&0xff));
150 /* Check whether CPU boot OK */
152 read_nic_dword(dev, CPU_GEN, &CPU_status);
154 if (CPU_status&CPU_GEN_BOOT_RDY)
156 } while (check_bootOk_time--);
158 if (!(CPU_status&CPU_GEN_BOOT_RDY))
159 goto CPUCheckMainCodeOKAndTurnOnCPU_Fail;
161 RT_TRACE(COMP_FIRMWARE, "Download Firmware: Boot ready!\n");
165 CPUCheckMainCodeOKAndTurnOnCPU_Fail:
166 RT_TRACE(COMP_ERR, "ERR in %s()\n", __func__);
171 static bool CPUcheck_firmware_ready(struct net_device *dev)
174 bool rt_status = true;
175 int check_time = 200000;
178 /* Check Firmware Ready */
180 read_nic_dword(dev, CPU_GEN, &CPU_status);
182 if (CPU_status&CPU_GEN_FIRM_RDY)
185 } while (check_time--);
187 if (!(CPU_status&CPU_GEN_FIRM_RDY))
188 goto CPUCheckFirmwareReady_Fail;
190 RT_TRACE(COMP_FIRMWARE, "Download Firmware: Firmware ready!\n");
194 CPUCheckFirmwareReady_Fail:
195 RT_TRACE(COMP_ERR, "ERR in %s()\n", __func__);
201 bool init_firmware(struct net_device *dev)
203 struct r8192_priv *priv = ieee80211_priv(dev);
204 bool rt_status = TRUE;
207 u8 *mapped_file = NULL;
209 opt_rst_type_e rst_opt = OPT_SYSTEM_RESET;
210 firmware_init_step_e starting_state = FW_INIT_STEP0_BOOT;
212 rt_firmware *pfirmware = priv->pFirmware;
213 const struct firmware *fw_entry;
214 const char *fw_name[3] = { "RTL8192U/boot.img",
216 "RTL8192U/data.img"};
219 RT_TRACE(COMP_FIRMWARE, " PlatformInitFirmware()==>\n");
221 if (pfirmware->firmware_status == FW_STATUS_0_INIT) {
222 /* it is called by reset */
223 rst_opt = OPT_SYSTEM_RESET;
224 starting_state = FW_INIT_STEP0_BOOT;
225 // TODO: system reset
227 } else if (pfirmware->firmware_status == FW_STATUS_5_READY) {
228 /* it is called by Initialize */
229 rst_opt = OPT_FIRMWARE_RESET;
230 starting_state = FW_INIT_STEP2_DATA;
232 RT_TRACE(COMP_FIRMWARE, "PlatformInitFirmware: undefined firmware state\n");
236 * Download boot, main, and data image for System reset.
237 * Download data image for firmware reset
239 for (init_step = starting_state; init_step <= FW_INIT_STEP2_DATA; init_step++) {
241 * Open image file, and map file to continuous memory if open file success.
242 * or read image file from array. Default load from IMG file
244 if (rst_opt == OPT_SYSTEM_RESET) {
245 rc = request_firmware(&fw_entry, fw_name[init_step],&priv->udev->dev);
247 RT_TRACE(COMP_ERR, "request firmware fail!\n");
248 goto download_firmware_fail;
251 if (fw_entry->size > sizeof(pfirmware->firmware_buf)) {
252 RT_TRACE(COMP_ERR, "img file size exceed the container buffer fail!\n");
253 goto download_firmware_fail;
256 if (init_step != FW_INIT_STEP1_MAIN) {
257 memcpy(pfirmware->firmware_buf,fw_entry->data,fw_entry->size);
258 mapped_file = pfirmware->firmware_buf;
259 file_length = fw_entry->size;
261 memset(pfirmware->firmware_buf, 0, 128);
262 memcpy(&pfirmware->firmware_buf[128],fw_entry->data,fw_entry->size);
263 mapped_file = pfirmware->firmware_buf;
264 file_length = fw_entry->size + 128;
266 pfirmware->firmware_buf_size = file_length;
267 } else if (rst_opt == OPT_FIRMWARE_RESET) {
268 /* we only need to download data.img here */
269 mapped_file = pfirmware->firmware_buf;
270 file_length = pfirmware->firmware_buf_size;
273 /* Download image file */
274 /* The firmware download process is just as following,
275 * 1. that is each packet will be segmented and inserted to the wait queue.
276 * 2. each packet segment will be put in the skb_buff packet.
277 * 3. each skb_buff packet data content will already include the firmware info
278 * and Tx descriptor info
280 rt_status = fw_download_code(dev, mapped_file, file_length);
281 if (rst_opt == OPT_SYSTEM_RESET)
282 release_firmware(fw_entry);
284 if (rt_status != TRUE)
285 goto download_firmware_fail;
288 case FW_INIT_STEP0_BOOT:
290 * initialize command descriptor.
291 * will set polling bit when firmware code is also configured
293 pfirmware->firmware_status = FW_STATUS_1_MOVE_BOOT_CODE;
296 * To initialize IMEM, CPU move code from 0x80000080,
297 * hence, we send 0x80 byte packet
301 case FW_INIT_STEP1_MAIN:
302 /* Download firmware code. Wait until Boot Ready and Turn on CPU */
303 pfirmware->firmware_status = FW_STATUS_2_MOVE_MAIN_CODE;
305 /* Check Put Code OK and Turn On CPU */
306 rt_status = CPUcheck_maincodeok_turnonCPU(dev);
307 if (rt_status != TRUE) {
308 RT_TRACE(COMP_ERR, "CPUcheck_maincodeok_turnonCPU fail!\n");
309 goto download_firmware_fail;
312 pfirmware->firmware_status = FW_STATUS_3_TURNON_CPU;
315 case FW_INIT_STEP2_DATA:
316 /* download initial data code */
317 pfirmware->firmware_status = FW_STATUS_4_MOVE_DATA_CODE;
320 rt_status = CPUcheck_firmware_ready(dev);
321 if (rt_status != TRUE) {
322 RT_TRACE(COMP_ERR, "CPUcheck_firmware_ready fail(%d)!\n",rt_status);
323 goto download_firmware_fail;
326 /* wait until data code is initialized ready.*/
327 pfirmware->firmware_status = FW_STATUS_5_READY;
332 RT_TRACE(COMP_FIRMWARE, "Firmware Download Success\n");
333 //assert(pfirmware->firmware_status == FW_STATUS_5_READY, ("Firmware Download Fail\n"));
337 download_firmware_fail:
338 RT_TRACE(COMP_ERR, "ERR in %s()\n", __func__);
344 MODULE_FIRMWARE("RTL8192U/boot.img");
345 MODULE_FIRMWARE("RTL8192U/main.img");
346 MODULE_FIRMWARE("RTL8192U/data.img");