drivers/net/wireless/ti/wlcore/boot.c

   1 /*
   2  * This file is part of wl1271
   3  *
   4  * Copyright (C) 2008-2010 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/slab.h>
  25 #include <linux/wl12xx.h>
  26 #include <linux/export.h>
  27
  28 #include "debug.h"
  29 #include "acx.h"
  30 #include "boot.h"
  31 #include "io.h"
  32 #include "event.h"
  33 #include "rx.h"
  34 #include "hw_ops.h"
  35
  36 static void wl1271_boot_set_ecpu_ctrl(struct wl1271 *wl, u32 flag)
  37 {
  38         u32 cpu_ctrl;
  39
  40         /* 10.5.0 run the firmware (I) */
  41         cpu_ctrl = wlcore_read_reg(wl, REG_ECPU_CONTROL);
  42
  43         /* 10.5.1 run the firmware (II) */
  44         cpu_ctrl |= flag;
  45         wlcore_write_reg(wl, REG_ECPU_CONTROL, cpu_ctrl);
  46 }
  47
  48 static int wlcore_parse_fw_ver(struct wl1271 *wl)
  49 {
  50         int ret;
  51
  52         ret = sscanf(wl->chip.fw_ver_str + 4, "%u.%u.%u.%u.%u",
  53                      &wl->chip.fw_ver[0], &wl->chip.fw_ver[1],
  54                      &wl->chip.fw_ver[2], &wl->chip.fw_ver[3],
  55                      &wl->chip.fw_ver[4]);
  56
  57         if (ret != 5) {
  58                 wl1271_warning("fw version incorrect value");
  59                 memset(wl->chip.fw_ver, 0, sizeof(wl->chip.fw_ver));
  60                 return -EINVAL;
  61         }
  62
  63         ret = wlcore_identify_fw(wl);
  64         if (ret < 0)
  65                 return ret;
  66
  67         return 0;
  68 }
  69
  70 static int wlcore_boot_fw_version(struct wl1271 *wl)
  71 {
  72         struct wl1271_static_data *static_data;
  73         int ret;
  74
  75         static_data = kmalloc(sizeof(*static_data), GFP_DMA);
  76         if (!static_data) {
  77                 wl1271_error("Couldn't allocate memory for static data!");
  78                 return -ENOMEM;
  79         }
  80
  81         wl1271_read(wl, wl->cmd_box_addr, static_data, sizeof(*static_data),
  82                     false);
  83
  84         strncpy(wl->chip.fw_ver_str, static_data->fw_version,
  85                 sizeof(wl->chip.fw_ver_str));
  86
  87         kfree(static_data);
  88
  89         /* make sure the string is NULL-terminated */
  90         wl->chip.fw_ver_str[sizeof(wl->chip.fw_ver_str) - 1] = '\0';
  91
  92         ret = wlcore_parse_fw_ver(wl);
  93         if (ret < 0)
  94                 return ret;
  95
  96         return 0;
  97 }
  98
  99 static int wl1271_boot_upload_firmware_chunk(struct wl1271 *wl, void *buf,
 100                                              size_t fw_data_len, u32 dest)
 101 {
 102         struct wlcore_partition_set partition;
 103         int addr, chunk_num, partition_limit;
 104         u8 *p, *chunk;
 105
 106         /* whal_FwCtrl_LoadFwImageSm() */
 107
 108         wl1271_debug(DEBUG_BOOT, "starting firmware upload");
 109
 110         wl1271_debug(DEBUG_BOOT, "fw_data_len %zd chunk_size %d",
 111                      fw_data_len, CHUNK_SIZE);
 112
 113         if ((fw_data_len % 4) != 0) {
 114                 wl1271_error("firmware length not multiple of four");
 115                 return -EIO;
 116         }
 117
 118         chunk = kmalloc(CHUNK_SIZE, GFP_KERNEL);
 119         if (!chunk) {
 120                 wl1271_error("allocation for firmware upload chunk failed");
 121                 return -ENOMEM;
 122         }
 123
 124         memcpy(&partition, &wl->ptable[PART_DOWN], sizeof(partition));
 125         partition.mem.start = dest;
 126         wlcore_set_partition(wl, &partition);
 127
 128         /* 10.1 set partition limit and chunk num */
 129         chunk_num = 0;
 130         partition_limit = wl->ptable[PART_DOWN].mem.size;
 131
 132         while (chunk_num < fw_data_len / CHUNK_SIZE) {
 133                 /* 10.2 update partition, if needed */
 134                 addr = dest + (chunk_num + 2) * CHUNK_SIZE;
 135                 if (addr > partition_limit) {
 136                         addr = dest + chunk_num * CHUNK_SIZE;
 137                         partition_limit = chunk_num * CHUNK_SIZE +
 138                                 wl->ptable[PART_DOWN].mem.size;
 139                         partition.mem.start = addr;
 140                         wlcore_set_partition(wl, &partition);
 141                 }
 142
 143                 /* 10.3 upload the chunk */
 144                 addr = dest + chunk_num * CHUNK_SIZE;
 145                 p = buf + chunk_num * CHUNK_SIZE;
 146                 memcpy(chunk, p, CHUNK_SIZE);
 147                 wl1271_debug(DEBUG_BOOT, "uploading fw chunk 0x%p to 0x%x",
 148                              p, addr);
 149                 wl1271_write(wl, addr, chunk, CHUNK_SIZE, false);
 150
 151                 chunk_num++;
 152         }
 153
 154         /* 10.4 upload the last chunk */
 155         addr = dest + chunk_num * CHUNK_SIZE;
 156         p = buf + chunk_num * CHUNK_SIZE;
 157         memcpy(chunk, p, fw_data_len % CHUNK_SIZE);
 158         wl1271_debug(DEBUG_BOOT, "uploading fw last chunk (%zd B) 0x%p to 0x%x",
 159                      fw_data_len % CHUNK_SIZE, p, addr);
 160         wl1271_write(wl, addr, chunk, fw_data_len % CHUNK_SIZE, false);
 161
 162         kfree(chunk);
 163         return 0;
 164 }
 165
 166 int wlcore_boot_upload_firmware(struct wl1271 *wl)
 167 {
 168         u32 chunks, addr, len;
 169         int ret = 0;
 170         u8 *fw;
 171
 172         fw = wl->fw;
 173         chunks = be32_to_cpup((__be32 *) fw);
 174         fw += sizeof(u32);
 175
 176         wl1271_debug(DEBUG_BOOT, "firmware chunks to be uploaded: %u", chunks);
 177
 178         while (chunks--) {
 179                 addr = be32_to_cpup((__be32 *) fw);
 180                 fw += sizeof(u32);
 181                 len = be32_to_cpup((__be32 *) fw);
 182                 fw += sizeof(u32);
 183
 184                 if (len > 300000) {
 185                         wl1271_info("firmware chunk too long: %u", len);
 186                         return -EINVAL;
 187                 }
 188                 wl1271_debug(DEBUG_BOOT, "chunk %d addr 0x%x len %u",
 189                              chunks, addr, len);
 190                 ret = wl1271_boot_upload_firmware_chunk(wl, fw, len, addr);
 191                 if (ret != 0)
 192                         break;
 193                 fw += len;
 194         }
 195
 196         return ret;
 197 }
 198 EXPORT_SYMBOL_GPL(wlcore_boot_upload_firmware);
 199
 200 int wlcore_boot_upload_nvs(struct wl1271 *wl)
 201 {
 202         size_t nvs_len, burst_len;
 203         int i;
 204         u32 dest_addr, val;
 205         u8 *nvs_ptr, *nvs_aligned;
 206
 207         if (wl->nvs == NULL)
 208                 return -ENODEV;
 209
 210         if (wl->quirks & WLCORE_QUIRK_LEGACY_NVS) {
 211                 struct wl1271_nvs_file *nvs =
 212                         (struct wl1271_nvs_file *)wl->nvs;
 213                 /*
 214                  * FIXME: the LEGACY NVS image support (NVS's missing the 5GHz
 215                  * band configurations) can be removed when those NVS files stop
 216                  * floating around.
 217                  */
 218                 if (wl->nvs_len == sizeof(struct wl1271_nvs_file) ||
 219                     wl->nvs_len == WL1271_INI_LEGACY_NVS_FILE_SIZE) {
 220                         if (nvs->general_params.dual_mode_select)
 221                                 wl->enable_11a = true;
 222                 }
 223
 224                 if (wl->nvs_len != sizeof(struct wl1271_nvs_file) &&
 225                     (wl->nvs_len != WL1271_INI_LEGACY_NVS_FILE_SIZE ||
 226                      wl->enable_11a)) {
 227                         wl1271_error("nvs size is not as expected: %zu != %zu",
 228                                 wl->nvs_len, sizeof(struct wl1271_nvs_file));
 229                         kfree(wl->nvs);
 230                         wl->nvs = NULL;
 231                         wl->nvs_len = 0;
 232                         return -EILSEQ;
 233                 }
 234
 235                 /* only the first part of the NVS needs to be uploaded */
 236                 nvs_len = sizeof(nvs->nvs);
 237                 nvs_ptr = (u8 *) nvs->nvs;
 238         } else {
 239                 struct wl128x_nvs_file *nvs = (struct wl128x_nvs_file *)wl->nvs;
 240
 241                 if (wl->nvs_len == sizeof(struct wl128x_nvs_file)) {
 242                         if (nvs->general_params.dual_mode_select)
 243                                 wl->enable_11a = true;
 244                 } else {
 245                         wl1271_error("nvs size is not as expected: %zu != %zu",
 246                                      wl->nvs_len,
 247                                      sizeof(struct wl128x_nvs_file));
 248                         kfree(wl->nvs);
 249                         wl->nvs = NULL;
 250                         wl->nvs_len = 0;
 251                         return -EILSEQ;
 252                 }
 253
 254                 /* only the first part of the NVS needs to be uploaded */
 255                 nvs_len = sizeof(nvs->nvs);
 256                 nvs_ptr = (u8 *)nvs->nvs;
 257         }
 258
 259         /* update current MAC address to NVS */
 260         nvs_ptr[11] = wl->addresses[0].addr[0];
 261         nvs_ptr[10] = wl->addresses[0].addr[1];
 262         nvs_ptr[6] = wl->addresses[0].addr[2];
 263         nvs_ptr[5] = wl->addresses[0].addr[3];
 264         nvs_ptr[4] = wl->addresses[0].addr[4];
 265         nvs_ptr[3] = wl->addresses[0].addr[5];
 266
 267         /*
 268          * Layout before the actual NVS tables:
 269          * 1 byte : burst length.
 270          * 2 bytes: destination address.
 271          * n bytes: data to burst copy.
 272          *
 273          * This is ended by a 0 length, then the NVS tables.
 274          */
 275
 276         /* FIXME: Do we need to check here whether the LSB is 1? */
 277         while (nvs_ptr[0]) {
 278                 burst_len = nvs_ptr[0];
 279                 dest_addr = (nvs_ptr[1] & 0xfe) | ((u32)(nvs_ptr[2] << 8));
 280
 281                 /*
 282                  * Due to our new wl1271_translate_reg_addr function,
 283                  * we need to add the register partition start address
 284                  * to the destination
 285                  */
 286                 dest_addr += wl->curr_part.reg.start;
 287
 288                 /* We move our pointer to the data */
 289                 nvs_ptr += 3;
 290
 291                 for (i = 0; i < burst_len; i++) {
 292                         if (nvs_ptr + 3 >= (u8 *) wl->nvs + nvs_len)
 293                                 goto out_badnvs;
 294
 295                         val = (nvs_ptr[0] | (nvs_ptr[1] << 8)
 296                                | (nvs_ptr[2] << 16) | (nvs_ptr[3] << 24));
 297
 298                         wl1271_debug(DEBUG_BOOT,
 299                                      "nvs burst write 0x%x: 0x%x",
 300                                      dest_addr, val);
 301                         wl1271_write32(wl, dest_addr, val);
 302
 303                         nvs_ptr += 4;
 304                         dest_addr += 4;
 305                 }
 306
 307                 if (nvs_ptr >= (u8 *) wl->nvs + nvs_len)
 308                         goto out_badnvs;
 309         }
 310
 311         /*
 312          * We've reached the first zero length, the first NVS table
 313          * is located at an aligned offset which is at least 7 bytes further.
 314          * NOTE: The wl->nvs->nvs element must be first, in order to
 315          * simplify the casting, we assume it is at the beginning of
 316          * the wl->nvs structure.
 317          */
 318         nvs_ptr = (u8 *)wl->nvs +
 319                         ALIGN(nvs_ptr - (u8 *)wl->nvs + 7, 4);
 320
 321         if (nvs_ptr >= (u8 *) wl->nvs + nvs_len)
 322                 goto out_badnvs;
 323
 324         nvs_len -= nvs_ptr - (u8 *)wl->nvs;
 325
 326         /* Now we must set the partition correctly */
 327         wlcore_set_partition(wl, &wl->ptable[PART_WORK]);
 328
 329         /* Copy the NVS tables to a new block to ensure alignment */
 330         nvs_aligned = kmemdup(nvs_ptr, nvs_len, GFP_KERNEL);
 331         if (!nvs_aligned)
 332                 return -ENOMEM;
 333
 334         /* And finally we upload the NVS tables */
 335         wlcore_write_data(wl, REG_CMD_MBOX_ADDRESS,
 336                           nvs_aligned, nvs_len, false);
 337
 338         kfree(nvs_aligned);
 339         return 0;
 340
 341 out_badnvs:
 342         wl1271_error("nvs data is malformed");
 343         return -EILSEQ;
 344 }
 345 EXPORT_SYMBOL_GPL(wlcore_boot_upload_nvs);
 346
 347 int wlcore_boot_run_firmware(struct wl1271 *wl)
 348 {
 349         int loop, ret;
 350         u32 chip_id, intr;
 351
 352         /* Make sure we have the boot partition */
 353         wlcore_set_partition(wl, &wl->ptable[PART_BOOT]);
 354
 355         wl1271_boot_set_ecpu_ctrl(wl, ECPU_CONTROL_HALT);
 356
 357         chip_id = wlcore_read_reg(wl, REG_CHIP_ID_B);
 358
 359         wl1271_debug(DEBUG_BOOT, "chip id after firmware boot: 0x%x", chip_id);
 360
 361         if (chip_id != wl->chip.id) {
 362                 wl1271_error("chip id doesn't match after firmware boot");
 363                 return -EIO;
 364         }
 365
 366         /* wait for init to complete */
 367         loop = 0;
 368         while (loop++ < INIT_LOOP) {
 369                 udelay(INIT_LOOP_DELAY);
 370                 intr = wlcore_read_reg(wl, REG_INTERRUPT_NO_CLEAR);
 371
 372                 if (intr == 0xffffffff) {
 373                         wl1271_error("error reading hardware complete "
 374                                      "init indication");
 375                         return -EIO;
 376                 }
 377                 /* check that ACX_INTR_INIT_COMPLETE is enabled */
 378                 else if (intr & WL1271_ACX_INTR_INIT_COMPLETE) {
 379                         wlcore_write_reg(wl, REG_INTERRUPT_ACK,
 380                                          WL1271_ACX_INTR_INIT_COMPLETE);
 381                         break;
 382                 }
 383         }
 384
 385         if (loop > INIT_LOOP) {
 386                 wl1271_error("timeout waiting for the hardware to "
 387                              "complete initialization");
 388                 return -EIO;
 389         }
 390
 391         /* get hardware config command mail box */
 392         wl->cmd_box_addr = wlcore_read_reg(wl, REG_COMMAND_MAILBOX_PTR);
 393
 394         wl1271_debug(DEBUG_MAILBOX, "cmd_box_addr 0x%x", wl->cmd_box_addr);
 395
 396         /* get hardware config event mail box */
 397         wl->mbox_ptr[0] = wlcore_read_reg(wl, REG_EVENT_MAILBOX_PTR);
 398         wl->mbox_ptr[1] = wl->mbox_ptr[0] + sizeof(struct event_mailbox);
 399
 400         wl1271_debug(DEBUG_MAILBOX, "MBOX ptrs: 0x%x 0x%x",
 401                      wl->mbox_ptr[0], wl->mbox_ptr[1]);
 402
 403         ret = wlcore_boot_fw_version(wl);
 404         if (ret < 0) {
 405                 wl1271_error("couldn't boot firmware");
 406                 return ret;
 407         }
 408
 409         /*
 410          * in case of full asynchronous mode the firmware event must be
 411          * ready to receive event from the command mailbox
 412          */
 413
 414         /* unmask required mbox events  */
 415         wl->event_mask = BSS_LOSE_EVENT_ID |
 416                 SCAN_COMPLETE_EVENT_ID |
 417                 ROLE_STOP_COMPLETE_EVENT_ID |
 418                 RSSI_SNR_TRIGGER_0_EVENT_ID |
 419                 PSPOLL_DELIVERY_FAILURE_EVENT_ID |
 420                 SOFT_GEMINI_SENSE_EVENT_ID |
 421                 PERIODIC_SCAN_REPORT_EVENT_ID |
 422                 PERIODIC_SCAN_COMPLETE_EVENT_ID |
 423                 DUMMY_PACKET_EVENT_ID |
 424                 PEER_REMOVE_COMPLETE_EVENT_ID |
 425                 BA_SESSION_RX_CONSTRAINT_EVENT_ID |
 426                 REMAIN_ON_CHANNEL_COMPLETE_EVENT_ID |
 427                 INACTIVE_STA_EVENT_ID |
 428                 MAX_TX_RETRY_EVENT_ID |
 429                 CHANNEL_SWITCH_COMPLETE_EVENT_ID;
 430
 431         ret = wl1271_event_unmask(wl);
 432         if (ret < 0) {
 433                 wl1271_error("EVENT mask setting failed");
 434                 return ret;
 435         }
 436
 437         /* set the working partition to its "running" mode offset */
 438         wlcore_set_partition(wl, &wl->ptable[PART_WORK]);
 439
 440         /* firmware startup completed */
 441         return 0;
 442 }
 443 EXPORT_SYMBOL_GPL(wlcore_boot_run_firmware);