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)
6 * original functions for finding root filesystem from Mike Baker
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.
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.
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.
28 * Copyright 2001-2003, Broadcom Corporation
29 * All Rights Reserved.
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.
36 * Flash mapping for ADM5120 boards
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 #include <linux/sched.h>
47 #ifdef CONFIG_MTD_PARTITIONS
48 #include <linux/mtd/partitions.h>
50 #include <linux/squashfs_fs.h>
51 #include <linux/jffs2.h>
52 #include <linux/crc32.h>
54 #include <asm/bootinfo.h>
55 #include <asm/mach-adm5120/myloader.h>
56 #include <asm/mach-adm5120/adm5120_info.h>
58 extern int parse_myloader_partitions(struct mtd_info
*master
,
59 struct mtd_partition
**pparts
,
60 unsigned long origin
);
62 /* Macros for switching flash bank
63 ADM5120 only support 2MB flash address space
64 so GPIO5 is used as A20
66 #define GPIO_IO ((volatile unsigned long *)0xb20000b8)
67 #define FLASH_A20_GPIO 5
68 #define FLASH_BOUNDARY 0x200000
71 #define TRX_MAGIC 0x30524448 /* "HDR0" */
73 #define TRX_MAX_LEN 0x3A0000
74 #define TRX_NO_HEADER 1 /* Do not write TRX header */
75 #define TRX_GZ_FILES 0x2 /* Contains up to TRX_MAX_OFFSET individual gzip files */
76 #define TRX_MAX_OFFSET 3
79 u32 magic
; /* "HDR0" */
80 u32 len
; /* Length of file including header */
81 u32 crc32
; /* 32-bit CRC from flag_version to end of file */
82 u32 flag_version
; /* 0:15 flags, 16:31 version */
83 u32 offsets
[TRX_MAX_OFFSET
]; /* Offsets of partitions from start of header */
86 #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))
87 #define NVRAM_SPACE 0x8000
88 #define WINDOW_ADDR 0x1fc00000
89 #define WINDOW_SIZE 0x400000
92 static struct mtd_info
*adm5120_mtd
;
94 static struct map_info adm5120_map
= {
95 name
: "adm5120 physically mapped flash",
101 #ifdef CONFIG_MTD_PARTITIONS
103 static struct mtd_partition adm5120_cfe_parts
[] = {
104 { name
: "cfe", offset
: 0, size
: 0, mask_flags
: MTD_WRITEABLE
, },
105 { name
: "linux", offset
: 0, size
: 0, },
106 { name
: "rootfs", offset
: 0, size
: 0, },
107 { name
: "nvram", offset
: 0, size
: 0, },
112 static void flash_switch_bank(unsigned long addr
)
116 /* Set GPIO as output */
117 val
= *GPIO_IO
| (1 << (FLASH_A20_GPIO
+16));
118 if ( addr
& FLASH_BOUNDARY
) {
119 val
|= 1 << (FLASH_A20_GPIO
+ 24);
121 val
&= ~(1 << (FLASH_A20_GPIO
+ 24));
126 static map_word
adm5120_map_read(struct map_info
*map
, unsigned long ofs
)
128 flash_switch_bank(ofs
);
129 return inline_map_read(map
, ofs
);
132 static void adm5120_map_write(struct map_info
*map
, const map_word datum
, unsigned long ofs
)
134 flash_switch_bank(ofs
);
135 inline_map_write(map
, datum
, ofs
);
138 static void adm5120_map_copy_from(struct map_info
*map
, void *to
, unsigned long from
, ssize_t len
)
142 if (from
< FLASH_BOUNDARY
) {
143 tmp
= (len
< (FLASH_BOUNDARY
- from
)) ? len
: (FLASH_BOUNDARY
- from
);
144 flash_switch_bank(0);
145 inline_map_copy_from(map
, to
, from
, tmp
);
146 to
= (void *)((char *)to
+ tmp
);
151 flash_switch_bank(FLASH_BOUNDARY
);
152 inline_map_copy_from(map
, to
, from
, len
);
158 find_cfe_size(struct mtd_info
*mtd
, size_t size
)
160 struct trx_header
*trx
;
161 unsigned char buf
[512];
166 trx
= (struct trx_header
*) buf
;
168 blocksize
= mtd
->erasesize
;
169 if (blocksize
< 0x10000)
172 for (off
= (128*1024); off
< size
; off
+= blocksize
) {
173 memset(buf
, 0xe5, sizeof(buf
));
178 if (mtd
->read(mtd
, off
, sizeof(buf
), &len
, buf
) ||
182 /* found a TRX header */
183 if (le32_to_cpu(trx
->magic
) == TRX_MAGIC
) {
189 "%s: Couldn't find bootloader size\n",
194 printk(KERN_NOTICE
"bootloader size: %d\n", off
);
200 * Copied from mtdblock.c
204 * Since typical flash erasable sectors are much larger than what Linux's
205 * buffer cache can handle, we must implement read-modify-write on flash
206 * sectors for each block write requests. To avoid over-erasing flash sectors
207 * and to speed things up, we locally cache a whole flash sector while it is
208 * being written to until a different sector is required.
211 static void erase_callback(struct erase_info
*done
)
213 wait_queue_head_t
*wait_q
= (wait_queue_head_t
*)done
->priv
;
217 static int erase_write (struct mtd_info
*mtd
, unsigned long pos
,
218 int len
, const char *buf
)
220 struct erase_info erase
;
221 DECLARE_WAITQUEUE(wait
, current
);
222 wait_queue_head_t wait_q
;
227 * First, let's erase the flash block.
230 init_waitqueue_head(&wait_q
);
232 erase
.callback
= erase_callback
;
235 erase
.priv
= (u_long
)&wait_q
;
237 set_current_state(TASK_INTERRUPTIBLE
);
238 add_wait_queue(&wait_q
, &wait
);
240 ret
= mtd
->erase(mtd
, &erase
);
242 set_current_state(TASK_RUNNING
);
243 remove_wait_queue(&wait_q
, &wait
);
244 printk (KERN_WARNING
"erase of region [0x%lx, 0x%x] "
245 "on \"%s\" failed\n",
246 pos
, len
, mtd
->name
);
250 schedule(); /* Wait for erase to finish. */
251 remove_wait_queue(&wait_q
, &wait
);
254 * Next, writhe data to flash.
257 ret
= mtd
->write (mtd
, pos
, len
, &retlen
, buf
);
269 find_root(struct mtd_info
*mtd
, size_t size
, struct mtd_partition
*part
)
271 struct trx_header trx
, *trx2
;
272 unsigned char buf
[512], *block
;
277 blocksize
= mtd
->erasesize
;
278 if (blocksize
< 0x10000)
281 for (off
= (128*1024); off
< size
; off
+= blocksize
) {
282 memset(&trx
, 0xe5, sizeof(trx
));
287 if (mtd
->read(mtd
, off
, sizeof(trx
), &len
, (char *) &trx
) ||
291 /* found a TRX header */
292 if (le32_to_cpu(trx
.magic
) == TRX_MAGIC
) {
293 part
->offset
= le32_to_cpu(trx
.offsets
[2]) ? :
294 le32_to_cpu(trx
.offsets
[1]);
295 part
->size
= le32_to_cpu(trx
.len
);
297 part
->size
-= part
->offset
;
305 "%s: Couldn't find root filesystem\n",
313 if (mtd
->read(mtd
, part
->offset
, sizeof(buf
), &len
, buf
) || len
!= sizeof(buf
))
316 /* Move the fs outside of the trx */
319 if (trx
.len
!= part
->offset
+ part
->size
- off
) {
320 /* Update the trx offsets and length */
321 trx
.len
= part
->offset
+ part
->size
- off
;
323 /* Update the trx crc32 */
324 for (i
= (u32
) &(((struct trx_header
*)NULL
)->flag_version
); i
<= trx
.len
; i
+= sizeof(buf
)) {
325 if (mtd
->read(mtd
, off
+ i
, sizeof(buf
), &len
, buf
) || len
!= sizeof(buf
))
327 crc
= crc32_le(crc
, buf
, min(sizeof(buf
), trx
.len
- i
));
331 /* read first eraseblock from the trx */
332 block
= kmalloc(mtd
->erasesize
, GFP_KERNEL
);
333 trx2
= (struct trx_header
*) block
;
334 if (mtd
->read(mtd
, off
, mtd
->erasesize
, &len
, block
) || len
!= mtd
->erasesize
) {
335 printk("Error accessing the first trx eraseblock\n");
339 printk("Updating TRX offsets and length:\n");
340 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
);
341 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
);
343 /* Write updated trx header to the flash */
344 memcpy(block
, &trx
, sizeof(trx
));
346 mtd
->unlock(mtd
, off
, mtd
->erasesize
);
347 erase_write(mtd
, off
, mtd
->erasesize
, block
);
357 struct mtd_partition
* __init
358 init_mtd_partitions(struct mtd_info
*mtd
, size_t size
)
362 if ((cfe_size
= find_cfe_size(mtd
,size
)) < 0)
366 adm5120_cfe_parts
[0].offset
= 0;
367 adm5120_cfe_parts
[0].size
= cfe_size
;
370 if (cfe_size
!= 384 * 1024) {
371 adm5120_cfe_parts
[3].offset
= size
- ROUNDUP(NVRAM_SPACE
, mtd
->erasesize
);
372 adm5120_cfe_parts
[3].size
= ROUNDUP(NVRAM_SPACE
, mtd
->erasesize
);
374 /* nvram (old 128kb config partition on netgear wgt634u) */
375 adm5120_cfe_parts
[3].offset
= adm5120_cfe_parts
[0].size
;
376 adm5120_cfe_parts
[3].size
= ROUNDUP(NVRAM_SPACE
, mtd
->erasesize
);
379 /* linux (kernel and rootfs) */
380 if (cfe_size
!= 384 * 1024) {
381 adm5120_cfe_parts
[1].offset
= adm5120_cfe_parts
[0].size
;
382 adm5120_cfe_parts
[1].size
= adm5120_cfe_parts
[3].offset
-
383 adm5120_cfe_parts
[1].offset
;
385 /* do not count the elf loader, which is on one block */
386 adm5120_cfe_parts
[1].offset
= adm5120_cfe_parts
[0].size
+
387 adm5120_cfe_parts
[3].size
+ mtd
->erasesize
;
388 adm5120_cfe_parts
[1].size
= size
-
389 adm5120_cfe_parts
[0].size
-
390 (2*adm5120_cfe_parts
[3].size
) -
394 /* find and size rootfs */
395 find_root(mtd
,size
,&adm5120_cfe_parts
[2]);
396 adm5120_cfe_parts
[2].size
= size
- adm5120_cfe_parts
[2].offset
- adm5120_cfe_parts
[3].size
;
398 return adm5120_cfe_parts
;
402 int __init
init_adm5120_map(void)
406 #if defined (CONFIG_MTD_PARTITIONS) || (CONFIG_MTD_MYLOADER_PARTS)
407 struct mtd_partition
*parts
;
408 int i
, parsed_nr_parts
= 0;
410 printk("adm5120 : flash init : 0x%08x 0x%08x\n", WINDOW_ADDR
, adm5120_board
.flash0_size
);
411 adm5120_map
.virt
= ioremap_nocache(WINDOW_ADDR
, adm5120_board
.flash0_size
);
413 if (!adm5120_map
.virt
) {
414 printk("Failed to ioremap\n");
417 simple_map_init(&adm5120_map
);
418 adm5120_map
.read
= adm5120_map_read
;
419 adm5120_map
.write
= adm5120_map_write
;
420 adm5120_map
.copy_from
= adm5120_map_copy_from
;
422 if (!(adm5120_mtd
= do_map_probe("cfi_probe", &adm5120_map
))) {
423 printk("Failed to do_map_probe\n");
424 iounmap((void *)adm5120_map
.virt
);
428 adm5120_mtd
->owner
= THIS_MODULE
;
430 size
= adm5120_mtd
->size
;
432 printk(KERN_NOTICE
"Flash device: 0x%x at 0x%x\n", size
, WINDOW_ADDR
);
434 #ifdef CONFIG_MTD_PARTITIONS
435 if (mips_machtype
== MACH_ADM5120_WP54G_WRT
)
437 printk(KERN_NOTICE
"adm5120 : using CFE flash mapping\n");
438 parts
= init_mtd_partitions(adm5120_mtd
, size
);
440 for (i
= 0; parts
[i
].name
; i
++);
441 ret
= add_mtd_partitions(adm5120_mtd
, parts
, i
);
444 printk(KERN_ERR
"Flash: add_mtd_partitions failed\n");
449 #ifdef CONFIG_MTD_MYLOADER_PARTS
450 if (adm5120_boot_loader
== BOOT_LOADER_MYLOADER
)
453 printk(KERN_NOTICE
"adm5120 : using MyLoader flash mapping\n");
455 if (parsed_nr_parts
== 0) {
456 ret
= parse_myloader_partitions(adm5120_mtd
, &parts
, 0);
459 part_type
="MyLoader";
460 parsed_nr_parts
= ret
;
463 ret
= add_mtd_partitions(adm5120_mtd
, parts
, parsed_nr_parts
);
466 printk(KERN_ERR
"Flash: add_mtd_partitions failed\n");
475 map_destroy(adm5120_mtd
);
476 if (adm5120_map
.virt
)
477 iounmap((void *)adm5120_map
.virt
);
478 adm5120_map
.virt
= 0;
482 void __exit
cleanup_adm5120_map(void)
484 #ifdef CONFIG_MTD_PARTITIONS
485 del_mtd_partitions(adm5120_mtd
);
487 map_destroy(adm5120_mtd
);
488 iounmap((void *)adm5120_map
.virt
);
491 module_init(init_adm5120_map
);
492 module_exit(cleanup_adm5120_map
);