1 /* $NetBSD: smc93cx6.c,v 1.14 2007/10/19 12:00:02 ad Exp $ */ 2 3 /* 4 * Interface for the 93C66/56/46/26/06 serial eeprom parts. 5 * 6 * Copyright (c) 1995, 1996 Daniel M. Eischen 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice immediately at the beginning of the file, without modification, 14 * this list of conditions, and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. Absolutely no warranty of function or purpose is made by the author 19 * Daniel M. Eischen. 20 * 4. Modifications may be freely made to this file if the above conditions 21 * are met. 22 * 23 * $FreeBSD: src/sys/dev/aic7xxx/93cx6.c,v 1.5 2000/01/07 23:08:17 gibbs Exp $ 24 */ 25 26 /* 27 * The instruction set of the 93C66/56/46/26/06 chips are as follows: 28 * 29 * Start OP * 30 * Function Bit Code Address** Data Description 31 * ------------------------------------------------------------------- 32 * READ 1 10 A5 - A0 Reads data stored in memory, 33 * starting at specified address 34 * EWEN 1 00 11XXXX Write enable must precede 35 * all programming modes 36 * ERASE 1 11 A5 - A0 Erase register A5A4A3A2A1A0 37 * WRITE 1 01 A5 - A0 D15 - D0 Writes register 38 * ERAL 1 00 10XXXX Erase all registers 39 * WRAL 1 00 01XXXX D15 - D0 Writes to all registers 40 * EWDS 1 00 00XXXX Disables all programming 41 * instructions 42 * *Note: A value of X for address is a don't care condition. 43 * **Note: There are 8 address bits for the 93C56/66 chips unlike 44 * the 93C46/26/06 chips which have 6 address bits. 45 * 46 * The 93C46 has a four wire interface: clock, chip select, data in, and 47 * data out. In order to perform one of the above functions, you need 48 * to enable the chip select for a clock period (typically a minimum of 49 * 1 usec, with the clock high and low a minimum of 750 and 250 nsec 50 * respectively). While the chip select remains high, you can clock in 51 * the instructions (above) starting with the start bit, followed by the 52 * OP code, Address, and Data (if needed). For the READ instruction, the 53 * requested 16-bit register contents is read from the data out line but 54 * is preceded by an initial zero (leading 0, followed by 16-bits, MSB 55 * first). The clock cycling from low to high initiates the next data 56 * bit to be sent from the chip. 57 * 58 */ 59 60 #include <sys/cdefs.h> 61 __KERNEL_RCSID(0, "$NetBSD: smc93cx6.c,v 1.14 2007/10/19 12:00:02 ad Exp $"); 62 63 #ifndef __NetBSD__ 64 #include "opt_aic7xxx.h" 65 #endif 66 67 #include <sys/param.h> 68 #include <sys/systm.h> 69 #include <sys/bus.h> 70 #ifdef __NetBSD__ 71 #include <dev/ic/smc93cx6var.h> 72 #else 73 #include <machine/bus_memio.h> 74 #include <machine/bus_pio.h> 75 #include <dev/aic7xxx/93cx6.h> 76 #endif 77 78 /* 79 * Right now, we only have to read the SEEPROM. But we make it easier to 80 * add other 93Cx6 functions. 81 */ 82 static struct seeprom_cmd { 83 unsigned char len; 84 unsigned char bits[3]; 85 } seeprom_read = {3, {1, 1, 0}}; 86 87 /* XXX bus barriers */ 88 #define CLOCK_PULSE(sd, rdy) do { \ 89 /* \ 90 * Wait for the SEERDY to go high; about 800 ns. \ 91 */ \ 92 int cpi = 1000; \ 93 if (rdy == 0) { \ 94 DELAY(4); /* more than long enough */ \ 95 break; \ 96 } \ 97 while ((SEEPROM_STATUS_INB(sd) & rdy) == 0 && cpi-- > 0) { \ 98 ; /* Do nothing */ \ 99 } \ 100 (void)SEEPROM_INB(sd); /* Clear clock */ \ 101 } while (0) 102 103 /* 104 * Read the serial EEPROM and returns 1 if successful and 0 if 105 * not successful. 106 */ 107 int 108 read_seeprom(sd, buf, start_addr, count) 109 struct seeprom_descriptor *sd; 110 u_int16_t *buf; 111 bus_size_t start_addr; 112 bus_size_t count; 113 { 114 int i = 0; 115 u_int k = 0; 116 u_int16_t v; 117 u_int32_t temp; 118 119 /* 120 * Read the requested registers of the seeprom. The loop 121 * will range from 0 to count-1. 122 */ 123 for (k = start_addr; k < count + start_addr; k++) { 124 /* Send chip select for one clock cycle. */ 125 temp = sd->sd_MS ^ sd->sd_CS; 126 SEEPROM_OUTB(sd, temp ^ sd->sd_CK); 127 CLOCK_PULSE(sd, sd->sd_RDY); 128 129 /* 130 * Now we're ready to send the read command followed by the 131 * address of the 16-bit register we want to read. 132 */ 133 for (i = 0; i < seeprom_read.len; i++) { 134 if (seeprom_read.bits[i] != 0) 135 temp ^= sd->sd_DO; 136 SEEPROM_OUTB(sd, temp); 137 CLOCK_PULSE(sd, sd->sd_RDY); 138 SEEPROM_OUTB(sd, temp ^ sd->sd_CK); 139 CLOCK_PULSE(sd, sd->sd_RDY); 140 if (seeprom_read.bits[i] != 0) 141 temp ^= sd->sd_DO; 142 } 143 /* Send the 6 or 8 bit address (MSB first, LSB last). */ 144 for (i = (sd->sd_chip - 1); i >= 0; i--) { 145 if ((k & (1 << i)) != 0) 146 temp ^= sd->sd_DO; 147 SEEPROM_OUTB(sd, temp); 148 CLOCK_PULSE(sd, sd->sd_RDY); 149 SEEPROM_OUTB(sd, temp ^ sd->sd_CK); 150 CLOCK_PULSE(sd, sd->sd_RDY); 151 if ((k & (1 << i)) != 0) 152 temp ^= sd->sd_DO; 153 } 154 155 /* 156 * Now read the 16 bit register. An initial 0 precedes the 157 * register contents which begins with bit 15 (MSB) and ends 158 * with bit 0 (LSB). The initial 0 will be shifted off the 159 * top of our word as we let the loop run from 0 to 16. 160 */ 161 v = 0; 162 for (i = 16; i >= 0; i--) { 163 SEEPROM_OUTB(sd, temp); 164 CLOCK_PULSE(sd, sd->sd_RDY); 165 v <<= 1; 166 if (SEEPROM_DATA_INB(sd) & sd->sd_DI) 167 v |= 1; 168 SEEPROM_OUTB(sd, temp ^ sd->sd_CK); 169 CLOCK_PULSE(sd, sd->sd_RDY); 170 } 171 172 buf[k - start_addr] = v; 173 174 /* Reset the chip select for the next command cycle. */ 175 temp = sd->sd_MS; 176 SEEPROM_OUTB(sd, temp); 177 CLOCK_PULSE(sd, sd->sd_RDY); 178 SEEPROM_OUTB(sd, temp ^ sd->sd_CK); 179 CLOCK_PULSE(sd, sd->sd_RDY); 180 SEEPROM_OUTB(sd, temp); 181 CLOCK_PULSE(sd, sd->sd_RDY); 182 } 183 #ifdef AHC_DUMP_EEPROM 184 printf("\nSerial EEPROM:\n\t"); 185 for (k = 0; k < count; k = k + 1) { 186 if (((k % 8) == 0) && (k != 0)) { 187 printf ("\n\t"); 188 } 189 printf (" 0x%x", buf[k]); 190 } 191 printf ("\n"); 192 #endif 193 return (1); 194 } 195