Backport [7224] to the adm5120 flash map driver
[openwrt/svn-archive/archive.git] / target / linux / adm5120-2.6 / files / drivers / mtd / maps / adm5120_mtd.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 ADM5120 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/squashfs_fs.h>
50 #include <linux/jffs2.h>
51 #include <linux/crc32.h>
52 #include <asm/io.h>
53 #include <asm/mach-adm5120/myloader.h>
54 #include <asm/mach-adm5120/adm5120_info.h>
55
56 extern int parse_myloader_partitions(struct mtd_info *master,
57 struct mtd_partition **pparts,
58 unsigned long origin);
59
60 /* Macros for switching flash bank
61 ADM5120 only support 2MB flash address space
62 so GPIO5 is used as A20
63 */
64 #define GPIO_IO ((volatile unsigned long *)0xb20000b8)
65 #define FLASH_A20_GPIO 5
66 #define FLASH_BOUNDARY 0x200000
67
68
69 #define TRX_MAGIC 0x30524448 /* "HDR0" */
70 #define TRX_VERSION 1
71 #define TRX_MAX_LEN 0x3A0000
72 #define TRX_NO_HEADER 1 /* Do not write TRX header */
73 #define TRX_GZ_FILES 0x2 /* Contains up to TRX_MAX_OFFSET individual gzip files */
74 #define TRX_MAX_OFFSET 3
75
76 struct trx_header {
77 u32 magic; /* "HDR0" */
78 u32 len; /* Length of file including header */
79 u32 crc32; /* 32-bit CRC from flag_version to end of file */
80 u32 flag_version; /* 0:15 flags, 16:31 version */
81 u32 offsets[TRX_MAX_OFFSET]; /* Offsets of partitions from start of header */
82 };
83
84 #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))
85 #define NVRAM_SPACE 0x8000
86 #define WINDOW_ADDR 0x1fc00000
87 #define WINDOW_SIZE 0x400000
88 #define BUSWIDTH 2
89
90 static struct mtd_info *adm5120_mtd;
91
92 static struct map_info adm5120_map = {
93 name: "adm5120 physically mapped flash",
94 size: WINDOW_SIZE,
95 bankwidth: BUSWIDTH,
96 phys: WINDOW_ADDR,
97 };
98
99 #ifdef CONFIG_MTD_PARTITIONS
100
101 static struct mtd_partition adm5120_cfe_parts[] = {
102 { name: "cfe", offset: 0, size: 0, mask_flags: MTD_WRITEABLE, },
103 { name: "linux", offset: 0, size: 0, },
104 { name: "rootfs", offset: 0, size: 0, },
105 { name: "nvram", offset: 0, size: 0, },
106 { name: NULL, },
107 };
108
109
110 static void flash_switch_bank(unsigned long addr)
111 {
112 unsigned long val;
113
114 /* Set GPIO as output */
115 val = *GPIO_IO | (1 << (FLASH_A20_GPIO+16));
116 if ( addr & FLASH_BOUNDARY ) {
117 val |= 1 << (FLASH_A20_GPIO + 24);
118 } else {
119 val &= ~(1 << (FLASH_A20_GPIO + 24));
120 }
121 *GPIO_IO = val;
122 }
123
124 static map_word adm5120_map_read(struct map_info *map, unsigned long ofs)
125 {
126 flash_switch_bank(ofs);
127 return inline_map_read(map, ofs);
128 }
129
130 static void adm5120_map_write(struct map_info *map, const map_word datum, unsigned long ofs)
131 {
132 flash_switch_bank(ofs);
133 inline_map_write(map, datum, ofs);
134 }
135
136 static void adm5120_map_copy_from(struct map_info *map, void *to, unsigned long from, ssize_t len)
137 {
138 ssize_t tmp;
139
140 if (from < FLASH_BOUNDARY) {
141 tmp = (len < (FLASH_BOUNDARY - from)) ? len : (FLASH_BOUNDARY - from);
142 flash_switch_bank(0);
143 inline_map_copy_from(map, to, from, tmp);
144 to = (void *)((char *)to + tmp);
145 from += tmp;
146 len -= tmp;
147 }
148 if (len > 0) {
149 flash_switch_bank(FLASH_BOUNDARY);
150 inline_map_copy_from(map, to, from, len);
151 }
152
153 }
154
155 static int __init
156 find_cfe_size(struct mtd_info *mtd, size_t size)
157 {
158 struct trx_header *trx;
159 unsigned char buf[512];
160 int off;
161 size_t len;
162 int blocksize;
163
164 trx = (struct trx_header *) buf;
165
166 blocksize = mtd->erasesize;
167 if (blocksize < 0x10000)
168 blocksize = 0x10000;
169
170 for (off = (128*1024); off < size; off += blocksize) {
171 memset(buf, 0xe5, sizeof(buf));
172
173 /*
174 * Read into buffer
175 */
176 if (mtd->read(mtd, off, sizeof(buf), &len, buf) ||
177 len != sizeof(buf))
178 continue;
179
180 /* found a TRX header */
181 if (le32_to_cpu(trx->magic) == TRX_MAGIC) {
182 goto found;
183 }
184 }
185
186 printk(KERN_NOTICE
187 "%s: Couldn't find bootloader size\n",
188 mtd->name);
189 return -1;
190
191 found:
192 printk(KERN_NOTICE "bootloader size: %d\n", off);
193 return off;
194
195 }
196
197 /*
198 * Copied from mtdblock.c
199 *
200 * Cache stuff...
201 *
202 * Since typical flash erasable sectors are much larger than what Linux's
203 * buffer cache can handle, we must implement read-modify-write on flash
204 * sectors for each block write requests. To avoid over-erasing flash sectors
205 * and to speed things up, we locally cache a whole flash sector while it is
206 * being written to until a different sector is required.
207 */
208
209 static void erase_callback(struct erase_info *done)
210 {
211 wait_queue_head_t *wait_q = (wait_queue_head_t *)done->priv;
212 wake_up(wait_q);
213 }
214
215 static int erase_write (struct mtd_info *mtd, unsigned long pos,
216 int len, const char *buf)
217 {
218 struct erase_info erase;
219 DECLARE_WAITQUEUE(wait, current);
220 wait_queue_head_t wait_q;
221 size_t retlen;
222 int ret;
223
224 /*
225 * First, let's erase the flash block.
226 */
227
228 init_waitqueue_head(&wait_q);
229 erase.mtd = mtd;
230 erase.callback = erase_callback;
231 erase.addr = pos;
232 erase.len = len;
233 erase.priv = (u_long)&wait_q;
234
235 set_current_state(TASK_INTERRUPTIBLE);
236 add_wait_queue(&wait_q, &wait);
237
238 ret = mtd->erase(mtd, &erase);
239 if (ret) {
240 set_current_state(TASK_RUNNING);
241 remove_wait_queue(&wait_q, &wait);
242 printk (KERN_WARNING "erase of region [0x%lx, 0x%x] "
243 "on \"%s\" failed\n",
244 pos, len, mtd->name);
245 return ret;
246 }
247
248 schedule(); /* Wait for erase to finish. */
249 remove_wait_queue(&wait_q, &wait);
250
251 /*
252 * Next, writhe data to flash.
253 */
254
255 ret = mtd->write (mtd, pos, len, &retlen, buf);
256 if (ret)
257 return ret;
258 if (retlen != len)
259 return -EIO;
260 return 0;
261 }
262
263
264
265
266 static int __init
267 find_root(struct mtd_info *mtd, size_t size, struct mtd_partition *part)
268 {
269 struct trx_header trx, *trx2;
270 unsigned char buf[512], *block;
271 int off, blocksize;
272 u32 i, crc = ~0;
273 size_t len;
274 struct squashfs_super_block *sb = (struct squashfs_super_block *) buf;
275
276 blocksize = mtd->erasesize;
277 if (blocksize < 0x10000)
278 blocksize = 0x10000;
279
280 for (off = (128*1024); off < size; off += blocksize) {
281 memset(&trx, 0xe5, sizeof(trx));
282
283 /*
284 * Read into buffer
285 */
286 if (mtd->read(mtd, off, sizeof(trx), &len, (char *) &trx) ||
287 len != sizeof(trx))
288 continue;
289
290 /* found a TRX header */
291 if (le32_to_cpu(trx.magic) == TRX_MAGIC) {
292 part->offset = le32_to_cpu(trx.offsets[2]) ? :
293 le32_to_cpu(trx.offsets[1]);
294 part->size = le32_to_cpu(trx.len);
295
296 part->size -= part->offset;
297 part->offset += off;
298
299 goto found;
300 }
301 }
302
303 printk(KERN_NOTICE
304 "%s: Couldn't find root filesystem\n",
305 mtd->name);
306 return -1;
307
308 found:
309 if (part->size == 0)
310 return 0;
311
312 if (mtd->read(mtd, part->offset, sizeof(buf), &len, buf) || len != sizeof(buf))
313 return 0;
314
315 /* Move the fs outside of the trx */
316 part->size = 0;
317
318 if (trx.len != part->offset + part->size - off) {
319 /* Update the trx offsets and length */
320 trx.len = part->offset + part->size - off;
321
322 /* Update the trx crc32 */
323 for (i = (u32) &(((struct trx_header *)NULL)->flag_version); i <= trx.len; i += sizeof(buf)) {
324 if (mtd->read(mtd, off + i, sizeof(buf), &len, buf) || len != sizeof(buf))
325 return 0;
326 crc = crc32_le(crc, buf, min(sizeof(buf), trx.len - i));
327 }
328 trx.crc32 = crc;
329
330 /* read first eraseblock from the trx */
331 block = kmalloc(mtd->erasesize, GFP_KERNEL);
332 trx2 = (struct trx_header *) block;
333 if (mtd->read(mtd, off, mtd->erasesize, &len, block) || len != mtd->erasesize) {
334 printk("Error accessing the first trx eraseblock\n");
335 return 0;
336 }
337
338 printk("Updating TRX offsets and length:\n");
339 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);
340 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);
341
342 /* Write updated trx header to the flash */
343 memcpy(block, &trx, sizeof(trx));
344 if (mtd->unlock)
345 mtd->unlock(mtd, off, mtd->erasesize);
346 erase_write(mtd, off, mtd->erasesize, block);
347 if (mtd->sync)
348 mtd->sync(mtd);
349 kfree(block);
350 printk("Done\n");
351 }
352
353 return part->size;
354 }
355
356 struct mtd_partition * __init
357 init_mtd_partitions(struct mtd_info *mtd, size_t size)
358 {
359 int cfe_size;
360
361 if ((cfe_size = find_cfe_size(mtd,size)) < 0)
362 return NULL;
363
364 /* boot loader */
365 adm5120_cfe_parts[0].offset = 0;
366 adm5120_cfe_parts[0].size = cfe_size;
367
368 /* nvram */
369 if (cfe_size != 384 * 1024) {
370 adm5120_cfe_parts[3].offset = size - ROUNDUP(NVRAM_SPACE, mtd->erasesize);
371 adm5120_cfe_parts[3].size = ROUNDUP(NVRAM_SPACE, mtd->erasesize);
372 } else {
373 /* nvram (old 128kb config partition on netgear wgt634u) */
374 adm5120_cfe_parts[3].offset = adm5120_cfe_parts[0].size;
375 adm5120_cfe_parts[3].size = ROUNDUP(NVRAM_SPACE, mtd->erasesize);
376 }
377
378 /* linux (kernel and rootfs) */
379 if (cfe_size != 384 * 1024) {
380 adm5120_cfe_parts[1].offset = adm5120_cfe_parts[0].size;
381 adm5120_cfe_parts[1].size = adm5120_cfe_parts[3].offset -
382 adm5120_cfe_parts[1].offset;
383 } else {
384 /* do not count the elf loader, which is on one block */
385 adm5120_cfe_parts[1].offset = adm5120_cfe_parts[0].size +
386 adm5120_cfe_parts[3].size + mtd->erasesize;
387 adm5120_cfe_parts[1].size = size -
388 adm5120_cfe_parts[0].size -
389 (2*adm5120_cfe_parts[3].size) -
390 mtd->erasesize;
391 }
392
393 /* find and size rootfs */
394 find_root(mtd,size,&adm5120_cfe_parts[2]);
395 adm5120_cfe_parts[2].size = size - adm5120_cfe_parts[2].offset - adm5120_cfe_parts[3].size;
396
397 return adm5120_cfe_parts;
398 }
399 #endif
400
401 int __init init_adm5120_map(void)
402 {
403 size_t size;
404 int ret = 0;
405 #if defined (CONFIG_MTD_PARTITIONS) || (CONFIG_MTD_MYLOADER_PARTS)
406 struct mtd_partition *parts;
407 int i, parsed_nr_parts = 0;
408 #endif
409 printk("adm5120 : flash init : 0x%08x 0x%08x\n", WINDOW_ADDR, WINDOW_SIZE);
410 adm5120_map.virt = ioremap_nocache(WINDOW_ADDR, WINDOW_SIZE);
411
412 if (!adm5120_map.virt) {
413 printk("Failed to ioremap\n");
414 return -EIO;
415 }
416 simple_map_init(&adm5120_map);
417 adm5120_map.read = adm5120_map_read;
418 adm5120_map.write = adm5120_map_write;
419 adm5120_map.copy_from = adm5120_map_copy_from;
420
421 if (!(adm5120_mtd = do_map_probe("cfi_probe", &adm5120_map))) {
422 printk("Failed to do_map_probe\n");
423 iounmap((void *)adm5120_map.virt);
424 return -ENXIO;
425 }
426
427 adm5120_mtd->owner = THIS_MODULE;
428
429 size = adm5120_mtd->size;
430
431 printk(KERN_NOTICE "Flash device: 0x%x at 0x%x\n", size, WINDOW_ADDR);
432
433 #ifdef CONFIG_MTD_PARTITIONS
434
435 if (adm5120_boot_loader == BOOT_LOADER_CFE)
436 {
437 printk(KERN_NOTICE "adm5120 : using CFE flash mapping\n");
438 parts = init_mtd_partitions(adm5120_mtd, size);
439
440 for (i = 0; parts[i].name; i++);
441 ret = add_mtd_partitions(adm5120_mtd, parts, i);
442
443 if (ret) {
444 printk(KERN_ERR "Flash: add_mtd_partitions failed\n");
445 goto fail;
446 }
447 }
448 #endif
449 #ifdef CONFIG_MTD_MYLOADER_PARTS
450 if (adm5120_boot_loader == BOOT_LOADER_MYLOADER)
451 {
452 printk(KERN_NOTICE "adm5120 : using MyLoader flash mapping\n");
453 char *part_type;
454
455 if (parsed_nr_parts == 0) {
456 ret = parse_myloader_partitions(adm5120_mtd, &parts, 0);
457
458 if (ret > 0) {
459 part_type ="MyLoader";
460 parsed_nr_parts = ret;
461 }
462 }
463 ret = add_mtd_partitions(adm5120_mtd, parts, parsed_nr_parts);
464
465 if (ret) {
466 printk(KERN_ERR "Flash: add_mtd_partitions failed\n");
467 goto fail;
468 }
469 }
470 #endif
471 return 0;
472
473 fail:
474 if (adm5120_mtd)
475 map_destroy(adm5120_mtd);
476 if (adm5120_map.virt)
477 iounmap((void *)adm5120_map.virt);
478 adm5120_map.virt = 0;
479 return ret;
480 }
481
482 void __exit cleanup_adm5120_map(void)
483 {
484 #ifdef CONFIG_MTD_PARTITIONS
485 del_mtd_partitions(adm5120_mtd);
486 #endif
487 map_destroy(adm5120_mtd);
488 iounmap((void *)adm5120_map.virt);
489 }
490
491 module_init(init_adm5120_map);
492 module_exit(cleanup_adm5120_map);