e01654ca0b2262b9bb2630630c0e8fde0c01a9a8
[openwrt/openwrt.git] / target / linux / brcm47xx-2.6 / files / drivers / mtd / maps / bcm47xx-flash.c
1 /*
2 * Copyright (C) 2006 Felix Fietkau <nbd@openwrt.org>
3 * Copyright (C) 2005 Waldemar Brodkorb <wbx@openwrt.org>
4 * Copyright (C) 2004 Florian Schirmer (jolt@tuxbox.org)
5 *
6 * original functions for finding root filesystem from Mike Baker
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
12 *
13 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
14 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
15 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
16 * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
19 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 * You should have received a copy of the GNU General Public License along
25 * with this program; if not, write to the Free Software Foundation, Inc.,
26 * 675 Mass Ave, Cambridge, MA 02139, USA.
27 *
28 * Copyright 2001-2003, Broadcom Corporation
29 * All Rights Reserved.
30 *
31 * THIS SOFTWARE IS OFFERED "AS IS", AND BROADCOM GRANTS NO WARRANTIES OF ANY
32 * KIND, EXPRESS OR IMPLIED, BY STATUTE, COMMUNICATION OR OTHERWISE. BROADCOM
33 * SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
34 * FOR A SPECIFIC PURPOSE OR NONINFRINGEMENT CONCERNING THIS SOFTWARE.
35 *
36 * Flash mapping for BCM947XX boards
37 */
38
39 #include <linux/init.h>
40 #include <linux/module.h>
41 #include <linux/types.h>
42 #include <linux/kernel.h>
43 #include <linux/wait.h>
44 #include <linux/mtd/mtd.h>
45 #include <linux/mtd/map.h>
46 #ifdef CONFIG_MTD_PARTITIONS
47 #include <linux/mtd/partitions.h>
48 #endif
49 #include <linux/crc32.h>
50 #ifdef CONFIG_SSB
51 #include <linux/ssb/ssb.h>
52 #endif
53 #include <asm/io.h>
54
55
56 #define TRX_MAGIC 0x30524448 /* "HDR0" */
57 #define TRX_VERSION 1
58 #define TRX_MAX_LEN 0x3A0000
59 #define TRX_NO_HEADER 1 /* Do not write TRX header */
60 #define TRX_GZ_FILES 0x2 /* Contains up to TRX_MAX_OFFSET individual gzip files */
61 #define TRX_MAX_OFFSET 3
62
63 struct trx_header {
64 u32 magic; /* "HDR0" */
65 u32 len; /* Length of file including header */
66 u32 crc32; /* 32-bit CRC from flag_version to end of file */
67 u32 flag_version; /* 0:15 flags, 16:31 version */
68 u32 offsets[TRX_MAX_OFFSET]; /* Offsets of partitions from start of header */
69 };
70
71 #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))
72 #define NVRAM_SPACE 0x8000
73 #define WINDOW_ADDR 0x1fc00000
74 #define WINDOW_SIZE 0x400000
75 #define BUSWIDTH 2
76
77 #ifdef CONFIG_SSB
78 extern struct ssb_bus ssb;
79 #endif
80 static struct mtd_info *bcm947xx_mtd;
81
82 static struct map_info bcm947xx_map = {
83 name: "Physically mapped flash",
84 size: WINDOW_SIZE,
85 bankwidth: BUSWIDTH,
86 phys: WINDOW_ADDR,
87 };
88
89 #ifdef CONFIG_MTD_PARTITIONS
90
91 static struct mtd_partition bcm947xx_parts[] = {
92 { name: "cfe", offset: 0, size: 0, mask_flags: MTD_WRITEABLE, },
93 { name: "linux", offset: 0, size: 0, },
94 { name: "rootfs", offset: 0, size: 0, },
95 { name: "nvram", offset: 0, size: 0, },
96 { name: NULL, },
97 };
98
99 static int __init
100 find_cfe_size(struct mtd_info *mtd, size_t size)
101 {
102 struct trx_header *trx;
103 unsigned char buf[512];
104 int off;
105 size_t len;
106 int blocksize;
107
108 trx = (struct trx_header *) buf;
109
110 blocksize = mtd->erasesize;
111 if (blocksize < 0x10000)
112 blocksize = 0x10000;
113
114 for (off = (128*1024); off < size; off += blocksize) {
115 memset(buf, 0xe5, sizeof(buf));
116
117 /*
118 * Read into buffer
119 */
120 if (mtd->read(mtd, off, sizeof(buf), &len, buf) ||
121 len != sizeof(buf))
122 continue;
123
124 /* found a TRX header */
125 if (le32_to_cpu(trx->magic) == TRX_MAGIC) {
126 goto found;
127 }
128 }
129
130 printk(KERN_NOTICE
131 "%s: Couldn't find bootloader size\n",
132 mtd->name);
133 return -1;
134
135 found:
136 printk(KERN_NOTICE "bootloader size: %d\n", off);
137 return off;
138
139 }
140
141 /*
142 * Copied from mtdblock.c
143 *
144 * Cache stuff...
145 *
146 * Since typical flash erasable sectors are much larger than what Linux's
147 * buffer cache can handle, we must implement read-modify-write on flash
148 * sectors for each block write requests. To avoid over-erasing flash sectors
149 * and to speed things up, we locally cache a whole flash sector while it is
150 * being written to until a different sector is required.
151 */
152
153 static void erase_callback(struct erase_info *done)
154 {
155 wait_queue_head_t *wait_q = (wait_queue_head_t *)done->priv;
156 wake_up(wait_q);
157 }
158
159 static int erase_write (struct mtd_info *mtd, unsigned long pos,
160 int len, const char *buf)
161 {
162 struct erase_info erase;
163 DECLARE_WAITQUEUE(wait, current);
164 wait_queue_head_t wait_q;
165 size_t retlen;
166 int ret;
167
168 /*
169 * First, let's erase the flash block.
170 */
171
172 init_waitqueue_head(&wait_q);
173 erase.mtd = mtd;
174 erase.callback = erase_callback;
175 erase.addr = pos;
176 erase.len = len;
177 erase.priv = (u_long)&wait_q;
178
179 set_current_state(TASK_INTERRUPTIBLE);
180 add_wait_queue(&wait_q, &wait);
181
182 ret = mtd->erase(mtd, &erase);
183 if (ret) {
184 set_current_state(TASK_RUNNING);
185 remove_wait_queue(&wait_q, &wait);
186 printk (KERN_WARNING "erase of region [0x%lx, 0x%x] "
187 "on \"%s\" failed\n",
188 pos, len, mtd->name);
189 return ret;
190 }
191
192 schedule(); /* Wait for erase to finish. */
193 remove_wait_queue(&wait_q, &wait);
194
195 /*
196 * Next, writhe data to flash.
197 */
198
199 ret = mtd->write (mtd, pos, len, &retlen, buf);
200 if (ret)
201 return ret;
202 if (retlen != len)
203 return -EIO;
204 return 0;
205 }
206
207
208
209
210 static int __init
211 find_root(struct mtd_info *mtd, size_t size, struct mtd_partition *part)
212 {
213 struct trx_header trx, *trx2;
214 unsigned char buf[512], *block;
215 int off, blocksize;
216 u32 i, crc = ~0;
217 size_t len;
218 struct squashfs_super_block *sb = (struct squashfs_super_block *) buf;
219
220 blocksize = mtd->erasesize;
221 if (blocksize < 0x10000)
222 blocksize = 0x10000;
223
224 for (off = (128*1024); off < size; off += blocksize) {
225 memset(&trx, 0xe5, sizeof(trx));
226
227 /*
228 * Read into buffer
229 */
230 if (mtd->read(mtd, off, sizeof(trx), &len, (char *) &trx) ||
231 len != sizeof(trx))
232 continue;
233
234 /* found a TRX header */
235 if (le32_to_cpu(trx.magic) == TRX_MAGIC) {
236 part->offset = le32_to_cpu(trx.offsets[2]) ? :
237 le32_to_cpu(trx.offsets[1]);
238 part->size = le32_to_cpu(trx.len);
239
240 part->size -= part->offset;
241 part->offset += off;
242
243 goto found;
244 }
245 }
246
247 printk(KERN_NOTICE
248 "%s: Couldn't find root filesystem\n",
249 mtd->name);
250 return -1;
251
252 found:
253 if (part->size == 0)
254 return 0;
255
256 if (mtd->read(mtd, part->offset, sizeof(buf), &len, buf) || len != sizeof(buf))
257 return 0;
258
259 /* Move the fs outside of the trx */
260 part->size = 0;
261
262 if (trx.len != part->offset + part->size - off) {
263 /* Update the trx offsets and length */
264 trx.len = part->offset + part->size - off;
265
266 /* Update the trx crc32 */
267 for (i = (u32) &(((struct trx_header *)NULL)->flag_version); i <= trx.len; i += sizeof(buf)) {
268 if (mtd->read(mtd, off + i, sizeof(buf), &len, buf) || len != sizeof(buf))
269 return 0;
270 crc = crc32_le(crc, buf, min(sizeof(buf), trx.len - i));
271 }
272 trx.crc32 = crc;
273
274 /* read first eraseblock from the trx */
275 block = kmalloc(mtd->erasesize, GFP_KERNEL);
276 trx2 = (struct trx_header *) block;
277 if (mtd->read(mtd, off, mtd->erasesize, &len, block) || len != mtd->erasesize) {
278 printk("Error accessing the first trx eraseblock\n");
279 return 0;
280 }
281
282 printk("Updating TRX offsets and length:\n");
283 printk("old trx = [0x%08x, 0x%08x, 0x%08x], len=0x%08x crc32=0x%08x\n", trx2->offsets[0], trx2->offsets[1], trx2->offsets[2], trx2->len, trx2->crc32);
284 printk("new trx = [0x%08x, 0x%08x, 0x%08x], len=0x%08x crc32=0x%08x\n", trx.offsets[0], trx.offsets[1], trx.offsets[2], trx.len, trx.crc32);
285
286 /* Write updated trx header to the flash */
287 memcpy(block, &trx, sizeof(trx));
288 if (mtd->unlock)
289 mtd->unlock(mtd, off, mtd->erasesize);
290 erase_write(mtd, off, mtd->erasesize, block);
291 if (mtd->sync)
292 mtd->sync(mtd);
293 kfree(block);
294 printk("Done\n");
295 }
296
297 return part->size;
298 }
299
300 struct mtd_partition * __init
301 init_mtd_partitions(struct mtd_info *mtd, size_t size)
302 {
303 int cfe_size;
304
305 if ((cfe_size = find_cfe_size(mtd,size)) < 0)
306 return NULL;
307
308 /* boot loader */
309 bcm947xx_parts[0].offset = 0;
310 bcm947xx_parts[0].size = cfe_size;
311
312 /* nvram */
313 if (cfe_size != 384 * 1024) {
314 bcm947xx_parts[3].offset = size - ROUNDUP(NVRAM_SPACE, mtd->erasesize);
315 bcm947xx_parts[3].size = ROUNDUP(NVRAM_SPACE, mtd->erasesize);
316 } else {
317 /* nvram (old 128kb config partition on netgear wgt634u) */
318 bcm947xx_parts[3].offset = bcm947xx_parts[0].size;
319 bcm947xx_parts[3].size = ROUNDUP(NVRAM_SPACE, mtd->erasesize);
320 }
321
322 /* linux (kernel and rootfs) */
323 if (cfe_size != 384 * 1024) {
324 bcm947xx_parts[1].offset = bcm947xx_parts[0].size;
325 bcm947xx_parts[1].size = bcm947xx_parts[3].offset -
326 bcm947xx_parts[1].offset;
327 } else {
328 /* do not count the elf loader, which is on one block */
329 bcm947xx_parts[1].offset = bcm947xx_parts[0].size +
330 bcm947xx_parts[3].size + mtd->erasesize;
331 bcm947xx_parts[1].size = size -
332 bcm947xx_parts[0].size -
333 (2*bcm947xx_parts[3].size) -
334 mtd->erasesize;
335 }
336
337 /* find and size rootfs */
338 if (find_root(mtd,size,&bcm947xx_parts[2])==0) {
339 bcm947xx_parts[2].size = size - bcm947xx_parts[2].offset -
340 bcm947xx_parts[3].size;
341 }
342
343 return bcm947xx_parts;
344 }
345 #endif
346
347 int __init init_bcm947xx_map(void)
348 {
349 #ifdef CONFIG_SSB
350 struct ssb_mipscore *mcore = &ssb.mipscore;
351 #endif
352 size_t size;
353 int ret = 0;
354 #ifdef CONFIG_MTD_PARTITIONS
355 struct mtd_partition *parts;
356 int i;
357 #endif
358
359 #ifdef CONFIG_SSB
360 u32 window = mcore->flash_window;
361 u32 window_size = mcore->flash_window_size;
362
363 printk("flash init: 0x%08x 0x%08x\n", window, window_size);
364 bcm947xx_map.phys = window;
365 bcm947xx_map.size = window_size;
366 bcm947xx_map.virt = ioremap_nocache(window, window_size);
367 #else
368 printk("flash init: 0x%08x 0x%08x\n", WINDOW_ADDR, WINDOW_SIZE);
369 bcm947xx_map.virt = ioremap_nocache(WINDOW_ADDR, WINDOW_SIZE);
370 #endif
371
372 if (!bcm947xx_map.virt) {
373 printk("Failed to ioremap\n");
374 return -EIO;
375 }
376 simple_map_init(&bcm947xx_map);
377
378 if (!(bcm947xx_mtd = do_map_probe("cfi_probe", &bcm947xx_map))) {
379 printk("Failed to do_map_probe\n");
380 iounmap((void *)bcm947xx_map.virt);
381 return -ENXIO;
382 }
383
384 bcm947xx_mtd->owner = THIS_MODULE;
385
386 size = bcm947xx_mtd->size;
387
388 printk(KERN_NOTICE "Flash device: 0x%x at 0x%x\n", size, WINDOW_ADDR);
389
390 #ifdef CONFIG_MTD_PARTITIONS
391 parts = init_mtd_partitions(bcm947xx_mtd, size);
392 for (i = 0; parts[i].name; i++);
393 ret = add_mtd_partitions(bcm947xx_mtd, parts, i);
394 if (ret) {
395 printk(KERN_ERR "Flash: add_mtd_partitions failed\n");
396 goto fail;
397 }
398 #endif
399 return 0;
400
401 fail:
402 if (bcm947xx_mtd)
403 map_destroy(bcm947xx_mtd);
404 if (bcm947xx_map.virt)
405 iounmap((void *)bcm947xx_map.virt);
406 bcm947xx_map.virt = 0;
407 return ret;
408 }
409
410 void __exit cleanup_bcm947xx_map(void)
411 {
412 #ifdef CONFIG_MTD_PARTITIONS
413 del_mtd_partitions(bcm947xx_mtd);
414 #endif
415 map_destroy(bcm947xx_mtd);
416 iounmap((void *)bcm947xx_map.virt);
417 }
418
419 module_init(init_bcm947xx_map);
420 module_exit(cleanup_bcm947xx_map);