blob: 191114bcfea72840bf3087a45c648b0b248ad75b [file] [log] [blame]
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +00001/*
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
Claus Gindhartef300232008-04-24 09:07:57 +000029#include <string.h>
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +000030#include <stdlib.h>
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000031#include "flash.h"
Sean Nelson14ba6682010-02-26 05:48:29 +000032#include "chipdrivers.h"
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000033
34// I need that Berkeley bit-map printer
Sean Nelson28accc22010-03-19 18:47:06 +000035void print_status_82802ab(uint8_t status)
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000036{
Stefan Reinauerab044b22009-09-16 08:26:59 +000037 printf_debug("%s", status & 0x80 ? "Ready:" : "Busy:");
38 printf_debug("%s", status & 0x40 ? "BE SUSPEND:" : "BE RUN/FINISH:");
39 printf_debug("%s", status & 0x20 ? "BE ERROR:" : "BE OK:");
40 printf_debug("%s", status & 0x10 ? "PROG ERR:" : "PROG OK:");
41 printf_debug("%s", status & 0x8 ? "VP ERR:" : "VPP OK:");
42 printf_debug("%s", status & 0x4 ? "PROG SUSPEND:" : "PROG RUN/FINISH:");
43 printf_debug("%s", status & 0x2 ? "WP|TBL#|WP#,ABORT:" : "UNLOCK:");
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000044}
45
46int probe_82802ab(struct flashchip *flash)
47{
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +000048 chipaddr bios = flash->virtual_memory;
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000049 uint8_t id1, id2;
50
Carl-Daniel Hailfinger4e9cebb2009-09-05 01:16:30 +000051 /* Reset to get a clean state */
52 chip_writeb(0xFF, bios);
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +000053 programmer_delay(10);
Carl-Daniel Hailfinger4e9cebb2009-09-05 01:16:30 +000054
55 /* Enter ID mode */
Carl-Daniel Hailfinger0472f3d2009-03-06 22:26:00 +000056 chip_writeb(0x90, bios);
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +000057 programmer_delay(10);
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000058
Carl-Daniel Hailfinger0472f3d2009-03-06 22:26:00 +000059 id1 = chip_readb(bios);
60 id2 = chip_readb(bios + 0x01);
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000061
62 /* Leave ID mode */
Carl-Daniel Hailfinger4e9cebb2009-09-05 01:16:30 +000063 chip_writeb(0xFF, bios);
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000064
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +000065 programmer_delay(10);
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000066
Uwe Hermann04aa59a2009-09-02 22:09:00 +000067 printf_debug("%s: id1 0x%02x, id2 0x%02x\n", __func__, id1, id2);
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000068
69 if (id1 != flash->manufacture_id || id2 != flash->model_id)
70 return 0;
71
Carl-Daniel Hailfinger81449a22010-03-15 03:48:42 +000072 if (flash->feature_bits & FEATURE_REGISTERMAP)
73 map_flash_registers(flash);
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000074
75 return 1;
76}
77
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +000078uint8_t wait_82802ab(chipaddr bios)
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000079{
80 uint8_t status;
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000081
Carl-Daniel Hailfinger0472f3d2009-03-06 22:26:00 +000082 chip_writeb(0x70, bios);
83 if ((chip_readb(bios) & 0x80) == 0) { // it's busy
84 while ((chip_readb(bios) & 0x80) == 0) ;
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000085 }
86
Carl-Daniel Hailfinger0472f3d2009-03-06 22:26:00 +000087 status = chip_readb(bios);
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000088
Carl-Daniel Hailfinger4e9cebb2009-09-05 01:16:30 +000089 /* Reset to get a clean state */
90 chip_writeb(0xFF, bios);
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +000091
92 return status;
93}
94
Sean Nelson28accc22010-03-19 18:47:06 +000095int unlock_82802ab(struct flashchip *flash)
96{
97 int i;
98 //chipaddr wrprotect = flash->virtual_registers + page + 2;
99
Sean Nelson46313192010-03-20 15:15:36 +0000100 for (i = 0; i < flash->total_size * 1024; i+= flash->page_size)
Sean Nelson28accc22010-03-19 18:47:06 +0000101 {
102 chip_writeb(0, flash->virtual_registers + i + 2);
103 }
104
105 return 0;
106}
107
108int erase_block_82802ab(struct flashchip *flash, unsigned int page, unsigned int pagesize)
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +0000109{
Sean Nelson54596372010-01-09 05:30:14 +0000110 chipaddr bios = flash->virtual_memory;
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +0000111 uint8_t status;
112
113 // clear status register
Sean Nelson54596372010-01-09 05:30:14 +0000114 chip_writeb(0x50, bios + page);
Stefan Reinauerab044b22009-09-16 08:26:59 +0000115
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +0000116 // now start it
Sean Nelson54596372010-01-09 05:30:14 +0000117 chip_writeb(0x20, bios + page);
118 chip_writeb(0xd0, bios + page);
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000119 programmer_delay(10);
Stefan Reinauerab044b22009-09-16 08:26:59 +0000120
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +0000121 // now let's see what the register is
Sean Nelson54596372010-01-09 05:30:14 +0000122 status = wait_82802ab(bios);
Sean Nelson28accc22010-03-19 18:47:06 +0000123 print_status_82802ab(status);
Stefan Reinauerab044b22009-09-16 08:26:59 +0000124
Sean Nelson54596372010-01-09 05:30:14 +0000125 if (check_erased_range(flash, page, pagesize)) {
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000126 fprintf(stderr, "ERASE FAILED!\n");
127 return -1;
Claus Gindhartef300232008-04-24 09:07:57 +0000128 }
Sean Nelson54596372010-01-09 05:30:14 +0000129 printf("DONE BLOCK 0x%x\n", page);
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +0000130
131 return 0;
132}
133
134int erase_82802ab(struct flashchip *flash)
135{
136 int i;
137 unsigned int total_size = flash->total_size * 1024;
138
139 printf("total_size is %d; flash->page_size is %d\n",
140 total_size, flash->page_size);
141 for (i = 0; i < total_size; i += flash->page_size)
Sean Nelson28accc22010-03-19 18:47:06 +0000142 if (erase_block_82802ab(flash, i, flash->page_size)) {
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000143 fprintf(stderr, "ERASE FAILED!\n");
144 return -1;
145 }
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +0000146 printf("DONE ERASE\n");
147
148 return 0;
149}
150
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000151void write_page_82802ab(chipaddr bios, uint8_t *src,
152 chipaddr dst, int page_size)
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +0000153{
154 int i;
155
156 for (i = 0; i < page_size; i++) {
157 /* transfer data from source to destination */
Carl-Daniel Hailfinger0472f3d2009-03-06 22:26:00 +0000158 chip_writeb(0x40, dst);
159 chip_writeb(*src++, dst++);
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +0000160 wait_82802ab(bios);
161 }
162}
163
164int write_82802ab(struct flashchip *flash, uint8_t *buf)
165{
166 int i;
167 int total_size = flash->total_size * 1024;
168 int page_size = flash->page_size;
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000169 chipaddr bios = flash->virtual_memory;
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000170 uint8_t *tmpbuf = malloc(page_size);
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +0000171
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000172 if (!tmpbuf) {
173 printf("Could not allocate memory!\n");
174 exit(1);
175 }
Claus Gindhartef300232008-04-24 09:07:57 +0000176 printf("Programming page: \n");
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +0000177 for (i = 0; i < total_size / page_size; i++) {
Claus Gindhartef300232008-04-24 09:07:57 +0000178 printf
179 ("\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");
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +0000180 printf("%04d at address: 0x%08x", i, i * page_size);
Claus Gindhartef300232008-04-24 09:07:57 +0000181
182 /* Auto Skip Blocks, which already contain the desired data
183 * Faster, because we only write, what has changed
184 * More secure, because blocks, which are excluded
185 * (with the exclude or layout feature)
186 * or not erased and rewritten; their data is retained also in
187 * sudden power off situations
188 */
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000189 chip_readn(tmpbuf, bios + i * page_size, page_size);
190 if (!memcmp((void *)(buf + i * page_size), tmpbuf, page_size)) {
Claus Gindhartef300232008-04-24 09:07:57 +0000191 printf("SKIPPED\n");
192 continue;
193 }
194
195 /* erase block by block and write block by block; this is the most secure way */
Sean Nelson28accc22010-03-19 18:47:06 +0000196 if (erase_block_82802ab(flash, i * page_size, page_size)) {
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000197 fprintf(stderr, "ERASE FAILED!\n");
198 return -1;
199 }
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +0000200 write_page_82802ab(bios, buf + i * page_size,
201 bios + i * page_size, page_size);
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +0000202 }
203 printf("\n");
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000204 free(tmpbuf);
Carl-Daniel Hailfingere7bcb192008-03-14 00:02:25 +0000205
206 return 0;
207}
Sean Nelsondee4a832010-03-22 04:39:31 +0000208
Sean Nelson88647102010-03-22 06:57:02 +0000209int unlock_28f004s5(struct flashchip *flash)
Sean Nelsondee4a832010-03-22 04:39:31 +0000210{
211 chipaddr bios = flash->virtual_memory;
Sean Nelson4e54de92010-03-22 07:03:26 +0000212 uint8_t mcfg, bcfg, need_unlock = 0, can_unlock = 0;
213 int i;
Sean Nelsondee4a832010-03-22 04:39:31 +0000214
215 /* Clear status register */
216 chip_writeb(0x50, bios);
217
218 /* Read identifier codes */
219 chip_writeb(0x90, bios);
220
221 /* Read master lock-bit */
222 mcfg = chip_readb(bios + 0x3);
223 msg_cinfo("master lock is ");
224 if (mcfg) {
225 msg_cdbg("locked!\n");
226 } else {
227 msg_cdbg("unlocked!\n");
228 can_unlock = 1;
229 }
230
231 /* Read block lock-bits */
232 for (i = 0; i < flash->total_size * 1024; i+= (64 * 1024)) {
233 bcfg = chip_readb(bios + i + 2); // read block lock config
234 msg_cdbg("block lock at %06x is %slocked!\n", i, bcfg ? "" : "un");
235 if (bcfg) {
236 need_unlock = 1;
237 }
238 }
239
240 /* Reset chip */
241 chip_writeb(0xFF, bios);
242
243 /* Unlock: clear block lock-bits, if needed */
244 if (can_unlock && need_unlock) {
245 chip_writeb(0x60, bios);
246 chip_writeb(0xD0, bios);
247 chip_writeb(0xFF, bios);
248 }
249
250 /* Error: master locked or a block is locked */
251 if (!can_unlock && need_unlock) {
252 msg_cerr("At least one block is locked and lockdown is active!\n");
253 return -1;
254 }
255
256 return 0;
257}