82802ab.c

/*
 * 82802ab.c: driver for programming JEDEC standard flash parts
 *
 *
 * Copyright 2000 Silicon Integrated System Corporation
 *
 *	This program is free software; you can redistribute it and/or modify
 *	it under the terms of the GNU General Public License as published by
 *	the Free Software Foundation; either version 2 of the License, or
 *	(at your option) any later version.
 *
 *	This program is distributed in the hope that it will be useful,
 *	but WITHOUT ANY WARRANTY; without even the implied warranty of
 *	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *	GNU General Public License for more details.
 *
 *	You should have received a copy of the GNU General Public License
 *	along with this program; if not, write to the Free Software
 *	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *
 * Reference: http://www.intel.com/design/chipsets/datashts/290658.htm
 *
 * $Id$
 */

#include <errno.h>
#include <fcntl.h>
#include <sys/mman.h>
#include <sys/io.h>
#include <unistd.h>
#include <stdio.h>

#include "flash.h"
#include "82802ab.h"

// I need that Berkeley bit-map printer
void print_82802ab_status(unsigned char status)
{
	printf("%s", status & 0x80 ? "Ready:" : "Busy:");
	printf("%s", status & 0x40 ? "BE SUSPEND:" : "BE RUN/FINISH:");
	printf("%s", status & 0x20 ? "BE ERROR:" : "BE OK:");
	printf("%s", status & 0x10 ? "PROG ERR:" : "PROG OK:");
	printf("%s", status & 0x8 ? "VP ERR:" : "VPP OK:");
	printf("%s", status & 0x4 ? "PROG SUSPEND:" : "PROG RUN/FINISH:");
	printf("%s", status & 0x2 ? "WP|TBL#|WP#,ABORT:" : "UNLOCK:");
}

int probe_82802ab (struct flashchip * flash)
{
	volatile unsigned char * bios = flash->virt_addr;
	unsigned char  id1, id2;

#if 0
	*(volatile unsigned char *) (bios + 0x5555) = 0xAA;
	*(volatile unsigned char *) (bios + 0x2AAA) = 0x55;
	*(volatile unsigned char *) (bios + 0x5555) = 0x90;
#endif

	*bios = 0xff;
	myusec_delay(10);
	*bios = 0x90;
	myusec_delay(10);

	id1 = *(volatile unsigned char *) bios;
	id2 = *(volatile unsigned char *) (bios + 0x01);

#if 1
	*(volatile unsigned char *) (bios + 0x5555) = 0xAA;
	*(volatile unsigned char *) (bios + 0x2AAA) = 0x55;
	*(volatile unsigned char *) (bios + 0x5555) = 0xF0;

#endif
	myusec_delay(10);

	printf(__FUNCTION__ "id1 %d, id2 %d\n", id1, id2);
	if (id1 == flash->manufacture_id && id2 == flash->model_id) {
		size_t size = flash->total_size * 1024;
		// we need to mmap the write-protect space. 
        	bios = mmap (0, size, PROT_WRITE | PROT_READ, MAP_SHARED,
                     flash->fd_mem, (off_t) (0 - 0x400000 - size));
        	if (bios == MAP_FAILED) {
			// it's this part but we can't map it ...
            		perror("Error MMAP /dev/mem");
            		exit(1);
        	}

		flash->virt_addr_2 = bios;
		return 1;
	}

	return 0;
}

unsigned char wait_82802ab(volatile unsigned char * bios)
{

	unsigned char status;
	unsigned char id1, id2;

	*bios = 0x70;
	if ((*bios & 0x80) == 0) { // it's busy
		while ((*bios & 0x80) == 0)
			;
	}

	status = *bios;

	// put another command to get out of status register mode
	
	*bios = 0x90;
	myusec_delay(10);

	id1 = *(volatile unsigned char *) bios;
	id2 = *(volatile unsigned char *) (bios + 0x01);
		
	// this is needed to jam it out of "read id" mode
	*(volatile unsigned char *) (bios + 0x5555) = 0xAA;
	*(volatile unsigned char *) (bios + 0x2AAA) = 0x55;
	*(volatile unsigned char *) (bios + 0x5555) = 0xF0;
	return status;
  
}
int erase_82802ab_block(struct flashchip *flash, int offset)
{
	volatile unsigned char * bios = flash->virt_addr + offset;
	volatile unsigned char *wrprotect = flash->virt_addr_2 + offset + 2;
	unsigned char status;

	// clear status register
	*bios = 0x50;
	printf("Erase at %p\n", bios);
	// clear write protect
	printf("write protect is at %p\n", (wrprotect));
	printf("write protect is 0x%x\n", *(wrprotect));
	*(wrprotect) = 0;
	printf("write protect is 0x%x\n", *(wrprotect));

	// now start it
	*(volatile unsigned char *) (bios) = 0x20;
	*(volatile unsigned char *) (bios) = 0xd0;
	myusec_delay(10);
	// now let's see what the register is
	status = wait_82802ab(flash->virt_addr);
	print_82802ab_status(status);
	printf("DONE BLOCK 0x%x\n", offset);
}
int erase_82802ab (struct flashchip * flash)
{
	int i;
	volatile unsigned char * bios = flash->virt_addr;
	unsigned int total_size = flash->total_size * 1024;

	printf("total_size is %d; flash->page_size is %d\n", 
			 total_size, flash->page_size);
	for(i = 0; i < total_size; i += flash->page_size)
		erase_82802ab_block(flash, i);
	printf("DONE ERASE\n");
}

void write_page_82802ab (volatile char * bios, char * src, volatile char * dst,
                                         int page_size)
{
        int i;

        for (i = 0; i < page_size; i++) {
                /* transfer data from source to destination */
                *dst = 0x40;
                *dst++ = *src++;
		wait_82802ab(bios);
        }

}

int write_82802ab (struct flashchip * flash, char * buf)
{
	int i;
	int total_size = flash->total_size *1024, page_size = flash->page_size;
	volatile unsigned char * bios = flash->virt_addr;

	erase_82802ab (flash);
	if (*bios != 0xff) {
		printf("ERASE FAILED\n");
		return -1;
	}
	printf ("Programming Page: ");
	for (i = 0; i < total_size/page_size; i++) {
		printf ("%04d at address: 0x%08x", i, i * page_size);
		write_page_82802ab(bios, buf + i * page_size, bios + i * page_size,
				 page_size);
		printf ("\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");
	}
	printf("\n");
	protect_82802ab (bios);
}