]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - drivers/staging/rtl8192e/r8192E_firmware.c
rtl8192e: Remove extra ifdefs
[mirror_ubuntu-hirsute-kernel.git] / drivers / staging / rtl8192e / r8192E_firmware.c
CommitLineData
94a79942
LF
1/******************************************************************************
2 * Copyright(c) 2008 - 2010 Realtek Corporation. All rights reserved.
3 *
4 * This program is distributed in the hope that it will be useful, but WITHOUT
5 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
6 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
7 * more details.
8 *
9 * You should have received a copy of the GNU General Public License along with
10 * this program; if not, write to the Free Software Foundation, Inc.,
11 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
12 *
13 * The full GNU General Public License is included in this distribution in the
14 * file called LICENSE.
15 *
16 * Contact Information:
17 * wlanfae <wlanfae@realtek.com>
18******************************************************************************/
19
94a79942
LF
20#include "rtl_core.h"
21#include "r8192E_hw.h"
94a79942 22#include "r8192E_hwimg.h"
94a79942 23#include "r8192E_firmware.h"
94a79942 24#include <linux/firmware.h>
94a79942
LF
25
26extern void firmware_init_param(struct net_device *dev)
27{
28 struct r8192_priv *priv = rtllib_priv(dev);
29 rt_firmware *pfirmware = priv->pFirmware;
30
31 pfirmware->cmdpacket_frag_thresold = GET_COMMAND_PACKET_FRAG_THRESHOLD(MAX_TRANSMIT_BUFFER_SIZE);
32}
33
34bool fw_download_code(struct net_device *dev, u8 *code_virtual_address, u32 buffer_len)
35{
36 struct r8192_priv *priv = rtllib_priv(dev);
37 bool rt_status = true;
38 u16 frag_threshold;
39 u16 frag_length, frag_offset = 0;
40 int i;
41
42 rt_firmware *pfirmware = priv->pFirmware;
43 struct sk_buff *skb;
44 unsigned char *seg_ptr;
45 cb_desc *tcb_desc;
46 u8 bLastIniPkt;
47
48 firmware_init_param(dev);
49 frag_threshold = pfirmware->cmdpacket_frag_thresold;
50 do {
51 if ((buffer_len - frag_offset) > frag_threshold) {
52 frag_length = frag_threshold ;
53 bLastIniPkt = 0;
54
55 } else {
56 frag_length = buffer_len - frag_offset;
57 bLastIniPkt = 1;
58
59 }
60
61 skb = dev_alloc_skb(frag_length + 4);
62 memcpy((unsigned char *)(skb->cb),&dev,sizeof(dev));
63 tcb_desc = (cb_desc*)(skb->cb + MAX_DEV_ADDR_SIZE);
64 tcb_desc->queue_index = TXCMD_QUEUE;
65 tcb_desc->bCmdOrInit = DESC_PACKET_TYPE_INIT;
66 tcb_desc->bLastIniPkt = bLastIniPkt;
67
68 seg_ptr = skb->data;
69 for (i=0 ; i < frag_length; i+=4) {
70 *seg_ptr++ = ((i+0)<frag_length)?code_virtual_address[i+3]:0;
71 *seg_ptr++ = ((i+1)<frag_length)?code_virtual_address[i+2]:0;
72 *seg_ptr++ = ((i+2)<frag_length)?code_virtual_address[i+1]:0;
73 *seg_ptr++ = ((i+3)<frag_length)?code_virtual_address[i+0]:0;
74 }
75 tcb_desc->txbuf_size= (u16)i;
76 skb_put(skb, i);
77
78 if (!priv->rtllib->check_nic_enough_desc(dev,tcb_desc->queue_index)||
79 (!skb_queue_empty(&priv->rtllib->skb_waitQ[tcb_desc->queue_index]))||\
80 (priv->rtllib->queue_stop) ) {
81 RT_TRACE(COMP_FIRMWARE, "===================> tx full!\n");
82 skb_queue_tail(&priv->rtllib->skb_waitQ[tcb_desc->queue_index], skb);
83 } else {
84 priv->rtllib->softmac_hard_start_xmit(skb,dev);
85 }
86
87 code_virtual_address += frag_length;
88 frag_offset += frag_length;
89
90 }while(frag_offset < buffer_len);
91
92 write_nic_byte(dev, TPPoll, TPPoll_CQ);
93
94 return rt_status;
95}
96
97bool
98fwSendNullPacket(
99 struct net_device *dev,
100 u32 Length
101)
102{
103 bool rtStatus = true;
104 struct r8192_priv *priv = rtllib_priv(dev);
105 struct sk_buff *skb;
106 cb_desc *tcb_desc;
107 unsigned char *ptr_buf;
108 bool bLastInitPacket = false;
109
110
111 skb = dev_alloc_skb(Length+ 4);
112 memcpy((unsigned char *)(skb->cb),&dev,sizeof(dev));
113 tcb_desc = (cb_desc*)(skb->cb + MAX_DEV_ADDR_SIZE);
114 tcb_desc->queue_index = TXCMD_QUEUE;
115 tcb_desc->bCmdOrInit = DESC_PACKET_TYPE_INIT;
116 tcb_desc->bLastIniPkt = bLastInitPacket;
117 ptr_buf = skb_put(skb, Length);
118 memset(ptr_buf,0,Length);
119 tcb_desc->txbuf_size= (u16)Length;
120
121 if (!priv->rtllib->check_nic_enough_desc(dev,tcb_desc->queue_index)||
122 (!skb_queue_empty(&priv->rtllib->skb_waitQ[tcb_desc->queue_index]))||\
123 (priv->rtllib->queue_stop) ) {
124 RT_TRACE(COMP_FIRMWARE,"===================NULL packet================> tx full!\n");
125 skb_queue_tail(&priv->rtllib->skb_waitQ[tcb_desc->queue_index], skb);
126 } else {
127 priv->rtllib->softmac_hard_start_xmit(skb,dev);
128 }
129
130 write_nic_byte(dev, TPPoll, TPPoll_CQ);
131 return rtStatus;
132}
133
134bool CPUcheck_maincodeok_turnonCPU(struct net_device *dev)
135{
136 bool rt_status = true;
137 u32 CPU_status = 0;
138 unsigned long timeout;
139
140 timeout = jiffies + MSECS(200);
141 while (time_before(jiffies, timeout)) {
142 CPU_status = read_nic_dword(dev, CPU_GEN);
143 if (CPU_status & CPU_GEN_PUT_CODE_OK)
144 break;
145 msleep(2);
146 }
147
148 if (!(CPU_status&CPU_GEN_PUT_CODE_OK)) {
149 RT_TRACE(COMP_ERR, "Download Firmware: Put code fail!\n");
150 goto CPUCheckMainCodeOKAndTurnOnCPU_Fail;
151 } else {
152 RT_TRACE(COMP_FIRMWARE, "Download Firmware: Put code ok!\n");
153 }
154
155 CPU_status = read_nic_dword(dev, CPU_GEN);
156 write_nic_byte(dev, CPU_GEN, (u8)((CPU_status|CPU_GEN_PWR_STB_CPU)&0xff));
157 mdelay(1);
158
159 timeout = jiffies + MSECS(200);
160 while (time_before(jiffies, timeout)) {
161 CPU_status = read_nic_dword(dev, CPU_GEN);
162 if (CPU_status&CPU_GEN_BOOT_RDY)
163 break;
164 msleep(2);
165 }
166
167 if (!(CPU_status&CPU_GEN_BOOT_RDY)) {
168 goto CPUCheckMainCodeOKAndTurnOnCPU_Fail;
169 } else {
170 RT_TRACE(COMP_FIRMWARE, "Download Firmware: Boot ready!\n");
171 }
172
173 return rt_status;
174
175CPUCheckMainCodeOKAndTurnOnCPU_Fail:
176 RT_TRACE(COMP_ERR, "ERR in %s()\n", __func__);
177 rt_status = false;
178 return rt_status;
179}
180
181bool CPUcheck_firmware_ready(struct net_device *dev)
182{
183
184 bool rt_status = true;
185 u32 CPU_status = 0;
186 unsigned long timeout;
187
188 timeout = jiffies + MSECS(20);
189 while (time_before(jiffies, timeout)) {
190 CPU_status = read_nic_dword(dev, CPU_GEN);
191 if (CPU_status&CPU_GEN_FIRM_RDY)
192 break;
193 msleep(2);
194 }
195
196 if (!(CPU_status&CPU_GEN_FIRM_RDY))
197 goto CPUCheckFirmwareReady_Fail;
198 else
199 RT_TRACE(COMP_FIRMWARE, "Download Firmware: Firmware ready!\n");
200
201 return rt_status;
202
203CPUCheckFirmwareReady_Fail:
204 RT_TRACE(COMP_ERR, "ERR in %s()\n", __func__);
205 rt_status = false;
206 return rt_status;
207
208}
209
210inline static bool firmware_check_ready(struct net_device *dev, u8 load_fw_status)
211{
212 struct r8192_priv *priv = rtllib_priv(dev);
213 rt_firmware *pfirmware = priv->pFirmware;
214 bool rt_status = true;
215
216 switch (load_fw_status) {
217 case FW_INIT_STEP0_BOOT:
218 pfirmware->firmware_status = FW_STATUS_1_MOVE_BOOT_CODE;
219#ifdef RTL8190P
220 rt_status = fwSendNullPacket(dev, RTL8190_CPU_START_OFFSET);
221 if (!rt_status) {
222 RT_TRACE(COMP_INIT, "fwSendNullPacket() fail ! \n");
223 }
224#endif
225 break;
226
227 case FW_INIT_STEP1_MAIN:
228 pfirmware->firmware_status = FW_STATUS_2_MOVE_MAIN_CODE;
229
230 rt_status = CPUcheck_maincodeok_turnonCPU(dev);
231 if (rt_status) {
232 pfirmware->firmware_status = FW_STATUS_3_TURNON_CPU;
233 } else {
234 RT_TRACE(COMP_FIRMWARE, "CPUcheck_maincodeok_turnonCPU fail!\n");
235 }
236
237 break;
238
239 case FW_INIT_STEP2_DATA:
240 pfirmware->firmware_status = FW_STATUS_4_MOVE_DATA_CODE;
241 mdelay(1);
242
243 rt_status = CPUcheck_firmware_ready(dev);
244 if (rt_status) {
245 pfirmware->firmware_status = FW_STATUS_5_READY;
246 } else {
247 RT_TRACE(COMP_FIRMWARE, "CPUcheck_firmware_ready fail(%d)!\n",rt_status);
248 }
249
250 break;
251 default:
252 rt_status = false;
253 RT_TRACE(COMP_FIRMWARE, "Unknown firware status");
254 break;
255 }
256
257 return rt_status;
258}
259
260bool init_firmware(struct net_device *dev)
261{
262 struct r8192_priv *priv = rtllib_priv(dev);
263 bool rt_status = true;
264
265#ifdef RTL8190P
266 u8 *firmware_img_buf[3] = { &Rtl8190PciFwBootArray[0],
267 &Rtl8190PciFwMainArray[0],
268 &Rtl8190PciFwDataArray[0]};
269
270 u32 firmware_img_len[3] = { sizeof(Rtl8190PciFwBootArray),
271 sizeof(Rtl8190PciFwMainArray),
272 sizeof(Rtl8190PciFwDataArray)};
273#else
274 u8 *firmware_img_buf[3] = { &Rtl8192PciEFwBootArray[0],
275 &Rtl8192PciEFwMainArray[0],
276 &Rtl8192PciEFwDataArray[0]};
277
278 u32 firmware_img_len[3] = { sizeof(Rtl8192PciEFwBootArray),
279 sizeof(Rtl8192PciEFwMainArray),
280 sizeof(Rtl8192PciEFwDataArray)};
281#endif
282 u32 file_length = 0;
283 u8 *mapped_file = NULL;
284 u8 init_step = 0;
285 opt_rst_type_e rst_opt = OPT_SYSTEM_RESET;
286 firmware_init_step_e starting_state = FW_INIT_STEP0_BOOT;
287
288 rt_firmware *pfirmware = priv->pFirmware;
289
290 RT_TRACE(COMP_FIRMWARE, " PlatformInitFirmware()==>\n");
291
292 if (pfirmware->firmware_status == FW_STATUS_0_INIT ) {
293 rst_opt = OPT_SYSTEM_RESET;
294 starting_state = FW_INIT_STEP0_BOOT;
295
296 }else if (pfirmware->firmware_status == FW_STATUS_5_READY) {
297 rst_opt = OPT_FIRMWARE_RESET;
298 starting_state = FW_INIT_STEP2_DATA;
299 }else {
300 RT_TRACE(COMP_FIRMWARE, "PlatformInitFirmware: undefined firmware state\n");
301 }
302
94a79942 303 priv->firmware_source = FW_SOURCE_IMG_FILE;
94a79942
LF
304 for (init_step = starting_state; init_step <= FW_INIT_STEP2_DATA; init_step++) {
305 if (rst_opt == OPT_SYSTEM_RESET) {
306 switch (priv->firmware_source) {
307 case FW_SOURCE_IMG_FILE:
308 {
94a79942
LF
309 if (pfirmware->firmware_buf_size[init_step] == 0) {
310 const char *fw_name[3] = { "RTL8192E/boot.img",
311 "RTL8192E/main.img",
312 "RTL8192E/data.img"
313 };
314 const struct firmware *fw_entry;
315 int rc;
316 rc = request_firmware(&fw_entry, fw_name[init_step],&priv->pdev->dev);
317 if (rc < 0 ) {
318 RT_TRACE(COMP_FIRMWARE, "request firmware fail!\n");
319 goto download_firmware_fail;
320 }
321 if (fw_entry->size > sizeof(pfirmware->firmware_buf[init_step])) {
322 RT_TRACE(COMP_FIRMWARE, "img file size exceed the container buffer fail!\n");
323 goto download_firmware_fail;
324 }
325
326 if (init_step != FW_INIT_STEP1_MAIN) {
327 memcpy(pfirmware->firmware_buf[init_step],fw_entry->data,fw_entry->size);
328 pfirmware->firmware_buf_size[init_step] = fw_entry->size;
329
330 } else {
331 memset(pfirmware->firmware_buf[init_step],0,128);
332 memcpy(&pfirmware->firmware_buf[init_step][128],fw_entry->data,fw_entry->size);
333 pfirmware->firmware_buf_size[init_step] = fw_entry->size+128;
334 }
335
336 if (rst_opt == OPT_SYSTEM_RESET) {
337 release_firmware(fw_entry);
338 }
339 }
340 mapped_file = pfirmware->firmware_buf[init_step];
341 file_length = pfirmware->firmware_buf_size[init_step];
94a79942
LF
342 break;
343 }
344 case FW_SOURCE_HEADER_FILE:
345 mapped_file = firmware_img_buf[init_step];
346 file_length = firmware_img_len[init_step];
347 if (init_step == FW_INIT_STEP2_DATA) {
348 memcpy(pfirmware->firmware_buf[init_step], mapped_file, file_length);
349 pfirmware->firmware_buf_size[init_step] = file_length;
350 }
351 break;
352
353 default:
354 break;
355 }
356
357
358 } else if (rst_opt == OPT_FIRMWARE_RESET) {
359 mapped_file = pfirmware->firmware_buf[init_step];
360 file_length = pfirmware->firmware_buf_size[init_step];
361 }
362
363 rt_status = fw_download_code(dev,mapped_file,file_length);
364 if (rt_status != true) {
365 goto download_firmware_fail;
366 }
367
368 if (!firmware_check_ready(dev, init_step)) {
369 goto download_firmware_fail;
370 }
371 }
372
373 RT_TRACE(COMP_FIRMWARE, "Firmware Download Success\n");
374 return rt_status;
375
376download_firmware_fail:
377 RT_TRACE(COMP_ERR, "ERR in %s()\n", __func__);
378 rt_status = false;
379 return rt_status;
380
381}