blob: c9f4b4fb7f461f036f5d0576badb015e53e9769d [file] [log] [blame]
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +00001/*
2 * msys_doc.c: driver for programming m-systems doc devices
3 *
4 *
5 * Copyright 2003 Niki W. Waibel <niki.waibel@gmx.net>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
22
23
24#include <stdio.h>
25#include <unistd.h>
26#include "flash.h"
27#include "msys_doc.h"
Ollie Lho184a4042005-11-26 21:55:36 +000028#include "debug.h"
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000029
30
31
32
Ollie Lho184a4042005-11-26 21:55:36 +000033static int doc_wait(volatile uint8_t *bios, int timeout);
34static uint8_t doc_read_chipid(volatile uint8_t *bios);
35static uint8_t doc_read_docstatus(volatile uint8_t *bios);
36static uint8_t doc_read_cdsncontrol(volatile uint8_t *bios);
37static void doc_write_cdsncontrol(volatile uint8_t *bios, uint8_t data);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000038
39
40
41
42
Ollie Lho761bf1b2004-03-20 16:46:10 +000043int probe_md2802(struct flashchip *flash)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000044{
Ollie Lho184a4042005-11-26 21:55:36 +000045 volatile uint8_t *bios = flash->virt_addr;
46 uint8_t chipid;
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000047#ifndef MSYSTEMS_DOC_NO_55AA_CHECKING
Ollie Lho184a4042005-11-26 21:55:36 +000048 uint8_t id_0x55, id_0xAA;
Ollie Lho761bf1b2004-03-20 16:46:10 +000049#endif /* !MSYSTEMS_DOC_NO_55AA_CHECKING */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000050 int i, toggle_a, toggle_b;
51
Ollie Lho184a4042005-11-26 21:55:36 +000052 printf_debug("%s:\n", __FUNCTION__);
53 printf_debug("%s: *******************************\n", __FUNCTION__);
54 printf_debug("%s: * THIS IS A PRE ALPHA VERSION *\n", __FUNCTION__);
55 printf_debug("%s: * IN THE DEVELOPEMENT *********\n", __FUNCTION__);
56 printf_debug("%s: * PROCESS RIGHT NOW. **********\n", __FUNCTION__);
57 printf_debug("%s: *******************************\n", __FUNCTION__);
58 printf_debug("%s: * IF YOU ARE NOT A DEVELOPER **\n", __FUNCTION__);
59 printf_debug("%s: * THEN DO NOT TRY TO READ OR **\n", __FUNCTION__);
60 printf_debug("%s: * WRITE TO THIS DEVICE ********\n", __FUNCTION__);
61 printf_debug("%s: *******************************\n", __FUNCTION__);
62 printf_debug("%s:\n", __FUNCTION__);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000063
Ollie Lho184a4042005-11-26 21:55:36 +000064 printf_debug("%s: switching off reset mode ...\n", __FUNCTION__);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000065 doc_write(0x85, bios, DOCControl);
66 doc_write(0x85, bios, DOCControl);
67 doc_read_4nop(bios);
Ollie Lho761bf1b2004-03-20 16:46:10 +000068 if (doc_wait(bios, 5000))
69 return (-1);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000070 printf("%s: switching off reset mode ... done\n", __FUNCTION__);
71 printf("%s:\n", __FUNCTION__);
72
73 printf("%s: switching off write protection ...\n", __FUNCTION__);
Ollie Lho761bf1b2004-03-20 16:46:10 +000074 doc_write_cdsncontrol(bios, doc_read_cdsncontrol(bios) & (~0x08));
75 printf("%s: switching off write protection ... done\n",
76 __FUNCTION__);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000077 printf("%s:\n", __FUNCTION__);
78
79
80 chipid = doc_read_chipid(bios);
81#ifndef MSYSTEMS_DOC_NO_55AA_CHECKING
82 id_0x55 = doc_read(bios, IPL_0x0000);
83 id_0xAA = doc_read(bios, IPL_0x0001);
Ollie Lho761bf1b2004-03-20 16:46:10 +000084#endif /* !MSYSTEMS_DOC_NO_55AA_CHECKING */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000085 printf("%s: IPL_0x0000: 0x%02x\n", __FUNCTION__, id_0x55);
86 printf("%s: IPL_0x0001: 0x%02x\n", __FUNCTION__, id_0xAA);
87 printf("%s: IPL_0x0002: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000088 doc_read(bios, IPL_0x0002));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000089 printf("%s: IPL_0x0003: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000090 doc_read(bios, IPL_0x0003));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000091 printf("%s:\n", __FUNCTION__);
92 printf("%s: ChipID: 0x%02x\n", __FUNCTION__, chipid);
93 printf("%s: DOCStatus: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000094 doc_read_docstatus(bios));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000095 printf("%s: FloorSelect: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000096 doc_read(bios, FloorSelect));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000097 printf("%s: CDSNControl: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000098 doc_read_cdsncontrol(bios));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000099 printf("%s: CDSNDeviceSelect: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000100 doc_read(bios, CDSNDeviceSelect));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000101 printf("%s: ECCConfiguration: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000102 doc_read(bios, ECCConfiguration));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000103 printf("%s: CDSNSlowIO: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000104 doc_read(bios, CDSNSlowIO));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000105 printf("%s: ECCSyndrome0: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000106 doc_read(bios, ECCSyndrome0));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000107 printf("%s: ECCSyndrome1: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000108 doc_read(bios, ECCSyndrome1));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000109 printf("%s: ECCSyndrome2: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000110 doc_read(bios, ECCSyndrome2));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000111 printf("%s: ECCSyndrome3: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000112 doc_read(bios, ECCSyndrome3));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000113 printf("%s: ECCSyndrome4: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000114 doc_read(bios, ECCSyndrome4));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000115 printf("%s: ECCSyndrome5: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000116 doc_read(bios, ECCSyndrome5));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000117 printf("%s: AliasResolution: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000118 doc_read(bios, AliasResolution));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000119 printf("%s: ConfigurationInput: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000120 doc_read(bios, ConfigurationInput));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000121 printf("%s: ReadPipelineInitialization: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000122 doc_read(bios, ReadPipelineInitialization));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000123 printf("%s: LastDataRead: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000124 doc_read(bios, LastDataRead));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000125 printf("%s:\n", __FUNCTION__);
126
127 printf("%s: checking ECCConfiguration toggle bit\n", __FUNCTION__);
128 printf("%s:", __FUNCTION__);
129 toggle_a = toggle_b = 0;
Ollie Lho761bf1b2004-03-20 16:46:10 +0000130 for (i = 0; i < 10; i++) {
Ollie Lho184a4042005-11-26 21:55:36 +0000131 uint8_t toggle = doc_toggle(bios);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000132
133 printf(" 0x%02x", toggle);
134
Ollie Lho761bf1b2004-03-20 16:46:10 +0000135 if (i % 2)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000136 toggle_a += toggle;
137 else
138 toggle_b += toggle;
Ollie Lho761bf1b2004-03-20 16:46:10 +0000139 } /* for(i=0; i<10; i++) */
140 printf("\n%s: toggle result: %d/%d\n", __FUNCTION__, toggle_a,
141 toggle_b);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000142
Ollie Lho761bf1b2004-03-20 16:46:10 +0000143 if (chipid == flash->model_id
144 && ((toggle_a == 5 && toggle_b == 0)
145 || (toggle_a == 0 && toggle_b == 5))
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000146#ifndef MSYSTEMS_DOC_NO_55AA_CHECKING
Ollie Lho761bf1b2004-03-20 16:46:10 +0000147 && id_0x55 == 0x55 && id_0xAA == 0xaa
148#endif /* !MSYSTEMS_DOC_NO_55AA_CHECKING */
149 ) {
150 return (1);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000151 }
152
Ollie Lho761bf1b2004-03-20 16:46:10 +0000153 return (0);
154} /* int probe_md2802(struct flashchip *flash) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000155
156
157
Ollie Lho184a4042005-11-26 21:55:36 +0000158int read_md2802(struct flashchip *flash, uint8_t *buf)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000159{
Ollie Lho761bf1b2004-03-20 16:46:10 +0000160
161 return (0);
Ollie Lho184a4042005-11-26 21:55:36 +0000162} /* int read_md2802(struct flashchip *flash, uint8_t *buf) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000163
164
165
Ollie Lho761bf1b2004-03-20 16:46:10 +0000166int erase_md2802(struct flashchip *flash)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000167{
Ollie Lho184a4042005-11-26 21:55:36 +0000168 volatile uint8_t *bios = flash->virt_addr;
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000169
Ollie Lho761bf1b2004-03-20 16:46:10 +0000170 return (1);
Ollie Lho184a4042005-11-26 21:55:36 +0000171 *(volatile uint8_t *) (bios + 0x5555) = 0xAA;
172 *(volatile uint8_t *) (bios + 0x2AAA) = 0x55;
173 *(volatile uint8_t *) (bios + 0x5555) = 0x80;
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000174
Ollie Lho184a4042005-11-26 21:55:36 +0000175 *(volatile uint8_t *) (bios + 0x5555) = 0xAA;
176 *(volatile uint8_t *) (bios + 0x2AAA) = 0x55;
177 *(volatile uint8_t *) (bios + 0x5555) = 0x10;
Ollie Lho761bf1b2004-03-20 16:46:10 +0000178} /* int erase_md2802(struct flashchip *flash) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000179
180
181
Ollie Lho184a4042005-11-26 21:55:36 +0000182int write_md2802(struct flashchip *flash, uint8_t *buf)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000183{
184 int i;
Ollie Lho761bf1b2004-03-20 16:46:10 +0000185 int total_size = flash->total_size * 1024, page_size =
186 flash->page_size;
Ollie Lho184a4042005-11-26 21:55:36 +0000187 volatile uint8_t *bios = flash->virt_addr;
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000188
Ollie Lho761bf1b2004-03-20 16:46:10 +0000189 return (1);
190 erase_md2802(flash);
Ollie Lho184a4042005-11-26 21:55:36 +0000191 if (*bios != (uint8_t) 0xff) {
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000192 printf("ERASE FAILED\n");
193 return -1;
194 }
Ollie Lho761bf1b2004-03-20 16:46:10 +0000195 printf("Programming Page: ");
196 for (i = 0; i < total_size / page_size; i++) {
197 printf("%04d at address: 0x%08x", i, i * page_size);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000198 //write_page_md2802(bios, buf + i * page_size, bios + i * page_size, page_size);
Ollie Lho761bf1b2004-03-20 16:46:10 +0000199 printf
200 ("\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b");
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000201 }
202 printf("\n");
203 //protect_md2802(bios);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000204
Ronald G. Minniche66bdb32004-04-13 19:10:48 +0000205 return 0;
Ollie Lho184a4042005-11-26 21:55:36 +0000206} /* int write_md2802(struct flashchip *flash, uint8_t *buf) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000207
208
209
210
211
212
213/*
214 wait timeout msec for doc to become ready
215 return:
216 0: ready
217 -1: timeout expired
218*/
Ollie Lho184a4042005-11-26 21:55:36 +0000219static int doc_wait(volatile uint8_t *bios, int timeout)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000220{
221 int i = 20;
222
223 doc_read_4nop(bios);
224
Ollie Lho761bf1b2004-03-20 16:46:10 +0000225 while (_doc_busy(bios) && (i != 0)) {
226 usleep(timeout * 1000 / 20);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000227 i--;
228 }
229
230 doc_read_2nop(bios);
231
Ollie Lho761bf1b2004-03-20 16:46:10 +0000232 if (_doc_busy(bios)) {
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000233 doc_read_2nop(bios);
Ollie Lho761bf1b2004-03-20 16:46:10 +0000234 return (-1);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000235 }
236
Ollie Lho761bf1b2004-03-20 16:46:10 +0000237 return (0);
Ollie Lho184a4042005-11-26 21:55:36 +0000238} /* static int doc_wait(volatile uint8_t *bios, int timeout) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000239
240
241
Ollie Lho184a4042005-11-26 21:55:36 +0000242static uint8_t doc_read_docstatus(volatile uint8_t *bios)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000243{
244 doc_read(bios, CDSNSlowIO);
245 doc_read_2nop(bios);
246
Ollie Lho761bf1b2004-03-20 16:46:10 +0000247 return (doc_read(bios, _DOCStatus));
Ollie Lho184a4042005-11-26 21:55:36 +0000248} /* static uint8_t doc_read_docstatus(volatile uint8_t *bios) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000249
250
251
Ollie Lho184a4042005-11-26 21:55:36 +0000252static uint8_t doc_read_chipid(volatile uint8_t *bios)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000253{
254 doc_read(bios, CDSNSlowIO);
255 doc_read_2nop(bios);
256
Ollie Lho761bf1b2004-03-20 16:46:10 +0000257 return (doc_read(bios, _ChipID));
Ollie Lho184a4042005-11-26 21:55:36 +0000258} /* static uint8_t doc_read_chipid(volatile uint8_t *bios) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000259
260
261
Ollie Lho184a4042005-11-26 21:55:36 +0000262static uint8_t doc_read_cdsncontrol(volatile uint8_t *bios)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000263{
Ollie Lho184a4042005-11-26 21:55:36 +0000264 uint8_t value;
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000265
266 /* the delays might be necessary when reading the busy bit,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000267 but because a read to this reg reads the busy bit
268 anyway we better do this delays... */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000269 doc_read_4nop(bios);
270 value = doc_read(bios, _CDSNControl);
271 doc_read_2nop(bios);
272
Ollie Lho761bf1b2004-03-20 16:46:10 +0000273 return (value);
Ollie Lho184a4042005-11-26 21:55:36 +0000274} /* static uint8_t doc_read_chipid(volatile char *bios) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000275
276
277
Ollie Lho184a4042005-11-26 21:55:36 +0000278static void doc_write_cdsncontrol(volatile uint8_t *bios, uint8_t data)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000279{
280 doc_write(data, bios, _CDSNControl);
281 doc_read_4nop(bios);
Ollie Lho184a4042005-11-26 21:55:36 +0000282} /* static void doc_write_chipid(volatile char *bios, uint8_t data) */