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