more jedec standard consolidatation.
[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 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 char *bios, unsigned int page)
64 {
65         volatile unsigned char *Temp;
66
67         /*  Issue the Sector Erase command   */
68         Temp = bios + 0x5555;   /* set up address to be BASE:5555h      */
69         *Temp = 0xAA;           /* write data 0xAA to the address       */
70         myusec_delay(10);
71         Temp = bios + 0x2AAA;   /* set up address to be BASE:2AAAh      */
72         *Temp = 0x55;           /* write data 0x55 to the address       */
73         myusec_delay(10);
74         Temp = bios + 0x5555;   /* set up address to be BASE:5555h      */
75         *Temp = 0x80;           /* write data 0x80 to the address       */
76         myusec_delay(10);
77         Temp = bios + 0x5555;   /* set up address to be BASE:5555h      */
78         *Temp = 0xAA;           /* write data 0xAA to the address       */
79         myusec_delay(10);
80         Temp = bios + 0x2AAA;   /* set up address to be BASE:2AAAh      */
81         *Temp = 0x55;           /* write data 0x55 to the address       */
82         myusec_delay(10);
83         Temp = bios + page;     /* set up address to be the current sector */
84         *Temp = 0x30;           /* write data 0x30 to the address       */
85         myusec_delay(10);
86
87         /* wait for Toggle bit ready         */
88         toggle_ready_jedec(bios);
89
90         return (0);
91 }
92
93 int erase_chip_jedec(struct flashchip *flash)
94 {
95         volatile unsigned char *bios = flash->virt_addr;
96         volatile unsigned char *Temp;
97
98         /*  Issue the JEDEC Chip Erase command   */
99         Temp = bios + 0x5555;   /* set up address to be BASE:5555h      */
100         *Temp = 0xAA;           /* write data 0xAA to the address       */
101         myusec_delay(10);
102         Temp = bios + 0x2AAA;   /* set up address to be BASE:2AAAh      */
103         *Temp = 0x55;           /* write data 0x55 to the address       */
104         myusec_delay(10);
105         Temp = bios + 0x5555;   /* set up address to be BASE:5555h      */
106         *Temp = 0x80;           /* write data 0x80 to the address       */
107         myusec_delay(10);
108         Temp = bios + 0x5555;   /* set up address to be BASE:5555h      */
109         *Temp = 0xAA;           /* write data 0xAA to the address       */
110         myusec_delay(10);
111         Temp = bios + 0x2AAA;   /* set up address to be BASE:2AAAh      */
112         *Temp = 0x55;           /* write data 0x55 to the address       */
113         myusec_delay(10);
114         Temp = bios + 0x5555;   /* set up address to be BASEy:5555h     */
115         *Temp = 0x10;           /* write data 0x10 to the address       */
116         myusec_delay(10);
117
118         toggle_ready_jedec(bios);
119
120         return (0);
121 }
122
123 void write_page_jedec(volatile char *bios, char *src, volatile char *dst,
124                       int page_size)
125 {
126         int i;
127
128         /* Issue JEDEC Data Unprotect comand */
129         *(volatile char *) (bios + 0x5555) = 0xAA;
130         *(volatile char *) (bios + 0x2AAA) = 0x55;
131         *(volatile char *) (bios + 0x5555) = 0xA0;
132
133         for (i = 0; i < page_size; i++) {
134                 /* transfer data from source to destination */
135                 *dst++ = *src++;
136         }
137
138         usleep(100);
139         toggle_ready_jedec(dst - 1);
140 }
141
142 int wirte_byte_program_jedec(volatile unsigned char *bios, unsigned char *src,
143                              volatile unsigned char *dst)
144 {
145         volatile unsigned char *Temp;
146
147         if (*dst != 0xff) {
148                 printf("FATAL: dst %p not erased (val 0x%x)\n",
149                        dst, *dst);
150                 return (-1);
151         }
152         /* transfer data from source to destination */
153         if (*src == 0xFF) {
154                 dst++, src++;
155                 /* If the data is 0xFF, don't program it */
156                 return 0;
157         }
158         /* Issue JEDEC Byte Program command */
159         Temp = bios + 0x5555;
160         *Temp = 0xAA;
161         Temp = bios + 0x2AAA;
162         *Temp = 0x55;
163         Temp = bios + 0x5555;
164         *Temp = 0xA0;
165         *dst = *src;
166         toggle_ready_jedec(bios);
167         if (*dst != *src)
168                 printf("BAD! dst 0x%lx val 0x%x src 0x%x\n",
169                        (unsigned long) dst, *dst, *src);
170         dst++, src++;
171         return 0;
172 }
173
174 int write_sector_jedec(volatile unsigned char *bios, unsigned char *src,
175                        volatile unsigned char *dst,
176                        unsigned int page_size)
177 {
178         int i;
179
180         for (i = 0; i < page_size; i++) {
181                 wirte_byte_program_jedec(bios, src, dst);
182         }
183
184         return (0);
185 }
186
187 int write_jedec(struct flashchip *flash, unsigned char *buf)
188 {
189         int i;
190         int total_size = flash->total_size * 1024;
191         int page_size = flash->page_size;
192         volatile unsigned char *bios = flash->virt_addr;
193
194         erase_chip_jedec(flash);
195         if (*bios != (unsigned char) 0xff) {
196                 printf("ERASE FAILED\n");
197                 return -1;
198         }
199         printf("Programming Page: ");
200         for (i = 0; i < total_size / page_size; i++) {
201                 printf("%04d at address: 0x%08x", i, i * page_size);
202                 write_page_jedec(bios, buf + i * page_size,
203                                  bios + i * page_size, page_size);
204                 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");
205         }
206         printf("\n");
207         protect_jedec(bios);
208
209         return (0);
210 }