paul@19 | 1 | /* |
paul@19 | 2 | Interfacing the Arduino Duemilanove to Am29F010 devices. |
paul@19 | 3 | |
paul@38 | 4 | Copyright (C) 2015, 2016 Paul Boddie <paul@boddie.org.uk> |
paul@19 | 5 | |
paul@19 | 6 | This program is free software; you can redistribute it and/or modify it under |
paul@19 | 7 | the terms of the GNU General Public License as published by the Free Software |
paul@19 | 8 | Foundation; either version 3 of the License, or (at your option) any later |
paul@19 | 9 | version. |
paul@19 | 10 | |
paul@19 | 11 | This program is distributed in the hope that it will be useful, but WITHOUT ANY |
paul@19 | 12 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A |
paul@19 | 13 | PARTICULAR PURPOSE. See the GNU General Public License for more details. |
paul@19 | 14 | |
paul@19 | 15 | You should have received a copy of the GNU General Public License along |
paul@19 | 16 | with this program. If not, see <http://www.gnu.org/licenses/>. |
paul@19 | 17 | */ |
paul@19 | 18 | |
paul@28 | 19 | const int CE = A5, OE = A4, WE = A3, A16 = A2, |
paul@38 | 20 | #ifdef CIRCUIT_74HC273 |
paul@38 | 21 | CS1 = 2, CS2 = 3, /* using 74HC273 */ |
paul@38 | 22 | #endif |
paul@38 | 23 | #ifdef CIRCUIT_74HC595 |
paul@38 | 24 | SHIFT_SCK = 2, SHIFT_RCK = 3, /* using 74HC595 */ |
paul@38 | 25 | SHIFT_SI = 12, |
paul@38 | 26 | #endif |
paul@27 | 27 | DQ0 = 7, DQ1 = 6, DQ2 = 5, DQ3 = 4, |
paul@13 | 28 | DQ4 = 8, DQ5 = 9, DQ6 = 10, DQ7 = 11; |
paul@2 | 29 | |
paul@31 | 30 | const int datapins[8] = {DQ7, DQ6, DQ5, DQ4, DQ3, DQ2, DQ1, DQ0}; |
paul@30 | 31 | const int BUFSIZE = 9; |
paul@6 | 32 | char inbuffer[BUFSIZE]; |
paul@13 | 33 | int nread = 0; |
paul@6 | 34 | |
paul@32 | 35 | const char RESET[][9] = { |
paul@32 | 36 | "W05555AA", "W02AAA55", "W05555F0" |
paul@7 | 37 | }; |
paul@32 | 38 | const char ERASE[][9] = { |
paul@32 | 39 | "W05555AA", "W02AAA55", "W0555580", "W05555AA", "W02AAA55" |
paul@32 | 40 | }; |
paul@32 | 41 | const char PROGRAM[][9] = { |
paul@32 | 42 | "W05555AA", "W02AAA55", "W05555A0" |
paul@7 | 43 | }; |
paul@2 | 44 | |
paul@2 | 45 | int fromHex(char c) |
paul@2 | 46 | { |
paul@2 | 47 | if ((c >= 48) && (c <= 57)) |
paul@2 | 48 | return c - 48; |
paul@2 | 49 | if ((c >= 65) && (c <= 70)) |
paul@2 | 50 | return c - 65 + 10; |
paul@2 | 51 | if ((c >= 97) && (c <= 102)) |
paul@2 | 52 | return c - 97 + 10; |
paul@2 | 53 | return 0; |
paul@2 | 54 | } |
paul@2 | 55 | |
paul@2 | 56 | void setDataOut() |
paul@2 | 57 | { |
paul@2 | 58 | pinMode(DQ0, OUTPUT); |
paul@2 | 59 | pinMode(DQ1, OUTPUT); |
paul@2 | 60 | pinMode(DQ2, OUTPUT); |
paul@2 | 61 | pinMode(DQ3, OUTPUT); |
paul@2 | 62 | pinMode(DQ4, OUTPUT); |
paul@2 | 63 | pinMode(DQ5, OUTPUT); |
paul@2 | 64 | pinMode(DQ6, OUTPUT); |
paul@2 | 65 | pinMode(DQ7, OUTPUT); |
paul@2 | 66 | } |
paul@2 | 67 | |
paul@2 | 68 | void setDataIn() |
paul@2 | 69 | { |
paul@2 | 70 | pinMode(DQ0, INPUT); |
paul@2 | 71 | pinMode(DQ1, INPUT); |
paul@2 | 72 | pinMode(DQ2, INPUT); |
paul@2 | 73 | pinMode(DQ3, INPUT); |
paul@2 | 74 | pinMode(DQ4, INPUT); |
paul@2 | 75 | pinMode(DQ5, INPUT); |
paul@2 | 76 | pinMode(DQ6, INPUT); |
paul@2 | 77 | pinMode(DQ7, INPUT); |
paul@2 | 78 | } |
paul@2 | 79 | |
paul@6 | 80 | int sampleData() |
paul@2 | 81 | { |
paul@31 | 82 | int i = 0; /* start at DQ7 */ |
paul@2 | 83 | int data = 0; |
paul@2 | 84 | |
paul@31 | 85 | while (i < 8) |
paul@2 | 86 | { |
paul@2 | 87 | data <<= 1; |
paul@31 | 88 | data += digitalRead(datapins[i]); |
paul@31 | 89 | i++; |
paul@2 | 90 | } |
paul@2 | 91 | |
paul@6 | 92 | return data; |
paul@6 | 93 | } |
paul@6 | 94 | |
paul@6 | 95 | int readData() |
paul@6 | 96 | { |
paul@6 | 97 | int data = 0; |
paul@6 | 98 | |
paul@6 | 99 | setDataIn(); |
paul@32 | 100 | delayMicroseconds(1); |
paul@6 | 101 | data = sampleData(); |
paul@2 | 102 | setDataOut(); |
paul@2 | 103 | return data; |
paul@2 | 104 | } |
paul@2 | 105 | |
paul@2 | 106 | void writeData(int data) |
paul@2 | 107 | { |
paul@31 | 108 | int i = 8; /* start at DQ0 */ |
paul@2 | 109 | |
paul@31 | 110 | while (i > 0) |
paul@2 | 111 | { |
paul@32 | 112 | i--; |
paul@31 | 113 | digitalWrite(datapins[i], data % 2); |
paul@2 | 114 | data >>= 1; |
paul@2 | 115 | } |
paul@2 | 116 | } |
paul@2 | 117 | |
paul@38 | 118 | #ifdef CIRCUIT_74HC273 |
paul@2 | 119 | void setAddress(int high, int low) |
paul@2 | 120 | { |
paul@28 | 121 | /* The top bit is sent directly. */ |
paul@28 | 122 | |
paul@28 | 123 | if (high & 0x100) |
paul@28 | 124 | digitalWrite(A16, HIGH); |
paul@28 | 125 | else |
paul@28 | 126 | digitalWrite(A16, LOW); |
paul@28 | 127 | |
paul@28 | 128 | /* The lower 16 bits are sent via the latches. */ |
paul@28 | 129 | |
paul@2 | 130 | writeData(high); |
paul@2 | 131 | delayMicroseconds(1); |
paul@2 | 132 | digitalWrite(CS2, HIGH); |
paul@2 | 133 | delayMicroseconds(1); |
paul@2 | 134 | digitalWrite(CS2, LOW); |
paul@2 | 135 | writeData(low); |
paul@2 | 136 | delayMicroseconds(1); |
paul@2 | 137 | digitalWrite(CS1, HIGH); |
paul@2 | 138 | delayMicroseconds(1); |
paul@2 | 139 | digitalWrite(CS1, LOW); |
paul@2 | 140 | } |
paul@38 | 141 | #endif |
paul@38 | 142 | |
paul@38 | 143 | #ifdef CIRCUIT_74HC595 |
paul@38 | 144 | void writeAddress(int v) |
paul@38 | 145 | { |
paul@38 | 146 | int mask; |
paul@38 | 147 | |
paul@38 | 148 | for (mask = 0x80; mask; mask >>= 1) |
paul@38 | 149 | { |
paul@38 | 150 | if (v & mask) |
paul@38 | 151 | { |
paul@38 | 152 | digitalWrite(SHIFT_SI, HIGH); |
paul@38 | 153 | } |
paul@38 | 154 | else |
paul@38 | 155 | { |
paul@38 | 156 | digitalWrite(SHIFT_SI, LOW); |
paul@38 | 157 | } |
paul@38 | 158 | |
paul@38 | 159 | delayMicroseconds(1); |
paul@38 | 160 | digitalWrite(SHIFT_SCK, HIGH); |
paul@38 | 161 | delayMicroseconds(1); |
paul@38 | 162 | digitalWrite(SHIFT_SCK, LOW); |
paul@38 | 163 | } |
paul@38 | 164 | |
paul@38 | 165 | delayMicroseconds(1); |
paul@38 | 166 | digitalWrite(SHIFT_RCK, HIGH); |
paul@38 | 167 | delayMicroseconds(1); |
paul@38 | 168 | digitalWrite(SHIFT_RCK, LOW); |
paul@38 | 169 | } |
paul@38 | 170 | |
paul@38 | 171 | void setAddress(int high, int low) |
paul@38 | 172 | { |
paul@38 | 173 | /* The top bit is sent directly. */ |
paul@38 | 174 | |
paul@38 | 175 | if (high & 0x100) |
paul@38 | 176 | digitalWrite(A16, HIGH); |
paul@38 | 177 | else |
paul@38 | 178 | digitalWrite(A16, LOW); |
paul@38 | 179 | |
paul@38 | 180 | /* The lower 16 bits are sent via the shift registers. */ |
paul@38 | 181 | |
paul@38 | 182 | writeAddress(high); |
paul@38 | 183 | writeAddress(low); |
paul@38 | 184 | } |
paul@38 | 185 | #endif |
paul@2 | 186 | |
paul@6 | 187 | int readOp(int high, int low) |
paul@2 | 188 | { |
paul@6 | 189 | int data; |
paul@2 | 190 | |
paul@3 | 191 | digitalWrite(CE, LOW); |
paul@2 | 192 | setAddress(high, low); |
paul@32 | 193 | delayMicroseconds(1); |
paul@2 | 194 | digitalWrite(OE, LOW); |
paul@2 | 195 | data = readData(); |
paul@32 | 196 | delayMicroseconds(1); |
paul@2 | 197 | digitalWrite(OE, HIGH); |
paul@3 | 198 | digitalWrite(CE, HIGH); |
paul@2 | 199 | |
paul@2 | 200 | return data; |
paul@2 | 201 | } |
paul@2 | 202 | |
paul@6 | 203 | void writeOp(int high, int low, int data) |
paul@6 | 204 | { |
paul@6 | 205 | digitalWrite(CE, LOW); |
paul@6 | 206 | setAddress(high, low); |
paul@32 | 207 | delayMicroseconds(1); |
paul@6 | 208 | digitalWrite(WE, LOW); |
paul@6 | 209 | writeData(data); |
paul@32 | 210 | delayMicroseconds(1); |
paul@6 | 211 | digitalWrite(WE, HIGH); |
paul@6 | 212 | digitalWrite(CE, HIGH); |
paul@6 | 213 | } |
paul@6 | 214 | |
paul@30 | 215 | int readCommand(const char buffer[], int nread) |
paul@6 | 216 | { |
paul@32 | 217 | int high, low; |
paul@6 | 218 | |
paul@32 | 219 | high = (fromHex(buffer[1]) << 8) + (fromHex(buffer[2]) << 4) + (fromHex(buffer[3])); |
paul@32 | 220 | low = (fromHex(buffer[4]) << 4) + (fromHex(buffer[5])); |
paul@6 | 221 | |
paul@6 | 222 | return readOp(high, low); |
paul@6 | 223 | } |
paul@6 | 224 | |
paul@30 | 225 | bool writeCommand(const char buffer[], int nread) |
paul@2 | 226 | { |
paul@32 | 227 | int high, low, data; |
paul@2 | 228 | |
paul@32 | 229 | high = (fromHex(buffer[1]) << 8) + (fromHex(buffer[2]) << 4) + (fromHex(buffer[3])); |
paul@32 | 230 | low = (fromHex(buffer[4]) << 4) + (fromHex(buffer[5])); |
paul@32 | 231 | data = (fromHex(buffer[6]) << 4) + (fromHex(buffer[7])); |
paul@2 | 232 | |
paul@6 | 233 | writeOp(high, low, data); |
paul@2 | 234 | |
paul@2 | 235 | return true; |
paul@2 | 236 | } |
paul@2 | 237 | |
paul@32 | 238 | bool haveCompletion(int data, int written) |
paul@32 | 239 | { |
paul@32 | 240 | return ((data & 0x80) == (written & 0x80)); |
paul@32 | 241 | } |
paul@32 | 242 | |
paul@32 | 243 | bool haveFault(int data) |
paul@32 | 244 | { |
paul@32 | 245 | return ((data & 0x20) != 0); |
paul@32 | 246 | } |
paul@32 | 247 | |
paul@6 | 248 | bool waitForCompletion(int high, int low, int written) |
paul@6 | 249 | { |
paul@32 | 250 | int data; |
paul@32 | 251 | bool match; |
paul@6 | 252 | |
paul@12 | 253 | setDataIn(); |
paul@12 | 254 | digitalWrite(CE, LOW); |
paul@12 | 255 | digitalWrite(OE, LOW); |
paul@12 | 256 | |
paul@6 | 257 | do |
paul@6 | 258 | { |
paul@32 | 259 | data = readOp(high, low); |
paul@32 | 260 | match = haveCompletion(data, written); |
paul@32 | 261 | } while (!match && !haveFault(data)); |
paul@6 | 262 | |
paul@32 | 263 | if (!match) |
paul@32 | 264 | { |
paul@32 | 265 | data = readOp(high, low); |
paul@32 | 266 | match = haveCompletion(data, written); |
paul@32 | 267 | } |
paul@32 | 268 | |
paul@32 | 269 | setDataOut(); |
paul@12 | 270 | digitalWrite(OE, HIGH); |
paul@12 | 271 | digitalWrite(CE, HIGH); |
paul@32 | 272 | return match; |
paul@32 | 273 | } |
paul@32 | 274 | |
paul@32 | 275 | bool reset() |
paul@32 | 276 | { |
paul@32 | 277 | for (int i = 0; i < 3; i++) |
paul@32 | 278 | { |
paul@32 | 279 | writeCommand(RESET[i], 7); |
paul@32 | 280 | } |
paul@6 | 281 | } |
paul@6 | 282 | |
paul@6 | 283 | bool chipErase() |
paul@6 | 284 | { |
paul@7 | 285 | for (int i = 0; i < 5; i++) |
paul@7 | 286 | { |
paul@30 | 287 | writeCommand(ERASE[i], 7); |
paul@7 | 288 | } |
paul@7 | 289 | writeOp(0x55, 0x55, 0x30); |
paul@6 | 290 | return waitForCompletion(0, 0, 0xff); |
paul@6 | 291 | } |
paul@6 | 292 | |
paul@13 | 293 | bool sectorErase(const char buffer[]) |
paul@6 | 294 | { |
paul@6 | 295 | int high; |
paul@6 | 296 | |
paul@29 | 297 | // 3-bit number shifted to A16...A14. |
paul@29 | 298 | // Thus, only sectors from 0 to 7 are supported. |
paul@6 | 299 | |
paul@29 | 300 | high = (fromHex(buffer[1]) << 6) & 0x1ff; |
paul@6 | 301 | |
paul@7 | 302 | for (int i = 0; i < 5; i++) |
paul@7 | 303 | { |
paul@30 | 304 | writeCommand(ERASE[i], 7); |
paul@7 | 305 | } |
paul@6 | 306 | writeOp(high, 0, 0x30); |
paul@6 | 307 | |
paul@6 | 308 | // Result of erase if 0xff written to all locations. |
paul@6 | 309 | |
paul@6 | 310 | return waitForCompletion(high, 0, 0xff); |
paul@6 | 311 | } |
paul@6 | 312 | |
paul@30 | 313 | bool program(const char buffer[], int nread) |
paul@6 | 314 | { |
paul@32 | 315 | int high, low, data; |
paul@6 | 316 | |
paul@32 | 317 | high = (fromHex(buffer[1]) << 8) + (fromHex(buffer[2]) << 4) + (fromHex(buffer[3])); |
paul@32 | 318 | low = (fromHex(buffer[4]) << 4) + (fromHex(buffer[5])); |
paul@32 | 319 | data = (fromHex(buffer[6]) << 4) + (fromHex(buffer[7])); |
paul@6 | 320 | |
paul@7 | 321 | for (int i = 0; i < 3; i++) |
paul@7 | 322 | { |
paul@30 | 323 | writeCommand(PROGRAM[i], 7); |
paul@7 | 324 | } |
paul@6 | 325 | writeOp(high, low, data); |
paul@6 | 326 | |
paul@6 | 327 | return waitForCompletion(high, low, data); |
paul@6 | 328 | } |
paul@6 | 329 | |
paul@2 | 330 | void setup() |
paul@2 | 331 | { |
paul@2 | 332 | Serial.begin(115200); |
paul@2 | 333 | pinMode(CE, OUTPUT); |
paul@2 | 334 | pinMode(OE, OUTPUT); |
paul@2 | 335 | pinMode(WE, OUTPUT); |
paul@28 | 336 | pinMode(A16, OUTPUT); |
paul@38 | 337 | |
paul@38 | 338 | #ifdef CIRCUIT_74HC273 |
paul@2 | 339 | pinMode(CS1, OUTPUT); |
paul@2 | 340 | pinMode(CS2, OUTPUT); |
paul@38 | 341 | #endif |
paul@38 | 342 | |
paul@38 | 343 | #ifdef CIRCUIT_74HC595 |
paul@38 | 344 | pinMode(SHIFT_SCK, OUTPUT); |
paul@38 | 345 | pinMode(SHIFT_RCK, OUTPUT); |
paul@38 | 346 | pinMode(SHIFT_SI, OUTPUT); |
paul@38 | 347 | #endif |
paul@38 | 348 | |
paul@2 | 349 | setDataOut(); |
paul@2 | 350 | |
paul@2 | 351 | // Initial state for the flash device. |
paul@2 | 352 | |
paul@2 | 353 | digitalWrite(CE, HIGH); |
paul@2 | 354 | digitalWrite(OE, HIGH); |
paul@2 | 355 | digitalWrite(WE, HIGH); |
paul@28 | 356 | digitalWrite(A16, LOW); |
paul@2 | 357 | |
paul@2 | 358 | // Initial state for the latches. |
paul@2 | 359 | |
paul@38 | 360 | #ifdef CIRCUIT_74HC273 |
paul@2 | 361 | digitalWrite(CS1, LOW); |
paul@2 | 362 | digitalWrite(CS2, LOW); |
paul@38 | 363 | #endif |
paul@38 | 364 | |
paul@38 | 365 | #ifdef CIRCUIT_74HC595 |
paul@38 | 366 | digitalWrite(SHIFT_SCK, LOW); |
paul@38 | 367 | digitalWrite(SHIFT_RCK, LOW); |
paul@38 | 368 | #endif |
paul@2 | 369 | |
paul@2 | 370 | // Interface loop. |
paul@2 | 371 | |
paul@3 | 372 | Serial.println("?"); |
paul@6 | 373 | } |
paul@2 | 374 | |
paul@6 | 375 | void loop() |
paul@6 | 376 | { |
paul@32 | 377 | /* Read bytes, obtaining the number read excluding any newline terminator. */ |
paul@32 | 378 | |
paul@13 | 379 | if (nread += Serial.readBytesUntil('\n', inbuffer + nread, BUFSIZE - nread)) |
paul@2 | 380 | { |
paul@32 | 381 | /* Handle each command, waiting for the newline. */ |
paul@32 | 382 | |
paul@6 | 383 | switch (inbuffer[0]) |
paul@2 | 384 | { |
paul@32 | 385 | case 'r': |
paul@32 | 386 | reset(); |
paul@32 | 387 | Serial.println("r"); |
paul@32 | 388 | nread = 0; |
paul@32 | 389 | break; |
paul@32 | 390 | |
paul@2 | 391 | case 'R': |
paul@32 | 392 | if (nread >= 6) |
paul@13 | 393 | { |
paul@30 | 394 | Serial.println(readCommand(inbuffer, nread), HEX); |
paul@13 | 395 | nread = 0; |
paul@13 | 396 | } |
paul@2 | 397 | break; |
paul@2 | 398 | |
paul@2 | 399 | case 'W': |
paul@32 | 400 | if (nread >= 8) |
paul@13 | 401 | { |
paul@30 | 402 | if (writeCommand(inbuffer, nread)) |
paul@13 | 403 | Serial.println("W"); |
paul@13 | 404 | else |
paul@13 | 405 | Serial.println("C"); |
paul@13 | 406 | nread = 0; |
paul@13 | 407 | } |
paul@2 | 408 | break; |
paul@2 | 409 | |
paul@6 | 410 | case 'E': |
paul@6 | 411 | if (chipErase()) |
paul@6 | 412 | Serial.println("E"); |
paul@6 | 413 | else |
paul@6 | 414 | Serial.println("C"); |
paul@13 | 415 | nread = 0; |
paul@6 | 416 | break; |
paul@6 | 417 | |
paul@6 | 418 | case 'S': |
paul@13 | 419 | if (nread >= 2) |
paul@13 | 420 | { |
paul@13 | 421 | if (sectorErase(inbuffer)) |
paul@13 | 422 | Serial.println("S"); |
paul@13 | 423 | else |
paul@13 | 424 | Serial.println("C"); |
paul@13 | 425 | nread = 0; |
paul@13 | 426 | } |
paul@6 | 427 | break; |
paul@6 | 428 | |
paul@6 | 429 | case 'P': |
paul@32 | 430 | if (nread >= 8) |
paul@13 | 431 | { |
paul@30 | 432 | if (program(inbuffer, nread)) |
paul@13 | 433 | Serial.println("P"); |
paul@13 | 434 | else |
paul@13 | 435 | Serial.println("C"); |
paul@13 | 436 | nread = 0; |
paul@13 | 437 | } |
paul@6 | 438 | break; |
paul@6 | 439 | |
paul@2 | 440 | default: |
paul@12 | 441 | Serial.println(inbuffer[0]); |
paul@13 | 442 | nread = 0; |
paul@2 | 443 | break; |
paul@2 | 444 | } |
paul@12 | 445 | |
paul@12 | 446 | Serial.flush(); |
paul@2 | 447 | } |
paul@2 | 448 | } |
paul@2 | 449 | |
paul@2 | 450 | extern "C" void __cxa_pure_virtual(void) { |
paul@2 | 451 | while(1); |
paul@2 | 452 | } |
paul@2 | 453 | |
paul@2 | 454 | // tabstop=4 expandtab shiftwidth=4 |