root / hw / eeprom93xx.c @ a6307b08
History | View | Annotate | Download (10.4 kB)
1 | 663e8e51 | ths | /*
|
---|---|---|---|
2 | 663e8e51 | ths | * QEMU EEPROM 93xx emulation
|
3 | 663e8e51 | ths | *
|
4 | 663e8e51 | ths | * Copyright (c) 2006-2007 Stefan Weil
|
5 | 663e8e51 | ths | *
|
6 | 663e8e51 | ths | * This program is free software; you can redistribute it and/or modify
|
7 | 663e8e51 | ths | * it under the terms of the GNU General Public License as published by
|
8 | 663e8e51 | ths | * the Free Software Foundation; either version 2 of the License, or
|
9 | 663e8e51 | ths | * (at your option) any later version.
|
10 | 663e8e51 | ths | *
|
11 | 663e8e51 | ths | * This program is distributed in the hope that it will be useful,
|
12 | 663e8e51 | ths | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
13 | 663e8e51 | ths | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
14 | 663e8e51 | ths | * GNU General Public License for more details.
|
15 | 663e8e51 | ths | *
|
16 | 663e8e51 | ths | * You should have received a copy of the GNU General Public License
|
17 | 8167ee88 | Blue Swirl | * along with this program; if not, see <http://www.gnu.org/licenses/>.
|
18 | 663e8e51 | ths | */
|
19 | 663e8e51 | ths | |
20 | 663e8e51 | ths | /* Emulation for serial EEPROMs:
|
21 | 663e8e51 | ths | * NMC93C06 256-Bit (16 x 16)
|
22 | 663e8e51 | ths | * NMC93C46 1024-Bit (64 x 16)
|
23 | 663e8e51 | ths | * NMC93C56 2028 Bit (128 x 16)
|
24 | 663e8e51 | ths | * NMC93C66 4096 Bit (256 x 16)
|
25 | 663e8e51 | ths | * Compatible devices include FM93C46 and others.
|
26 | 663e8e51 | ths | *
|
27 | 663e8e51 | ths | * Other drivers use these interface functions:
|
28 | 663e8e51 | ths | * eeprom93xx_new - add a new EEPROM (with 16, 64 or 256 words)
|
29 | 663e8e51 | ths | * eeprom93xx_free - destroy EEPROM
|
30 | 663e8e51 | ths | * eeprom93xx_read - read data from the EEPROM
|
31 | 663e8e51 | ths | * eeprom93xx_write - write data to the EEPROM
|
32 | 663e8e51 | ths | * eeprom93xx_data - get EEPROM data array for external manipulation
|
33 | 663e8e51 | ths | *
|
34 | 663e8e51 | ths | * Todo list:
|
35 | 663e8e51 | ths | * - No emulation of EEPROM timings.
|
36 | 663e8e51 | ths | */
|
37 | 663e8e51 | ths | |
38 | 87ecb68b | pbrook | #include "hw.h" |
39 | 663e8e51 | ths | #include "eeprom93xx.h" |
40 | 663e8e51 | ths | |
41 | 663e8e51 | ths | /* Debug EEPROM emulation. */
|
42 | 663e8e51 | ths | //~ #define DEBUG_EEPROM
|
43 | 663e8e51 | ths | |
44 | 663e8e51 | ths | #ifdef DEBUG_EEPROM
|
45 | 001faf32 | Blue Swirl | #define logout(fmt, ...) fprintf(stderr, "EEPROM\t%-24s" fmt, __func__, ## __VA_ARGS__) |
46 | 663e8e51 | ths | #else
|
47 | 001faf32 | Blue Swirl | #define logout(fmt, ...) ((void)0) |
48 | 663e8e51 | ths | #endif
|
49 | 663e8e51 | ths | |
50 | 7ab2589c | aurel32 | #define EEPROM_INSTANCE 0 |
51 | 7ab2589c | aurel32 | #define OLD_EEPROM_VERSION 20061112 |
52 | 7ab2589c | aurel32 | #define EEPROM_VERSION (OLD_EEPROM_VERSION + 1) |
53 | 663e8e51 | ths | |
54 | 663e8e51 | ths | #if 0
|
55 | 663e8e51 | ths | typedef enum {
|
56 | 663e8e51 | ths | eeprom_read = 0x80, /* read register xx */
|
57 | 663e8e51 | ths | eeprom_write = 0x40, /* write register xx */
|
58 | 663e8e51 | ths | eeprom_erase = 0xc0, /* erase register xx */
|
59 | 663e8e51 | ths | eeprom_ewen = 0x30, /* erase / write enable */
|
60 | 663e8e51 | ths | eeprom_ewds = 0x00, /* erase / write disable */
|
61 | 663e8e51 | ths | eeprom_eral = 0x20, /* erase all registers */
|
62 | 663e8e51 | ths | eeprom_wral = 0x10, /* write all registers */
|
63 | 663e8e51 | ths | eeprom_amask = 0x0f,
|
64 | 663e8e51 | ths | eeprom_imask = 0xf0
|
65 | 663e8e51 | ths | } eeprom_instruction_t;
|
66 | 663e8e51 | ths | #endif
|
67 | 663e8e51 | ths | |
68 | 663e8e51 | ths | #ifdef DEBUG_EEPROM
|
69 | 663e8e51 | ths | static const char *opstring[] = { |
70 | 663e8e51 | ths | "extended", "write", "read", "erase" |
71 | 663e8e51 | ths | }; |
72 | 663e8e51 | ths | #endif
|
73 | 663e8e51 | ths | |
74 | 663e8e51 | ths | struct _eeprom_t {
|
75 | 663e8e51 | ths | uint8_t tick; |
76 | 663e8e51 | ths | uint8_t address; |
77 | 663e8e51 | ths | uint8_t command; |
78 | 663e8e51 | ths | uint8_t writeable; |
79 | 663e8e51 | ths | |
80 | 663e8e51 | ths | uint8_t eecs; |
81 | 663e8e51 | ths | uint8_t eesk; |
82 | 663e8e51 | ths | uint8_t eedo; |
83 | 663e8e51 | ths | |
84 | 663e8e51 | ths | uint8_t addrbits; |
85 | 7ab2589c | aurel32 | uint16_t size; |
86 | 663e8e51 | ths | uint16_t data; |
87 | 663e8e51 | ths | uint16_t contents[0];
|
88 | 663e8e51 | ths | }; |
89 | 663e8e51 | ths | |
90 | 663e8e51 | ths | /* Code for saving and restoring of EEPROM state. */
|
91 | 663e8e51 | ths | |
92 | 663e8e51 | ths | static void eeprom_save(QEMUFile *f, void *opaque) |
93 | 663e8e51 | ths | { |
94 | 663e8e51 | ths | /* Save EEPROM data. */
|
95 | 663e8e51 | ths | unsigned address;
|
96 | 663e8e51 | ths | eeprom_t *eeprom = (eeprom_t *)opaque; |
97 | d4ae799c | aurel32 | |
98 | d4ae799c | aurel32 | qemu_put_byte(f, eeprom->tick); |
99 | d4ae799c | aurel32 | qemu_put_byte(f, eeprom->address); |
100 | d4ae799c | aurel32 | qemu_put_byte(f, eeprom->command); |
101 | d4ae799c | aurel32 | qemu_put_byte(f, eeprom->writeable); |
102 | d4ae799c | aurel32 | |
103 | d4ae799c | aurel32 | qemu_put_byte(f, eeprom->eecs); |
104 | d4ae799c | aurel32 | qemu_put_byte(f, eeprom->eesk); |
105 | d4ae799c | aurel32 | qemu_put_byte(f, eeprom->eedo); |
106 | d4ae799c | aurel32 | |
107 | d4ae799c | aurel32 | qemu_put_byte(f, eeprom->addrbits); |
108 | 7ab2589c | aurel32 | qemu_put_be16(f, eeprom->size); |
109 | 663e8e51 | ths | qemu_put_be16(f, eeprom->data); |
110 | 663e8e51 | ths | for (address = 0; address < eeprom->size; address++) { |
111 | 663e8e51 | ths | qemu_put_be16(f, eeprom->contents[address]); |
112 | 663e8e51 | ths | } |
113 | 663e8e51 | ths | } |
114 | 663e8e51 | ths | |
115 | 663e8e51 | ths | static int eeprom_load(QEMUFile *f, void *opaque, int version_id) |
116 | 663e8e51 | ths | { |
117 | 663e8e51 | ths | /* Load EEPROM data from saved data if version and EEPROM size
|
118 | 663e8e51 | ths | of data and current EEPROM are identical. */
|
119 | 663e8e51 | ths | eeprom_t *eeprom = (eeprom_t *)opaque; |
120 | 663e8e51 | ths | int result = -EINVAL;
|
121 | 7ab2589c | aurel32 | if (version_id >= OLD_EEPROM_VERSION) {
|
122 | 663e8e51 | ths | unsigned address;
|
123 | 7ab2589c | aurel32 | int size = eeprom->size;
|
124 | d4ae799c | aurel32 | |
125 | d4ae799c | aurel32 | eeprom->tick = qemu_get_byte(f); |
126 | d4ae799c | aurel32 | eeprom->address = qemu_get_byte(f); |
127 | d4ae799c | aurel32 | eeprom->command = qemu_get_byte(f); |
128 | d4ae799c | aurel32 | eeprom->writeable = qemu_get_byte(f); |
129 | d4ae799c | aurel32 | |
130 | d4ae799c | aurel32 | eeprom->eecs = qemu_get_byte(f); |
131 | d4ae799c | aurel32 | eeprom->eesk = qemu_get_byte(f); |
132 | d4ae799c | aurel32 | eeprom->eedo = qemu_get_byte(f); |
133 | d4ae799c | aurel32 | |
134 | d4ae799c | aurel32 | eeprom->addrbits = qemu_get_byte(f); |
135 | 7ab2589c | aurel32 | if (version_id == OLD_EEPROM_VERSION) {
|
136 | 7ab2589c | aurel32 | eeprom->size = qemu_get_byte(f); |
137 | 7ab2589c | aurel32 | qemu_get_byte(f); |
138 | 7ab2589c | aurel32 | } else {
|
139 | 7ab2589c | aurel32 | eeprom->size = qemu_get_be16(f); |
140 | 7ab2589c | aurel32 | } |
141 | d4ae799c | aurel32 | |
142 | 663e8e51 | ths | if (eeprom->size == size) {
|
143 | 663e8e51 | ths | eeprom->data = qemu_get_be16(f); |
144 | 663e8e51 | ths | for (address = 0; address < eeprom->size; address++) { |
145 | 663e8e51 | ths | eeprom->contents[address] = qemu_get_be16(f); |
146 | 663e8e51 | ths | } |
147 | 663e8e51 | ths | result = 0;
|
148 | 663e8e51 | ths | } |
149 | 663e8e51 | ths | } |
150 | 663e8e51 | ths | return result;
|
151 | 663e8e51 | ths | } |
152 | 663e8e51 | ths | |
153 | 663e8e51 | ths | void eeprom93xx_write(eeprom_t *eeprom, int eecs, int eesk, int eedi) |
154 | 663e8e51 | ths | { |
155 | 663e8e51 | ths | uint8_t tick = eeprom->tick; |
156 | 663e8e51 | ths | uint8_t eedo = eeprom->eedo; |
157 | 663e8e51 | ths | uint16_t address = eeprom->address; |
158 | 663e8e51 | ths | uint8_t command = eeprom->command; |
159 | 663e8e51 | ths | |
160 | 663e8e51 | ths | logout("CS=%u SK=%u DI=%u DO=%u, tick = %u\n",
|
161 | 663e8e51 | ths | eecs, eesk, eedi, eedo, tick); |
162 | 663e8e51 | ths | |
163 | 663e8e51 | ths | if (! eeprom->eecs && eecs) {
|
164 | 663e8e51 | ths | /* Start chip select cycle. */
|
165 | 663e8e51 | ths | logout("Cycle start, waiting for 1st start bit (0)\n");
|
166 | 663e8e51 | ths | tick = 0;
|
167 | 663e8e51 | ths | command = 0x0;
|
168 | 663e8e51 | ths | address = 0x0;
|
169 | 663e8e51 | ths | } else if (eeprom->eecs && ! eecs) { |
170 | 663e8e51 | ths | /* End chip select cycle. This triggers write / erase. */
|
171 | 663e8e51 | ths | if (eeprom->writeable) {
|
172 | 663e8e51 | ths | uint8_t subcommand = address >> (eeprom->addrbits - 2);
|
173 | 663e8e51 | ths | if (command == 0 && subcommand == 2) { |
174 | 663e8e51 | ths | /* Erase all. */
|
175 | 663e8e51 | ths | for (address = 0; address < eeprom->size; address++) { |
176 | 663e8e51 | ths | eeprom->contents[address] = 0xffff;
|
177 | 663e8e51 | ths | } |
178 | 663e8e51 | ths | } else if (command == 3) { |
179 | 663e8e51 | ths | /* Erase word. */
|
180 | 663e8e51 | ths | eeprom->contents[address] = 0xffff;
|
181 | 663e8e51 | ths | } else if (tick >= 2 + 2 + eeprom->addrbits + 16) { |
182 | 663e8e51 | ths | if (command == 1) { |
183 | 663e8e51 | ths | /* Write word. */
|
184 | 663e8e51 | ths | eeprom->contents[address] &= eeprom->data; |
185 | 663e8e51 | ths | } else if (command == 0 && subcommand == 1) { |
186 | 663e8e51 | ths | /* Write all. */
|
187 | 663e8e51 | ths | for (address = 0; address < eeprom->size; address++) { |
188 | 663e8e51 | ths | eeprom->contents[address] &= eeprom->data; |
189 | 663e8e51 | ths | } |
190 | 663e8e51 | ths | } |
191 | 663e8e51 | ths | } |
192 | 663e8e51 | ths | } |
193 | 663e8e51 | ths | /* Output DO is tristate, read results in 1. */
|
194 | 663e8e51 | ths | eedo = 1;
|
195 | 663e8e51 | ths | } else if (eecs && ! eeprom->eesk && eesk) { |
196 | 663e8e51 | ths | /* Raising edge of clock shifts data in. */
|
197 | 663e8e51 | ths | if (tick == 0) { |
198 | 663e8e51 | ths | /* Wait for 1st start bit. */
|
199 | 663e8e51 | ths | if (eedi == 0) { |
200 | 663e8e51 | ths | logout("Got correct 1st start bit, waiting for 2nd start bit (1)\n");
|
201 | 663e8e51 | ths | tick++; |
202 | 663e8e51 | ths | } else {
|
203 | 663e8e51 | ths | logout("wrong 1st start bit (is 1, should be 0)\n");
|
204 | 663e8e51 | ths | tick = 2;
|
205 | 663e8e51 | ths | //~ assert(!"wrong start bit");
|
206 | 663e8e51 | ths | } |
207 | 663e8e51 | ths | } else if (tick == 1) { |
208 | 663e8e51 | ths | /* Wait for 2nd start bit. */
|
209 | 663e8e51 | ths | if (eedi != 0) { |
210 | 663e8e51 | ths | logout("Got correct 2nd start bit, getting command + address\n");
|
211 | 663e8e51 | ths | tick++; |
212 | 663e8e51 | ths | } else {
|
213 | 663e8e51 | ths | logout("1st start bit is longer than needed\n");
|
214 | 663e8e51 | ths | } |
215 | 663e8e51 | ths | } else if (tick < 2 + 2) { |
216 | 663e8e51 | ths | /* Got 2 start bits, transfer 2 opcode bits. */
|
217 | 663e8e51 | ths | tick++; |
218 | 663e8e51 | ths | command <<= 1;
|
219 | 663e8e51 | ths | if (eedi) {
|
220 | 663e8e51 | ths | command += 1;
|
221 | 663e8e51 | ths | } |
222 | 663e8e51 | ths | } else if (tick < 2 + 2 + eeprom->addrbits) { |
223 | 663e8e51 | ths | /* Got 2 start bits and 2 opcode bits, transfer all address bits. */
|
224 | 663e8e51 | ths | tick++; |
225 | 663e8e51 | ths | address = ((address << 1) | eedi);
|
226 | 663e8e51 | ths | if (tick == 2 + 2 + eeprom->addrbits) { |
227 | 663e8e51 | ths | logout("%s command, address = 0x%02x (value 0x%04x)\n",
|
228 | 663e8e51 | ths | opstring[command], address, eeprom->contents[address]); |
229 | 663e8e51 | ths | if (command == 2) { |
230 | 663e8e51 | ths | eedo = 0;
|
231 | 663e8e51 | ths | } |
232 | 663e8e51 | ths | address = address % eeprom->size; |
233 | 663e8e51 | ths | if (command == 0) { |
234 | 663e8e51 | ths | /* Command code in upper 2 bits of address. */
|
235 | 663e8e51 | ths | switch (address >> (eeprom->addrbits - 2)) { |
236 | 663e8e51 | ths | case 0: |
237 | 663e8e51 | ths | logout("write disable command\n");
|
238 | 663e8e51 | ths | eeprom->writeable = 0;
|
239 | 663e8e51 | ths | break;
|
240 | 663e8e51 | ths | case 1: |
241 | 663e8e51 | ths | logout("write all command\n");
|
242 | 663e8e51 | ths | break;
|
243 | 663e8e51 | ths | case 2: |
244 | 663e8e51 | ths | logout("erase all command\n");
|
245 | 663e8e51 | ths | break;
|
246 | 663e8e51 | ths | case 3: |
247 | 663e8e51 | ths | logout("write enable command\n");
|
248 | 663e8e51 | ths | eeprom->writeable = 1;
|
249 | 663e8e51 | ths | break;
|
250 | 663e8e51 | ths | } |
251 | 663e8e51 | ths | } else {
|
252 | 663e8e51 | ths | /* Read, write or erase word. */
|
253 | 663e8e51 | ths | eeprom->data = eeprom->contents[address]; |
254 | 663e8e51 | ths | } |
255 | 663e8e51 | ths | } |
256 | 663e8e51 | ths | } else if (tick < 2 + 2 + eeprom->addrbits + 16) { |
257 | 663e8e51 | ths | /* Transfer 16 data bits. */
|
258 | 663e8e51 | ths | tick++; |
259 | 663e8e51 | ths | if (command == 2) { |
260 | 663e8e51 | ths | /* Read word. */
|
261 | 663e8e51 | ths | eedo = ((eeprom->data & 0x8000) != 0); |
262 | 663e8e51 | ths | } |
263 | 663e8e51 | ths | eeprom->data <<= 1;
|
264 | 663e8e51 | ths | eeprom->data += eedi; |
265 | 663e8e51 | ths | } else {
|
266 | 663e8e51 | ths | logout("additional unneeded tick, not processed\n");
|
267 | 663e8e51 | ths | } |
268 | 663e8e51 | ths | } |
269 | 663e8e51 | ths | /* Save status of EEPROM. */
|
270 | 663e8e51 | ths | eeprom->tick = tick; |
271 | 663e8e51 | ths | eeprom->eecs = eecs; |
272 | 663e8e51 | ths | eeprom->eesk = eesk; |
273 | 663e8e51 | ths | eeprom->eedo = eedo; |
274 | 663e8e51 | ths | eeprom->address = address; |
275 | 663e8e51 | ths | eeprom->command = command; |
276 | 663e8e51 | ths | } |
277 | 663e8e51 | ths | |
278 | 663e8e51 | ths | uint16_t eeprom93xx_read(eeprom_t *eeprom) |
279 | 663e8e51 | ths | { |
280 | 663e8e51 | ths | /* Return status of pin DO (0 or 1). */
|
281 | 663e8e51 | ths | logout("CS=%u DO=%u\n", eeprom->eecs, eeprom->eedo);
|
282 | 663e8e51 | ths | return (eeprom->eedo);
|
283 | 663e8e51 | ths | } |
284 | 663e8e51 | ths | |
285 | 663e8e51 | ths | #if 0
|
286 | 663e8e51 | ths | void eeprom93xx_reset(eeprom_t *eeprom)
|
287 | 663e8e51 | ths | {
|
288 | 663e8e51 | ths | /* prepare eeprom */
|
289 | 663e8e51 | ths | logout("eeprom = 0x%p\n", eeprom);
|
290 | 663e8e51 | ths | eeprom->tick = 0;
|
291 | 663e8e51 | ths | eeprom->command = 0;
|
292 | 663e8e51 | ths | }
|
293 | 663e8e51 | ths | #endif
|
294 | 663e8e51 | ths | |
295 | 663e8e51 | ths | eeprom_t *eeprom93xx_new(uint16_t nwords) |
296 | 663e8e51 | ths | { |
297 | 663e8e51 | ths | /* Add a new EEPROM (with 16, 64 or 256 words). */
|
298 | 663e8e51 | ths | eeprom_t *eeprom; |
299 | 663e8e51 | ths | uint8_t addrbits; |
300 | 663e8e51 | ths | |
301 | 663e8e51 | ths | switch (nwords) {
|
302 | 663e8e51 | ths | case 16: |
303 | 663e8e51 | ths | case 64: |
304 | 663e8e51 | ths | addrbits = 6;
|
305 | 663e8e51 | ths | break;
|
306 | 663e8e51 | ths | case 128: |
307 | 663e8e51 | ths | case 256: |
308 | 663e8e51 | ths | addrbits = 8;
|
309 | 663e8e51 | ths | break;
|
310 | 663e8e51 | ths | default:
|
311 | 663e8e51 | ths | assert(!"Unsupported EEPROM size, fallback to 64 words!");
|
312 | 663e8e51 | ths | nwords = 64;
|
313 | 663e8e51 | ths | addrbits = 6;
|
314 | 663e8e51 | ths | } |
315 | 663e8e51 | ths | |
316 | 663e8e51 | ths | eeprom = (eeprom_t *)qemu_mallocz(sizeof(*eeprom) + nwords * 2); |
317 | 663e8e51 | ths | eeprom->size = nwords; |
318 | 663e8e51 | ths | eeprom->addrbits = addrbits; |
319 | 663e8e51 | ths | /* Output DO is tristate, read results in 1. */
|
320 | 663e8e51 | ths | eeprom->eedo = 1;
|
321 | 663e8e51 | ths | logout("eeprom = 0x%p, nwords = %u\n", eeprom, nwords);
|
322 | 7ab2589c | aurel32 | register_savevm("eeprom", EEPROM_INSTANCE, EEPROM_VERSION,
|
323 | 663e8e51 | ths | eeprom_save, eeprom_load, eeprom); |
324 | 663e8e51 | ths | return eeprom;
|
325 | 663e8e51 | ths | } |
326 | 663e8e51 | ths | |
327 | 663e8e51 | ths | void eeprom93xx_free(eeprom_t *eeprom)
|
328 | 663e8e51 | ths | { |
329 | 663e8e51 | ths | /* Destroy EEPROM. */
|
330 | 663e8e51 | ths | logout("eeprom = 0x%p\n", eeprom);
|
331 | 391354f1 | Mark McLoughlin | unregister_savevm("eeprom", eeprom);
|
332 | 663e8e51 | ths | qemu_free(eeprom); |
333 | 663e8e51 | ths | } |
334 | 663e8e51 | ths | |
335 | 663e8e51 | ths | uint16_t *eeprom93xx_data(eeprom_t *eeprom) |
336 | 663e8e51 | ths | { |
337 | 663e8e51 | ths | /* Get EEPROM data array. */
|
338 | 663e8e51 | ths | return &eeprom->contents[0]; |
339 | 663e8e51 | ths | } |
340 | 663e8e51 | ths | |
341 | 663e8e51 | ths | /* eof */ |