famicom ROM cartridge utility - unagi
flash memory driver
-Copyright (C) 2008 sato_tiff
+Copyright (C) 2008 ±·³«È¯¶¨Æ±Áȹç
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
#include <stdlib.h>
#include <string.h>
#include <windows.h>
-#include "driver_master.h"
+#include "type.h"
+#include "header.h"
#include "flashmemory.h"
/*
driver for Winbond W29C020, W49F002
*/
/*
-----memory detail----
-VRC6 CPU memory bank
-cpu address|rom address |page|task
-$8000-$bfff|0x00000-0x03fff|0 |write 0x2aaa+0x8000
-$c000-$dfff|0x04000-0x05fff|2 |write 0x5555+0x8000
-$e000-$efff|0x3e000-0x3ffff|fix |boot area
-
-MMC3 CPU memory bank
-cpu address|rom address |page|task
-$8000-$9fff|0x02000-0x03fff|1 |write 0x2aaa+0x8000-0x2000
-$a000-$bfff|0x04000-0x05fff|2 |write 0x5555+0x8000-0x4000
-$c000-$efff|ËöÈø |fix |boot area
-
-generic CPU memory bank
-cpu address|rom address |page|task
-$8000-$9fff|0x02000-0x03fff|1 |write 0x2aaa+0x8000-0x2000
-$a000-$bfff|0x04000-0x05fff|2 |write 0x5555+0x8000-0x4000
-$c000-$dfff|n * 0x2000 |n |write area
-$e000-$efff|ËöÈø |fix |boot area, ̤»ÈÍÑ
-
-generic PPU memory bank
-ppu address|rom address |page|task
-$0000-$03ff|0x02800-0x02bff|0x0a|write 0x2aaa-0x2800
-$0400-$07ff|0x05400-0x057ff|0x15|write 0x5555-0x5400
-$0800-$0fff|̤»ÈÍÑ
-$1000-$1fff|n * 0x0400 |n |write area
-*/
-/*
JEDEC flash memory command
http://www.sst.com/downloads/software_driver/SST49LF002A.txt
*/
long address, data;
};
enum{
- flash_task_end = 0x46494649
+ ADDRESS_0000 = 0,
+ ADDRESS_2AAA = 0x2aaa,
+ ADDRESS_5555 = 0x5555,
+ FLASH_COMMAND_END
};
static const struct flash_task PRODUCTID_ENTRY[] = {
- {0x5555, 0xaa},
- {0x2aaa, 0x55},
- {0x5555, 0x90},
- {flash_task_end, 0}
+ {ADDRESS_5555, 0xaa},
+ {ADDRESS_2AAA, 0x55},
+ {ADDRESS_5555, 0x90},
+ {FLASH_COMMAND_END, 0}
};
static const struct flash_task PRODUCTID_EXIT[] = {
- {0x5555, 0xaa},
- {0x2aaa, 0x55},
- {0x5555, 0xf0},
- {flash_task_end, 0}
+ {ADDRESS_5555, 0xaa},
+ {ADDRESS_2AAA, 0x55},
+ {ADDRESS_5555, 0xf0},
+ {FLASH_COMMAND_END, 0}
};
static const struct flash_task PROTECT_DISABLE[] = {
- {0x5555, 0xaa},
- {0x2aaa, 0x55},
- {0x5555, 0xa0},
- {flash_task_end, 0}
+ {ADDRESS_5555, 0xaa},
+ {ADDRESS_2AAA, 0x55},
+ {ADDRESS_5555, 0xa0},
+ {FLASH_COMMAND_END, 0}
};
static const struct flash_task PROTECT_ENABLE[] = {
- {0x5555, 0xaa},
- {0x2aaa, 0x55},
- {0x5555, 0x80},
- {0x5555, 0xaa},
- {0x2aaa, 0x55},
- {0x5555, 0x20},
- {flash_task_end, 0}
+ {ADDRESS_5555, 0xaa},
+ {ADDRESS_2AAA, 0x55},
+ {ADDRESS_5555, 0x80},
+ {ADDRESS_5555, 0xaa},
+ {ADDRESS_2AAA, 0x55},
+ {ADDRESS_5555, 0x20},
+ {FLASH_COMMAND_END, 0}
};
-static const struct flash_task ERASE[] = {
- {0x5555, 0xaa},
- {0x2aaa, 0x55},
- {0x5555, 0x80},
- {0x5555, 0xaa},
- {0x2aaa, 0x55},
- {0x5555, 0x10},
- {flash_task_end, 0}
+static const struct flash_task ERASE_CHIP[] = {
+ {ADDRESS_5555, 0xaa},
+ {ADDRESS_2AAA, 0x55},
+ {ADDRESS_5555, 0x80},
+ {ADDRESS_5555, 0xaa},
+ {ADDRESS_2AAA, 0x55},
+ {ADDRESS_5555, 0x10},
+ {FLASH_COMMAND_END, 0}
+};
+
+static const struct flash_task ERASE_SECTOR[] = {
+ {ADDRESS_5555, 0xaa},
+ {ADDRESS_2AAA, 0x55},
+ {ADDRESS_5555, 0x80},
+ {ADDRESS_5555, 0xaa},
+ {ADDRESS_2AAA, 0x55},
+ //¤³¤Î¤¢¤È sectoraddress ¤Ë 0x30 ¤ò write
+ {FLASH_COMMAND_END, 0}
};
-static void task_set(const struct reader_driver *d, const struct flash_task *t, long address_2aaa, long address_5555)
+static const struct flash_task PP[] = {
+ {ADDRESS_5555, 0xaa},
+ {ADDRESS_2AAA, 0x55},
+ {ADDRESS_5555, 0x80},
+ {ADDRESS_5555, 0xaa},
+ {ADDRESS_2AAA, 0x55},
+ {ADDRESS_5555, 0x60},
+ {FLASH_COMMAND_END, 0}
+};
+
+static void command_set(const struct flash_order *d, const struct flash_task *t)
{
- while(t->address != flash_task_end){
- long cpu_address = 0;
+ while(t->address != FLASH_COMMAND_END){
+ long logical_address = 0;
switch(t->address){
- case 0x2aaa:
- cpu_address = address_2aaa;
+ case ADDRESS_0000: //bank ¤Ë¤è¤Ã¤Æ¤ÏÀßÄê¤Ç¤¤Ê¤¤¤«¤â?
+ logical_address = d->command_0000;
+ break;
+ case ADDRESS_2AAA:
+ logical_address = d->command_2aaa;
break;
- case 0x5555:
- cpu_address = address_5555;
+ case ADDRESS_5555:
+ logical_address = d->command_5555;
break;
default:
- assert(0);
+ assert(0); //unknown task address
}
- d->cpu_flash_write(cpu_address, t->data);
+ d->flash_write(logical_address, t->data);
t++;
}
}
/*
---- product ID check ----
*/
-static int productid_check(const struct reader_driver *d, const struct flash_driver *f, long address_0000, long address_2aaa, long address_5555)
+#define dprintf if(DEBUG==1) printf
+static int productid_check(const struct flash_order *d, const struct flash_driver *f)
{
u8 data[3];
- task_set(d, PRODUCTID_ENTRY, address_2aaa, address_5555);
- d->cpu_read(address_0000, 3, data);
- task_set(d, PRODUCTID_EXIT, address_2aaa, address_5555);
+ command_set(d, PRODUCTID_ENTRY);
+ d->read(d->command_0000, 3, data);
+ command_set(d, PRODUCTID_EXIT);
if(f->id_manufacurer != data[0]){
return NG;
}
return OK;
}
+static int productid_sram(const struct flash_order *d, const struct flash_driver *f)
+{
+ return OK;
+}
/*
---- toggle check ----
databit6
*/
const int CHECK_RETRY_MAX = 0x10000;
-static int toggle_check(const struct reader_driver *d, long address)
+static int toggle_check_d6(const struct flash_order *d, long address)
{
u8 predata;
int retry = 0;
- d->cpu_read(address, 1, &predata); //read DQ6
+ d->read(address, 1, &predata); //read DQ6
predata &= 0x40;
while(retry < CHECK_RETRY_MAX){
u8 data;
- d->cpu_read(address, 1, &data); //read DQ6 again
+ d->read(address, 1, &data); //read DQ6 again
data &= 0x40;
if(predata == data){
return OK;
return NG;
}
+static int toggle_check_d2d5d6(const struct flash_order *d, long address)
+{
+ u8 predata;
+ int retry = 0;
+ d->read(address, 1, &predata);
+ predata &= 0x40;
+ do{
+ u8 data;
+ d->read(address, 1, &data);
+ //DQ6 toggle check
+ if(predata == (data & 0x40)){
+ return OK;
+ }
+ //DQ5 == 0 ¤Ê¤é¤ä¤ê¤Ê¤ª¤·
+ if(data & 0x20){
+ //recheck toggle bit, read twice
+ u8 t[2];
+ d->read(address, 1, &t[0]);
+ d->read(address, 1, &t[1]);
+ if((t[0] & 0x40) == (t[1] & 0x40)){
+ return OK;
+ }
+ //Program/Erase operation not complete, write reset command.
+ return NG;
+ }
+ if((retry & 0x0f) == 0){
+ dprintf("toggle out %06x \n", (int) address);
+ }
+ retry++;
+ }while(retry < CHECK_RETRY_MAX);
+ return NG;
+}
+
/*
---- polling check ----
databit7
*/
-static int polling_check(const struct reader_driver *d, long address, u8 truedata)
+static int polling_check_d7(const struct flash_order *d, long address, u8 truedata)
{
int retry = 0;
truedata &= 0x80;
while(retry < CHECK_RETRY_MAX){
u8 data;
- d->cpu_read(address, 1, &data);
+ d->read(address, 1, &data);
data &= 0x80;
if(truedata == data){
return OK;
return NG;
}
+static int polling_check_d5d7(const struct flash_order *d, long address, u8 truedata)
+{
+ int retry = 0;
+
+ truedata &= 0x80;
+ do{
+ u8 data;
+ d->read(address, 1, &data);
+ if(truedata == (data & 0x80)){
+ return OK;
+ }
+ if(data & 0x20){
+ d->read(address, 1, &data);
+ if(truedata == (data & 0x80)){
+ return OK;
+ }
+ dprintf("%s error", __FUNCTION__);
+ return NG;
+ }
+ retry++;
+ }while(retry < CHECK_RETRY_MAX);
+ return NG;
+}
/*
---- erase ----
*/
-static void flash_erase(const struct reader_driver *d, long address_2aaa, long address_5555)
+static void flash_erase_chip_2aaa(const struct flash_order *d)
{
- task_set(d, ERASE, address_2aaa, address_5555);
- toggle_check(d, address_2aaa);
- //Sleep(200); //Tec 0.2 sec
+ command_set(d, ERASE_CHIP);
+ toggle_check_d6(d, d->command_2aaa);
+ Sleep(200); //Tec 0.2 sec
}
+static void flash_erase_chip_02aa(const struct flash_order *d)
+{
+ u8 data;
+ d->read(d->command_2aaa, 1, &data);
+ command_set(d, ERASE_CHIP);
+ if(0){
+ toggle_check_d2d5d6(d, d->command_2aaa);
+
+ }else{
+ polling_check_d5d7(d, d->command_2aaa, data);
+ }
+ Sleep(8000); //chip erase time 8sec, max64sec
+}
+
+#if DEBUG==1
+static void sram_erase(const struct flash_order *d)
+{
+ //bank ÀÚ¤êÂؤ¨¤¬È¼¤¦¤Î¤Ç¼ÂÁõ¤Ç¤¤Ê¤¤
+}
+#endif
+
/*
---- program ----
*/
-static int program_byte(const struct reader_driver *d, long address, const u8 *data, long length, long address_2aaa, long address_5555)
+static int program_byte(const struct flash_order *d, long address, const u8 *data, long length)
{
+ int retry = 0;
while(length != 0){
if(*data != 0xff){
- task_set(d, PROTECT_DISABLE, address_2aaa, address_5555);
- d->cpu_flash_write(address, *data);
- if(toggle_check(d, address) == NG){
- if(DEBUG == 1){
- printf("%s NG\n", __FUNCTION__);
- }
+ fflush(stdout);
+ command_set(d, PROTECT_DISABLE);
+ d->flash_write(address, *data);
+ if(toggle_check_d6(d, address) == NG){
+ dprintf("%s NG\n", __FUNCTION__);
return NG;
}
- if(0){
- u8 putdata;
- d->cpu_read(address, 1, &putdata);
- if(putdata != *data){
- printf("%s %06x retry\n", __FUNCTION__, (int) address);
- continue;
- }
- }
}
- if((DEBUG == 1) && (address & 0x1f) == 0){
- printf("%s %06x\n", __FUNCTION__, (int) address);
- fflush(stdout);
+ u8 dummy;
+ d->read(address, 1, &dummy);
+ if(*data == dummy){
+ address++;
+ data++;
+ length--;
+ retry = 0;
+ }else if(retry > 8){
+ dprintf("%s %06x error\n", __FUNCTION__, (int) address);
+ address++;
+ data++;
+ length--;
+ retry = 0;
+ if(DEBUG == 0){
+ return NG;
+ }
+ }else{
+ retry++;
}
- address++;
- data++;
- length--;
}
return OK;
}
-static int program_pagewrite(const struct reader_driver *d, long address, const u8 *data, long length, long address_2aaa, long address_5555)
+static int program_pagewrite(const struct flash_order *d, long address, const u8 *data, long length)
{
- task_set(d, PROTECT_DISABLE, address_2aaa, address_5555);
+ const long toggle_address = address ;
+ command_set(d, PROTECT_DISABLE);
while(length != 0){
- d->cpu_flash_write(address, *data);
+ d->flash_write(address, *data);
address++;
data++;
length--;
}
- Sleep(1);
- return toggle_check(d, address);
+ int ret = toggle_check_d6(d, toggle_address);
+ if(0){
+ data--;
+ polling_check_d7(d, address - 1, *data);
+ }
+
+ return ret;
}
/*
----- block compare ----
+¸ÇͥǥХ¤¥¹¥É¥é¥¤¥Ð
*/
-static void compare(const struct reader_driver *d, long address, const u8 *data, long length)
+static void w49f002_init(const struct flash_order *d)
+{
+/*
+byte program mode ¤Ç¤Ï 1->0 ¤Ë¤¹¤ë¤À¤±¡£ 0->1 ¤Ï erase ¤Î¤ß¡£
+¤è¤Ã¤Æ½é´ü²½»þ¤Ë¤Ï erase ¤ò¼Â¹Ô¤¹¤ë
+*/
+ flash_erase_chip_2aaa(d);
+}
+
+static void w49f002_write(const struct flash_order *d, long address, long length, const struct memory *m)
{
- u8 *romdata, *r;
- romdata = malloc(length);
- d->cpu_read(address, length, romdata);
- r = romdata;
+ program_byte(d, address, m->data, length);
+// dprintf("write %s 0x%06x done\n", m->name, (int) m->offset);
+}
+
+static void am29f040_init(const struct flash_order *d)
+{
+ flash_erase_chip_02aa(d);
+}
+
+static void am29f040_write(const struct flash_order *d, long address, long length, const struct memory *m)
+{
+ const u8 *data;
+ data = m->data;
while(length != 0){
- if(*r != *data){
- printf("%06x\n", (int)address);
+ if(*data != 0xff){
+ command_set(d, PROTECT_DISABLE);
+ d->flash_write(address, *data);
+ if(toggle_check_d2d5d6(d, address) == NG){
+ dprintf("%s NG\n", __FUNCTION__);
+ return;
+ }
}
- r++;
- data++;
address++;
+ data++;
length--;
}
- free(romdata);
}
+static void init_nop(const struct flash_order *d)
+{
/*
-¸ÇͥǥХ¤¥¹¥É¥é¥¤¥Ð
+page write mode ¤Ç¤Ï¤È¤¯¤Ë¤Ê¤·
*/
-static void w49f002_write(const struct reader_driver *d, long address, const u8 *data, long length, long address_2aaa, long address_5555)
-{
- program_byte(d, address, data, length, address_2aaa, address_5555);
- compare(d, address, data, length);
}
-static void w29c020_write(const struct reader_driver *d, long address, const u8 *data, long length, long address_2aaa, long address_5555)
+static void w29c040_write(const struct flash_order *d, long address, long length, const struct memory *m)
{
- {
- const long pagesize = 0x80;
+ u8 *cmp;
+ int ngblock = 0;
+ int retry = 0;
+ assert(d->pagesize != 0);
+ cmp = malloc(d->pagesize);
+ do{
long a = address;
long i = length;
+ long offset = m->offset;
const u8 *dd;
- dd = data;
- while(i >= 0){
- int result = program_pagewrite(d, a, dd, pagesize, address_2aaa, address_5555);
- if(result == NG){
- return;
+
+ dd = m->data;
+ ngblock = 0;
+ while(i != 0){
+ d->read(a, d->pagesize, cmp);
+ if(memcmp(cmp, dd, d->pagesize) != 0){
+ ngblock++;
+ dprintf("write %s 0x%06x\n", m->name, (int) offset);
+ int result = program_pagewrite(d, a, dd, d->pagesize);
+ if(result == NG){
+ printf("%s: write error\n", __FUNCTION__);
+ free(cmp);
+ return;
+ }
}
- a += pagesize;
- dd += pagesize;
- i -= pagesize;
+ a += d->pagesize;
+ dd += d->pagesize;
+ offset += d->pagesize;
+ i -= d->pagesize;
+ }
+ dprintf("%s 0x%06x, ngblock %d\n", m->name, (int) m->offset, ngblock);
+ if(retry >= 3 && ngblock >= 16){
+ dprintf("skip\n");
+ break;
}
+ else if(retry > 12){
+ dprintf("skip\n");
+ break;
+ }
+ retry++;
+ fflush(stdout);
+ }while(ngblock != 0);
+
+ free(cmp);
+}
+
+static void sram_write(const struct flash_order *d, long address, long length, const struct memory *m)
+{
+ const u8 *data;
+ data = m->data;
+ while(length != 0){
+ d->flash_write(address, *data);
+ address++;
+ data++;
+ length--;
}
- compare(d, address, data, length);
+}
+
+static void dummy_write(const struct flash_order *d, long address, long length, const struct memory *m)
+{
}
/*
¥Ç¥Ð¥¤¥¹¥ê¥¹¥È
*/
+//0x80 °Ê¹ß¤ÏËÜÅö¤Î¥Ç¥Ð¥¤¥¹½ÅÊ£¤·¤Ê¤¤¤È»×¤¦. 狼 JEDEC ¤Î¤È¤³¤ò¤·¤é¤Ù¤Æ.
+static const struct flash_driver DRIVER_SRAM256K = {
+ .name = "SRAM256K",
+ .capacity = 0x8000,
+ .pagesize = 0,
+ .id_manufacurer = FLASH_ID_DEVICE_SRAM,
+ .id_device = FLASH_ID_DEVICE_SRAM,
+ .productid_check = productid_sram,
+#if DEBUG==1
+ .erase = sram_erase,
+#endif
+ .init = init_nop,
+ .write = sram_write
+};
+
+static const struct flash_driver DRIVER_DUMMY = {
+ .name = "dummy",
+ .capacity = 0x40000,
+ .pagesize = 0,
+ .id_manufacurer = FLASH_ID_DEVICE_DUMMY,
+ .id_device = FLASH_ID_DEVICE_DUMMY,
+ .productid_check = productid_sram,
+#if DEBUG==1
+ .erase = sram_erase,
+#endif
+ .init = init_nop,
+ .write = dummy_write
+};
+
static const struct flash_driver DRIVER_W29C020 = {
- name: "W29C020",
- capacity: 0x40000,
- id_manufacurer: 0xda,
- id_device: 0x45,
- productid_check: productid_check,
- erase: flash_erase,
- write: w29c020_write
+ .name = "W29C020",
+ .capacity = 0x40000,
+ .pagesize = 0x80,
+ .id_manufacurer = 0xda,
+ .id_device = 0x45,
+ .productid_check = productid_check,
+#if DEBUG==1
+ .erase = flash_erase_chip_2aaa,
+#endif
+ .init = init_nop,
+ .write = w29c040_write
+};
+
+static const struct flash_driver DRIVER_W29C040 = {
+ .name = "W29C040",
+ .capacity = 0x80000,
+ .pagesize = 0x100,
+ .id_manufacurer = 0xda,
+ .id_device = 0x46,
+ .productid_check = productid_check,
+#if DEBUG==1
+ .erase = flash_erase_chip_2aaa,
+#endif
+ .init = init_nop,
+ .write = w29c040_write
};
static const struct flash_driver DRIVER_W49F002 = {
- name: "W49F002",
- capacity: 0x40000,
- id_manufacurer: 0xda,
- id_device: 0xae,
- productid_check: productid_check,
- erase: flash_erase,
- write: w49f002_write
+ .name = "W49F002",
+ .capacity = 0x40000,
+ .pagesize = 0,
+ .id_manufacurer = 0xda,
+ .id_device = 0xae,
+ .productid_check = productid_check,
+#if DEBUG==1
+ .erase = flash_erase_chip_2aaa,
+#endif
+ .init = w49f002_init,
+ .write = w49f002_write
+};
+
+/*
+MANUFATUTER ID 0x7f1c
+EN29F002T DEVICE ID 0x7f92
+EN29F002B DEVICE ID 0x7f97
+
+command address ¤¬ 0x00555, 0x00aaa ¤Ë¤Ê¤Ã¤Æ¤ë
+*/
+static const struct flash_driver DRIVER_EN29F002T = {
+ .name = "EN29F002T",
+ .capacity = 0x40000,
+ .pagesize = 0,
+ .id_manufacurer = 0x1c,
+ .id_device = 0x92,
+ .productid_check = productid_check,
+#if DEBUG==1
+ .erase = flash_erase_chip_02aa,
+#endif
+ .init = am29f040_init,
+ .write = am29f040_write
+};
+
+static const struct flash_driver DRIVER_AM29F040B = {
+ .name = "AM29F040B",
+ .capacity = 0x80000,
+ .pagesize = 0,
+ .id_manufacurer = 0x01,
+ .id_device = 0xa4,
+ .productid_check = productid_check,
+#if DEBUG==1
+ .erase = flash_erase_chip_02aa,
+#endif
+ .init = am29f040_init,
+ .write = am29f040_write
};
static const struct flash_driver *DRIVER_LIST[] = {
- &DRIVER_W29C020, &DRIVER_W49F002,
+ &DRIVER_W29C020, &DRIVER_W29C040,
+ &DRIVER_W49F002, &DRIVER_EN29F002T, &DRIVER_AM29F040B,
+ &DRIVER_SRAM256K,
+ &DRIVER_DUMMY,
NULL
};