wl1271: added missing packed modifier in some acx structs
[linux-2.6-block.git] / drivers / net / wireless / wl12xx / wl1271_boot.c
CommitLineData
f5fc0f86
LC
1/*
2 * This file is part of wl1271
3 *
4 * Copyright (C) 2008-2009 Nokia Corporation
5 *
6 * Contact: Luciano Coelho <luciano.coelho@nokia.com>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA
21 *
22 */
23
24#include <linux/gpio.h>
25
26#include "wl1271_acx.h"
27#include "wl1271_reg.h"
28#include "wl1271_boot.h"
29#include "wl1271_spi.h"
30#include "wl1271_event.h"
31
32static struct wl1271_partition_set part_table[PART_TABLE_LEN] = {
33 [PART_DOWN] = {
34 .mem = {
35 .start = 0x00000000,
36 .size = 0x000177c0
37 },
38 .reg = {
39 .start = REGISTERS_BASE,
40 .size = 0x00008800
41 },
451de97a
JO
42 .mem2 = {
43 .start = 0x00000000,
44 .size = 0x00000000
45 },
46 .mem3 = {
47 .start = 0x00000000,
48 .size = 0x00000000
49 },
f5fc0f86
LC
50 },
51
52 [PART_WORK] = {
53 .mem = {
54 .start = 0x00040000,
55 .size = 0x00014fc0
56 },
57 .reg = {
58 .start = REGISTERS_BASE,
451de97a
JO
59 .size = 0x0000a000
60 },
61 .mem2 = {
62 .start = 0x003004f8,
63 .size = 0x00000004
64 },
65 .mem3 = {
66 .start = 0x00040404,
67 .size = 0x00000000
f5fc0f86
LC
68 },
69 },
70
71 [PART_DRPW] = {
72 .mem = {
73 .start = 0x00040000,
74 .size = 0x00014fc0
75 },
76 .reg = {
77 .start = DRPW_BASE,
78 .size = 0x00006000
451de97a
JO
79 },
80 .mem2 = {
81 .start = 0x00000000,
82 .size = 0x00000000
83 },
84 .mem3 = {
85 .start = 0x00000000,
86 .size = 0x00000000
f5fc0f86
LC
87 }
88 }
89};
90
91static void wl1271_boot_set_ecpu_ctrl(struct wl1271 *wl, u32 flag)
92{
93 u32 cpu_ctrl;
94
95 /* 10.5.0 run the firmware (I) */
74621417 96 cpu_ctrl = wl1271_spi_read32(wl, ACX_REG_ECPU_CONTROL);
f5fc0f86
LC
97
98 /* 10.5.1 run the firmware (II) */
99 cpu_ctrl |= flag;
74621417 100 wl1271_spi_write32(wl, ACX_REG_ECPU_CONTROL, cpu_ctrl);
f5fc0f86
LC
101}
102
103static void wl1271_boot_fw_version(struct wl1271 *wl)
104{
105 struct wl1271_static_data static_data;
106
74621417
JO
107 wl1271_spi_read(wl, wl->cmd_box_addr,
108 &static_data, sizeof(static_data), false);
f5fc0f86
LC
109
110 strncpy(wl->chip.fw_ver, static_data.fw_version,
111 sizeof(wl->chip.fw_ver));
112
113 /* make sure the string is NULL-terminated */
114 wl->chip.fw_ver[sizeof(wl->chip.fw_ver) - 1] = '\0';
115}
116
117static int wl1271_boot_upload_firmware_chunk(struct wl1271 *wl, void *buf,
118 size_t fw_data_len, u32 dest)
119{
451de97a 120 struct wl1271_partition_set partition;
f5fc0f86 121 int addr, chunk_num, partition_limit;
1fba4974 122 u8 *p, *chunk;
f5fc0f86
LC
123
124 /* whal_FwCtrl_LoadFwImageSm() */
125
126 wl1271_debug(DEBUG_BOOT, "starting firmware upload");
127
73d0a13c
LC
128 wl1271_debug(DEBUG_BOOT, "fw_data_len %zd chunk_size %d",
129 fw_data_len, CHUNK_SIZE);
f5fc0f86 130
f5fc0f86
LC
131 if ((fw_data_len % 4) != 0) {
132 wl1271_error("firmware length not multiple of four");
133 return -EIO;
134 }
135
1fba4974 136 chunk = kmalloc(CHUNK_SIZE, GFP_KERNEL);
ed317788 137 if (!chunk) {
1fba4974
JO
138 wl1271_error("allocation for firmware upload chunk failed");
139 return -ENOMEM;
140 }
141
451de97a
JO
142 memcpy(&partition, &part_table[PART_DOWN], sizeof(partition));
143 partition.mem.start = dest;
144 wl1271_set_partition(wl, &partition);
f5fc0f86
LC
145
146 /* 10.1 set partition limit and chunk num */
147 chunk_num = 0;
148 partition_limit = part_table[PART_DOWN].mem.size;
149
150 while (chunk_num < fw_data_len / CHUNK_SIZE) {
151 /* 10.2 update partition, if needed */
152 addr = dest + (chunk_num + 2) * CHUNK_SIZE;
153 if (addr > partition_limit) {
154 addr = dest + chunk_num * CHUNK_SIZE;
155 partition_limit = chunk_num * CHUNK_SIZE +
156 part_table[PART_DOWN].mem.size;
451de97a
JO
157 partition.mem.start = addr;
158 wl1271_set_partition(wl, &partition);
f5fc0f86
LC
159 }
160
161 /* 10.3 upload the chunk */
162 addr = dest + chunk_num * CHUNK_SIZE;
163 p = buf + chunk_num * CHUNK_SIZE;
1fba4974 164 memcpy(chunk, p, CHUNK_SIZE);
f5fc0f86
LC
165 wl1271_debug(DEBUG_BOOT, "uploading fw chunk 0x%p to 0x%x",
166 p, addr);
74621417 167 wl1271_spi_write(wl, addr, chunk, CHUNK_SIZE, false);
f5fc0f86
LC
168
169 chunk_num++;
170 }
171
172 /* 10.4 upload the last chunk */
173 addr = dest + chunk_num * CHUNK_SIZE;
174 p = buf + chunk_num * CHUNK_SIZE;
1fba4974 175 memcpy(chunk, p, fw_data_len % CHUNK_SIZE);
73d0a13c 176 wl1271_debug(DEBUG_BOOT, "uploading fw last chunk (%zd B) 0x%p to 0x%x",
f5fc0f86 177 fw_data_len % CHUNK_SIZE, p, addr);
74621417 178 wl1271_spi_write(wl, addr, chunk, fw_data_len % CHUNK_SIZE, false);
f5fc0f86 179
1fba4974 180 kfree(chunk);
f5fc0f86
LC
181 return 0;
182}
183
184static int wl1271_boot_upload_firmware(struct wl1271 *wl)
185{
186 u32 chunks, addr, len;
ed317788 187 int ret = 0;
f5fc0f86
LC
188 u8 *fw;
189
190 fw = wl->fw;
191 chunks = be32_to_cpup((u32 *) fw);
192 fw += sizeof(u32);
193
194 wl1271_debug(DEBUG_BOOT, "firmware chunks to be uploaded: %u", chunks);
195
196 while (chunks--) {
197 addr = be32_to_cpup((u32 *) fw);
198 fw += sizeof(u32);
199 len = be32_to_cpup((u32 *) fw);
200 fw += sizeof(u32);
201
202 if (len > 300000) {
203 wl1271_info("firmware chunk too long: %u", len);
204 return -EINVAL;
205 }
206 wl1271_debug(DEBUG_BOOT, "chunk %d addr 0x%x len %u",
207 chunks, addr, len);
ed317788
JO
208 ret = wl1271_boot_upload_firmware_chunk(wl, fw, len, addr);
209 if (ret != 0)
210 break;
f5fc0f86
LC
211 fw += len;
212 }
213
ed317788 214 return ret;
f5fc0f86
LC
215}
216
217static int wl1271_boot_upload_nvs(struct wl1271 *wl)
218{
219 size_t nvs_len, burst_len;
220 int i;
221 u32 dest_addr, val;
222 u8 *nvs_ptr, *nvs, *nvs_aligned;
223
224 nvs = wl->nvs;
225 if (nvs == NULL)
226 return -ENODEV;
227
228 nvs_ptr = nvs;
229
230 nvs_len = wl->nvs_len;
231
232 /* Update the device MAC address into the nvs */
233 nvs[11] = wl->mac_addr[0];
234 nvs[10] = wl->mac_addr[1];
235 nvs[6] = wl->mac_addr[2];
236 nvs[5] = wl->mac_addr[3];
237 nvs[4] = wl->mac_addr[4];
238 nvs[3] = wl->mac_addr[5];
239
240 /*
241 * Layout before the actual NVS tables:
242 * 1 byte : burst length.
243 * 2 bytes: destination address.
244 * n bytes: data to burst copy.
245 *
246 * This is ended by a 0 length, then the NVS tables.
247 */
248
249 /* FIXME: Do we need to check here whether the LSB is 1? */
250 while (nvs_ptr[0]) {
251 burst_len = nvs_ptr[0];
252 dest_addr = (nvs_ptr[1] & 0xfe) | ((u32)(nvs_ptr[2] << 8));
253
254 /* FIXME: Due to our new wl1271_translate_reg_addr function,
255 we need to add the REGISTER_BASE to the destination */
256 dest_addr += REGISTERS_BASE;
257
258 /* We move our pointer to the data */
259 nvs_ptr += 3;
260
261 for (i = 0; i < burst_len; i++) {
262 val = (nvs_ptr[0] | (nvs_ptr[1] << 8)
263 | (nvs_ptr[2] << 16) | (nvs_ptr[3] << 24));
264
265 wl1271_debug(DEBUG_BOOT,
266 "nvs burst write 0x%x: 0x%x",
267 dest_addr, val);
74621417 268 wl1271_spi_write32(wl, dest_addr, val);
f5fc0f86
LC
269
270 nvs_ptr += 4;
271 dest_addr += 4;
272 }
273 }
274
275 /*
276 * We've reached the first zero length, the first NVS table
277 * is 7 bytes further.
278 */
279 nvs_ptr += 7;
280 nvs_len -= nvs_ptr - nvs;
281 nvs_len = ALIGN(nvs_len, 4);
282
283 /* FIXME: The driver sets the partition here, but this is not needed,
284 since it sets to the same one as currently in use */
285 /* Now we must set the partition correctly */
451de97a 286 wl1271_set_partition(wl, &part_table[PART_WORK]);
f5fc0f86
LC
287
288 /* Copy the NVS tables to a new block to ensure alignment */
289 nvs_aligned = kmemdup(nvs_ptr, nvs_len, GFP_KERNEL);
ed317788
JO
290 if (!nvs_aligned)
291 return -ENOMEM;
f5fc0f86
LC
292
293 /* And finally we upload the NVS tables */
294 /* FIXME: In wl1271, we upload everything at once.
295 No endianness handling needed here?! The ref driver doesn't do
296 anything about it at this point */
74621417 297 wl1271_spi_write(wl, CMD_MBOX_ADDRESS, nvs_aligned, nvs_len, false);
f5fc0f86
LC
298
299 kfree(nvs_aligned);
300 return 0;
301}
302
303static void wl1271_boot_enable_interrupts(struct wl1271 *wl)
304{
305 enable_irq(wl->irq);
74621417 306 wl1271_spi_write32(wl, ACX_REG_INTERRUPT_MASK,
73d0a13c 307 WL1271_ACX_INTR_ALL & ~(WL1271_INTR_MASK));
74621417 308 wl1271_spi_write32(wl, HI_CFG, HI_CFG_DEF_VAL);
f5fc0f86
LC
309}
310
311static int wl1271_boot_soft_reset(struct wl1271 *wl)
312{
313 unsigned long timeout;
314 u32 boot_data;
315
316 /* perform soft reset */
74621417
JO
317 wl1271_spi_write32(wl, ACX_REG_SLV_SOFT_RESET,
318 ACX_SLV_SOFT_RESET_BIT);
f5fc0f86
LC
319
320 /* SOFT_RESET is self clearing */
321 timeout = jiffies + usecs_to_jiffies(SOFT_RESET_MAX_TIME);
322 while (1) {
74621417 323 boot_data = wl1271_spi_read32(wl, ACX_REG_SLV_SOFT_RESET);
f5fc0f86
LC
324 wl1271_debug(DEBUG_BOOT, "soft reset bootdata 0x%x", boot_data);
325 if ((boot_data & ACX_SLV_SOFT_RESET_BIT) == 0)
326 break;
327
328 if (time_after(jiffies, timeout)) {
329 /* 1.2 check pWhalBus->uSelfClearTime if the
330 * timeout was reached */
331 wl1271_error("soft reset timeout");
332 return -1;
333 }
334
335 udelay(SOFT_RESET_STALL_TIME);
336 }
337
338 /* disable Rx/Tx */
74621417 339 wl1271_spi_write32(wl, ENABLE, 0x0);
f5fc0f86
LC
340
341 /* disable auto calibration on start*/
74621417 342 wl1271_spi_write32(wl, SPARE_A2, 0xffff);
f5fc0f86
LC
343
344 return 0;
345}
346
347static int wl1271_boot_run_firmware(struct wl1271 *wl)
348{
349 int loop, ret;
350 u32 chip_id, interrupt;
351
352 wl1271_boot_set_ecpu_ctrl(wl, ECPU_CONTROL_HALT);
353
74621417 354 chip_id = wl1271_spi_read32(wl, CHIP_ID_B);
f5fc0f86
LC
355
356 wl1271_debug(DEBUG_BOOT, "chip id after firmware boot: 0x%x", chip_id);
357
358 if (chip_id != wl->chip.id) {
359 wl1271_error("chip id doesn't match after firmware boot");
360 return -EIO;
361 }
362
363 /* wait for init to complete */
364 loop = 0;
365 while (loop++ < INIT_LOOP) {
366 udelay(INIT_LOOP_DELAY);
74621417
JO
367 interrupt = wl1271_spi_read32(wl,
368 ACX_REG_INTERRUPT_NO_CLEAR);
f5fc0f86
LC
369
370 if (interrupt == 0xffffffff) {
371 wl1271_error("error reading hardware complete "
372 "init indication");
373 return -EIO;
374 }
375 /* check that ACX_INTR_INIT_COMPLETE is enabled */
376 else if (interrupt & WL1271_ACX_INTR_INIT_COMPLETE) {
74621417 377 wl1271_spi_write32(wl, ACX_REG_INTERRUPT_ACK,
f5fc0f86
LC
378 WL1271_ACX_INTR_INIT_COMPLETE);
379 break;
380 }
381 }
382
383 if (loop >= INIT_LOOP) {
384 wl1271_error("timeout waiting for the hardware to "
385 "complete initialization");
386 return -EIO;
387 }
388
389 /* get hardware config command mail box */
74621417 390 wl->cmd_box_addr = wl1271_spi_read32(wl, REG_COMMAND_MAILBOX_PTR);
f5fc0f86
LC
391
392 /* get hardware config event mail box */
74621417 393 wl->event_box_addr = wl1271_spi_read32(wl, REG_EVENT_MAILBOX_PTR);
f5fc0f86
LC
394
395 /* set the working partition to its "running" mode offset */
451de97a 396 wl1271_set_partition(wl, &part_table[PART_WORK]);
f5fc0f86
LC
397
398 wl1271_debug(DEBUG_MAILBOX, "cmd_box_addr 0x%x event_box_addr 0x%x",
399 wl->cmd_box_addr, wl->event_box_addr);
400
401 wl1271_boot_fw_version(wl);
402
403 /*
404 * in case of full asynchronous mode the firmware event must be
405 * ready to receive event from the command mailbox
406 */
407
be823e5b
JO
408 /* unmask required mbox events */
409 wl->event_mask = BSS_LOSE_EVENT_ID |
410 SCAN_COMPLETE_EVENT_ID;
f5fc0f86
LC
411
412 ret = wl1271_event_unmask(wl);
413 if (ret < 0) {
414 wl1271_error("EVENT mask setting failed");
415 return ret;
416 }
417
418 wl1271_event_mbox_config(wl);
419
420 /* firmware startup completed */
421 return 0;
422}
423
424static int wl1271_boot_write_irq_polarity(struct wl1271 *wl)
425{
e8768eeb 426 u32 polarity;
f5fc0f86 427
e8768eeb 428 polarity = wl1271_top_reg_read(wl, OCP_REG_POLARITY);
f5fc0f86
LC
429
430 /* We use HIGH polarity, so unset the LOW bit */
431 polarity &= ~POLARITY_LOW;
e8768eeb 432 wl1271_top_reg_write(wl, OCP_REG_POLARITY, polarity);
f5fc0f86
LC
433
434 return 0;
435}
436
437int wl1271_boot(struct wl1271 *wl)
438{
439 int ret = 0;
440 u32 tmp, clk, pause;
441
284134eb
JO
442 if (REF_CLOCK == 0 || REF_CLOCK == 2 || REF_CLOCK == 4)
443 /* ref clk: 19.2/38.4/38.4-XTAL */
f5fc0f86
LC
444 clk = 0x3;
445 else if (REF_CLOCK == 1 || REF_CLOCK == 3)
446 /* ref clk: 26/52 */
447 clk = 0x5;
448
284134eb
JO
449 if (REF_CLOCK != 0) {
450 u16 val;
451 /* Set clock type */
452 val = wl1271_top_reg_read(wl, OCP_REG_CLK_TYPE);
453 val &= FREF_CLK_TYPE_BITS;
454 val |= CLK_REQ_PRCM;
455 wl1271_top_reg_write(wl, OCP_REG_CLK_TYPE, val);
456 } else {
457 u16 val;
458 /* Set clock polarity */
459 val = wl1271_top_reg_read(wl, OCP_REG_CLK_POLARITY);
460 val &= FREF_CLK_POLARITY_BITS;
461 val |= CLK_REQ_OUTN_SEL;
462 wl1271_top_reg_write(wl, OCP_REG_CLK_POLARITY, val);
463 }
464
74621417 465 wl1271_spi_write32(wl, PLL_PARAMETERS, clk);
f5fc0f86 466
74621417 467 pause = wl1271_spi_read32(wl, PLL_PARAMETERS);
f5fc0f86
LC
468
469 wl1271_debug(DEBUG_BOOT, "pause1 0x%x", pause);
470
471 pause &= ~(WU_COUNTER_PAUSE_VAL); /* FIXME: This should probably be
472 * WU_COUNTER_PAUSE_VAL instead of
473 * 0x3ff (magic number ). How does
474 * this work?! */
475 pause |= WU_COUNTER_PAUSE_VAL;
74621417 476 wl1271_spi_write32(wl, WU_COUNTER_PAUSE, pause);
f5fc0f86
LC
477
478 /* Continue the ELP wake up sequence */
74621417 479 wl1271_spi_write32(wl, WELP_ARM_COMMAND, WELP_ARM_COMMAND_VAL);
f5fc0f86
LC
480 udelay(500);
481
451de97a 482 wl1271_set_partition(wl, &part_table[PART_DRPW]);
f5fc0f86
LC
483
484 /* Read-modify-write DRPW_SCRATCH_START register (see next state)
485 to be used by DRPw FW. The RTRIM value will be added by the FW
486 before taking DRPw out of reset */
487
488 wl1271_debug(DEBUG_BOOT, "DRPW_SCRATCH_START %08x", DRPW_SCRATCH_START);
74621417 489 clk = wl1271_spi_read32(wl, DRPW_SCRATCH_START);
f5fc0f86
LC
490
491 wl1271_debug(DEBUG_BOOT, "clk2 0x%x", clk);
492
493 /* 2 */
494 clk |= (REF_CLOCK << 1) << 4;
74621417 495 wl1271_spi_write32(wl, DRPW_SCRATCH_START, clk);
f5fc0f86 496
451de97a 497 wl1271_set_partition(wl, &part_table[PART_WORK]);
f5fc0f86
LC
498
499 /* Disable interrupts */
74621417 500 wl1271_spi_write32(wl, ACX_REG_INTERRUPT_MASK, WL1271_ACX_INTR_ALL);
f5fc0f86
LC
501
502 ret = wl1271_boot_soft_reset(wl);
503 if (ret < 0)
504 goto out;
505
506 /* 2. start processing NVS file */
507 ret = wl1271_boot_upload_nvs(wl);
508 if (ret < 0)
509 goto out;
510
511 /* write firmware's last address (ie. it's length) to
512 * ACX_EEPROMLESS_IND_REG */
513 wl1271_debug(DEBUG_BOOT, "ACX_EEPROMLESS_IND_REG");
514
74621417
JO
515 wl1271_spi_write32(wl, ACX_EEPROMLESS_IND_REG,
516 ACX_EEPROMLESS_IND_REG);
f5fc0f86 517
74621417 518 tmp = wl1271_spi_read32(wl, CHIP_ID_B);
f5fc0f86
LC
519
520 wl1271_debug(DEBUG_BOOT, "chip id 0x%x", tmp);
521
522 /* 6. read the EEPROM parameters */
74621417 523 tmp = wl1271_spi_read32(wl, SCR_PAD2);
f5fc0f86
LC
524
525 ret = wl1271_boot_write_irq_polarity(wl);
526 if (ret < 0)
527 goto out;
528
529 /* FIXME: Need to check whether this is really what we want */
74621417 530 wl1271_spi_write32(wl, ACX_REG_INTERRUPT_MASK,
f5fc0f86
LC
531 WL1271_ACX_ALL_EVENTS_VECTOR);
532
533 /* WL1271: The reference driver skips steps 7 to 10 (jumps directly
534 * to upload_fw) */
535
536 ret = wl1271_boot_upload_firmware(wl);
537 if (ret < 0)
538 goto out;
539
540 /* 10.5 start firmware */
541 ret = wl1271_boot_run_firmware(wl);
542 if (ret < 0)
543 goto out;
544
eb5b28d0
JO
545 /* Enable firmware interrupts now */
546 wl1271_boot_enable_interrupts(wl);
547
f5fc0f86
LC
548 /* set the wl1271 default filters */
549 wl->rx_config = WL1271_DEFAULT_RX_CONFIG;
550 wl->rx_filter = WL1271_DEFAULT_RX_FILTER;
551
552 wl1271_event_mbox_config(wl);
553
554out:
555 return ret;
556}