util/flashrom/82802ab.c

   1 /*
   2  * This file is part of the flashrom project.
   3  *
   4  * Copyright (C) 2000 Silicon Integrated System Corporation
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 /*
  22  * Datasheet:
  23  *  - Name: Intel 82802AB/82802AC Firmware Hub (FWH)
  24  *  - URL: http://www.intel.com/design/chipsets/datashts/290658.htm
  25  *  - PDF: http://download.intel.com/design/chipsets/datashts/29065804.pdf
  26  *  - Order number: 290658-004
  27  */
  28
  29 #include <stdio.h>
  30 #include <stdint.h>
  31 #include "flash.h"
  32
  33 // I need that Berkeley bit-map printer
  34 void print_82802ab_status(uint8_t status)
  35 {
  36         printf("%s", status & 0x80 ? "Ready:" : "Busy:");
  37         printf("%s", status & 0x40 ? "BE SUSPEND:" : "BE RUN/FINISH:");
  38         printf("%s", status & 0x20 ? "BE ERROR:" : "BE OK:");
  39         printf("%s", status & 0x10 ? "PROG ERR:" : "PROG OK:");
  40         printf("%s", status & 0x8 ? "VP ERR:" : "VPP OK:");
  41         printf("%s", status & 0x4 ? "PROG SUSPEND:" : "PROG RUN/FINISH:");
  42         printf("%s", status & 0x2 ? "WP|TBL#|WP#,ABORT:" : "UNLOCK:");
  43 }
  44
  45 int probe_82802ab(struct flashchip *flash)
  46 {
  47         volatile uint8_t *bios = flash->virtual_memory;
  48         uint8_t id1, id2;
  49
  50 #if 0
  51         *(volatile uint8_t *)(bios + 0x5555) = 0xAA;
  52         *(volatile uint8_t *)(bios + 0x2AAA) = 0x55;
  53         *(volatile uint8_t *)(bios + 0x5555) = 0x90;
  54 #endif
  55
  56         *bios = 0xff;
  57         myusec_delay(10);
  58         *bios = 0x90;
  59         myusec_delay(10);
  60
  61         id1 = *(volatile uint8_t *)bios;
  62         id2 = *(volatile uint8_t *)(bios + 0x01);
  63
  64         /* Leave ID mode */
  65         *(volatile uint8_t *)(bios + 0x5555) = 0xAA;
  66         *(volatile uint8_t *)(bios + 0x2AAA) = 0x55;
  67         *(volatile uint8_t *)(bios + 0x5555) = 0xF0;
  68
  69         myusec_delay(10);
  70
  71         printf_debug("%s: id1 0x%x, id2 0x%x\n", __FUNCTION__, id1, id2);
  72
  73         if (id1 != flash->manufacture_id || id2 != flash->model_id)
  74                 return 0;
  75
  76         map_flash_registers(flash);
  77
  78         return 1;
  79 }
  80
  81 uint8_t wait_82802ab(volatile uint8_t *bios)
  82 {
  83         uint8_t status;
  84         uint8_t id1, id2;
  85
  86         *bios = 0x70;
  87         if ((*bios & 0x80) == 0) {      // it's busy
  88                 while ((*bios & 0x80) == 0) ;
  89         }
  90
  91         status = *bios;
  92
  93         // put another command to get out of status register mode
  94
  95         *bios = 0x90;
  96         myusec_delay(10);
  97
  98         id1 = *(volatile uint8_t *)bios;
  99         id2 = *(volatile uint8_t *)(bios + 0x01);
 100
 101         // this is needed to jam it out of "read id" mode
 102         *(volatile uint8_t *)(bios + 0x5555) = 0xAA;
 103         *(volatile uint8_t *)(bios + 0x2AAA) = 0x55;
 104         *(volatile uint8_t *)(bios + 0x5555) = 0xF0;
 105
 106         return status;
 107 }
 108
 109 int erase_82802ab_block(struct flashchip *flash, int offset)
 110 {
 111         volatile uint8_t *bios = flash->virtual_memory + offset;
 112         volatile uint8_t *wrprotect = flash->virtual_registers + offset + 2;
 113         uint8_t status;
 114
 115         // clear status register
 116         *bios = 0x50;
 117         //printf("Erase at %p\n", bios);
 118         // clear write protect
 119         //printf("write protect is at %p\n", (wrprotect));
 120         //printf("write protect is 0x%x\n", *(wrprotect));
 121         *(wrprotect) = 0;
 122         //printf("write protect is 0x%x\n", *(wrprotect));
 123
 124         // now start it
 125         *(volatile uint8_t *)(bios) = 0x20;
 126         *(volatile uint8_t *)(bios) = 0xd0;
 127         myusec_delay(10);
 128         // now let's see what the register is
 129         status = wait_82802ab(flash->virtual_memory);
 130         //print_82802ab_status(status);
 131         printf("DONE BLOCK 0x%x\n", offset);
 132
 133         return 0;
 134 }
 135
 136 int erase_82802ab(struct flashchip *flash)
 137 {
 138         int i;
 139         unsigned int total_size = flash->total_size * 1024;
 140
 141         printf("total_size is %d; flash->page_size is %d\n",
 142                total_size, flash->page_size);
 143         for (i = 0; i < total_size; i += flash->page_size)
 144                 erase_82802ab_block(flash, i);
 145         printf("DONE ERASE\n");
 146
 147         return 0;
 148 }
 149
 150 void write_page_82802ab(volatile uint8_t *bios, uint8_t *src,
 151                         volatile uint8_t *dst, int page_size)
 152 {
 153         int i;
 154
 155         for (i = 0; i < page_size; i++) {
 156                 /* transfer data from source to destination */
 157                 *dst = 0x40;
 158                 *dst++ = *src++;
 159                 wait_82802ab(bios);
 160         }
 161 }
 162
 163 int write_82802ab(struct flashchip *flash, uint8_t *buf)
 164 {
 165         int i;
 166         int total_size = flash->total_size * 1024;
 167         int page_size = flash->page_size;
 168         volatile uint8_t *bios = flash->virtual_memory;
 169
 170         erase_82802ab(flash);
 171         if (*bios != 0xff) {
 172                 printf("ERASE FAILED\n");
 173                 return -1;
 174         }
 175         printf("Programming page: ");
 176         for (i = 0; i < total_size / page_size; i++) {
 177                 printf("%04d at address: 0x%08x", i, i * page_size);
 178                 write_page_82802ab(bios, buf + i * page_size,
 179                                    bios + i * page_size, page_size);
 180                 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");
 181         }
 182         printf("\n");
 183         protect_jedec(bios);
 184
 185         return 0;
 186 }