blob: 64bc87e3f201e08a684c4066af7bf0efed6a1179 [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
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000022#include <stdio.h>
23#include <unistd.h>
24#include "flash.h"
25#include "msys_doc.h"
Ollie Lho184a4042005-11-26 21:55:36 +000026#include "debug.h"
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000027
Ollie Lho184a4042005-11-26 21:55:36 +000028static int doc_wait(volatile uint8_t *bios, int timeout);
29static uint8_t doc_read_chipid(volatile uint8_t *bios);
30static uint8_t doc_read_docstatus(volatile uint8_t *bios);
31static uint8_t doc_read_cdsncontrol(volatile uint8_t *bios);
32static void doc_write_cdsncontrol(volatile uint8_t *bios, uint8_t data);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000033
Ollie Lho761bf1b2004-03-20 16:46:10 +000034int probe_md2802(struct flashchip *flash)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000035{
Stefan Reinauerce532972007-05-23 17:20:56 +000036 volatile uint8_t *bios = flash->virtual_memory;
Ollie Lho184a4042005-11-26 21:55:36 +000037 uint8_t chipid;
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000038#ifndef MSYSTEMS_DOC_NO_55AA_CHECKING
Ollie Lho184a4042005-11-26 21:55:36 +000039 uint8_t id_0x55, id_0xAA;
Ollie Lho761bf1b2004-03-20 16:46:10 +000040#endif /* !MSYSTEMS_DOC_NO_55AA_CHECKING */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000041 int i, toggle_a, toggle_b;
42
Ollie Lho184a4042005-11-26 21:55:36 +000043 printf_debug("%s:\n", __FUNCTION__);
44 printf_debug("%s: *******************************\n", __FUNCTION__);
45 printf_debug("%s: * THIS IS A PRE ALPHA VERSION *\n", __FUNCTION__);
46 printf_debug("%s: * IN THE DEVELOPEMENT *********\n", __FUNCTION__);
47 printf_debug("%s: * PROCESS RIGHT NOW. **********\n", __FUNCTION__);
48 printf_debug("%s: *******************************\n", __FUNCTION__);
49 printf_debug("%s: * IF YOU ARE NOT A DEVELOPER **\n", __FUNCTION__);
50 printf_debug("%s: * THEN DO NOT TRY TO READ OR **\n", __FUNCTION__);
51 printf_debug("%s: * WRITE TO THIS DEVICE ********\n", __FUNCTION__);
52 printf_debug("%s: *******************************\n", __FUNCTION__);
53 printf_debug("%s:\n", __FUNCTION__);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000054
Ollie Lho184a4042005-11-26 21:55:36 +000055 printf_debug("%s: switching off reset mode ...\n", __FUNCTION__);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000056 doc_write(0x85, bios, DOCControl);
57 doc_write(0x85, bios, DOCControl);
58 doc_read_4nop(bios);
Ollie Lho761bf1b2004-03-20 16:46:10 +000059 if (doc_wait(bios, 5000))
60 return (-1);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000061 printf("%s: switching off reset mode ... done\n", __FUNCTION__);
62 printf("%s:\n", __FUNCTION__);
63
64 printf("%s: switching off write protection ...\n", __FUNCTION__);
Ollie Lho761bf1b2004-03-20 16:46:10 +000065 doc_write_cdsncontrol(bios, doc_read_cdsncontrol(bios) & (~0x08));
Uwe Hermanna7e05482007-05-09 10:17:44 +000066 printf("%s: switching off write protection ... done\n", __FUNCTION__);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000067 printf("%s:\n", __FUNCTION__);
68
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000069 chipid = doc_read_chipid(bios);
70#ifndef MSYSTEMS_DOC_NO_55AA_CHECKING
71 id_0x55 = doc_read(bios, IPL_0x0000);
72 id_0xAA = doc_read(bios, IPL_0x0001);
Ollie Lho761bf1b2004-03-20 16:46:10 +000073#endif /* !MSYSTEMS_DOC_NO_55AA_CHECKING */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000074 printf("%s: IPL_0x0000: 0x%02x\n", __FUNCTION__, id_0x55);
75 printf("%s: IPL_0x0001: 0x%02x\n", __FUNCTION__, id_0xAA);
76 printf("%s: IPL_0x0002: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000077 doc_read(bios, IPL_0x0002));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000078 printf("%s: IPL_0x0003: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000079 doc_read(bios, IPL_0x0003));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000080 printf("%s:\n", __FUNCTION__);
81 printf("%s: ChipID: 0x%02x\n", __FUNCTION__, chipid);
82 printf("%s: DOCStatus: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000083 doc_read_docstatus(bios));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000084 printf("%s: FloorSelect: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000085 doc_read(bios, FloorSelect));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000086 printf("%s: CDSNControl: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000087 doc_read_cdsncontrol(bios));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000088 printf("%s: CDSNDeviceSelect: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000089 doc_read(bios, CDSNDeviceSelect));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000090 printf("%s: ECCConfiguration: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000091 doc_read(bios, ECCConfiguration));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000092 printf("%s: CDSNSlowIO: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000093 doc_read(bios, CDSNSlowIO));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000094 printf("%s: ECCSyndrome0: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000095 doc_read(bios, ECCSyndrome0));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000096 printf("%s: ECCSyndrome1: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000097 doc_read(bios, ECCSyndrome1));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000098 printf("%s: ECCSyndrome2: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +000099 doc_read(bios, ECCSyndrome2));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000100 printf("%s: ECCSyndrome3: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000101 doc_read(bios, ECCSyndrome3));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000102 printf("%s: ECCSyndrome4: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000103 doc_read(bios, ECCSyndrome4));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000104 printf("%s: ECCSyndrome5: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000105 doc_read(bios, ECCSyndrome5));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000106 printf("%s: AliasResolution: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000107 doc_read(bios, AliasResolution));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000108 printf("%s: ConfigurationInput: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000109 doc_read(bios, ConfigurationInput));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000110 printf("%s: ReadPipelineInitialization: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000111 doc_read(bios, ReadPipelineInitialization));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000112 printf("%s: LastDataRead: 0x%02x\n", __FUNCTION__,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000113 doc_read(bios, LastDataRead));
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000114 printf("%s:\n", __FUNCTION__);
115
116 printf("%s: checking ECCConfiguration toggle bit\n", __FUNCTION__);
117 printf("%s:", __FUNCTION__);
118 toggle_a = toggle_b = 0;
Ollie Lho761bf1b2004-03-20 16:46:10 +0000119 for (i = 0; i < 10; i++) {
Ollie Lho184a4042005-11-26 21:55:36 +0000120 uint8_t toggle = doc_toggle(bios);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000121
122 printf(" 0x%02x", toggle);
123
Ollie Lho761bf1b2004-03-20 16:46:10 +0000124 if (i % 2)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000125 toggle_a += toggle;
126 else
127 toggle_b += toggle;
Ollie Lho761bf1b2004-03-20 16:46:10 +0000128 } /* for(i=0; i<10; i++) */
129 printf("\n%s: toggle result: %d/%d\n", __FUNCTION__, toggle_a,
130 toggle_b);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000131
Uwe Hermanna7e05482007-05-09 10:17:44 +0000132 if (chipid == flash->model_id && ((toggle_a == 5 && toggle_b == 0)
133 || (toggle_a == 0 && toggle_b == 5))
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000134#ifndef MSYSTEMS_DOC_NO_55AA_CHECKING
Ollie Lho761bf1b2004-03-20 16:46:10 +0000135 && id_0x55 == 0x55 && id_0xAA == 0xaa
136#endif /* !MSYSTEMS_DOC_NO_55AA_CHECKING */
137 ) {
138 return (1);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000139 }
140
Ollie Lho761bf1b2004-03-20 16:46:10 +0000141 return (0);
142} /* int probe_md2802(struct flashchip *flash) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000143
Ollie Lho184a4042005-11-26 21:55:36 +0000144int read_md2802(struct flashchip *flash, uint8_t *buf)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000145{
Ollie Lho761bf1b2004-03-20 16:46:10 +0000146
147 return (0);
Ollie Lho184a4042005-11-26 21:55:36 +0000148} /* int read_md2802(struct flashchip *flash, uint8_t *buf) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000149
Ollie Lho761bf1b2004-03-20 16:46:10 +0000150int erase_md2802(struct flashchip *flash)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000151{
Stefan Reinauerce532972007-05-23 17:20:56 +0000152 volatile uint8_t *bios = flash->virtual_memory;
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000153
Ollie Lho761bf1b2004-03-20 16:46:10 +0000154 return (1);
Uwe Hermanna7e05482007-05-09 10:17:44 +0000155 *(volatile uint8_t *)(bios + 0x5555) = 0xAA;
156 *(volatile uint8_t *)(bios + 0x2AAA) = 0x55;
157 *(volatile uint8_t *)(bios + 0x5555) = 0x80;
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000158
Uwe Hermanna7e05482007-05-09 10:17:44 +0000159 *(volatile uint8_t *)(bios + 0x5555) = 0xAA;
160 *(volatile uint8_t *)(bios + 0x2AAA) = 0x55;
161 *(volatile uint8_t *)(bios + 0x5555) = 0x10;
Ollie Lho761bf1b2004-03-20 16:46:10 +0000162} /* int erase_md2802(struct flashchip *flash) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000163
Ollie Lho184a4042005-11-26 21:55:36 +0000164int write_md2802(struct flashchip *flash, uint8_t *buf)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000165{
166 int i;
Uwe Hermanna7e05482007-05-09 10:17:44 +0000167 int total_size = flash->total_size * 1024;
168 int page_size = flash->page_size;
Stefan Reinauerce532972007-05-23 17:20:56 +0000169 volatile uint8_t *bios = flash->virtual_memory;
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000170
Ollie Lho761bf1b2004-03-20 16:46:10 +0000171 return (1);
172 erase_md2802(flash);
Ollie Lho184a4042005-11-26 21:55:36 +0000173 if (*bios != (uint8_t) 0xff) {
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000174 printf("ERASE FAILED\n");
175 return -1;
176 }
Ollie Lho761bf1b2004-03-20 16:46:10 +0000177 printf("Programming Page: ");
178 for (i = 0; i < total_size / page_size; i++) {
179 printf("%04d at address: 0x%08x", i, i * page_size);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000180 //write_page_md2802(bios, buf + i * page_size, bios + i * page_size, page_size);
Ollie Lho761bf1b2004-03-20 16:46:10 +0000181 printf
182 ("\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 +0000183 }
184 printf("\n");
185 //protect_md2802(bios);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000186
Ronald G. Minniche66bdb32004-04-13 19:10:48 +0000187 return 0;
Ollie Lho184a4042005-11-26 21:55:36 +0000188} /* int write_md2802(struct flashchip *flash, uint8_t *buf) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000189
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000190/*
191 wait timeout msec for doc to become ready
192 return:
193 0: ready
194 -1: timeout expired
195*/
Ollie Lho184a4042005-11-26 21:55:36 +0000196static int doc_wait(volatile uint8_t *bios, int timeout)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000197{
198 int i = 20;
199
200 doc_read_4nop(bios);
201
Ollie Lho761bf1b2004-03-20 16:46:10 +0000202 while (_doc_busy(bios) && (i != 0)) {
203 usleep(timeout * 1000 / 20);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000204 i--;
205 }
206
207 doc_read_2nop(bios);
208
Ollie Lho761bf1b2004-03-20 16:46:10 +0000209 if (_doc_busy(bios)) {
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000210 doc_read_2nop(bios);
Ollie Lho761bf1b2004-03-20 16:46:10 +0000211 return (-1);
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000212 }
213
Ollie Lho761bf1b2004-03-20 16:46:10 +0000214 return (0);
Ollie Lho184a4042005-11-26 21:55:36 +0000215} /* static int doc_wait(volatile uint8_t *bios, int timeout) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000216
Ollie Lho184a4042005-11-26 21:55:36 +0000217static uint8_t doc_read_docstatus(volatile uint8_t *bios)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000218{
219 doc_read(bios, CDSNSlowIO);
220 doc_read_2nop(bios);
221
Ollie Lho761bf1b2004-03-20 16:46:10 +0000222 return (doc_read(bios, _DOCStatus));
Ollie Lho184a4042005-11-26 21:55:36 +0000223} /* static uint8_t doc_read_docstatus(volatile uint8_t *bios) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000224
Ollie Lho184a4042005-11-26 21:55:36 +0000225static uint8_t doc_read_chipid(volatile uint8_t *bios)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000226{
227 doc_read(bios, CDSNSlowIO);
228 doc_read_2nop(bios);
229
Ollie Lho761bf1b2004-03-20 16:46:10 +0000230 return (doc_read(bios, _ChipID));
Ollie Lho184a4042005-11-26 21:55:36 +0000231} /* static uint8_t doc_read_chipid(volatile uint8_t *bios) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000232
Ollie Lho184a4042005-11-26 21:55:36 +0000233static uint8_t doc_read_cdsncontrol(volatile uint8_t *bios)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000234{
Ollie Lho184a4042005-11-26 21:55:36 +0000235 uint8_t value;
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000236
237 /* the delays might be necessary when reading the busy bit,
Ollie Lho761bf1b2004-03-20 16:46:10 +0000238 but because a read to this reg reads the busy bit
239 anyway we better do this delays... */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000240 doc_read_4nop(bios);
241 value = doc_read(bios, _CDSNControl);
242 doc_read_2nop(bios);
243
Ollie Lho761bf1b2004-03-20 16:46:10 +0000244 return (value);
Ollie Lho184a4042005-11-26 21:55:36 +0000245} /* static uint8_t doc_read_chipid(volatile char *bios) */
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000246
Ollie Lho184a4042005-11-26 21:55:36 +0000247static void doc_write_cdsncontrol(volatile uint8_t *bios, uint8_t data)
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +0000248{
249 doc_write(data, bios, _CDSNControl);
250 doc_read_4nop(bios);
Ollie Lho184a4042005-11-26 21:55:36 +0000251} /* static void doc_write_chipid(volatile char *bios, uint8_t data) */