drivers/staging/rdma/hfi1/firmware.c

   1 /*
   2  * Copyright(c) 2015, 2016 Intel Corporation.
   3  *
   4  * This file is provided under a dual BSD/GPLv2 license.  When using or
   5  * redistributing this file, you may do so under either license.
   6  *
   7  * GPL LICENSE SUMMARY
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of version 2 of the GNU General Public License as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * BSD LICENSE
  19  *
  20  * Redistribution and use in source and binary forms, with or without
  21  * modification, are permitted provided that the following conditions
  22  * are met:
  23  *
  24  *  - Redistributions of source code must retain the above copyright
  25  *    notice, this list of conditions and the following disclaimer.
  26  *  - Redistributions in binary form must reproduce the above copyright
  27  *    notice, this list of conditions and the following disclaimer in
  28  *    the documentation and/or other materials provided with the
  29  *    distribution.
  30  *  - Neither the name of Intel Corporation nor the names of its
  31  *    contributors may be used to endorse or promote products derived
  32  *    from this software without specific prior written permission.
  33  *
  34  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  35  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  36  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  37  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  38  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  39  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  40  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  41  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  42  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  43  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  44  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  45  *
  46  */
  47
  48 #include <linux/firmware.h>
  49 #include <linux/mutex.h>
  50 #include <linux/module.h>
  51 #include <linux/delay.h>
  52 #include <linux/crc32.h>
  53
  54 #include "hfi.h"
  55 #include "trace.h"
  56
  57 /*
  58  * Make it easy to toggle firmware file name and if it gets loaded by
  59  * editing the following. This may be something we do while in development
  60  * but not necessarily something a user would ever need to use.
  61  */
  62 #define DEFAULT_FW_8051_NAME_FPGA "hfi_dc8051.bin"
  63 #define DEFAULT_FW_8051_NAME_ASIC "hfi1_dc8051.fw"
  64 #define DEFAULT_FW_FABRIC_NAME "hfi1_fabric.fw"
  65 #define DEFAULT_FW_SBUS_NAME "hfi1_sbus.fw"
  66 #define DEFAULT_FW_PCIE_NAME "hfi1_pcie.fw"
  67 #define DEFAULT_PLATFORM_CONFIG_NAME "hfi1_platform.dat"
  68 #define ALT_FW_8051_NAME_ASIC "hfi1_dc8051_d.fw"
  69 #define ALT_FW_FABRIC_NAME "hfi1_fabric_d.fw"
  70 #define ALT_FW_SBUS_NAME "hfi1_sbus_d.fw"
  71 #define ALT_FW_PCIE_NAME "hfi1_pcie_d.fw"
  72
  73 static uint fw_8051_load = 1;
  74 static uint fw_fabric_serdes_load = 1;
  75 static uint fw_pcie_serdes_load = 1;
  76 static uint fw_sbus_load = 1;
  77
  78 /*
  79  * Access required in platform.c
  80  * Maintains state of whether the platform config was fetched via the
  81  * fallback option
  82  */
  83 uint platform_config_load;
  84
  85 /* Firmware file names get set in hfi1_firmware_init() based on the above */
  86 static char *fw_8051_name;
  87 static char *fw_fabric_serdes_name;
  88 static char *fw_sbus_name;
  89 static char *fw_pcie_serdes_name;
  90 static char *platform_config_name;
  91
  92 #define SBUS_MAX_POLL_COUNT 100
  93 #define SBUS_COUNTER(reg, name) \
  94         (((reg) >> ASIC_STS_SBUS_COUNTERS_##name##_CNT_SHIFT) & \
  95          ASIC_STS_SBUS_COUNTERS_##name##_CNT_MASK)
  96
  97 /*
  98  * Firmware security header.
  99  */
 100 struct css_header {
 101         u32 module_type;
 102         u32 header_len;
 103         u32 header_version;
 104         u32 module_id;
 105         u32 module_vendor;
 106         u32 date;               /* BCD yyyymmdd */
 107         u32 size;               /* in DWORDs */
 108         u32 key_size;           /* in DWORDs */
 109         u32 modulus_size;       /* in DWORDs */
 110         u32 exponent_size;      /* in DWORDs */
 111         u32 reserved[22];
 112 };
 113
 114 /* expected field values */
 115 #define CSS_MODULE_TYPE    0x00000006
 116 #define CSS_HEADER_LEN     0x000000a1
 117 #define CSS_HEADER_VERSION 0x00010000
 118 #define CSS_MODULE_VENDOR  0x00008086
 119
 120 #define KEY_SIZE      256
 121 #define MU_SIZE         8
 122 #define EXPONENT_SIZE   4
 123
 124 /* the file itself */
 125 struct firmware_file {
 126         struct css_header css_header;
 127         u8 modulus[KEY_SIZE];
 128         u8 exponent[EXPONENT_SIZE];
 129         u8 signature[KEY_SIZE];
 130         u8 firmware[];
 131 };
 132
 133 struct augmented_firmware_file {
 134         struct css_header css_header;
 135         u8 modulus[KEY_SIZE];
 136         u8 exponent[EXPONENT_SIZE];
 137         u8 signature[KEY_SIZE];
 138         u8 r2[KEY_SIZE];
 139         u8 mu[MU_SIZE];
 140         u8 firmware[];
 141 };
 142
 143 /* augmented file size difference */
 144 #define AUGMENT_SIZE (sizeof(struct augmented_firmware_file) - \
 145                                                 sizeof(struct firmware_file))
 146
 147 struct firmware_details {
 148         /* Linux core piece */
 149         const struct firmware *fw;
 150
 151         struct css_header *css_header;
 152         u8 *firmware_ptr;               /* pointer to binary data */
 153         u32 firmware_len;               /* length in bytes */
 154         u8 *modulus;                    /* pointer to the modulus */
 155         u8 *exponent;                   /* pointer to the exponent */
 156         u8 *signature;                  /* pointer to the signature */
 157         u8 *r2;                         /* pointer to r2 */
 158         u8 *mu;                         /* pointer to mu */
 159         struct augmented_firmware_file dummy_header;
 160 };
 161
 162 /*
 163  * The mutex protects fw_state, fw_err, and all of the firmware_details
 164  * variables.
 165  */
 166 static DEFINE_MUTEX(fw_mutex);
 167 enum fw_state {
 168         FW_EMPTY,
 169         FW_TRY,
 170         FW_FINAL,
 171         FW_ERR
 172 };
 173
 174 static enum fw_state fw_state = FW_EMPTY;
 175 static int fw_err;
 176 static struct firmware_details fw_8051;
 177 static struct firmware_details fw_fabric;
 178 static struct firmware_details fw_pcie;
 179 static struct firmware_details fw_sbus;
 180 static const struct firmware *platform_config;
 181
 182 /* flags for turn_off_spicos() */
 183 #define SPICO_SBUS   0x1
 184 #define SPICO_FABRIC 0x2
 185 #define ENABLE_SPICO_SMASK 0x1
 186
 187 /* security block commands */
 188 #define RSA_CMD_INIT  0x1
 189 #define RSA_CMD_START 0x2
 190
 191 /* security block status */
 192 #define RSA_STATUS_IDLE   0x0
 193 #define RSA_STATUS_ACTIVE 0x1
 194 #define RSA_STATUS_DONE   0x2
 195 #define RSA_STATUS_FAILED 0x3
 196
 197 /* RSA engine timeout, in ms */
 198 #define RSA_ENGINE_TIMEOUT 100 /* ms */
 199
 200 /* hardware mutex timeout, in ms */
 201 #define HM_TIMEOUT 4000 /* 4 s */
 202
 203 /* 8051 memory access timeout, in us */
 204 #define DC8051_ACCESS_TIMEOUT 100 /* us */
 205
 206 /* the number of fabric SerDes on the SBus */
 207 #define NUM_FABRIC_SERDES 4
 208
 209 /* SBus fabric SerDes addresses, one set per HFI */
 210 static const u8 fabric_serdes_addrs[2][NUM_FABRIC_SERDES] = {
 211         { 0x01, 0x02, 0x03, 0x04 },
 212         { 0x28, 0x29, 0x2a, 0x2b }
 213 };
 214
 215 /* SBus PCIe SerDes addresses, one set per HFI */
 216 static const u8 pcie_serdes_addrs[2][NUM_PCIE_SERDES] = {
 217         { 0x08, 0x0a, 0x0c, 0x0e, 0x10, 0x12, 0x14, 0x16,
 218           0x18, 0x1a, 0x1c, 0x1e, 0x20, 0x22, 0x24, 0x26 },
 219         { 0x2f, 0x31, 0x33, 0x35, 0x37, 0x39, 0x3b, 0x3d,
 220           0x3f, 0x41, 0x43, 0x45, 0x47, 0x49, 0x4b, 0x4d }
 221 };
 222
 223 /* SBus PCIe PCS addresses, one set per HFI */
 224 const u8 pcie_pcs_addrs[2][NUM_PCIE_SERDES] = {
 225         { 0x09, 0x0b, 0x0d, 0x0f, 0x11, 0x13, 0x15, 0x17,
 226           0x19, 0x1b, 0x1d, 0x1f, 0x21, 0x23, 0x25, 0x27 },
 227         { 0x30, 0x32, 0x34, 0x36, 0x38, 0x3a, 0x3c, 0x3e,
 228           0x40, 0x42, 0x44, 0x46, 0x48, 0x4a, 0x4c, 0x4e }
 229 };
 230
 231 /* SBus fabric SerDes broadcast addresses, one per HFI */
 232 static const u8 fabric_serdes_broadcast[2] = { 0xe4, 0xe5 };
 233 static const u8 all_fabric_serdes_broadcast = 0xe1;
 234
 235 /* SBus PCIe SerDes broadcast addresses, one per HFI */
 236 const u8 pcie_serdes_broadcast[2] = { 0xe2, 0xe3 };
 237 static const u8 all_pcie_serdes_broadcast = 0xe0;
 238
 239 /* forwards */
 240 static void dispose_one_firmware(struct firmware_details *fdet);
 241 static int load_fabric_serdes_firmware(struct hfi1_devdata *dd,
 242                                        struct firmware_details *fdet);
 243
 244 /*
 245  * Read a single 64-bit value from 8051 data memory.
 246  *
 247  * Expects:
 248  * o caller to have already set up data read, no auto increment
 249  * o caller to turn off read enable when finished
 250  *
 251  * The address argument is a byte offset.  Bits 0:2 in the address are
 252  * ignored - i.e. the hardware will always do aligned 8-byte reads as if
 253  * the lower bits are zero.
 254  *
 255  * Return 0 on success, -ENXIO on a read error (timeout).
 256  */
 257 static int __read_8051_data(struct hfi1_devdata *dd, u32 addr, u64 *result)
 258 {
 259         u64 reg;
 260         int count;
 261
 262         /* start the read at the given address */
 263         reg = ((addr & DC_DC8051_CFG_RAM_ACCESS_CTRL_ADDRESS_MASK)
 264                         << DC_DC8051_CFG_RAM_ACCESS_CTRL_ADDRESS_SHIFT)
 265                 | DC_DC8051_CFG_RAM_ACCESS_CTRL_READ_ENA_SMASK;
 266         write_csr(dd, DC_DC8051_CFG_RAM_ACCESS_CTRL, reg);
 267
 268         /* wait until ACCESS_COMPLETED is set */
 269         count = 0;
 270         while ((read_csr(dd, DC_DC8051_CFG_RAM_ACCESS_STATUS)
 271                     & DC_DC8051_CFG_RAM_ACCESS_STATUS_ACCESS_COMPLETED_SMASK)
 272                     == 0) {
 273                 count++;
 274                 if (count > DC8051_ACCESS_TIMEOUT) {
 275                         dd_dev_err(dd, "timeout reading 8051 data\n");
 276                         return -ENXIO;
 277                 }
 278                 ndelay(10);
 279         }
 280
 281         /* gather the data */
 282         *result = read_csr(dd, DC_DC8051_CFG_RAM_ACCESS_RD_DATA);
 283
 284         return 0;
 285 }
 286
 287 /*
 288  * Read 8051 data starting at addr, for len bytes.  Will read in 8-byte chunks.
 289  * Return 0 on success, -errno on error.
 290  */
 291 int read_8051_data(struct hfi1_devdata *dd, u32 addr, u32 len, u64 *result)
 292 {
 293         unsigned long flags;
 294         u32 done;
 295         int ret = 0;
 296
 297         spin_lock_irqsave(&dd->dc8051_memlock, flags);
 298
 299         /* data read set-up, no auto-increment */
 300         write_csr(dd, DC_DC8051_CFG_RAM_ACCESS_SETUP, 0);
 301
 302         for (done = 0; done < len; addr += 8, done += 8, result++) {
 303                 ret = __read_8051_data(dd, addr, result);
 304                 if (ret)
 305                         break;
 306         }
 307
 308         /* turn off read enable */
 309         write_csr(dd, DC_DC8051_CFG_RAM_ACCESS_CTRL, 0);
 310
 311         spin_unlock_irqrestore(&dd->dc8051_memlock, flags);
 312
 313         return ret;
 314 }
 315
 316 /*
 317  * Write data or code to the 8051 code or data RAM.
 318  */
 319 static int write_8051(struct hfi1_devdata *dd, int code, u32 start,
 320                       const u8 *data, u32 len)
 321 {
 322         u64 reg;
 323         u32 offset;
 324         int aligned, count;
 325
 326         /* check alignment */
 327         aligned = ((unsigned long)data & 0x7) == 0;
 328
 329         /* write set-up */
 330         reg = (code ? DC_DC8051_CFG_RAM_ACCESS_SETUP_RAM_SEL_SMASK : 0ull)
 331                 | DC_DC8051_CFG_RAM_ACCESS_SETUP_AUTO_INCR_ADDR_SMASK;
 332         write_csr(dd, DC_DC8051_CFG_RAM_ACCESS_SETUP, reg);
 333
 334         reg = ((start & DC_DC8051_CFG_RAM_ACCESS_CTRL_ADDRESS_MASK)
 335                         << DC_DC8051_CFG_RAM_ACCESS_CTRL_ADDRESS_SHIFT)
 336                 | DC_DC8051_CFG_RAM_ACCESS_CTRL_WRITE_ENA_SMASK;
 337         write_csr(dd, DC_DC8051_CFG_RAM_ACCESS_CTRL, reg);
 338
 339         /* write */
 340         for (offset = 0; offset < len; offset += 8) {
 341                 int bytes = len - offset;
 342
 343                 if (bytes < 8) {
 344                         reg = 0;
 345                         memcpy(&reg, &data[offset], bytes);
 346                 } else if (aligned) {
 347                         reg = *(u64 *)&data[offset];
 348                 } else {
 349                         memcpy(&reg, &data[offset], 8);
 350                 }
 351                 write_csr(dd, DC_DC8051_CFG_RAM_ACCESS_WR_DATA, reg);
 352
 353                 /* wait until ACCESS_COMPLETED is set */
 354                 count = 0;
 355                 while ((read_csr(dd, DC_DC8051_CFG_RAM_ACCESS_STATUS)
 356                     & DC_DC8051_CFG_RAM_ACCESS_STATUS_ACCESS_COMPLETED_SMASK)
 357                     == 0) {
 358                         count++;
 359                         if (count > DC8051_ACCESS_TIMEOUT) {
 360                                 dd_dev_err(dd, "timeout writing 8051 data\n");
 361                                 return -ENXIO;
 362                         }
 363                         udelay(1);
 364                 }
 365         }
 366
 367         /* turn off write access, auto increment (also sets to data access) */
 368         write_csr(dd, DC_DC8051_CFG_RAM_ACCESS_CTRL, 0);
 369         write_csr(dd, DC_DC8051_CFG_RAM_ACCESS_SETUP, 0);
 370
 371         return 0;
 372 }
 373
 374 /* return 0 if values match, non-zero and complain otherwise */
 375 static int invalid_header(struct hfi1_devdata *dd, const char *what,
 376                           u32 actual, u32 expected)
 377 {
 378         if (actual == expected)
 379                 return 0;
 380
 381         dd_dev_err(dd,
 382                    "invalid firmware header field %s: expected 0x%x, actual 0x%x\n",
 383                    what, expected, actual);
 384         return 1;
 385 }
 386
 387 /*
 388  * Verify that the static fields in the CSS header match.
 389  */
 390 static int verify_css_header(struct hfi1_devdata *dd, struct css_header *css)
 391 {
 392         /* verify CSS header fields (most sizes are in DW, so add /4) */
 393         if (invalid_header(dd, "module_type", css->module_type,
 394                            CSS_MODULE_TYPE) ||
 395             invalid_header(dd, "header_len", css->header_len,
 396                            (sizeof(struct firmware_file) / 4)) ||
 397             invalid_header(dd, "header_version", css->header_version,
 398                            CSS_HEADER_VERSION) ||
 399             invalid_header(dd, "module_vendor", css->module_vendor,
 400                            CSS_MODULE_VENDOR) ||
 401             invalid_header(dd, "key_size", css->key_size, KEY_SIZE / 4) ||
 402             invalid_header(dd, "modulus_size", css->modulus_size,
 403                            KEY_SIZE / 4) ||
 404             invalid_header(dd, "exponent_size", css->exponent_size,
 405                            EXPONENT_SIZE / 4)) {
 406                 return -EINVAL;
 407         }
 408         return 0;
 409 }
 410
 411 /*
 412  * Make sure there are at least some bytes after the prefix.
 413  */
 414 static int payload_check(struct hfi1_devdata *dd, const char *name,
 415                          long file_size, long prefix_size)
 416 {
 417         /* make sure we have some payload */
 418         if (prefix_size >= file_size) {
 419                 dd_dev_err(dd,
 420                            "firmware \"%s\", size %ld, must be larger than %ld bytes\n",
 421                            name, file_size, prefix_size);
 422                 return -EINVAL;
 423         }
 424
 425         return 0;
 426 }
 427
 428 /*
 429  * Request the firmware from the system.  Extract the pieces and fill in
 430  * fdet.  If successful, the caller will need to call dispose_one_firmware().
 431  * Returns 0 on success, -ERRNO on error.
 432  */
 433 static int obtain_one_firmware(struct hfi1_devdata *dd, const char *name,
 434                                struct firmware_details *fdet)
 435 {
 436         struct css_header *css;
 437         int ret;
 438
 439         memset(fdet, 0, sizeof(*fdet));
 440
 441         ret = request_firmware(&fdet->fw, name, &dd->pcidev->dev);
 442         if (ret) {
 443                 dd_dev_warn(dd, "cannot find firmware \"%s\", err %d\n",
 444                             name, ret);
 445                 return ret;
 446         }
 447
 448         /* verify the firmware */
 449         if (fdet->fw->size < sizeof(struct css_header)) {
 450                 dd_dev_err(dd, "firmware \"%s\" is too small\n", name);
 451                 ret = -EINVAL;
 452                 goto done;
 453         }
 454         css = (struct css_header *)fdet->fw->data;
 455
 456         hfi1_cdbg(FIRMWARE, "Firmware %s details:", name);
 457         hfi1_cdbg(FIRMWARE, "file size: 0x%lx bytes", fdet->fw->size);
 458         hfi1_cdbg(FIRMWARE, "CSS structure:");
 459         hfi1_cdbg(FIRMWARE, "  module_type    0x%x", css->module_type);
 460         hfi1_cdbg(FIRMWARE, "  header_len     0x%03x (0x%03x bytes)",
 461                   css->header_len, 4 * css->header_len);
 462         hfi1_cdbg(FIRMWARE, "  header_version 0x%x", css->header_version);
 463         hfi1_cdbg(FIRMWARE, "  module_id      0x%x", css->module_id);
 464         hfi1_cdbg(FIRMWARE, "  module_vendor  0x%x", css->module_vendor);
 465         hfi1_cdbg(FIRMWARE, "  date           0x%x", css->date);
 466         hfi1_cdbg(FIRMWARE, "  size           0x%03x (0x%03x bytes)",
 467                   css->size, 4 * css->size);
 468         hfi1_cdbg(FIRMWARE, "  key_size       0x%03x (0x%03x bytes)",
 469                   css->key_size, 4 * css->key_size);
 470         hfi1_cdbg(FIRMWARE, "  modulus_size   0x%03x (0x%03x bytes)",
 471                   css->modulus_size, 4 * css->modulus_size);
 472         hfi1_cdbg(FIRMWARE, "  exponent_size  0x%03x (0x%03x bytes)",
 473                   css->exponent_size, 4 * css->exponent_size);
 474         hfi1_cdbg(FIRMWARE, "firmware size: 0x%lx bytes",
 475                   fdet->fw->size - sizeof(struct firmware_file));
 476
 477         /*
 478          * If the file does not have a valid CSS header, fail.
 479          * Otherwise, check the CSS size field for an expected size.
 480          * The augmented file has r2 and mu inserted after the header
 481          * was generated, so there will be a known difference between
 482          * the CSS header size and the actual file size.  Use this
 483          * difference to identify an augmented file.
 484          *
 485          * Note: css->size is in DWORDs, multiply by 4 to get bytes.
 486          */
 487         ret = verify_css_header(dd, css);
 488         if (ret) {
 489                 dd_dev_info(dd, "Invalid CSS header for \"%s\"\n", name);
 490         } else if ((css->size * 4) == fdet->fw->size) {
 491                 /* non-augmented firmware file */
 492                 struct firmware_file *ff = (struct firmware_file *)
 493                                                         fdet->fw->data;
 494
 495                 /* make sure there are bytes in the payload */
 496                 ret = payload_check(dd, name, fdet->fw->size,
 497                                     sizeof(struct firmware_file));
 498                 if (ret == 0) {
 499                         fdet->css_header = css;
 500                         fdet->modulus = ff->modulus;
 501                         fdet->exponent = ff->exponent;
 502                         fdet->signature = ff->signature;
 503                         fdet->r2 = fdet->dummy_header.r2; /* use dummy space */
 504                         fdet->mu = fdet->dummy_header.mu; /* use dummy space */
 505                         fdet->firmware_ptr = ff->firmware;
 506                         fdet->firmware_len = fdet->fw->size -
 507                                                 sizeof(struct firmware_file);
 508                         /*
 509                          * Header does not include r2 and mu - generate here.
 510                          * For now, fail.
 511                          */
 512                         dd_dev_err(dd, "driver is unable to validate firmware without r2 and mu (not in firmware file)\n");
 513                         ret = -EINVAL;
 514                 }
 515         } else if ((css->size * 4) + AUGMENT_SIZE == fdet->fw->size) {
 516                 /* augmented firmware file */
 517                 struct augmented_firmware_file *aff =
 518                         (struct augmented_firmware_file *)fdet->fw->data;
 519
 520                 /* make sure there are bytes in the payload */
 521                 ret = payload_check(dd, name, fdet->fw->size,
 522                                     sizeof(struct augmented_firmware_file));
 523                 if (ret == 0) {
 524                         fdet->css_header = css;
 525                         fdet->modulus = aff->modulus;
 526                         fdet->exponent = aff->exponent;
 527                         fdet->signature = aff->signature;
 528                         fdet->r2 = aff->r2;
 529                         fdet->mu = aff->mu;
 530                         fdet->firmware_ptr = aff->firmware;
 531                         fdet->firmware_len = fdet->fw->size -
 532                                         sizeof(struct augmented_firmware_file);
 533                 }
 534         } else {
 535                 /* css->size check failed */
 536                 dd_dev_err(dd,
 537                            "invalid firmware header field size: expected 0x%lx or 0x%lx, actual 0x%x\n",
 538                            fdet->fw->size / 4,
 539                            (fdet->fw->size - AUGMENT_SIZE) / 4,
 540                            css->size);
 541
 542                 ret = -EINVAL;
 543         }
 544
 545 done:
 546         /* if returning an error, clean up after ourselves */
 547         if (ret)
 548                 dispose_one_firmware(fdet);
 549         return ret;
 550 }
 551
 552 static void dispose_one_firmware(struct firmware_details *fdet)
 553 {
 554         release_firmware(fdet->fw);
 555         /* erase all previous information */
 556         memset(fdet, 0, sizeof(*fdet));
 557 }
 558
 559 /*
 560  * Obtain the 4 firmwares from the OS.  All must be obtained at once or not
 561  * at all.  If called with the firmware state in FW_TRY, use alternate names.
 562  * On exit, this routine will have set the firmware state to one of FW_TRY,
 563  * FW_FINAL, or FW_ERR.
 564  *
 565  * Must be holding fw_mutex.
 566  */
 567 static void __obtain_firmware(struct hfi1_devdata *dd)
 568 {
 569         int err = 0;
 570
 571         if (fw_state == FW_FINAL)       /* nothing more to obtain */
 572                 return;
 573         if (fw_state == FW_ERR)         /* already in error */
 574                 return;
 575
 576         /* fw_state is FW_EMPTY or FW_TRY */
 577 retry:
 578         if (fw_state == FW_TRY) {
 579                 /*
 580                  * We tried the original and it failed.  Move to the
 581                  * alternate.
 582                  */
 583                 dd_dev_warn(dd, "using alternate firmware names\n");
 584                 /*
 585                  * Let others run.  Some systems, when missing firmware, does
 586                  * something that holds for 30 seconds.  If we do that twice
 587                  * in a row it triggers task blocked warning.
 588                  */
 589                 cond_resched();
 590                 if (fw_8051_load)
 591                         dispose_one_firmware(&fw_8051);
 592                 if (fw_fabric_serdes_load)
 593                         dispose_one_firmware(&fw_fabric);
 594                 if (fw_sbus_load)
 595                         dispose_one_firmware(&fw_sbus);
 596                 if (fw_pcie_serdes_load)
 597                         dispose_one_firmware(&fw_pcie);
 598                 fw_8051_name = ALT_FW_8051_NAME_ASIC;
 599                 fw_fabric_serdes_name = ALT_FW_FABRIC_NAME;
 600                 fw_sbus_name = ALT_FW_SBUS_NAME;
 601                 fw_pcie_serdes_name = ALT_FW_PCIE_NAME;
 602         }
 603
 604         if (fw_sbus_load) {
 605                 err = obtain_one_firmware(dd, fw_sbus_name, &fw_sbus);
 606                 if (err)
 607                         goto done;
 608         }
 609
 610         if (fw_pcie_serdes_load) {
 611                 err = obtain_one_firmware(dd, fw_pcie_serdes_name, &fw_pcie);
 612                 if (err)
 613                         goto done;
 614         }
 615
 616         if (fw_fabric_serdes_load) {
 617                 err = obtain_one_firmware(dd, fw_fabric_serdes_name,
 618                                           &fw_fabric);
 619                 if (err)
 620                         goto done;
 621         }
 622
 623         if (fw_8051_load) {
 624                 err = obtain_one_firmware(dd, fw_8051_name, &fw_8051);
 625                 if (err)
 626                         goto done;
 627         }
 628
 629 done:
 630         if (err) {
 631                 /* oops, had problems obtaining a firmware */
 632                 if (fw_state == FW_EMPTY && dd->icode == ICODE_RTL_SILICON) {
 633                         /* retry with alternate (RTL only) */
 634                         fw_state = FW_TRY;
 635                         goto retry;
 636                 }
 637                 dd_dev_err(dd, "unable to obtain working firmware\n");
 638                 fw_state = FW_ERR;
 639                 fw_err = -ENOENT;
 640         } else {
 641                 /* success */
 642                 if (fw_state == FW_EMPTY &&
 643                     dd->icode != ICODE_FUNCTIONAL_SIMULATOR)
 644                         fw_state = FW_TRY;      /* may retry later */
 645                 else
 646                         fw_state = FW_FINAL;    /* cannot try again */
 647         }
 648 }
 649
 650 /*
 651  * Called by all HFIs when loading their firmware - i.e. device probe time.
 652  * The first one will do the actual firmware load.  Use a mutex to resolve
 653  * any possible race condition.
 654  *
 655  * The call to this routine cannot be moved to driver load because the kernel
 656  * call request_firmware() requires a device which is only available after
 657  * the first device probe.
 658  */
 659 static int obtain_firmware(struct hfi1_devdata *dd)
 660 {
 661         unsigned long timeout;
 662         int err = 0;
 663
 664         mutex_lock(&fw_mutex);
 665
 666         /* 40s delay due to long delay on missing firmware on some systems */
 667         timeout = jiffies + msecs_to_jiffies(40000);
 668         while (fw_state == FW_TRY) {
 669                 /*
 670                  * Another device is trying the firmware.  Wait until it
 671                  * decides what works (or not).
 672                  */
 673                 if (time_after(jiffies, timeout)) {
 674                         /* waited too long */
 675                         dd_dev_err(dd, "Timeout waiting for firmware try");
 676                         fw_state = FW_ERR;
 677                         fw_err = -ETIMEDOUT;
 678                         break;
 679                 }
 680                 mutex_unlock(&fw_mutex);
 681                 msleep(20);     /* arbitrary delay */
 682                 mutex_lock(&fw_mutex);
 683         }
 684         /* not in FW_TRY state */
 685
 686         if (fw_state == FW_FINAL) {
 687                 if (platform_config) {
 688                         dd->platform_config.data = platform_config->data;
 689                         dd->platform_config.size = platform_config->size;
 690                 }
 691                 goto done;      /* already acquired */
 692         } else if (fw_state == FW_ERR) {
 693                 goto done;      /* already tried and failed */
 694         }
 695         /* fw_state is FW_EMPTY */
 696
 697         /* set fw_state to FW_TRY, FW_FINAL, or FW_ERR, and fw_err */
 698         __obtain_firmware(dd);
 699
 700         if (platform_config_load) {
 701                 platform_config = NULL;
 702                 err = request_firmware(&platform_config, platform_config_name,
 703                                        &dd->pcidev->dev);
 704                 if (err) {
 705                         platform_config = NULL;
 706                         goto done;
 707                 }
 708                 dd->platform_config.data = platform_config->data;
 709                 dd->platform_config.size = platform_config->size;
 710         }
 711
 712 done:
 713         mutex_unlock(&fw_mutex);
 714
 715         return fw_err;
 716 }
 717
 718 /*
 719  * Called when the driver unloads.  The timing is asymmetric with its
 720  * counterpart, obtain_firmware().  If called at device remove time,
 721  * then it is conceivable that another device could probe while the
 722  * firmware is being disposed.  The mutexes can be moved to do that
 723  * safely, but then the firmware would be requested from the OS multiple
 724  * times.
 725  *
 726  * No mutex is needed as the driver is unloading and there cannot be any
 727  * other callers.
 728  */
 729 void dispose_firmware(void)
 730 {
 731         dispose_one_firmware(&fw_8051);
 732         dispose_one_firmware(&fw_fabric);
 733         dispose_one_firmware(&fw_pcie);
 734         dispose_one_firmware(&fw_sbus);
 735
 736         release_firmware(platform_config);
 737         platform_config = NULL;
 738
 739         /* retain the error state, otherwise revert to empty */
 740         if (fw_state != FW_ERR)
 741                 fw_state = FW_EMPTY;
 742 }
 743
 744 /*
 745  * Called with the result of a firmware download.
 746  *
 747  * Return 1 to retry loading the firmware, 0 to stop.
 748  */
 749 static int retry_firmware(struct hfi1_devdata *dd, int load_result)
 750 {
 751         int retry;
 752
 753         mutex_lock(&fw_mutex);
 754
 755         if (load_result == 0) {
 756                 /*
 757                  * The load succeeded, so expect all others to do the same.
 758                  * Do not retry again.
 759                  */
 760                 if (fw_state == FW_TRY)
 761                         fw_state = FW_FINAL;
 762                 retry = 0;      /* do NOT retry */
 763         } else if (fw_state == FW_TRY) {
 764                 /* load failed, obtain alternate firmware */
 765                 __obtain_firmware(dd);
 766                 retry = (fw_state == FW_FINAL);
 767         } else {
 768                 /* else in FW_FINAL or FW_ERR, no retry in either case */
 769                 retry = 0;
 770         }
 771
 772         mutex_unlock(&fw_mutex);
 773         return retry;
 774 }
 775
 776 /*
 777  * Write a block of data to a given array CSR.  All calls will be in
 778  * multiples of 8 bytes.
 779  */
 780 static void write_rsa_data(struct hfi1_devdata *dd, int what,
 781                            const u8 *data, int nbytes)
 782 {
 783         int qw_size = nbytes / 8;
 784         int i;
 785
 786         if (((unsigned long)data & 0x7) == 0) {
 787                 /* aligned */
 788                 u64 *ptr = (u64 *)data;
 789
 790                 for (i = 0; i < qw_size; i++, ptr++)
 791                         write_csr(dd, what + (8 * i), *ptr);
 792         } else {
 793                 /* not aligned */
 794                 for (i = 0; i < qw_size; i++, data += 8) {
 795                         u64 value;
 796
 797                         memcpy(&value, data, 8);
 798                         write_csr(dd, what + (8 * i), value);
 799                 }
 800         }
 801 }
 802
 803 /*
 804  * Write a block of data to a given CSR as a stream of writes.  All calls will
 805  * be in multiples of 8 bytes.
 806  */
 807 static void write_streamed_rsa_data(struct hfi1_devdata *dd, int what,
 808                                     const u8 *data, int nbytes)
 809 {
 810         u64 *ptr = (u64 *)data;
 811         int qw_size = nbytes / 8;
 812
 813         for (; qw_size > 0; qw_size--, ptr++)
 814                 write_csr(dd, what, *ptr);
 815 }
 816
 817 /*
 818  * Download the signature and start the RSA mechanism.  Wait for
 819  * RSA_ENGINE_TIMEOUT before giving up.
 820  */
 821 static int run_rsa(struct hfi1_devdata *dd, const char *who,
 822                    const u8 *signature)
 823 {
 824         unsigned long timeout;
 825         u64 reg;
 826         u32 status;
 827         int ret = 0;
 828
 829         /* write the signature */
 830         write_rsa_data(dd, MISC_CFG_RSA_SIGNATURE, signature, KEY_SIZE);
 831
 832         /* initialize RSA */
 833         write_csr(dd, MISC_CFG_RSA_CMD, RSA_CMD_INIT);
 834
 835         /*
 836          * Make sure the engine is idle and insert a delay between the two
 837          * writes to MISC_CFG_RSA_CMD.
 838          */
 839         status = (read_csr(dd, MISC_CFG_FW_CTRL)
 840                            & MISC_CFG_FW_CTRL_RSA_STATUS_SMASK)
 841                              >> MISC_CFG_FW_CTRL_RSA_STATUS_SHIFT;
 842         if (status != RSA_STATUS_IDLE) {
 843                 dd_dev_err(dd, "%s security engine not idle - giving up\n",
 844                            who);
 845                 return -EBUSY;
 846         }
 847
 848         /* start RSA */
 849         write_csr(dd, MISC_CFG_RSA_CMD, RSA_CMD_START);
 850
 851         /*
 852          * Look for the result.
 853          *
 854          * The RSA engine is hooked up to two MISC errors.  The driver
 855          * masks these errors as they do not respond to the standard
 856          * error "clear down" mechanism.  Look for these errors here and
 857          * clear them when possible.  This routine will exit with the
 858          * errors of the current run still set.
 859          *
 860          * MISC_FW_AUTH_FAILED_ERR
 861          *      Firmware authorization failed.  This can be cleared by
 862          *      re-initializing the RSA engine, then clearing the status bit.
 863          *      Do not re-init the RSA angine immediately after a successful
 864          *      run - this will reset the current authorization.
 865          *
 866          * MISC_KEY_MISMATCH_ERR
 867          *      Key does not match.  The only way to clear this is to load
 868          *      a matching key then clear the status bit.  If this error
 869          *      is raised, it will persist outside of this routine until a
 870          *      matching key is loaded.
 871          */
 872         timeout = msecs_to_jiffies(RSA_ENGINE_TIMEOUT) + jiffies;
 873         while (1) {
 874                 status = (read_csr(dd, MISC_CFG_FW_CTRL)
 875                            & MISC_CFG_FW_CTRL_RSA_STATUS_SMASK)
 876                              >> MISC_CFG_FW_CTRL_RSA_STATUS_SHIFT;
 877
 878                 if (status == RSA_STATUS_IDLE) {
 879                         /* should not happen */
 880                         dd_dev_err(dd, "%s firmware security bad idle state\n",
 881                                    who);
 882                         ret = -EINVAL;
 883                         break;
 884                 } else if (status == RSA_STATUS_DONE) {
 885                         /* finished successfully */
 886                         break;
 887                 } else if (status == RSA_STATUS_FAILED) {
 888                         /* finished unsuccessfully */
 889                         ret = -EINVAL;
 890                         break;
 891                 }
 892                 /* else still active */
 893
 894                 if (time_after(jiffies, timeout)) {
 895                         /*
 896                          * Timed out while active.  We can't reset the engine
 897                          * if it is stuck active, but run through the
 898                          * error code to see what error bits are set.
 899                          */
 900                         dd_dev_err(dd, "%s firmware security time out\n", who);
 901                         ret = -ETIMEDOUT;
 902                         break;
 903                 }
 904
 905                 msleep(20);
 906         }
 907
 908         /*
 909          * Arrive here on success or failure.  Clear all RSA engine
 910          * errors.  All current errors will stick - the RSA logic is keeping
 911          * error high.  All previous errors will clear - the RSA logic
 912          * is not keeping the error high.
 913          */
 914         write_csr(dd, MISC_ERR_CLEAR,
 915                   MISC_ERR_STATUS_MISC_FW_AUTH_FAILED_ERR_SMASK |
 916                   MISC_ERR_STATUS_MISC_KEY_MISMATCH_ERR_SMASK);
 917         /*
 918          * All that is left are the current errors.  Print warnings on
 919          * authorization failure details, if any.  Firmware authorization
 920          * can be retried, so these are only warnings.
 921          */
 922         reg = read_csr(dd, MISC_ERR_STATUS);
 923         if (ret) {
 924                 if (reg & MISC_ERR_STATUS_MISC_FW_AUTH_FAILED_ERR_SMASK)
 925                         dd_dev_warn(dd, "%s firmware authorization failed\n",
 926                                     who);
 927                 if (reg & MISC_ERR_STATUS_MISC_KEY_MISMATCH_ERR_SMASK)
 928                         dd_dev_warn(dd, "%s firmware key mismatch\n", who);
 929         }
 930
 931         return ret;
 932 }
 933
 934 static void load_security_variables(struct hfi1_devdata *dd,
 935                                     struct firmware_details *fdet)
 936 {
 937         /* Security variables a.  Write the modulus */
 938         write_rsa_data(dd, MISC_CFG_RSA_MODULUS, fdet->modulus, KEY_SIZE);
 939         /* Security variables b.  Write the r2 */
 940         write_rsa_data(dd, MISC_CFG_RSA_R2, fdet->r2, KEY_SIZE);
 941         /* Security variables c.  Write the mu */
 942         write_rsa_data(dd, MISC_CFG_RSA_MU, fdet->mu, MU_SIZE);
 943         /* Security variables d.  Write the header */
 944         write_streamed_rsa_data(dd, MISC_CFG_SHA_PRELOAD,
 945                                 (u8 *)fdet->css_header,
 946                                 sizeof(struct css_header));
 947 }
 948
 949 /* return the 8051 firmware state */
 950 static inline u32 get_firmware_state(struct hfi1_devdata *dd)
 951 {
 952         u64 reg = read_csr(dd, DC_DC8051_STS_CUR_STATE);
 953
 954         return (reg >> DC_DC8051_STS_CUR_STATE_FIRMWARE_SHIFT)
 955                                 & DC_DC8051_STS_CUR_STATE_FIRMWARE_MASK;
 956 }
 957
 958 /*
 959  * Wait until the firmware is up and ready to take host requests.
 960  * Return 0 on success, -ETIMEDOUT on timeout.
 961  */
 962 int wait_fm_ready(struct hfi1_devdata *dd, u32 mstimeout)
 963 {
 964         unsigned long timeout;
 965
 966         /* in the simulator, the fake 8051 is always ready */
 967         if (dd->icode == ICODE_FUNCTIONAL_SIMULATOR)
 968                 return 0;
 969
 970         timeout = msecs_to_jiffies(mstimeout) + jiffies;
 971         while (1) {
 972                 if (get_firmware_state(dd) == 0xa0)     /* ready */
 973                         return 0;
 974                 if (time_after(jiffies, timeout))       /* timed out */
 975                         return -ETIMEDOUT;
 976                 usleep_range(1950, 2050); /* sleep 2ms-ish */
 977         }
 978 }
 979
 980 /*
 981  * Load the 8051 firmware.
 982  */
 983 static int load_8051_firmware(struct hfi1_devdata *dd,
 984                               struct firmware_details *fdet)
 985 {
 986         u64 reg;
 987         int ret;
 988         u8 ver_a, ver_b;
 989
 990         /*
 991          * DC Reset sequence
 992          * Load DC 8051 firmware
 993          */
 994         /*
 995          * DC reset step 1: Reset DC8051
 996          */
 997         reg = DC_DC8051_CFG_RST_M8051W_SMASK
 998                 | DC_DC8051_CFG_RST_CRAM_SMASK
 999                 | DC_DC8051_CFG_RST_DRAM_SMASK
1000                 | DC_DC8051_CFG_RST_IRAM_SMASK
1001                 | DC_DC8051_CFG_RST_SFR_SMASK;
1002         write_csr(dd, DC_DC8051_CFG_RST, reg);
1003
1004         /*
1005          * DC reset step 2 (optional): Load 8051 data memory with link
1006          * configuration
1007          */
1008
1009         /*
1010          * DC reset step 3: Load DC8051 firmware
1011          */
1012         /* release all but the core reset */
1013         reg = DC_DC8051_CFG_RST_M8051W_SMASK;
1014         write_csr(dd, DC_DC8051_CFG_RST, reg);
1015
1016         /* Firmware load step 1 */
1017         load_security_variables(dd, fdet);
1018
1019         /*
1020          * Firmware load step 2.  Clear MISC_CFG_FW_CTRL.FW_8051_LOADED
1021          */
1022         write_csr(dd, MISC_CFG_FW_CTRL, 0);
1023
1024         /* Firmware load steps 3-5 */
1025         ret = write_8051(dd, 1/*code*/, 0, fdet->firmware_ptr,
1026                          fdet->firmware_len);
1027         if (ret)
1028                 return ret;
1029
1030         /*
1031          * DC reset step 4. Host starts the DC8051 firmware
1032          */
1033         /*
1034          * Firmware load step 6.  Set MISC_CFG_FW_CTRL.FW_8051_LOADED
1035          */
1036         write_csr(dd, MISC_CFG_FW_CTRL, MISC_CFG_FW_CTRL_FW_8051_LOADED_SMASK);
1037
1038         /* Firmware load steps 7-10 */
1039         ret = run_rsa(dd, "8051", fdet->signature);
1040         if (ret)
1041                 return ret;
1042
1043         /* clear all reset bits, releasing the 8051 */
1044         write_csr(dd, DC_DC8051_CFG_RST, 0ull);
1045
1046         /*
1047          * DC reset step 5. Wait for firmware to be ready to accept host
1048          * requests.
1049          */
1050         ret = wait_fm_ready(dd, TIMEOUT_8051_START);
1051         if (ret) { /* timed out */
1052                 dd_dev_err(dd, "8051 start timeout, current state 0x%x\n",
1053                            get_firmware_state(dd));
1054                 return -ETIMEDOUT;
1055         }
1056
1057         read_misc_status(dd, &ver_a, &ver_b);
1058         dd_dev_info(dd, "8051 firmware version %d.%d\n",
1059                     (int)ver_b, (int)ver_a);
1060         dd->dc8051_ver = dc8051_ver(ver_b, ver_a);
1061
1062         return 0;
1063 }
1064
1065 /*
1066  * Write the SBus request register
1067  *
1068  * No need for masking - the arguments are sized exactly.
1069  */
1070 void sbus_request(struct hfi1_devdata *dd,
1071                   u8 receiver_addr, u8 data_addr, u8 command, u32 data_in)
1072 {
1073         write_csr(dd, ASIC_CFG_SBUS_REQUEST,
1074                   ((u64)data_in << ASIC_CFG_SBUS_REQUEST_DATA_IN_SHIFT) |
1075                   ((u64)command << ASIC_CFG_SBUS_REQUEST_COMMAND_SHIFT) |
1076                   ((u64)data_addr << ASIC_CFG_SBUS_REQUEST_DATA_ADDR_SHIFT) |
1077                   ((u64)receiver_addr <<
1078                    ASIC_CFG_SBUS_REQUEST_RECEIVER_ADDR_SHIFT));
1079 }
1080
1081 /*
1082  * Turn off the SBus and fabric serdes spicos.
1083  *
1084  * + Must be called with Sbus fast mode turned on.
1085  * + Must be called after fabric serdes broadcast is set up.
1086  * + Must be called before the 8051 is loaded - assumes 8051 is not loaded
1087  *   when using MISC_CFG_FW_CTRL.
1088  */
1089 static void turn_off_spicos(struct hfi1_devdata *dd, int flags)
1090 {
1091         /* only needed on A0 */
1092         if (!is_ax(dd))
1093                 return;
1094
1095         dd_dev_info(dd, "Turning off spicos:%s%s\n",
1096                     flags & SPICO_SBUS ? " SBus" : "",
1097                     flags & SPICO_FABRIC ? " fabric" : "");
1098
1099         write_csr(dd, MISC_CFG_FW_CTRL, ENABLE_SPICO_SMASK);
1100         /* disable SBus spico */
1101         if (flags & SPICO_SBUS)
1102                 sbus_request(dd, SBUS_MASTER_BROADCAST, 0x01,
1103                              WRITE_SBUS_RECEIVER, 0x00000040);
1104
1105         /* disable the fabric serdes spicos */
1106         if (flags & SPICO_FABRIC)
1107                 sbus_request(dd, fabric_serdes_broadcast[dd->hfi1_id],
1108                              0x07, WRITE_SBUS_RECEIVER, 0x00000000);
1109         write_csr(dd, MISC_CFG_FW_CTRL, 0);
1110 }
1111
1112 /*
1113  * Reset all of the fabric serdes for this HFI in preparation to take the
1114  * link to Polling.
1115  *
1116  * To do a reset, we need to write to to the serdes registers.  Unfortunately,
1117  * the fabric serdes download to the other HFI on the ASIC will have turned
1118  * off the firmware validation on this HFI.  This means we can't write to the
1119  * registers to reset the serdes.  Work around this by performing a complete
1120  * re-download and validation of the fabric serdes firmware.  This, as a
1121  * by-product, will reset the serdes.  NOTE: the re-download requires that
1122  * the 8051 be in the Offline state.  I.e. not actively trying to use the
1123  * serdes.  This routine is called at the point where the link is Offline and
1124  * is getting ready to go to Polling.
1125  */
1126 void fabric_serdes_reset(struct hfi1_devdata *dd)
1127 {
1128         if (!fw_fabric_serdes_load)
1129                 return;
1130
1131         if (is_ax(dd)) {
1132                 /* A0 serdes do not work with a re-download */
1133                 u8 ra = fabric_serdes_broadcast[dd->hfi1_id];
1134
1135                 acquire_hw_mutex(dd);
1136                 set_sbus_fast_mode(dd);
1137                 /* place SerDes in reset and disable SPICO */
1138                 sbus_request(dd, ra, 0x07, WRITE_SBUS_RECEIVER, 0x00000011);
1139                 /* wait 100 refclk cycles @ 156.25MHz => 640ns */
1140                 udelay(1);
1141                 /* remove SerDes reset */
1142                 sbus_request(dd, ra, 0x07, WRITE_SBUS_RECEIVER, 0x00000010);
1143                 /* turn SPICO enable on */
1144                 sbus_request(dd, ra, 0x07, WRITE_SBUS_RECEIVER, 0x00000002);
1145                 clear_sbus_fast_mode(dd);
1146                 release_hw_mutex(dd);
1147                 return;
1148         }
1149
1150         acquire_hw_mutex(dd);
1151         set_sbus_fast_mode(dd);
1152
1153         turn_off_spicos(dd, SPICO_FABRIC);
1154         /*
1155          * No need for firmware retry - what to download has already been
1156          * decided.
1157          * No need to pay attention to the load return - the only failure
1158          * is a validation failure, which has already been checked by the
1159          * initial download.
1160          */
1161         (void)load_fabric_serdes_firmware(dd, &fw_fabric);
1162
1163         clear_sbus_fast_mode(dd);
1164         release_hw_mutex(dd);
1165 }
1166
1167 /* Access to the SBus in this routine should probably be serialized */
1168 int sbus_request_slow(struct hfi1_devdata *dd,
1169                       u8 receiver_addr, u8 data_addr, u8 command, u32 data_in)
1170 {
1171         u64 reg, count = 0;
1172
1173         sbus_request(dd, receiver_addr, data_addr, command, data_in);
1174         write_csr(dd, ASIC_CFG_SBUS_EXECUTE,
1175                   ASIC_CFG_SBUS_EXECUTE_EXECUTE_SMASK);
1176         /* Wait for both DONE and RCV_DATA_VALID to go high */
1177         reg = read_csr(dd, ASIC_STS_SBUS_RESULT);
1178         while (!((reg & ASIC_STS_SBUS_RESULT_DONE_SMASK) &&
1179                  (reg & ASIC_STS_SBUS_RESULT_RCV_DATA_VALID_SMASK))) {
1180                 if (count++ >= SBUS_MAX_POLL_COUNT) {
1181                         u64 counts = read_csr(dd, ASIC_STS_SBUS_COUNTERS);
1182                         /*
1183                          * If the loop has timed out, we are OK if DONE bit
1184                          * is set and RCV_DATA_VALID and EXECUTE counters
1185                          * are the same. If not, we cannot proceed.
1186                          */
1187                         if ((reg & ASIC_STS_SBUS_RESULT_DONE_SMASK) &&
1188                             (SBUS_COUNTER(counts, RCV_DATA_VALID) ==
1189                              SBUS_COUNTER(counts, EXECUTE)))
1190                                 break;
1191                         return -ETIMEDOUT;
1192                 }
1193                 udelay(1);
1194                 reg = read_csr(dd, ASIC_STS_SBUS_RESULT);
1195         }
1196         count = 0;
1197         write_csr(dd, ASIC_CFG_SBUS_EXECUTE, 0);
1198         /* Wait for DONE to clear after EXECUTE is cleared */
1199         reg = read_csr(dd, ASIC_STS_SBUS_RESULT);
1200         while (reg & ASIC_STS_SBUS_RESULT_DONE_SMASK) {
1201                 if (count++ >= SBUS_MAX_POLL_COUNT)
1202                         return -ETIME;
1203                 udelay(1);
1204                 reg = read_csr(dd, ASIC_STS_SBUS_RESULT);
1205         }
1206         return 0;
1207 }
1208
1209 static int load_fabric_serdes_firmware(struct hfi1_devdata *dd,
1210                                        struct firmware_details *fdet)
1211 {
1212         int i, err;
1213         const u8 ra = fabric_serdes_broadcast[dd->hfi1_id]; /* receiver addr */
1214
1215         dd_dev_info(dd, "Downloading fabric firmware\n");
1216
1217         /* step 1: load security variables */
1218         load_security_variables(dd, fdet);
1219         /* step 2: place SerDes in reset and disable SPICO */
1220         sbus_request(dd, ra, 0x07, WRITE_SBUS_RECEIVER, 0x00000011);
1221         /* wait 100 refclk cycles @ 156.25MHz => 640ns */
1222         udelay(1);
1223         /* step 3:  remove SerDes reset */
1224         sbus_request(dd, ra, 0x07, WRITE_SBUS_RECEIVER, 0x00000010);
1225         /* step 4: assert IMEM override */
1226         sbus_request(dd, ra, 0x00, WRITE_SBUS_RECEIVER, 0x40000000);
1227         /* step 5: download SerDes machine code */
1228         for (i = 0; i < fdet->firmware_len; i += 4) {
1229                 sbus_request(dd, ra, 0x0a, WRITE_SBUS_RECEIVER,
1230                              *(u32 *)&fdet->firmware_ptr[i]);
1231         }
1232         /* step 6: IMEM override off */
1233         sbus_request(dd, ra, 0x00, WRITE_SBUS_RECEIVER, 0x00000000);
1234         /* step 7: turn ECC on */
1235         sbus_request(dd, ra, 0x0b, WRITE_SBUS_RECEIVER, 0x000c0000);
1236
1237         /* steps 8-11: run the RSA engine */
1238         err = run_rsa(dd, "fabric serdes", fdet->signature);
1239         if (err)
1240                 return err;
1241
1242         /* step 12: turn SPICO enable on */
1243         sbus_request(dd, ra, 0x07, WRITE_SBUS_RECEIVER, 0x00000002);
1244         /* step 13: enable core hardware interrupts */
1245         sbus_request(dd, ra, 0x08, WRITE_SBUS_RECEIVER, 0x00000000);
1246
1247         return 0;
1248 }
1249
1250 static int load_sbus_firmware(struct hfi1_devdata *dd,
1251                               struct firmware_details *fdet)
1252 {
1253         int i, err;
1254         const u8 ra = SBUS_MASTER_BROADCAST; /* receiver address */
1255
1256         dd_dev_info(dd, "Downloading SBus firmware\n");
1257
1258         /* step 1: load security variables */
1259         load_security_variables(dd, fdet);
1260         /* step 2: place SPICO into reset and enable off */
1261         sbus_request(dd, ra, 0x01, WRITE_SBUS_RECEIVER, 0x000000c0);
1262         /* step 3: remove reset, enable off, IMEM_CNTRL_EN on */
1263         sbus_request(dd, ra, 0x01, WRITE_SBUS_RECEIVER, 0x00000240);
1264         /* step 4: set starting IMEM address for burst download */
1265         sbus_request(dd, ra, 0x03, WRITE_SBUS_RECEIVER, 0x80000000);
1266         /* step 5: download the SBus Master machine code */
1267         for (i = 0; i < fdet->firmware_len; i += 4) {
1268                 sbus_request(dd, ra, 0x14, WRITE_SBUS_RECEIVER,
1269                              *(u32 *)&fdet->firmware_ptr[i]);
1270         }
1271         /* step 6: set IMEM_CNTL_EN off */
1272         sbus_request(dd, ra, 0x01, WRITE_SBUS_RECEIVER, 0x00000040);
1273         /* step 7: turn ECC on */
1274         sbus_request(dd, ra, 0x16, WRITE_SBUS_RECEIVER, 0x000c0000);
1275
1276         /* steps 8-11: run the RSA engine */
1277         err = run_rsa(dd, "SBus", fdet->signature);
1278         if (err)
1279                 return err;
1280
1281         /* step 12: set SPICO_ENABLE on */
1282         sbus_request(dd, ra, 0x01, WRITE_SBUS_RECEIVER, 0x00000140);
1283
1284         return 0;
1285 }
1286
1287 static int load_pcie_serdes_firmware(struct hfi1_devdata *dd,
1288                                      struct firmware_details *fdet)
1289 {
1290         int i;
1291         const u8 ra = SBUS_MASTER_BROADCAST; /* receiver address */
1292
1293         dd_dev_info(dd, "Downloading PCIe firmware\n");
1294
1295         /* step 1: load security variables */
1296         load_security_variables(dd, fdet);
1297         /* step 2: assert single step (halts the SBus Master spico) */
1298         sbus_request(dd, ra, 0x05, WRITE_SBUS_RECEIVER, 0x00000001);
1299         /* step 3: enable XDMEM access */
1300         sbus_request(dd, ra, 0x01, WRITE_SBUS_RECEIVER, 0x00000d40);
1301         /* step 4: load firmware into SBus Master XDMEM */
1302         /*
1303          * NOTE: the dmem address, write_en, and wdata are all pre-packed,
1304          * we only need to pick up the bytes and write them
1305          */
1306         for (i = 0; i < fdet->firmware_len; i += 4) {
1307                 sbus_request(dd, ra, 0x04, WRITE_SBUS_RECEIVER,
1308                              *(u32 *)&fdet->firmware_ptr[i]);
1309         }
1310         /* step 5: disable XDMEM access */
1311         sbus_request(dd, ra, 0x01, WRITE_SBUS_RECEIVER, 0x00000140);
1312         /* step 6: allow SBus Spico to run */
1313         sbus_request(dd, ra, 0x05, WRITE_SBUS_RECEIVER, 0x00000000);
1314
1315         /*
1316          * steps 7-11: run RSA, if it succeeds, firmware is available to
1317          * be swapped
1318          */
1319         return run_rsa(dd, "PCIe serdes", fdet->signature);
1320 }
1321
1322 /*
1323  * Set the given broadcast values on the given list of devices.
1324  */
1325 static void set_serdes_broadcast(struct hfi1_devdata *dd, u8 bg1, u8 bg2,
1326                                  const u8 *addrs, int count)
1327 {
1328         while (--count >= 0) {
1329                 /*
1330                  * Set BROADCAST_GROUP_1 and BROADCAST_GROUP_2, leave
1331                  * defaults for everything else.  Do not read-modify-write,
1332                  * per instruction from the manufacturer.
1333                  *
1334                  * Register 0xfd:
1335                  *      bits    what
1336                  *      -----   ---------------------------------
1337                  *        0     IGNORE_BROADCAST  (default 0)
1338                  *      11:4    BROADCAST_GROUP_1 (default 0xff)
1339                  *      23:16   BROADCAST_GROUP_2 (default 0xff)
1340                  */
1341                 sbus_request(dd, addrs[count], 0xfd, WRITE_SBUS_RECEIVER,
1342                              (u32)bg1 << 4 | (u32)bg2 << 16);
1343         }
1344 }
1345
1346 int acquire_hw_mutex(struct hfi1_devdata *dd)
1347 {
1348         unsigned long timeout;
1349         int try = 0;
1350         u8 mask = 1 << dd->hfi1_id;
1351         u8 user;
1352
1353 retry:
1354         timeout = msecs_to_jiffies(HM_TIMEOUT) + jiffies;
1355         while (1) {
1356                 write_csr(dd, ASIC_CFG_MUTEX, mask);
1357                 user = (u8)read_csr(dd, ASIC_CFG_MUTEX);
1358                 if (user == mask)
1359                         return 0; /* success */
1360                 if (time_after(jiffies, timeout))
1361                         break; /* timed out */
1362                 msleep(20);
1363         }
1364
1365         /* timed out */
1366         dd_dev_err(dd,
1367                    "Unable to acquire hardware mutex, mutex mask %u, my mask %u (%s)\n",
1368                    (u32)user, (u32)mask, (try == 0) ? "retrying" : "giving up");
1369
1370         if (try == 0) {
1371                 /* break mutex and retry */
1372                 write_csr(dd, ASIC_CFG_MUTEX, 0);
1373                 try++;
1374                 goto retry;
1375         }
1376
1377         return -EBUSY;
1378 }
1379
1380 void release_hw_mutex(struct hfi1_devdata *dd)
1381 {
1382         write_csr(dd, ASIC_CFG_MUTEX, 0);
1383 }
1384
1385 void set_sbus_fast_mode(struct hfi1_devdata *dd)
1386 {
1387         write_csr(dd, ASIC_CFG_SBUS_EXECUTE,
1388                   ASIC_CFG_SBUS_EXECUTE_FAST_MODE_SMASK);
1389 }
1390
1391 void clear_sbus_fast_mode(struct hfi1_devdata *dd)
1392 {
1393         u64 reg, count = 0;
1394
1395         reg = read_csr(dd, ASIC_STS_SBUS_COUNTERS);
1396         while (SBUS_COUNTER(reg, EXECUTE) !=
1397                SBUS_COUNTER(reg, RCV_DATA_VALID)) {
1398                 if (count++ >= SBUS_MAX_POLL_COUNT)
1399                         break;
1400                 udelay(1);
1401                 reg = read_csr(dd, ASIC_STS_SBUS_COUNTERS);
1402         }
1403         write_csr(dd, ASIC_CFG_SBUS_EXECUTE, 0);
1404 }
1405
1406 int load_firmware(struct hfi1_devdata *dd)
1407 {
1408         int ret;
1409
1410         if (fw_fabric_serdes_load) {
1411                 ret = acquire_hw_mutex(dd);
1412                 if (ret)
1413                         return ret;
1414
1415                 set_sbus_fast_mode(dd);
1416
1417                 set_serdes_broadcast(dd, all_fabric_serdes_broadcast,
1418                                      fabric_serdes_broadcast[dd->hfi1_id],
1419                                      fabric_serdes_addrs[dd->hfi1_id],
1420                                      NUM_FABRIC_SERDES);
1421                 turn_off_spicos(dd, SPICO_FABRIC);
1422                 do {
1423                         ret = load_fabric_serdes_firmware(dd, &fw_fabric);
1424                 } while (retry_firmware(dd, ret));
1425
1426                 clear_sbus_fast_mode(dd);
1427                 release_hw_mutex(dd);
1428                 if (ret)
1429                         return ret;
1430         }
1431
1432         if (fw_8051_load) {
1433                 do {
1434                         ret = load_8051_firmware(dd, &fw_8051);
1435                 } while (retry_firmware(dd, ret));
1436                 if (ret)
1437                         return ret;
1438         }
1439
1440         return 0;
1441 }
1442
1443 int hfi1_firmware_init(struct hfi1_devdata *dd)
1444 {
1445         /* only RTL can use these */
1446         if (dd->icode != ICODE_RTL_SILICON) {
1447                 fw_fabric_serdes_load = 0;
1448                 fw_pcie_serdes_load = 0;
1449                 fw_sbus_load = 0;
1450         }
1451
1452         /* no 8051 or QSFP on simulator */
1453         if (dd->icode == ICODE_FUNCTIONAL_SIMULATOR) {
1454                 fw_8051_load = 0;
1455                 platform_config_load = 0;
1456         }
1457
1458         if (!fw_8051_name) {
1459                 if (dd->icode == ICODE_RTL_SILICON)
1460                         fw_8051_name = DEFAULT_FW_8051_NAME_ASIC;
1461                 else
1462                         fw_8051_name = DEFAULT_FW_8051_NAME_FPGA;
1463         }
1464         if (!fw_fabric_serdes_name)
1465                 fw_fabric_serdes_name = DEFAULT_FW_FABRIC_NAME;
1466         if (!fw_sbus_name)
1467                 fw_sbus_name = DEFAULT_FW_SBUS_NAME;
1468         if (!fw_pcie_serdes_name)
1469                 fw_pcie_serdes_name = DEFAULT_FW_PCIE_NAME;
1470         if (!platform_config_name)
1471                 platform_config_name = DEFAULT_PLATFORM_CONFIG_NAME;
1472
1473         return obtain_firmware(dd);
1474 }
1475
1476 /*
1477  * This function is a helper function for parse_platform_config(...) and
1478  * does not check for validity of the platform configuration cache
1479  * (because we know it is invalid as we are building up the cache).
1480  * As such, this should not be called from anywhere other than
1481  * parse_platform_config
1482  */
1483 static int check_meta_version(struct hfi1_devdata *dd, u32 *system_table)
1484 {
1485         u32 meta_ver, meta_ver_meta, ver_start, ver_len, mask;
1486         struct platform_config_cache *pcfgcache = &dd->pcfg_cache;
1487
1488         if (!system_table)
1489                 return -EINVAL;
1490
1491         meta_ver_meta =
1492         *(pcfgcache->config_tables[PLATFORM_CONFIG_SYSTEM_TABLE].table_metadata
1493         + SYSTEM_TABLE_META_VERSION);
1494
1495         mask = ((1 << METADATA_TABLE_FIELD_START_LEN_BITS) - 1);
1496         ver_start = meta_ver_meta & mask;
1497
1498         meta_ver_meta >>= METADATA_TABLE_FIELD_LEN_SHIFT;
1499
1500         mask = ((1 << METADATA_TABLE_FIELD_LEN_LEN_BITS) - 1);
1501         ver_len = meta_ver_meta & mask;
1502
1503         ver_start /= 8;
1504         meta_ver = *((u8 *)system_table + ver_start) & ((1 << ver_len) - 1);
1505
1506         if (meta_ver < 5) {
1507                 dd_dev_info(
1508                         dd, "%s:Please update platform config\n", __func__);
1509                 return -EINVAL;
1510         }
1511         return 0;
1512 }
1513
1514 int parse_platform_config(struct hfi1_devdata *dd)
1515 {
1516         struct platform_config_cache *pcfgcache = &dd->pcfg_cache;
1517         u32 *ptr = NULL;
1518         u32 header1 = 0, header2 = 0, magic_num = 0, crc = 0, file_length = 0;
1519         u32 record_idx = 0, table_type = 0, table_length_dwords = 0;
1520         int ret = -EINVAL; /* assume failure */
1521
1522         if (!dd->platform_config.data) {
1523                 dd_dev_info(dd, "%s: Missing config file\n", __func__);
1524                 goto bail;
1525         }
1526         ptr = (u32 *)dd->platform_config.data;
1527
1528         magic_num = *ptr;
1529         ptr++;
1530         if (magic_num != PLATFORM_CONFIG_MAGIC_NUM) {
1531                 dd_dev_info(dd, "%s: Bad config file\n", __func__);
1532                 goto bail;
1533         }
1534
1535         /* Field is file size in DWORDs */
1536         file_length = (*ptr) * 4;
1537         ptr++;
1538
1539         if (file_length > dd->platform_config.size) {
1540                 dd_dev_info(dd, "%s:File claims to be larger than read size\n",
1541                             __func__);
1542                 goto bail;
1543         } else if (file_length < dd->platform_config.size) {
1544                 dd_dev_info(dd,
1545                             "%s:File claims to be smaller than read size, continuing\n",
1546                             __func__);
1547         }
1548         /* exactly equal, perfection */
1549
1550         /*
1551          * In both cases where we proceed, using the self-reported file length
1552          * is the safer option
1553          */
1554         while (ptr < (u32 *)(dd->platform_config.data + file_length)) {
1555                 header1 = *ptr;
1556                 header2 = *(ptr + 1);
1557                 if (header1 != ~header2) {
1558                         dd_dev_info(dd, "%s: Failed validation at offset %ld\n",
1559                                     __func__, (ptr - (u32 *)
1560                                                dd->platform_config.data));
1561                         goto bail;
1562                 }
1563
1564                 record_idx = *ptr &
1565                         ((1 << PLATFORM_CONFIG_HEADER_RECORD_IDX_LEN_BITS) - 1);
1566
1567                 table_length_dwords = (*ptr >>
1568                                 PLATFORM_CONFIG_HEADER_TABLE_LENGTH_SHIFT) &
1569                       ((1 << PLATFORM_CONFIG_HEADER_TABLE_LENGTH_LEN_BITS) - 1);
1570
1571                 table_type = (*ptr >> PLATFORM_CONFIG_HEADER_TABLE_TYPE_SHIFT) &
1572                         ((1 << PLATFORM_CONFIG_HEADER_TABLE_TYPE_LEN_BITS) - 1);
1573
1574                 /* Done with this set of headers */
1575                 ptr += 2;
1576
1577                 if (record_idx) {
1578                         /* data table */
1579                         switch (table_type) {
1580                         case PLATFORM_CONFIG_SYSTEM_TABLE:
1581                                 pcfgcache->config_tables[table_type].num_table =
1582                                                                         1;
1583                                 ret = check_meta_version(dd, ptr);
1584                                 if (ret)
1585                                         goto bail;
1586                                 break;
1587                         case PLATFORM_CONFIG_PORT_TABLE:
1588                                 pcfgcache->config_tables[table_type].num_table =
1589                                                                         2;
1590                                 break;
1591                         case PLATFORM_CONFIG_RX_PRESET_TABLE:
1592                                 /* fall through */
1593                         case PLATFORM_CONFIG_TX_PRESET_TABLE:
1594                                 /* fall through */
1595                         case PLATFORM_CONFIG_QSFP_ATTEN_TABLE:
1596                                 /* fall through */
1597                         case PLATFORM_CONFIG_VARIABLE_SETTINGS_TABLE:
1598                                 pcfgcache->config_tables[table_type].num_table =
1599                                                         table_length_dwords;
1600                                 break;
1601                         default:
1602                                 dd_dev_info(dd,
1603                                             "%s: Unknown data table %d, offset %ld\n",
1604                                             __func__, table_type,
1605                                             (ptr - (u32 *)
1606                                              dd->platform_config.data));
1607                                 goto bail; /* We don't trust this file now */
1608                         }
1609                         pcfgcache->config_tables[table_type].table = ptr;
1610                 } else {
1611                         /* metadata table */
1612                         switch (table_type) {
1613                         case PLATFORM_CONFIG_SYSTEM_TABLE:
1614                                 /* fall through */
1615                         case PLATFORM_CONFIG_PORT_TABLE:
1616                                 /* fall through */
1617                         case PLATFORM_CONFIG_RX_PRESET_TABLE:
1618                                 /* fall through */
1619                         case PLATFORM_CONFIG_TX_PRESET_TABLE:
1620                                 /* fall through */
1621                         case PLATFORM_CONFIG_QSFP_ATTEN_TABLE:
1622                                 /* fall through */
1623                         case PLATFORM_CONFIG_VARIABLE_SETTINGS_TABLE:
1624                                 break;
1625                         default:
1626                                 dd_dev_info(dd,
1627                                             "%s: Unknown meta table %d, offset %ld\n",
1628                                             __func__, table_type,
1629                                             (ptr -
1630                                              (u32 *)dd->platform_config.data));
1631                                 goto bail; /* We don't trust this file now */
1632                         }
1633                         pcfgcache->config_tables[table_type].table_metadata =
1634                                                                         ptr;
1635                 }
1636
1637                 /* Calculate and check table crc */
1638                 crc = crc32_le(~(u32)0, (unsigned char const *)ptr,
1639                                (table_length_dwords * 4));
1640                 crc ^= ~(u32)0;
1641
1642                 /* Jump the table */
1643                 ptr += table_length_dwords;
1644                 if (crc != *ptr) {
1645                         dd_dev_info(dd, "%s: Failed CRC check at offset %ld\n",
1646                                     __func__, (ptr -
1647                                                (u32 *)
1648                                                dd->platform_config.data));
1649                         goto bail;
1650                 }
1651                 /* Jump the CRC DWORD */
1652                 ptr++;
1653         }
1654
1655         pcfgcache->cache_valid = 1;
1656         return 0;
1657 bail:
1658         memset(pcfgcache, 0, sizeof(struct platform_config_cache));
1659         return ret;
1660 }
1661
1662 static int get_platform_fw_field_metadata(struct hfi1_devdata *dd, int table,
1663                                           int field, u32 *field_len_bits,
1664                                           u32 *field_start_bits)
1665 {
1666         struct platform_config_cache *pcfgcache = &dd->pcfg_cache;
1667         u32 *src_ptr = NULL;
1668
1669         if (!pcfgcache->cache_valid)
1670                 return -EINVAL;
1671
1672         switch (table) {
1673         case PLATFORM_CONFIG_SYSTEM_TABLE:
1674                 /* fall through */
1675         case PLATFORM_CONFIG_PORT_TABLE:
1676                 /* fall through */
1677         case PLATFORM_CONFIG_RX_PRESET_TABLE:
1678                 /* fall through */
1679         case PLATFORM_CONFIG_TX_PRESET_TABLE:
1680                 /* fall through */
1681         case PLATFORM_CONFIG_QSFP_ATTEN_TABLE:
1682                 /* fall through */
1683         case PLATFORM_CONFIG_VARIABLE_SETTINGS_TABLE:
1684                 if (field && field < platform_config_table_limits[table])
1685                         src_ptr =
1686                         pcfgcache->config_tables[table].table_metadata + field;
1687                 break;
1688         default:
1689                 dd_dev_info(dd, "%s: Unknown table\n", __func__);
1690                 break;
1691         }
1692
1693         if (!src_ptr)
1694                 return -EINVAL;
1695
1696         if (field_start_bits)
1697                 *field_start_bits = *src_ptr &
1698                       ((1 << METADATA_TABLE_FIELD_START_LEN_BITS) - 1);
1699
1700         if (field_len_bits)
1701                 *field_len_bits = (*src_ptr >> METADATA_TABLE_FIELD_LEN_SHIFT)
1702                        & ((1 << METADATA_TABLE_FIELD_LEN_LEN_BITS) - 1);
1703
1704         return 0;
1705 }
1706
1707 /* This is the central interface to getting data out of the platform config
1708  * file. It depends on parse_platform_config() having populated the
1709  * platform_config_cache in hfi1_devdata, and checks the cache_valid member to
1710  * validate the sanity of the cache.
1711  *
1712  * The non-obvious parameters:
1713  * @table_index: Acts as a look up key into which instance of the tables the
1714  * relevant field is fetched from.
1715  *
1716  * This applies to the data tables that have multiple instances. The port table
1717  * is an exception to this rule as each HFI only has one port and thus the
1718  * relevant table can be distinguished by hfi_id.
1719  *
1720  * @data: pointer to memory that will be populated with the field requested.
1721  * @len: length of memory pointed by @data in bytes.
1722  */
1723 int get_platform_config_field(struct hfi1_devdata *dd,
1724                               enum platform_config_table_type_encoding
1725                               table_type, int table_index, int field_index,
1726                               u32 *data, u32 len)
1727 {
1728         int ret = 0, wlen = 0, seek = 0;
1729         u32 field_len_bits = 0, field_start_bits = 0, *src_ptr = NULL;
1730         struct platform_config_cache *pcfgcache = &dd->pcfg_cache;
1731
1732         if (data)
1733                 memset(data, 0, len);
1734         else
1735                 return -EINVAL;
1736
1737         ret = get_platform_fw_field_metadata(dd, table_type, field_index,
1738                                              &field_len_bits,
1739                                              &field_start_bits);
1740         if (ret)
1741                 return -EINVAL;
1742
1743         /* Convert length to bits */
1744         len *= 8;
1745
1746         /* Our metadata function checked cache_valid and field_index for us */
1747         switch (table_type) {
1748         case PLATFORM_CONFIG_SYSTEM_TABLE:
1749                 src_ptr = pcfgcache->config_tables[table_type].table;
1750
1751                 if (field_index != SYSTEM_TABLE_QSFP_POWER_CLASS_MAX) {
1752                         if (len < field_len_bits)
1753                                 return -EINVAL;
1754
1755                         seek = field_start_bits / 8;
1756                         wlen = field_len_bits / 8;
1757
1758                         src_ptr = (u32 *)((u8 *)src_ptr + seek);
1759
1760                         /*
1761                          * We expect the field to be byte aligned and whole byte
1762                          * lengths if we are here
1763                          */
1764                         memcpy(data, src_ptr, wlen);
1765                         return 0;
1766                 }
1767                 break;
1768         case PLATFORM_CONFIG_PORT_TABLE:
1769                 /* Port table is 4 DWORDS */
1770                 src_ptr = dd->hfi1_id ?
1771                         pcfgcache->config_tables[table_type].table + 4 :
1772                         pcfgcache->config_tables[table_type].table;
1773                 break;
1774         case PLATFORM_CONFIG_RX_PRESET_TABLE:
1775                 /* fall through */
1776         case PLATFORM_CONFIG_TX_PRESET_TABLE:
1777                 /* fall through */
1778         case PLATFORM_CONFIG_QSFP_ATTEN_TABLE:
1779                 /* fall through */
1780         case PLATFORM_CONFIG_VARIABLE_SETTINGS_TABLE:
1781                 src_ptr = pcfgcache->config_tables[table_type].table;
1782
1783                 if (table_index <
1784                         pcfgcache->config_tables[table_type].num_table)
1785                         src_ptr += table_index;
1786                 else
1787                         src_ptr = NULL;
1788                 break;
1789         default:
1790                 dd_dev_info(dd, "%s: Unknown table\n", __func__);
1791                 break;
1792         }
1793
1794         if (!src_ptr || len < field_len_bits)
1795                 return -EINVAL;
1796
1797         src_ptr += (field_start_bits / 32);
1798         *data = (*src_ptr >> (field_start_bits % 32)) &
1799                         ((1 << field_len_bits) - 1);
1800
1801         return 0;
1802 }
1803
1804 /*
1805  * Download the firmware needed for the Gen3 PCIe SerDes.  An update
1806  * to the SBus firmware is needed before updating the PCIe firmware.
1807  *
1808  * Note: caller must be holding the HW mutex.
1809  */
1810 int load_pcie_firmware(struct hfi1_devdata *dd)
1811 {
1812         int ret = 0;
1813
1814         /* both firmware loads below use the SBus */
1815         set_sbus_fast_mode(dd);
1816
1817         if (fw_sbus_load) {
1818                 turn_off_spicos(dd, SPICO_SBUS);
1819                 do {
1820                         ret = load_sbus_firmware(dd, &fw_sbus);
1821                 } while (retry_firmware(dd, ret));
1822                 if (ret)
1823                         goto done;
1824         }
1825
1826         if (fw_pcie_serdes_load) {
1827                 dd_dev_info(dd, "Setting PCIe SerDes broadcast\n");
1828                 set_serdes_broadcast(dd, all_pcie_serdes_broadcast,
1829                                      pcie_serdes_broadcast[dd->hfi1_id],
1830                                      pcie_serdes_addrs[dd->hfi1_id],
1831                                      NUM_PCIE_SERDES);
1832                 do {
1833                         ret = load_pcie_serdes_firmware(dd, &fw_pcie);
1834                 } while (retry_firmware(dd, ret));
1835                 if (ret)
1836                         goto done;
1837         }
1838
1839 done:
1840         clear_sbus_fast_mode(dd);
1841
1842         return ret;
1843 }
1844
1845 /*
1846  * Read the GUID from the hardware, store it in dd.
1847  */
1848 void read_guid(struct hfi1_devdata *dd)
1849 {
1850         /* Take the DC out of reset to get a valid GUID value */
1851         write_csr(dd, CCE_DC_CTRL, 0);
1852         (void)read_csr(dd, CCE_DC_CTRL);
1853
1854         dd->base_guid = read_csr(dd, DC_DC8051_CFG_LOCAL_GUID);
1855         dd_dev_info(dd, "GUID %llx",
1856                     (unsigned long long)dd->base_guid);
1857 }