2 * This file is part of wl1271
4 * Copyright (C) 2008-2010 Nokia Corporation
6 * Contact: Luciano Coelho <luciano.coelho@nokia.com>
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.
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.
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
24 #include <linux/slab.h>
25 #include <linux/wl12xx.h>
34 static struct wl1271_partition_set part_table[PART_TABLE_LEN] = {
41 .start = REGISTERS_BASE,
60 .start = REGISTERS_BASE,
93 static void wl1271_boot_set_ecpu_ctrl(struct wl1271 *wl, u32 flag)
97 /* 10.5.0 run the firmware (I) */
98 cpu_ctrl = wl1271_read32(wl, ACX_REG_ECPU_CONTROL);
100 /* 10.5.1 run the firmware (II) */
102 wl1271_write32(wl, ACX_REG_ECPU_CONTROL, cpu_ctrl);
105 static void wl1271_parse_fw_ver(struct wl1271 *wl)
109 ret = sscanf(wl->chip.fw_ver_str + 4, "%u.%u.%u.%u.%u",
110 &wl->chip.fw_ver[0], &wl->chip.fw_ver[1],
111 &wl->chip.fw_ver[2], &wl->chip.fw_ver[3],
112 &wl->chip.fw_ver[4]);
115 wl1271_warning("fw version incorrect value");
116 memset(wl->chip.fw_ver, 0, sizeof(wl->chip.fw_ver));
121 static void wl1271_boot_fw_version(struct wl1271 *wl)
123 struct wl1271_static_data static_data;
125 wl1271_read(wl, wl->cmd_box_addr, &static_data, sizeof(static_data),
128 strncpy(wl->chip.fw_ver_str, static_data.fw_version,
129 sizeof(wl->chip.fw_ver_str));
131 /* make sure the string is NULL-terminated */
132 wl->chip.fw_ver_str[sizeof(wl->chip.fw_ver_str) - 1] = '\0';
134 wl1271_parse_fw_ver(wl);
137 static int wl1271_boot_upload_firmware_chunk(struct wl1271 *wl, void *buf,
138 size_t fw_data_len, u32 dest)
140 struct wl1271_partition_set partition;
141 int addr, chunk_num, partition_limit;
144 /* whal_FwCtrl_LoadFwImageSm() */
146 wl1271_debug(DEBUG_BOOT, "starting firmware upload");
148 wl1271_debug(DEBUG_BOOT, "fw_data_len %zd chunk_size %d",
149 fw_data_len, CHUNK_SIZE);
151 if ((fw_data_len % 4) != 0) {
152 wl1271_error("firmware length not multiple of four");
156 chunk = kmalloc(CHUNK_SIZE, GFP_KERNEL);
158 wl1271_error("allocation for firmware upload chunk failed");
162 memcpy(&partition, &part_table[PART_DOWN], sizeof(partition));
163 partition.mem.start = dest;
164 wl1271_set_partition(wl, &partition);
166 /* 10.1 set partition limit and chunk num */
168 partition_limit = part_table[PART_DOWN].mem.size;
170 while (chunk_num < fw_data_len / CHUNK_SIZE) {
171 /* 10.2 update partition, if needed */
172 addr = dest + (chunk_num + 2) * CHUNK_SIZE;
173 if (addr > partition_limit) {
174 addr = dest + chunk_num * CHUNK_SIZE;
175 partition_limit = chunk_num * CHUNK_SIZE +
176 part_table[PART_DOWN].mem.size;
177 partition.mem.start = addr;
178 wl1271_set_partition(wl, &partition);
181 /* 10.3 upload the chunk */
182 addr = dest + chunk_num * CHUNK_SIZE;
183 p = buf + chunk_num * CHUNK_SIZE;
184 memcpy(chunk, p, CHUNK_SIZE);
185 wl1271_debug(DEBUG_BOOT, "uploading fw chunk 0x%p to 0x%x",
187 wl1271_write(wl, addr, chunk, CHUNK_SIZE, false);
192 /* 10.4 upload the last chunk */
193 addr = dest + chunk_num * CHUNK_SIZE;
194 p = buf + chunk_num * CHUNK_SIZE;
195 memcpy(chunk, p, fw_data_len % CHUNK_SIZE);
196 wl1271_debug(DEBUG_BOOT, "uploading fw last chunk (%zd B) 0x%p to 0x%x",
197 fw_data_len % CHUNK_SIZE, p, addr);
198 wl1271_write(wl, addr, chunk, fw_data_len % CHUNK_SIZE, false);
204 static int wl1271_boot_upload_firmware(struct wl1271 *wl)
206 u32 chunks, addr, len;
211 chunks = be32_to_cpup((__be32 *) fw);
214 wl1271_debug(DEBUG_BOOT, "firmware chunks to be uploaded: %u", chunks);
217 addr = be32_to_cpup((__be32 *) fw);
219 len = be32_to_cpup((__be32 *) fw);
223 wl1271_info("firmware chunk too long: %u", len);
226 wl1271_debug(DEBUG_BOOT, "chunk %d addr 0x%x len %u",
228 ret = wl1271_boot_upload_firmware_chunk(wl, fw, len, addr);
237 static int wl1271_boot_upload_nvs(struct wl1271 *wl)
239 size_t nvs_len, burst_len;
242 u8 *nvs_ptr, *nvs_aligned;
247 if (wl->chip.id == CHIP_ID_1283_PG20) {
248 struct wl128x_nvs_file *nvs = (struct wl128x_nvs_file *)wl->nvs;
250 if (wl->nvs_len == sizeof(struct wl128x_nvs_file)) {
251 if (nvs->general_params.dual_mode_select)
252 wl->enable_11a = true;
254 wl1271_error("nvs size is not as expected: %zu != %zu",
256 sizeof(struct wl128x_nvs_file));
263 /* only the first part of the NVS needs to be uploaded */
264 nvs_len = sizeof(nvs->nvs);
265 nvs_ptr = (u8 *)nvs->nvs;
268 struct wl1271_nvs_file *nvs =
269 (struct wl1271_nvs_file *)wl->nvs;
271 * FIXME: the LEGACY NVS image support (NVS's missing the 5GHz
272 * band configurations) can be removed when those NVS files stop
275 if (wl->nvs_len == sizeof(struct wl1271_nvs_file) ||
276 wl->nvs_len == WL1271_INI_LEGACY_NVS_FILE_SIZE) {
277 /* for now 11a is unsupported in AP mode */
278 if (wl->bss_type != BSS_TYPE_AP_BSS &&
279 nvs->general_params.dual_mode_select)
280 wl->enable_11a = true;
283 if (wl->nvs_len != sizeof(struct wl1271_nvs_file) &&
284 (wl->nvs_len != WL1271_INI_LEGACY_NVS_FILE_SIZE ||
286 wl1271_error("nvs size is not as expected: %zu != %zu",
287 wl->nvs_len, sizeof(struct wl1271_nvs_file));
294 /* only the first part of the NVS needs to be uploaded */
295 nvs_len = sizeof(nvs->nvs);
296 nvs_ptr = (u8 *) nvs->nvs;
299 /* update current MAC address to NVS */
300 nvs_ptr[11] = wl->mac_addr[0];
301 nvs_ptr[10] = wl->mac_addr[1];
302 nvs_ptr[6] = wl->mac_addr[2];
303 nvs_ptr[5] = wl->mac_addr[3];
304 nvs_ptr[4] = wl->mac_addr[4];
305 nvs_ptr[3] = wl->mac_addr[5];
308 * Layout before the actual NVS tables:
309 * 1 byte : burst length.
310 * 2 bytes: destination address.
311 * n bytes: data to burst copy.
313 * This is ended by a 0 length, then the NVS tables.
316 /* FIXME: Do we need to check here whether the LSB is 1? */
318 burst_len = nvs_ptr[0];
319 dest_addr = (nvs_ptr[1] & 0xfe) | ((u32)(nvs_ptr[2] << 8));
322 * Due to our new wl1271_translate_reg_addr function,
323 * we need to add the REGISTER_BASE to the destination
325 dest_addr += REGISTERS_BASE;
327 /* We move our pointer to the data */
330 for (i = 0; i < burst_len; i++) {
331 val = (nvs_ptr[0] | (nvs_ptr[1] << 8)
332 | (nvs_ptr[2] << 16) | (nvs_ptr[3] << 24));
334 wl1271_debug(DEBUG_BOOT,
335 "nvs burst write 0x%x: 0x%x",
337 wl1271_write32(wl, dest_addr, val);
345 * We've reached the first zero length, the first NVS table
346 * is located at an aligned offset which is at least 7 bytes further.
347 * NOTE: The wl->nvs->nvs element must be first, in order to
348 * simplify the casting, we assume it is at the beginning of
349 * the wl->nvs structure.
351 nvs_ptr = (u8 *)wl->nvs +
352 ALIGN(nvs_ptr - (u8 *)wl->nvs + 7, 4);
353 nvs_len -= nvs_ptr - (u8 *)wl->nvs;
355 /* Now we must set the partition correctly */
356 wl1271_set_partition(wl, &part_table[PART_WORK]);
358 /* Copy the NVS tables to a new block to ensure alignment */
359 nvs_aligned = kmemdup(nvs_ptr, nvs_len, GFP_KERNEL);
363 /* And finally we upload the NVS tables */
364 wl1271_write(wl, CMD_MBOX_ADDRESS, nvs_aligned, nvs_len, false);
370 static void wl1271_boot_enable_interrupts(struct wl1271 *wl)
372 wl1271_enable_interrupts(wl);
373 wl1271_write32(wl, ACX_REG_INTERRUPT_MASK,
374 WL1271_ACX_INTR_ALL & ~(WL1271_INTR_MASK));
375 wl1271_write32(wl, HI_CFG, HI_CFG_DEF_VAL);
378 static int wl1271_boot_soft_reset(struct wl1271 *wl)
380 unsigned long timeout;
383 /* perform soft reset */
384 wl1271_write32(wl, ACX_REG_SLV_SOFT_RESET, ACX_SLV_SOFT_RESET_BIT);
386 /* SOFT_RESET is self clearing */
387 timeout = jiffies + usecs_to_jiffies(SOFT_RESET_MAX_TIME);
389 boot_data = wl1271_read32(wl, ACX_REG_SLV_SOFT_RESET);
390 wl1271_debug(DEBUG_BOOT, "soft reset bootdata 0x%x", boot_data);
391 if ((boot_data & ACX_SLV_SOFT_RESET_BIT) == 0)
394 if (time_after(jiffies, timeout)) {
395 /* 1.2 check pWhalBus->uSelfClearTime if the
396 * timeout was reached */
397 wl1271_error("soft reset timeout");
401 udelay(SOFT_RESET_STALL_TIME);
405 wl1271_write32(wl, ENABLE, 0x0);
407 /* disable auto calibration on start*/
408 wl1271_write32(wl, SPARE_A2, 0xffff);
413 static int wl1271_boot_run_firmware(struct wl1271 *wl)
418 wl1271_boot_set_ecpu_ctrl(wl, ECPU_CONTROL_HALT);
420 chip_id = wl1271_read32(wl, CHIP_ID_B);
422 wl1271_debug(DEBUG_BOOT, "chip id after firmware boot: 0x%x", chip_id);
424 if (chip_id != wl->chip.id) {
425 wl1271_error("chip id doesn't match after firmware boot");
429 /* wait for init to complete */
431 while (loop++ < INIT_LOOP) {
432 udelay(INIT_LOOP_DELAY);
433 intr = wl1271_read32(wl, ACX_REG_INTERRUPT_NO_CLEAR);
435 if (intr == 0xffffffff) {
436 wl1271_error("error reading hardware complete "
440 /* check that ACX_INTR_INIT_COMPLETE is enabled */
441 else if (intr & WL1271_ACX_INTR_INIT_COMPLETE) {
442 wl1271_write32(wl, ACX_REG_INTERRUPT_ACK,
443 WL1271_ACX_INTR_INIT_COMPLETE);
448 if (loop > INIT_LOOP) {
449 wl1271_error("timeout waiting for the hardware to "
450 "complete initialization");
454 /* get hardware config command mail box */
455 wl->cmd_box_addr = wl1271_read32(wl, REG_COMMAND_MAILBOX_PTR);
457 /* get hardware config event mail box */
458 wl->event_box_addr = wl1271_read32(wl, REG_EVENT_MAILBOX_PTR);
460 /* set the working partition to its "running" mode offset */
461 wl1271_set_partition(wl, &part_table[PART_WORK]);
463 wl1271_debug(DEBUG_MAILBOX, "cmd_box_addr 0x%x event_box_addr 0x%x",
464 wl->cmd_box_addr, wl->event_box_addr);
466 wl1271_boot_fw_version(wl);
469 * in case of full asynchronous mode the firmware event must be
470 * ready to receive event from the command mailbox
473 /* unmask required mbox events */
474 wl->event_mask = BSS_LOSE_EVENT_ID |
475 SCAN_COMPLETE_EVENT_ID |
477 JOIN_EVENT_COMPLETE_ID |
478 DISCONNECT_EVENT_COMPLETE_ID |
479 RSSI_SNR_TRIGGER_0_EVENT_ID |
480 PSPOLL_DELIVERY_FAILURE_EVENT_ID |
481 SOFT_GEMINI_SENSE_EVENT_ID;
483 if (wl->bss_type == BSS_TYPE_AP_BSS)
484 wl->event_mask |= STA_REMOVE_COMPLETE_EVENT_ID;
486 wl->event_mask |= DUMMY_PACKET_EVENT_ID;
488 ret = wl1271_event_unmask(wl);
490 wl1271_error("EVENT mask setting failed");
494 wl1271_event_mbox_config(wl);
496 /* firmware startup completed */
500 static int wl1271_boot_write_irq_polarity(struct wl1271 *wl)
504 polarity = wl1271_top_reg_read(wl, OCP_REG_POLARITY);
506 /* We use HIGH polarity, so unset the LOW bit */
507 polarity &= ~POLARITY_LOW;
508 wl1271_top_reg_write(wl, OCP_REG_POLARITY, polarity);
513 static void wl1271_boot_hw_version(struct wl1271 *wl)
517 fuse = wl1271_top_reg_read(wl, REG_FUSE_DATA_2_1);
518 fuse = (fuse & PG_VER_MASK) >> PG_VER_OFFSET;
520 wl->hw_pg_ver = (s8)fuse;
522 if (((wl->hw_pg_ver & PG_MAJOR_VER_MASK) >> PG_MAJOR_VER_OFFSET) < 3)
523 wl->quirks |= WL12XX_QUIRK_END_OF_TRANSACTION;
526 static int wl128x_switch_tcxo_to_fref(struct wl1271 *wl)
530 /* Mask bits [2] & [8:4] in the sys_clk_cfg register */
531 spare_reg = wl1271_top_reg_read(wl, WL_SPARE_REG);
532 if (spare_reg == 0xFFFF)
534 spare_reg |= (BIT(3) | BIT(5) | BIT(6));
535 wl1271_top_reg_write(wl, WL_SPARE_REG, spare_reg);
537 /* Enable FREF_CLK_REQ & mux MCS and coex PLLs to FREF */
538 wl1271_top_reg_write(wl, SYS_CLK_CFG_REG,
539 WL_CLK_REQ_TYPE_PG2 | MCS_PLL_CLK_SEL_FREF);
541 /* Delay execution for 15msec, to let the HW settle */
547 static bool wl128x_is_tcxo_valid(struct wl1271 *wl)
551 tcxo_detection = wl1271_top_reg_read(wl, TCXO_CLK_DETECT_REG);
552 if (tcxo_detection & TCXO_DET_FAILED)
558 static bool wl128x_is_fref_valid(struct wl1271 *wl)
562 fref_detection = wl1271_top_reg_read(wl, FREF_CLK_DETECT_REG);
563 if (fref_detection & FREF_CLK_DETECT_FAIL)
569 static int wl128x_manually_configure_mcs_pll(struct wl1271 *wl)
571 wl1271_top_reg_write(wl, MCS_PLL_M_REG, MCS_PLL_M_REG_VAL);
572 wl1271_top_reg_write(wl, MCS_PLL_N_REG, MCS_PLL_N_REG_VAL);
573 wl1271_top_reg_write(wl, MCS_PLL_CONFIG_REG, MCS_PLL_CONFIG_REG_VAL);
578 static int wl128x_configure_mcs_pll(struct wl1271 *wl, int clk)
584 /* Mask bits [3:1] in the sys_clk_cfg register */
585 spare_reg = wl1271_top_reg_read(wl, WL_SPARE_REG);
586 if (spare_reg == 0xFFFF)
589 wl1271_top_reg_write(wl, WL_SPARE_REG, spare_reg);
591 /* Handle special cases of the TCXO clock */
592 if (wl->tcxo_clock == WL12XX_TCXOCLOCK_16_8 ||
593 wl->tcxo_clock == WL12XX_TCXOCLOCK_33_6)
594 return wl128x_manually_configure_mcs_pll(wl);
596 /* Set the input frequency according to the selected clock source */
597 input_freq = (clk & 1) + 1;
599 pll_config = wl1271_top_reg_read(wl, MCS_PLL_CONFIG_REG);
600 if (pll_config == 0xFFFF)
602 pll_config |= (input_freq << MCS_SEL_IN_FREQ_SHIFT);
603 pll_config |= MCS_PLL_ENABLE_HP;
604 wl1271_top_reg_write(wl, MCS_PLL_CONFIG_REG, pll_config);
610 * WL128x has two clocks input - TCXO and FREF.
611 * TCXO is the main clock of the device, while FREF is used to sync
612 * between the GPS and the cellular modem.
613 * In cases where TCXO is 32.736MHz or 16.368MHz, the FREF will be used
614 * as the WLAN/BT main clock.
616 static int wl128x_boot_clk(struct wl1271 *wl, int *selected_clock)
620 /* For XTAL-only modes, FREF will be used after switching from TCXO */
621 if (wl->ref_clock == WL12XX_REFCLOCK_26_XTAL ||
622 wl->ref_clock == WL12XX_REFCLOCK_38_XTAL) {
623 if (!wl128x_switch_tcxo_to_fref(wl))
628 /* Query the HW, to determine which clock source we should use */
629 sys_clk_cfg = wl1271_top_reg_read(wl, SYS_CLK_CFG_REG);
630 if (sys_clk_cfg == 0xFFFF)
632 if (sys_clk_cfg & PRCM_CM_EN_MUX_WLAN_FREF)
635 /* If TCXO is either 32.736MHz or 16.368MHz, switch to FREF */
636 if (wl->tcxo_clock == WL12XX_TCXOCLOCK_16_368 ||
637 wl->tcxo_clock == WL12XX_TCXOCLOCK_32_736) {
638 if (!wl128x_switch_tcxo_to_fref(wl))
643 /* TCXO clock is selected */
644 if (!wl128x_is_tcxo_valid(wl))
646 *selected_clock = wl->tcxo_clock;
650 /* FREF clock is selected */
651 if (!wl128x_is_fref_valid(wl))
653 *selected_clock = wl->ref_clock;
656 return wl128x_configure_mcs_pll(wl, *selected_clock);
659 static int wl127x_boot_clk(struct wl1271 *wl)
664 wl1271_boot_hw_version(wl);
666 if (wl->ref_clock == CONF_REF_CLK_19_2_E ||
667 wl->ref_clock == CONF_REF_CLK_38_4_E ||
668 wl->ref_clock == CONF_REF_CLK_38_4_M_XTAL)
669 /* ref clk: 19.2/38.4/38.4-XTAL */
671 else if (wl->ref_clock == CONF_REF_CLK_26_E ||
672 wl->ref_clock == CONF_REF_CLK_52_E)
678 if (wl->ref_clock != CONF_REF_CLK_19_2_E) {
680 /* Set clock type (open drain) */
681 val = wl1271_top_reg_read(wl, OCP_REG_CLK_TYPE);
682 val &= FREF_CLK_TYPE_BITS;
683 wl1271_top_reg_write(wl, OCP_REG_CLK_TYPE, val);
685 /* Set clock pull mode (no pull) */
686 val = wl1271_top_reg_read(wl, OCP_REG_CLK_PULL);
688 wl1271_top_reg_write(wl, OCP_REG_CLK_PULL, val);
691 /* Set clock polarity */
692 val = wl1271_top_reg_read(wl, OCP_REG_CLK_POLARITY);
693 val &= FREF_CLK_POLARITY_BITS;
694 val |= CLK_REQ_OUTN_SEL;
695 wl1271_top_reg_write(wl, OCP_REG_CLK_POLARITY, val);
698 wl1271_write32(wl, PLL_PARAMETERS, clk);
700 pause = wl1271_read32(wl, PLL_PARAMETERS);
702 wl1271_debug(DEBUG_BOOT, "pause1 0x%x", pause);
704 pause &= ~(WU_COUNTER_PAUSE_VAL);
705 pause |= WU_COUNTER_PAUSE_VAL;
706 wl1271_write32(wl, WU_COUNTER_PAUSE, pause);
711 /* uploads NVS and firmware */
712 int wl1271_load_firmware(struct wl1271 *wl)
716 int selected_clock = -1;
718 if (wl->chip.id == CHIP_ID_1283_PG20) {
719 ret = wl128x_boot_clk(wl, &selected_clock);
723 ret = wl127x_boot_clk(wl);
728 /* Continue the ELP wake up sequence */
729 wl1271_write32(wl, WELP_ARM_COMMAND, WELP_ARM_COMMAND_VAL);
732 wl1271_set_partition(wl, &part_table[PART_DRPW]);
734 /* Read-modify-write DRPW_SCRATCH_START register (see next state)
735 to be used by DRPw FW. The RTRIM value will be added by the FW
736 before taking DRPw out of reset */
738 wl1271_debug(DEBUG_BOOT, "DRPW_SCRATCH_START %08x", DRPW_SCRATCH_START);
739 clk = wl1271_read32(wl, DRPW_SCRATCH_START);
741 wl1271_debug(DEBUG_BOOT, "clk2 0x%x", clk);
743 if (wl->chip.id == CHIP_ID_1283_PG20) {
744 clk |= ((selected_clock & 0x3) << 1) << 4;
746 clk |= (wl->ref_clock << 1) << 4;
749 wl1271_write32(wl, DRPW_SCRATCH_START, clk);
751 wl1271_set_partition(wl, &part_table[PART_WORK]);
753 /* Disable interrupts */
754 wl1271_write32(wl, ACX_REG_INTERRUPT_MASK, WL1271_ACX_INTR_ALL);
756 ret = wl1271_boot_soft_reset(wl);
760 /* 2. start processing NVS file */
761 ret = wl1271_boot_upload_nvs(wl);
765 /* write firmware's last address (ie. it's length) to
766 * ACX_EEPROMLESS_IND_REG */
767 wl1271_debug(DEBUG_BOOT, "ACX_EEPROMLESS_IND_REG");
769 wl1271_write32(wl, ACX_EEPROMLESS_IND_REG, ACX_EEPROMLESS_IND_REG);
771 tmp = wl1271_read32(wl, CHIP_ID_B);
773 wl1271_debug(DEBUG_BOOT, "chip id 0x%x", tmp);
775 /* 6. read the EEPROM parameters */
776 tmp = wl1271_read32(wl, SCR_PAD2);
778 /* WL1271: The reference driver skips steps 7 to 10 (jumps directly
781 if (wl->chip.id == CHIP_ID_1283_PG20)
782 wl1271_top_reg_write(wl, SDIO_IO_DS, wl->conf.hci_io_ds);
784 ret = wl1271_boot_upload_firmware(wl);
791 EXPORT_SYMBOL_GPL(wl1271_load_firmware);
793 int wl1271_boot(struct wl1271 *wl)
797 /* upload NVS and firmware */
798 ret = wl1271_load_firmware(wl);
802 /* 10.5 start firmware */
803 ret = wl1271_boot_run_firmware(wl);
807 ret = wl1271_boot_write_irq_polarity(wl);
811 wl1271_write32(wl, ACX_REG_INTERRUPT_MASK,
812 WL1271_ACX_ALL_EVENTS_VECTOR);
814 /* Enable firmware interrupts now */
815 wl1271_boot_enable_interrupts(wl);
817 /* set the wl1271 default filters */
818 wl1271_set_default_filters(wl);
820 wl1271_event_mbox_config(wl);