Do a major clean-up of the BUSDMA architecture. A large number of
[dragonfly.git] / sys / dev / netif / rtw / smc93cx6.c
CommitLineData
44db266b
SZ
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 immediately at the beginning of the file, without modification,
12 * this list of conditions, and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Absolutely no warranty of function or purpose is made by the author
17 * Daniel M. Eischen.
18 * 4. Modifications may be freely made to this file if the above conditions
19 * are met.
20 *
21 * $FreeBSD: src/sys/dev/aic7xxx/93cx6.c,v 1.5 2000/01/07 23:08:17 gibbs Exp $
22 * $NetBSD: smc93cx6.c,v 1.12 2005/12/11 12:21:28 christos Exp $
1f7ab7c9 23 * $DragonFly: src/sys/dev/netif/rtw/smc93cx6.c,v 1.2 2006/10/25 20:55:58 dillon Exp $
44db266b
SZ
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 "opt_aic7xxx.h"
61
62#include <sys/param.h>
63#include <sys/systm.h>
1f7ab7c9 64#include <sys/bus.h>
44db266b
SZ
65
66#include "smc93cx6var.h"
67
68/*
69 * Right now, we only have to read the SEEPROM. But we make it easier to
70 * add other 93Cx6 functions.
71 */
72static struct seeprom_cmd {
73 unsigned char len;
74 unsigned char bits[3];
75} seeprom_read = {3, {1, 1, 0}};
76
77/* XXX bus barriers */
78#define CLOCK_PULSE(sd, rdy) do { \
79 /* \
80 * Wait for the SEERDY to go high; about 800 ns. \
81 */ \
82 int cpi = 1000; \
83 if (rdy == 0) { \
84 DELAY(4); /* more than long enough */ \
85 break; \
86 } \
87 while ((SEEPROM_STATUS_INB(sd) & rdy) == 0 && cpi-- > 0) { \
88 ; /* Do nothing */ \
89 } \
90 (void)SEEPROM_INB(sd); /* Clear clock */ \
91} while (0)
92
93/*
94 * Read the serial EEPROM and returns 1 if successful and 0 if
95 * not successful.
96 */
97int
98read_seeprom(sd, buf, start_addr, count)
99 struct seeprom_descriptor *sd;
100 u_int16_t *buf;
101 bus_size_t start_addr;
102 bus_size_t count;
103{
104 int i = 0;
105 u_int k = 0;
106 u_int16_t v;
107 u_int32_t temp;
108
109 /*
110 * Read the requested registers of the seeprom. The loop
111 * will range from 0 to count-1.
112 */
113 for (k = start_addr; k < count + start_addr; k++) {
114 /* Send chip select for one clock cycle. */
115 temp = sd->sd_MS ^ sd->sd_CS;
116 SEEPROM_OUTB(sd, temp ^ sd->sd_CK);
117 CLOCK_PULSE(sd, sd->sd_RDY);
118
119 /*
120 * Now we're ready to send the read command followed by the
121 * address of the 16-bit register we want to read.
122 */
123 for (i = 0; i < seeprom_read.len; i++) {
124 if (seeprom_read.bits[i] != 0)
125 temp ^= sd->sd_DO;
126 SEEPROM_OUTB(sd, temp);
127 CLOCK_PULSE(sd, sd->sd_RDY);
128 SEEPROM_OUTB(sd, temp ^ sd->sd_CK);
129 CLOCK_PULSE(sd, sd->sd_RDY);
130 if (seeprom_read.bits[i] != 0)
131 temp ^= sd->sd_DO;
132 }
133 /* Send the 6 or 8 bit address (MSB first, LSB last). */
134 for (i = (sd->sd_chip - 1); i >= 0; i--) {
135 if ((k & (1 << i)) != 0)
136 temp ^= sd->sd_DO;
137 SEEPROM_OUTB(sd, temp);
138 CLOCK_PULSE(sd, sd->sd_RDY);
139 SEEPROM_OUTB(sd, temp ^ sd->sd_CK);
140 CLOCK_PULSE(sd, sd->sd_RDY);
141 if ((k & (1 << i)) != 0)
142 temp ^= sd->sd_DO;
143 }
144
145 /*
146 * Now read the 16 bit register. An initial 0 precedes the
147 * register contents which begins with bit 15 (MSB) and ends
148 * with bit 0 (LSB). The initial 0 will be shifted off the
149 * top of our word as we let the loop run from 0 to 16.
150 */
151 v = 0;
152 for (i = 16; i >= 0; i--) {
153 SEEPROM_OUTB(sd, temp);
154 CLOCK_PULSE(sd, sd->sd_RDY);
155 v <<= 1;
156 if (SEEPROM_DATA_INB(sd) & sd->sd_DI)
157 v |= 1;
158 SEEPROM_OUTB(sd, temp ^ sd->sd_CK);
159 CLOCK_PULSE(sd, sd->sd_RDY);
160 }
161
162 buf[k - start_addr] = v;
163
164 /* Reset the chip select for the next command cycle. */
165 temp = sd->sd_MS;
166 SEEPROM_OUTB(sd, temp);
167 CLOCK_PULSE(sd, sd->sd_RDY);
168 SEEPROM_OUTB(sd, temp ^ sd->sd_CK);
169 CLOCK_PULSE(sd, sd->sd_RDY);
170 SEEPROM_OUTB(sd, temp);
171 CLOCK_PULSE(sd, sd->sd_RDY);
172 }
173#ifdef AHC_DUMP_EEPROM
174 printf("\nSerial EEPROM:\n\t");
175 for (k = 0; k < count; k = k + 1) {
176 if (((k % 8) == 0) && (k != 0)) {
177 printf ("\n\t");
178 }
179 printf (" 0x%x", buf[k]);
180 }
181 printf ("\n");
182#endif
183 return (1);
184}