drivers/infiniband/hw/ipath/ipath_eeprom.c

   1 /*
   2  * Copyright (c) 2006 QLogic, Inc. All rights reserved.
   3  * Copyright (c) 2003, 2004, 2005, 2006 PathScale, Inc. All rights reserved.
   4  *
   5  * This software is available to you under a choice of one of two
   6  * licenses.  You may choose to be licensed under the terms of the GNU
   7  * General Public License (GPL) Version 2, available from the file
   8  * COPYING in the main directory of this source tree, or the
   9  * OpenIB.org BSD license below:
  10  *
  11  *     Redistribution and use in source and binary forms, with or
  12  *     without modification, are permitted provided that the following
  13  *     conditions are met:
  14  *
  15  *      - Redistributions of source code must retain the above
  16  *        copyright notice, this list of conditions and the following
  17  *        disclaimer.
  18  *
  19  *      - Redistributions in binary form must reproduce the above
  20  *        copyright notice, this list of conditions and the following
  21  *        disclaimer in the documentation and/or other materials
  22  *        provided with the distribution.
  23  *
  24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  31  * SOFTWARE.
  32  */
  33
  34 #include <linux/delay.h>
  35 #include <linux/pci.h>
  36 #include <linux/vmalloc.h>
  37
  38 #include "ipath_kernel.h"
  39
  40 /*
  41  * InfiniPath I2C driver for a serial eeprom.  This is not a generic
  42  * I2C interface.  For a start, the device we're using (Atmel AT24C11)
  43  * doesn't work like a regular I2C device.  It looks like one
  44  * electrically, but not logically.  Normal I2C devices have a single
  45  * 7-bit or 10-bit I2C address that they respond to.  Valid 7-bit
  46  * addresses range from 0x03 to 0x77.  Addresses 0x00 to 0x02 and 0x78
  47  * to 0x7F are special reserved addresses (e.g. 0x00 is the "general
  48  * call" address.)  The Atmel device, on the other hand, responds to ALL
  49  * 7-bit addresses.  It's designed to be the only device on a given I2C
  50  * bus.  A 7-bit address corresponds to the memory address within the
  51  * Atmel device itself.
  52  *
  53  * Also, the timing requirements mean more than simple software
  54  * bitbanging, with readbacks from chip to ensure timing (simple udelay
  55  * is not enough).
  56  *
  57  * This all means that accessing the device is specialized enough
  58  * that using the standard kernel I2C bitbanging interface would be
  59  * impossible.  For example, the core I2C eeprom driver expects to find
  60  * a device at one or more of a limited set of addresses only.  It doesn't
  61  * allow writing to an eeprom.  It also doesn't provide any means of
  62  * accessing eeprom contents from within the kernel, only via sysfs.
  63  */
  64
  65 enum i2c_type {
  66         i2c_line_scl = 0,
  67         i2c_line_sda
  68 };
  69
  70 enum i2c_state {
  71         i2c_line_low = 0,
  72         i2c_line_high
  73 };
  74
  75 #define READ_CMD 1
  76 #define WRITE_CMD 0
  77
  78 static int eeprom_init;
  79
  80 /*
  81  * The gpioval manipulation really should be protected by spinlocks
  82  * or be converted to use atomic operations.
  83  */
  84
  85 /**
  86  * i2c_gpio_set - set a GPIO line
  87  * @dd: the infinipath device
  88  * @line: the line to set
  89  * @new_line_state: the state to set
  90  *
  91  * Returns 0 if the line was set to the new state successfully, non-zero
  92  * on error.
  93  */
  94 static int i2c_gpio_set(struct ipath_devdata *dd,
  95                         enum i2c_type line,
  96                         enum i2c_state new_line_state)
  97 {
  98         u64 out_mask, dir_mask, *gpioval;
  99         unsigned long flags = 0;
 100
 101         gpioval = &dd->ipath_gpio_out;
 102
 103         if (line == i2c_line_scl) {
 104                 dir_mask = dd->ipath_gpio_scl;
 105                 out_mask = (1UL << dd->ipath_gpio_scl_num);
 106         } else {
 107                 dir_mask = dd->ipath_gpio_sda;
 108                 out_mask = (1UL << dd->ipath_gpio_sda_num);
 109         }
 110
 111         spin_lock_irqsave(&dd->ipath_gpio_lock, flags);
 112         if (new_line_state == i2c_line_high) {
 113                 /* tri-state the output rather than force high */
 114                 dd->ipath_extctrl &= ~dir_mask;
 115         } else {
 116                 /* config line to be an output */
 117                 dd->ipath_extctrl |= dir_mask;
 118         }
 119         ipath_write_kreg(dd, dd->ipath_kregs->kr_extctrl, dd->ipath_extctrl);
 120
 121         /* set output as well (no real verify) */
 122         if (new_line_state == i2c_line_high)
 123                 *gpioval |= out_mask;
 124         else
 125                 *gpioval &= ~out_mask;
 126
 127         ipath_write_kreg(dd, dd->ipath_kregs->kr_gpio_out, *gpioval);
 128         spin_unlock_irqrestore(&dd->ipath_gpio_lock, flags);
 129
 130         return 0;
 131 }
 132
 133 /**
 134  * i2c_gpio_get - get a GPIO line state
 135  * @dd: the infinipath device
 136  * @line: the line to get
 137  * @curr_statep: where to put the line state
 138  *
 139  * Returns 0 if the line was set to the new state successfully, non-zero
 140  * on error.  curr_state is not set on error.
 141  */
 142 static int i2c_gpio_get(struct ipath_devdata *dd,
 143                         enum i2c_type line,
 144                         enum i2c_state *curr_statep)
 145 {
 146         u64 read_val, mask;
 147         int ret;
 148         unsigned long flags = 0;
 149
 150         /* check args */
 151         if (curr_statep == NULL) {
 152                 ret = 1;
 153                 goto bail;
 154         }
 155
 156         /* config line to be an input */
 157         if (line == i2c_line_scl)
 158                 mask = dd->ipath_gpio_scl;
 159         else
 160                 mask = dd->ipath_gpio_sda;
 161
 162         spin_lock_irqsave(&dd->ipath_gpio_lock, flags);
 163         dd->ipath_extctrl &= ~mask;
 164         ipath_write_kreg(dd, dd->ipath_kregs->kr_extctrl, dd->ipath_extctrl);
 165         /*
 166          * Below is very unlikely to reflect true input state if Output
 167          * Enable actually changed.
 168          */
 169         read_val = ipath_read_kreg64(dd, dd->ipath_kregs->kr_extstatus);
 170         spin_unlock_irqrestore(&dd->ipath_gpio_lock, flags);
 171
 172         if (read_val & mask)
 173                 *curr_statep = i2c_line_high;
 174         else
 175                 *curr_statep = i2c_line_low;
 176
 177         ret = 0;
 178
 179 bail:
 180         return ret;
 181 }
 182
 183 /**
 184  * i2c_wait_for_writes - wait for a write
 185  * @dd: the infinipath device
 186  *
 187  * We use this instead of udelay directly, so we can make sure
 188  * that previous register writes have been flushed all the way
 189  * to the chip.  Since we are delaying anyway, the cost doesn't
 190  * hurt, and makes the bit twiddling more regular
 191  */
 192 static void i2c_wait_for_writes(struct ipath_devdata *dd)
 193 {
 194         (void)ipath_read_kreg32(dd, dd->ipath_kregs->kr_scratch);
 195         rmb();
 196 }
 197
 198 static void scl_out(struct ipath_devdata *dd, u8 bit)
 199 {
 200         udelay(1);
 201         i2c_gpio_set(dd, i2c_line_scl, bit ? i2c_line_high : i2c_line_low);
 202
 203         i2c_wait_for_writes(dd);
 204 }
 205
 206 static void sda_out(struct ipath_devdata *dd, u8 bit)
 207 {
 208         i2c_gpio_set(dd, i2c_line_sda, bit ? i2c_line_high : i2c_line_low);
 209
 210         i2c_wait_for_writes(dd);
 211 }
 212
 213 static u8 sda_in(struct ipath_devdata *dd, int wait)
 214 {
 215         enum i2c_state bit;
 216
 217         if (i2c_gpio_get(dd, i2c_line_sda, &bit))
 218                 ipath_dbg("get bit failed!\n");
 219
 220         if (wait)
 221                 i2c_wait_for_writes(dd);
 222
 223         return bit == i2c_line_high ? 1U : 0;
 224 }
 225
 226 /**
 227  * i2c_ackrcv - see if ack following write is true
 228  * @dd: the infinipath device
 229  */
 230 static int i2c_ackrcv(struct ipath_devdata *dd)
 231 {
 232         u8 ack_received;
 233
 234         /* AT ENTRY SCL = LOW */
 235         /* change direction, ignore data */
 236         ack_received = sda_in(dd, 1);
 237         scl_out(dd, i2c_line_high);
 238         ack_received = sda_in(dd, 1) == 0;
 239         scl_out(dd, i2c_line_low);
 240         return ack_received;
 241 }
 242
 243 /**
 244  * wr_byte - write a byte, one bit at a time
 245  * @dd: the infinipath device
 246  * @data: the byte to write
 247  *
 248  * Returns 0 if we got the following ack, otherwise 1
 249  */
 250 static int wr_byte(struct ipath_devdata *dd, u8 data)
 251 {
 252         int bit_cntr;
 253         u8 bit;
 254
 255         for (bit_cntr = 7; bit_cntr >= 0; bit_cntr--) {
 256                 bit = (data >> bit_cntr) & 1;
 257                 sda_out(dd, bit);
 258                 scl_out(dd, i2c_line_high);
 259                 scl_out(dd, i2c_line_low);
 260         }
 261         return (!i2c_ackrcv(dd)) ? 1 : 0;
 262 }
 263
 264 static void send_ack(struct ipath_devdata *dd)
 265 {
 266         sda_out(dd, i2c_line_low);
 267         scl_out(dd, i2c_line_high);
 268         scl_out(dd, i2c_line_low);
 269         sda_out(dd, i2c_line_high);
 270 }
 271
 272 /**
 273  * i2c_startcmd - transmit the start condition, followed by address/cmd
 274  * @dd: the infinipath device
 275  * @offset_dir: direction byte
 276  *
 277  *      (both clock/data high, clock high, data low while clock is high)
 278  */
 279 static int i2c_startcmd(struct ipath_devdata *dd, u8 offset_dir)
 280 {
 281         int res;
 282
 283         /* issue start sequence */
 284         sda_out(dd, i2c_line_high);
 285         scl_out(dd, i2c_line_high);
 286         sda_out(dd, i2c_line_low);
 287         scl_out(dd, i2c_line_low);
 288
 289         /* issue length and direction byte */
 290         res = wr_byte(dd, offset_dir);
 291
 292         if (res)
 293                 ipath_cdbg(VERBOSE, "No ack to complete start\n");
 294
 295         return res;
 296 }
 297
 298 /**
 299  * stop_cmd - transmit the stop condition
 300  * @dd: the infinipath device
 301  *
 302  * (both clock/data low, clock high, data high while clock is high)
 303  */
 304 static void stop_cmd(struct ipath_devdata *dd)
 305 {
 306         scl_out(dd, i2c_line_low);
 307         sda_out(dd, i2c_line_low);
 308         scl_out(dd, i2c_line_high);
 309         sda_out(dd, i2c_line_high);
 310         udelay(2);
 311 }
 312
 313 /**
 314  * eeprom_reset - reset I2C communication
 315  * @dd: the infinipath device
 316  */
 317
 318 static int eeprom_reset(struct ipath_devdata *dd)
 319 {
 320         int clock_cycles_left = 9;
 321         u64 *gpioval = &dd->ipath_gpio_out;
 322         int ret;
 323         unsigned long flags;
 324
 325         spin_lock_irqsave(&dd->ipath_gpio_lock, flags);
 326         /* Make sure shadows are consistent */
 327         dd->ipath_extctrl = ipath_read_kreg64(dd, dd->ipath_kregs->kr_extctrl);
 328         *gpioval = ipath_read_kreg64(dd, dd->ipath_kregs->kr_gpio_out);
 329         spin_unlock_irqrestore(&dd->ipath_gpio_lock, flags);
 330
 331         ipath_cdbg(VERBOSE, "Resetting i2c eeprom; initial gpioout reg "
 332                    "is %llx\n", (unsigned long long) *gpioval);
 333
 334         eeprom_init = 1;
 335         /*
 336          * This is to get the i2c into a known state, by first going low,
 337          * then tristate sda (and then tristate scl as first thing
 338          * in loop)
 339          */
 340         scl_out(dd, i2c_line_low);
 341         sda_out(dd, i2c_line_high);
 342
 343         while (clock_cycles_left--) {
 344                 scl_out(dd, i2c_line_high);
 345
 346                 if (sda_in(dd, 0)) {
 347                         sda_out(dd, i2c_line_low);
 348                         scl_out(dd, i2c_line_low);
 349                         ret = 0;
 350                         goto bail;
 351                 }
 352
 353                 scl_out(dd, i2c_line_low);
 354         }
 355
 356         ret = 1;
 357
 358 bail:
 359         return ret;
 360 }
 361
 362 /**
 363  * ipath_eeprom_read - receives bytes from the eeprom via I2C
 364  * @dd: the infinipath device
 365  * @eeprom_offset: address to read from
 366  * @buffer: where to store result
 367  * @len: number of bytes to receive
 368  */
 369
 370 int ipath_eeprom_read(struct ipath_devdata *dd, u8 eeprom_offset,
 371                       void *buffer, int len)
 372 {
 373         /* compiler complains unless initialized */
 374         u8 single_byte = 0;
 375         int bit_cntr;
 376         int ret;
 377
 378         if (!eeprom_init)
 379                 eeprom_reset(dd);
 380
 381         eeprom_offset = (eeprom_offset << 1) | READ_CMD;
 382
 383         if (i2c_startcmd(dd, eeprom_offset)) {
 384                 ipath_dbg("Failed startcmd\n");
 385                 stop_cmd(dd);
 386                 ret = 1;
 387                 goto bail;
 388         }
 389
 390         /*
 391          * eeprom keeps clocking data out as long as we ack, automatically
 392          * incrementing the address.
 393          */
 394         while (len-- > 0) {
 395                 /* get data */
 396                 single_byte = 0;
 397                 for (bit_cntr = 8; bit_cntr; bit_cntr--) {
 398                         u8 bit;
 399                         scl_out(dd, i2c_line_high);
 400                         bit = sda_in(dd, 0);
 401                         single_byte |= bit << (bit_cntr - 1);
 402                         scl_out(dd, i2c_line_low);
 403                 }
 404
 405                 /* send ack if not the last byte */
 406                 if (len)
 407                         send_ack(dd);
 408
 409                 *((u8 *) buffer) = single_byte;
 410                 buffer++;
 411         }
 412
 413         stop_cmd(dd);
 414
 415         ret = 0;
 416
 417 bail:
 418         return ret;
 419 }
 420
 421 /**
 422  * ipath_eeprom_write - writes data to the eeprom via I2C
 423  * @dd: the infinipath device
 424  * @eeprom_offset: where to place data
 425  * @buffer: data to write
 426  * @len: number of bytes to write
 427  */
 428 int ipath_eeprom_write(struct ipath_devdata *dd, u8 eeprom_offset,
 429                        const void *buffer, int len)
 430 {
 431         u8 single_byte;
 432         int sub_len;
 433         const u8 *bp = buffer;
 434         int max_wait_time, i;
 435         int ret;
 436
 437         if (!eeprom_init)
 438                 eeprom_reset(dd);
 439
 440         while (len > 0) {
 441                 if (i2c_startcmd(dd, (eeprom_offset << 1) | WRITE_CMD)) {
 442                         ipath_dbg("Failed to start cmd offset %u\n",
 443                                   eeprom_offset);
 444                         goto failed_write;
 445                 }
 446
 447                 sub_len = min(len, 4);
 448                 eeprom_offset += sub_len;
 449                 len -= sub_len;
 450
 451                 for (i = 0; i < sub_len; i++) {
 452                         if (wr_byte(dd, *bp++)) {
 453                                 ipath_dbg("no ack after byte %u/%u (%u "
 454                                           "total remain)\n", i, sub_len,
 455                                           len + sub_len - i);
 456                                 goto failed_write;
 457                         }
 458                 }
 459
 460                 stop_cmd(dd);
 461
 462                 /*
 463                  * wait for write complete by waiting for a successful
 464                  * read (the chip replies with a zero after the write
 465                  * cmd completes, and before it writes to the eeprom.
 466                  * The startcmd for the read will fail the ack until
 467                  * the writes have completed.   We do this inline to avoid
 468                  * the debug prints that are in the real read routine
 469                  * if the startcmd fails.
 470                  */
 471                 max_wait_time = 100;
 472                 while (i2c_startcmd(dd, READ_CMD)) {
 473                         stop_cmd(dd);
 474                         if (!--max_wait_time) {
 475                                 ipath_dbg("Did not get successful read to "
 476                                           "complete write\n");
 477                                 goto failed_write;
 478                         }
 479                 }
 480                 /* now read the zero byte */
 481                 for (i = single_byte = 0; i < 8; i++) {
 482                         u8 bit;
 483                         scl_out(dd, i2c_line_high);
 484                         bit = sda_in(dd, 0);
 485                         scl_out(dd, i2c_line_low);
 486                         single_byte <<= 1;
 487                         single_byte |= bit;
 488                 }
 489                 stop_cmd(dd);
 490         }
 491
 492         ret = 0;
 493         goto bail;
 494
 495 failed_write:
 496         stop_cmd(dd);
 497         ret = 1;
 498
 499 bail:
 500         return ret;
 501 }
 502
 503 static u8 flash_csum(struct ipath_flash *ifp, int adjust)
 504 {
 505         u8 *ip = (u8 *) ifp;
 506         u8 csum = 0, len;
 507
 508         for (len = 0; len < ifp->if_length; len++)
 509                 csum += *ip++;
 510         csum -= ifp->if_csum;
 511         csum = ~csum;
 512         if (adjust)
 513                 ifp->if_csum = csum;
 514
 515         return csum;
 516 }
 517
 518 /**
 519  * ipath_get_guid - get the GUID from the i2c device
 520  * @dd: the infinipath device
 521  *
 522  * We have the capability to use the ipath_nguid field, and get
 523  * the guid from the first chip's flash, to use for all of them.
 524  */
 525 void ipath_get_eeprom_info(struct ipath_devdata *dd)
 526 {
 527         void *buf;
 528         struct ipath_flash *ifp;
 529         __be64 guid;
 530         int len;
 531         u8 csum, *bguid;
 532         int t = dd->ipath_unit;
 533         struct ipath_devdata *dd0 = ipath_lookup(0);
 534
 535         if (t && dd0->ipath_nguid > 1 && t <= dd0->ipath_nguid) {
 536                 u8 *bguid, oguid;
 537                 dd->ipath_guid = dd0->ipath_guid;
 538                 bguid = (u8 *) & dd->ipath_guid;
 539
 540                 oguid = bguid[7];
 541                 bguid[7] += t;
 542                 if (oguid > bguid[7]) {
 543                         if (bguid[6] == 0xff) {
 544                                 if (bguid[5] == 0xff) {
 545                                         ipath_dev_err(
 546                                                 dd,
 547                                                 "Can't set %s GUID from "
 548                                                 "base, wraps to OUI!\n",
 549                                                 ipath_get_unit_name(t));
 550                                         dd->ipath_guid = 0;
 551                                         goto bail;
 552                                 }
 553                                 bguid[5]++;
 554                         }
 555                         bguid[6]++;
 556                 }
 557                 dd->ipath_nguid = 1;
 558
 559                 ipath_dbg("nguid %u, so adding %u to device 0 guid, "
 560                           "for %llx\n",
 561                           dd0->ipath_nguid, t,
 562                           (unsigned long long) be64_to_cpu(dd->ipath_guid));
 563                 goto bail;
 564         }
 565
 566         len = offsetof(struct ipath_flash, if_future);
 567         buf = vmalloc(len);
 568         if (!buf) {
 569                 ipath_dev_err(dd, "Couldn't allocate memory to read %u "
 570                               "bytes from eeprom for GUID\n", len);
 571                 goto bail;
 572         }
 573
 574         if (ipath_eeprom_read(dd, 0, buf, len)) {
 575                 ipath_dev_err(dd, "Failed reading GUID from eeprom\n");
 576                 goto done;
 577         }
 578         ifp = (struct ipath_flash *)buf;
 579
 580         csum = flash_csum(ifp, 0);
 581         if (csum != ifp->if_csum) {
 582                 dev_info(&dd->pcidev->dev, "Bad I2C flash checksum: "
 583                          "0x%x, not 0x%x\n", csum, ifp->if_csum);
 584                 goto done;
 585         }
 586         if (*(__be64 *) ifp->if_guid == 0ULL ||
 587             *(__be64 *) ifp->if_guid == __constant_cpu_to_be64(-1LL)) {
 588                 ipath_dev_err(dd, "Invalid GUID %llx from flash; "
 589                               "ignoring\n",
 590                               *(unsigned long long *) ifp->if_guid);
 591                 /* don't allow GUID if all 0 or all 1's */
 592                 goto done;
 593         }
 594
 595         /* complain, but allow it */
 596         if (*(u64 *) ifp->if_guid == 0x100007511000000ULL)
 597                 dev_info(&dd->pcidev->dev, "Warning, GUID %llx is "
 598                          "default, probably not correct!\n",
 599                          *(unsigned long long *) ifp->if_guid);
 600
 601         bguid = ifp->if_guid;
 602         if (!bguid[0] && !bguid[1] && !bguid[2]) {
 603                 /* original incorrect GUID format in flash; fix in
 604                  * core copy, by shifting up 2 octets; don't need to
 605                  * change top octet, since both it and shifted are
 606                  * 0.. */
 607                 bguid[1] = bguid[3];
 608                 bguid[2] = bguid[4];
 609                 bguid[3] = bguid[4] = 0;
 610                 guid = *(__be64 *) ifp->if_guid;
 611                 ipath_cdbg(VERBOSE, "Old GUID format in flash, top 3 zero, "
 612                            "shifting 2 octets\n");
 613         } else
 614                 guid = *(__be64 *) ifp->if_guid;
 615         dd->ipath_guid = guid;
 616         dd->ipath_nguid = ifp->if_numguid;
 617         /*
 618          * Things are slightly complicated by the desire to transparently
 619          * support both the Pathscale 10-digit serial number and the QLogic
 620          * 13-character version.
 621          */
 622         if ((ifp->if_fversion > 1) && ifp->if_sprefix[0]
 623                 && ((u8 *)ifp->if_sprefix)[0] != 0xFF) {
 624                 /* This board has a Serial-prefix, which is stored
 625                  * elsewhere for backward-compatibility.
 626                  */
 627                 char *snp = dd->ipath_serial;
 628                 int len;
 629                 memcpy(snp, ifp->if_sprefix, sizeof ifp->if_sprefix);
 630                 snp[sizeof ifp->if_sprefix] = '\0';
 631                 len = strlen(snp);
 632                 snp += len;
 633                 len = (sizeof dd->ipath_serial) - len;
 634                 if (len > sizeof ifp->if_serial) {
 635                         len = sizeof ifp->if_serial;
 636                 }
 637                 memcpy(snp, ifp->if_serial, len);
 638         } else
 639                 memcpy(dd->ipath_serial, ifp->if_serial,
 640                        sizeof ifp->if_serial);
 641         if (!strstr(ifp->if_comment, "Tested successfully"))
 642                 ipath_dev_err(dd, "Board SN %s did not pass functional "
 643                         "test: %s\n", dd->ipath_serial,
 644                         ifp->if_comment);
 645
 646         ipath_cdbg(VERBOSE, "Initted GUID to %llx from eeprom\n",
 647                    (unsigned long long) be64_to_cpu(dd->ipath_guid));
 648
 649 done:
 650         vfree(buf);
 651
 652 bail:;
 653 }