sys/dev/disk/aic7xxx/aic7xxx_93cx6.c

   1 /*
   2  * Interface for the 93C66/56/46/26/06 serial eeprom parts.
   3  *
   4  * Copyright (c) 1995, 1996 Daniel M. Eischen
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions, and the following disclaimer,
  12  *    without modification.
  13  * 2. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * Alternatively, this software may be distributed under the terms of the
  17  * GNU General Public License ("GPL").
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  23  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  * $Id: //depot/aic7xxx/aic7xxx/aic7xxx_93cx6.c#17 $
  32  *
  33  * $FreeBSD: src/sys/dev/aic7xxx/aic7xxx_93cx6.c,v 1.8.2.6 2002/08/31 07:25:53 gibbs Exp $
  34  * $DragonFly: src/sys/dev/disk/aic7xxx/aic7xxx_93cx6.c,v 1.3 2003/08/07 21:16:51 dillon Exp $
  35  */
  36
  37 /*
  38  *   The instruction set of the 93C66/56/46/26/06 chips are as follows:
  39  *
  40  *               Start  OP          *
  41  *     Function   Bit  Code  Address**  Data     Description
  42  *     -------------------------------------------------------------------
  43  *     READ        1    10   A5 - A0             Reads data stored in memory,
  44  *                                               starting at specified address
  45  *     EWEN        1    00   11XXXX              Write enable must precede
  46  *                                               all programming modes
  47  *     ERASE       1    11   A5 - A0             Erase register A5A4A3A2A1A0
  48  *     WRITE       1    01   A5 - A0   D15 - D0  Writes register
  49  *     ERAL        1    00   10XXXX              Erase all registers
  50  *     WRAL        1    00   01XXXX    D15 - D0  Writes to all registers
  51  *     EWDS        1    00   00XXXX              Disables all programming
  52  *                                               instructions
  53  *     *Note: A value of X for address is a don't care condition.
  54  *    **Note: There are 8 address bits for the 93C56/66 chips unlike
  55  *            the 93C46/26/06 chips which have 6 address bits.
  56  *
  57  *   The 93C46 has a four wire interface: clock, chip select, data in, and
  58  *   data out.  In order to perform one of the above functions, you need
  59  *   to enable the chip select for a clock period (typically a minimum of
  60  *   1 usec, with the clock high and low a minimum of 750 and 250 nsec
  61  *   respectively).  While the chip select remains high, you can clock in
  62  *   the instructions (above) starting with the start bit, followed by the
  63  *   OP code, Address, and Data (if needed).  For the READ instruction, the
  64  *   requested 16-bit register contents is read from the data out line but
  65  *   is preceded by an initial zero (leading 0, followed by 16-bits, MSB
  66  *   first).  The clock cycling from low to high initiates the next data
  67  *   bit to be sent from the chip.
  68  *
  69  */
  70
  71 #ifdef __linux__
  72 #include "aic7xxx_osm.h"
  73 #include "aic7xxx_inline.h"
  74 #include "aic7xxx_93cx6.h"
  75 #else
  76 #include "aic7xxx_osm.h"
  77 #include "aic7xxx_inline.h"
  78 #include "aic7xxx_93cx6.h"
  79 #endif
  80
  81 /*
  82  * Right now, we only have to read the SEEPROM.  But we make it easier to
  83  * add other 93Cx6 functions.
  84  */
  85 static struct seeprom_cmd {
  86         uint8_t len;
  87         uint8_t bits[9];
  88 } seeprom_read = {3, {1, 1, 0}};
  89
  90 static struct seeprom_cmd seeprom_ewen = {9, {1, 0, 0, 1, 1, 0, 0, 0, 0}};
  91 static struct seeprom_cmd seeprom_ewds = {9, {1, 0, 0, 0, 0, 0, 0, 0, 0}};
  92 static struct seeprom_cmd seeprom_write = {3, {1, 0, 1}};
  93
  94 /*
  95  * Wait for the SEERDY to go high; about 800 ns.
  96  */
  97 #define CLOCK_PULSE(sd, rdy)                            \
  98         while ((SEEPROM_STATUS_INB(sd) & rdy) == 0) {   \
  99                 ;  /* Do nothing */                     \
 100         }                                               \
 101         (void)SEEPROM_INB(sd);  /* Clear clock */
 102
 103 /*
 104  * Send a START condition and the given command
 105  */
 106 static void
 107 send_seeprom_cmd(struct seeprom_descriptor *sd, struct seeprom_cmd *cmd)
 108 {
 109         uint8_t temp;
 110         int i = 0;
 111
 112         /* Send chip select for one clock cycle. */
 113         temp = sd->sd_MS ^ sd->sd_CS;
 114         SEEPROM_OUTB(sd, temp ^ sd->sd_CK);
 115         CLOCK_PULSE(sd, sd->sd_RDY);
 116
 117         for (i = 0; i < cmd->len; i++) {
 118                 if (cmd->bits[i] != 0)
 119                         temp ^= sd->sd_DO;
 120                 SEEPROM_OUTB(sd, temp);
 121                 CLOCK_PULSE(sd, sd->sd_RDY);
 122                 SEEPROM_OUTB(sd, temp ^ sd->sd_CK);
 123                 CLOCK_PULSE(sd, sd->sd_RDY);
 124                 if (cmd->bits[i] != 0)
 125                         temp ^= sd->sd_DO;
 126         }
 127 }
 128
 129 /*
 130  * Clear CS put the chip in the reset state, where it can wait for new commands.
 131  */
 132 static void
 133 reset_seeprom(struct seeprom_descriptor *sd)
 134 {
 135         uint8_t temp;
 136
 137         temp = sd->sd_MS;
 138         SEEPROM_OUTB(sd, temp);
 139         CLOCK_PULSE(sd, sd->sd_RDY);
 140         SEEPROM_OUTB(sd, temp ^ sd->sd_CK);
 141         CLOCK_PULSE(sd, sd->sd_RDY);
 142         SEEPROM_OUTB(sd, temp);
 143         CLOCK_PULSE(sd, sd->sd_RDY);
 144 }
 145
 146 /*
 147  * Read the serial EEPROM and returns 1 if successful and 0 if
 148  * not successful.
 149  */
 150 int
 151 ahc_read_seeprom(struct seeprom_descriptor *sd, uint16_t *buf,
 152                  u_int start_addr, u_int count)
 153 {
 154         int i = 0;
 155         u_int k = 0;
 156         uint16_t v;
 157         uint8_t temp;
 158
 159         /*
 160          * Read the requested registers of the seeprom.  The loop
 161          * will range from 0 to count-1.
 162          */
 163         for (k = start_addr; k < count + start_addr; k++) {
 164                 /*
 165                  * Now we're ready to send the read command followed by the
 166                  * address of the 16-bit register we want to read.
 167                  */
 168                 send_seeprom_cmd(sd, &seeprom_read);
 169
 170                 /* Send the 6 or 8 bit address (MSB first, LSB last). */
 171                 temp = sd->sd_MS ^ sd->sd_CS;
 172                 for (i = (sd->sd_chip - 1); i >= 0; i--) {
 173                         if ((k & (1 << i)) != 0)
 174                                 temp ^= sd->sd_DO;
 175                         SEEPROM_OUTB(sd, temp);
 176                         CLOCK_PULSE(sd, sd->sd_RDY);
 177                         SEEPROM_OUTB(sd, temp ^ sd->sd_CK);
 178                         CLOCK_PULSE(sd, sd->sd_RDY);
 179                         if ((k & (1 << i)) != 0)
 180                                 temp ^= sd->sd_DO;
 181                 }
 182
 183                 /*
 184                  * Now read the 16 bit register.  An initial 0 precedes the
 185                  * register contents which begins with bit 15 (MSB) and ends
 186                  * with bit 0 (LSB).  The initial 0 will be shifted off the
 187                  * top of our word as we let the loop run from 0 to 16.
 188                  */
 189                 v = 0;
 190                 for (i = 16; i >= 0; i--) {
 191                         SEEPROM_OUTB(sd, temp);
 192                         CLOCK_PULSE(sd, sd->sd_RDY);
 193                         v <<= 1;
 194                         if (SEEPROM_DATA_INB(sd) & sd->sd_DI)
 195                                 v |= 1;
 196                         SEEPROM_OUTB(sd, temp ^ sd->sd_CK);
 197                         CLOCK_PULSE(sd, sd->sd_RDY);
 198                 }
 199
 200                 buf[k - start_addr] = v;
 201
 202                 /* Reset the chip select for the next command cycle. */
 203                 reset_seeprom(sd);
 204         }
 205 #ifdef AHC_DUMP_EEPROM
 206         printf("\nSerial EEPROM:\n\t");
 207         for (k = 0; k < count; k = k + 1) {
 208                 if (((k % 8) == 0) && (k != 0)) {
 209                         printf ("\n\t");
 210                 }
 211                 printf (" 0x%x", buf[k]);
 212         }
 213         printf ("\n");
 214 #endif
 215         return (1);
 216 }
 217
 218 /*
 219  * Write the serial EEPROM and return 1 if successful and 0 if
 220  * not successful.
 221  */
 222 int
 223 ahc_write_seeprom(struct seeprom_descriptor *sd, uint16_t *buf,
 224                   u_int start_addr, u_int count)
 225 {
 226         uint16_t v;
 227         uint8_t temp;
 228         int i, k;
 229
 230         /* Place the chip into write-enable mode */
 231         send_seeprom_cmd(sd, &seeprom_ewen);
 232         reset_seeprom(sd);
 233
 234         /* Write all requested data out to the seeprom. */
 235         temp = sd->sd_MS ^ sd->sd_CS;
 236         for (k = start_addr; k < count + start_addr; k++) {
 237                 /* Send the write command */
 238                 send_seeprom_cmd(sd, &seeprom_write);
 239
 240                 /* Send the 6 or 8 bit address (MSB first). */
 241                 for (i = (sd->sd_chip - 1); i >= 0; i--) {
 242                         if ((k & (1 << i)) != 0)
 243                                 temp ^= sd->sd_DO;
 244                         SEEPROM_OUTB(sd, temp);
 245                         CLOCK_PULSE(sd, sd->sd_RDY);
 246                         SEEPROM_OUTB(sd, temp ^ sd->sd_CK);
 247                         CLOCK_PULSE(sd, sd->sd_RDY);
 248                         if ((k & (1 << i)) != 0)
 249                                 temp ^= sd->sd_DO;
 250                 }
 251
 252                 /* Write the 16 bit value, MSB first */
 253                 v = buf[k - start_addr];
 254                 for (i = 15; i >= 0; i--) {
 255                         if ((v & (1 << i)) != 0)
 256                                 temp ^= sd->sd_DO;
 257                         SEEPROM_OUTB(sd, temp);
 258                         CLOCK_PULSE(sd, sd->sd_RDY);
 259                         SEEPROM_OUTB(sd, temp ^ sd->sd_CK);
 260                         CLOCK_PULSE(sd, sd->sd_RDY);
 261                         if ((v & (1 << i)) != 0)
 262                                 temp ^= sd->sd_DO;
 263                 }
 264
 265                 /* Wait for the chip to complete the write */
 266                 temp = sd->sd_MS;
 267                 SEEPROM_OUTB(sd, temp);
 268                 CLOCK_PULSE(sd, sd->sd_RDY);
 269                 temp = sd->sd_MS ^ sd->sd_CS;
 270                 do {
 271                         SEEPROM_OUTB(sd, temp);
 272                         CLOCK_PULSE(sd, sd->sd_RDY);
 273                         SEEPROM_OUTB(sd, temp ^ sd->sd_CK);
 274                         CLOCK_PULSE(sd, sd->sd_RDY);
 275                 } while ((SEEPROM_DATA_INB(sd) & sd->sd_DI) == 0);
 276
 277                 reset_seeprom(sd);
 278         }
 279
 280         /* Put the chip back into write-protect mode */
 281         send_seeprom_cmd(sd, &seeprom_ewds);
 282         reset_seeprom(sd);
 283
 284         return (1);
 285 }
 286
 287 int
 288 ahc_verify_cksum(struct seeprom_config *sc)
 289 {
 290         int i;
 291         int maxaddr;
 292         uint32_t checksum;
 293         uint16_t *scarray;
 294
 295         maxaddr = (sizeof(*sc)/2) - 1;
 296         checksum = 0;
 297         scarray = (uint16_t *)sc;
 298
 299         for (i = 0; i < maxaddr; i++)
 300                 checksum = checksum + scarray[i];
 301         if (checksum == 0
 302          || (checksum & 0xFFFF) != sc->checksum) {
 303                 return (0);
 304         } else {
 305                 return(1);
 306         }
 307 }