353b17ab983bcbdda7296efb03e97e5cf943f64b
[coreboot.git] / util / flash_and_burn / jedec.c
1 /*
2  * jedec.c: driver for programming JEDEC standard flash parts
3  *
4  *
5  * Copyright 2000 Silicon Integrated System Corporation
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  *
22  * Reference:
23  *
24  * $Id$
25  */
26
27 #include <stdio.h>
28 #include "flash.h"
29 #include "jedec.h"
30
31 int probe_jedec(struct flashchip *flash)
32 {
33         volatile unsigned char *bios = flash->virt_addr;
34         unsigned char id1, id2;
35
36         /* Issue JEDEC Product ID Entry command */
37         *(volatile char *) (bios + 0x5555) = 0xAA;
38         myusec_delay(10);
39         *(volatile char *) (bios + 0x2AAA) = 0x55;
40         myusec_delay(10);
41         *(volatile char *) (bios + 0x5555) = 0x90;
42         myusec_delay(10);
43
44         /* Read product ID */
45         id1 = *(volatile unsigned char *) bios;
46         id2 = *(volatile unsigned char *) (bios + 0x01);
47
48         /* Issue JEDEC Product ID Exit command */
49         *(volatile char *) (bios + 0x5555) = 0xAA;
50         myusec_delay(10);
51         *(volatile char *) (bios + 0x2AAA) = 0x55;
52         myusec_delay(10);
53         *(volatile char *) (bios + 0x5555) = 0xF0;
54         myusec_delay(10);
55
56         printf("%s: id1 0x%x, id2 0x%x\n", __FUNCTION__, id1, id2);
57         if (id1 == flash->manufacture_id && id2 == flash->model_id)
58                 return 1;
59
60         return 0;
61 }
62
63 int erase_sector_jedec(volatile unsigned char *bios, unsigned int page)
64 {
65         /*  Issue the Sector Erase command   */
66         *(volatile char *) (bios + 0x5555) = 0xAA;
67         myusec_delay(10);
68         *(volatile char *) (bios + 0x2AAA) = 0x55;
69         myusec_delay(10);
70         *(volatile char *) (bios + 0x5555) = 0x80;
71         myusec_delay(10);
72
73         *(volatile char *) (bios + 0x5555) = 0xAA;
74         myusec_delay(10);
75         *(volatile char *) (bios + 0x2AAA) = 0x55;
76         myusec_delay(10);
77         *(volatile char *) (bios + page)   = 0x30;
78         myusec_delay(10);
79
80         /* wait for Toggle bit ready         */
81         toggle_ready_jedec(bios);
82
83         return (0);
84 }
85
86 int erase_block_jedec(volatile unsigned char *bios, unsigned int block)
87 {
88         /*  Issue the Sector Erase command   */
89         *(volatile char *) (bios + 0x5555) = 0xAA;
90         myusec_delay(10);
91         *(volatile char *) (bios + 0x2AAA) = 0x55;
92         myusec_delay(10);
93         *(volatile char *) (bios + 0x5555) = 0x80;
94         myusec_delay(10);
95
96         *(volatile char *) (bios + 0x5555) = 0xAA;
97         myusec_delay(10);
98         *(volatile char *) (bios + 0x2AAA) = 0x55;
99         myusec_delay(10);
100         *(volatile char *) (bios + block)  = 0x50;
101         myusec_delay(10);
102
103         /* wait for Toggle bit ready         */
104         toggle_ready_jedec(bios);
105
106         return (0);
107 }
108
109 int erase_chip_jedec(struct flashchip *flash)
110 {
111         volatile unsigned char *bios = flash->virt_addr;
112
113         /*  Issue the JEDEC Chip Erase command   */
114         *(volatile char *) (bios + 0x5555) = 0xAA;
115         myusec_delay(10);
116         *(volatile char *) (bios + 0x2AAA) = 0x55;
117         myusec_delay(10);
118         *(volatile char *) (bios + 0x5555) = 0x80;
119         myusec_delay(10);
120
121         *(volatile char *) (bios + 0x5555) = 0xAA;
122         myusec_delay(10);
123         *(volatile char *) (bios + 0x2AAA) = 0x55;
124         myusec_delay(10);
125         *(volatile char *) (bios + 0x5555) = 0x10;
126         myusec_delay(10);
127
128         toggle_ready_jedec(bios);
129
130         return (0);
131 }
132
133 int write_page_write_jedec(volatile unsigned char *bios, unsigned char *src,
134                            volatile unsigned char *dst, int page_size)
135 {
136         int i;
137
138         /* Issue JEDEC Data Unprotect comand */
139         *(volatile unsigned char *) (bios + 0x5555) = 0xAA;
140         *(volatile unsigned char *) (bios + 0x2AAA) = 0x55;
141         *(volatile unsigned char *) (bios + 0x5555) = 0xA0;
142
143         /* transfer data from source to destination */
144         for (i = 0; i < page_size; i++) {
145                 /* If the data is 0xFF, don't program it */
146                 if (*src == 0xFF)
147                         continue;
148                 *dst++ = *src++;
149         }
150
151         toggle_ready_jedec(dst - 1);
152
153         return 0;
154 }
155
156 int write_byte_program_jedec(volatile unsigned char *bios, unsigned char *src,
157                              volatile unsigned char *dst)
158 {
159         int tried = 0;
160
161         /* If the data is 0xFF, don't program it */
162         if (*src == 0xFF) {
163                 return 0;
164         }
165
166 retry:
167         /* Issue JEDEC Byte Program command */
168         *(volatile unsigned char *) (bios + 0x5555) = 0xAA;
169         *(volatile unsigned char *) (bios + 0x2AAA) = 0x55;
170         *(volatile unsigned char *) (bios + 0x5555) = 0xA0;
171
172         /* transfer data from source to destination */
173         *dst = *src;
174         toggle_ready_jedec(bios);
175
176         if (*dst != *src && tried++ < 0x10) {
177                 goto retry;
178         }
179
180         return 0;
181 }
182
183 int write_sector_jedec(volatile unsigned char *bios, unsigned char *src,
184                        volatile unsigned char *dst, unsigned int page_size)
185 {
186         int i;
187
188         for (i = 0; i < page_size; i++) {
189                 write_byte_program_jedec(bios, src, dst);
190                 dst++, src++;
191         }
192
193         return (0);
194 }
195
196 int write_jedec(struct flashchip *flash, unsigned char *buf)
197 {
198         int i;
199         int total_size = flash->total_size * 1024;
200         int page_size = flash->page_size;
201         volatile unsigned char *bios = flash->virt_addr;
202
203         erase_chip_jedec(flash);
204         if (*bios != (unsigned char) 0xff) {
205                 printf("ERASE FAILED\n");
206                 return -1;
207         }
208         printf("Programming Page: ");
209         for (i = 0; i < total_size / page_size; i++) {
210                 printf("%04d at address: 0x%08x", i, i * page_size);
211                 write_page_write_jedec(bios, buf + i * page_size,
212                                        bios + i * page_size, page_size);
213                 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");
214         }
215         printf("\n");
216         protect_jedec(bios);
217
218         return (0);
219 }