2 * $Id: redboot.c,v 1.21 2006/03/30 18:34:37 bjd Exp $
4 * Parse RedBoot-style Flash Image System (FIS) tables and
5 * produce a Linux partition array to match.
8 #include <linux/kernel.h>
9 #include <linux/slab.h>
10 #include <linux/init.h>
11 #include <linux/vmalloc.h>
13 #include <linux/mtd/mtd.h>
14 #include <linux/mtd/partitions.h>
16 struct fis_image_desc
{
17 unsigned char name
[16]; // Null terminated name
18 uint32_t flash_base
; // Address within FLASH of image
19 uint32_t mem_base
; // Address in memory where it executes
20 uint32_t size
; // Length of image
21 uint32_t entry_point
; // Execution entry point
22 uint32_t data_length
; // Length of actual data
23 unsigned char _pad
[256-(16+7*sizeof(uint32_t))];
24 uint32_t desc_cksum
; // Checksum over image descriptor
25 uint32_t file_cksum
; // Checksum over image data
29 struct fis_image_desc
*img
;
30 struct fis_list
*next
;
33 static int directory
= CONFIG_MTD_REDBOOT_DIRECTORY_BLOCK
;
34 module_param(directory
, int, 0);
36 static inline int redboot_checksum(struct fis_image_desc
*img
)
38 /* RedBoot doesn't actually write the desc_cksum field yet AFAICT */
42 static int parse_redboot_partitions(struct mtd_info
*master
,
43 struct mtd_partition
**pparts
,
44 unsigned long fis_origin
)
47 struct fis_image_desc
*buf
;
48 struct mtd_partition
*parts
;
49 struct fis_list
*fl
= NULL
, *tmp_fl
;
58 #ifdef CONFIG_MTD_REDBOOT_PARTS_UNALLOCATED
59 static char nullstring
[] = "unallocated";
62 buf
= vmalloc(master
->erasesize
);
68 offset
= master
->size
+ directory
*master
->erasesize
;
70 offset
= directory
*master
->erasesize
;
72 printk(KERN_NOTICE
"Searching for RedBoot partition table in %s at offset 0x%lx\n",
73 master
->name
, offset
);
75 ret
= master
->read(master
, offset
,
76 master
->erasesize
, &retlen
, (void *)buf
);
81 if (retlen
!= master
->erasesize
) {
86 numslots
= (master
->erasesize
/ sizeof(struct fis_image_desc
));
87 for (i
= 0; i
< numslots
; i
++) {
88 if (!memcmp(buf
[i
].name
, "FIS directory", 14)) {
89 /* This is apparently the FIS directory entry for the
90 * FIS directory itself. The FIS directory size is
91 * one erase block; if the buf[i].size field is
92 * swab32(erasesize) then we know we are looking at
93 * a byte swapped FIS directory - swap all the entries!
94 * (NOTE: this is 'size' not 'data_length'; size is
95 * the full size of the entry.)
97 if (swab32(buf
[i
].size
) == master
->erasesize
) {
99 for (j
= 0; j
< numslots
; ++j
) {
101 /* A single 0xff denotes a deleted entry.
102 * Two of them in a row is the end of the table.
104 if (buf
[j
].name
[0] == 0xff) {
105 if (buf
[j
].name
[1] == 0xff) {
112 /* The unsigned long fields were written with the
113 * wrong byte sex, name and pad have no byte sex.
115 swab32s(&buf
[j
].flash_base
);
116 swab32s(&buf
[j
].mem_base
);
117 swab32s(&buf
[j
].size
);
118 swab32s(&buf
[j
].entry_point
);
119 swab32s(&buf
[j
].data_length
);
120 swab32s(&buf
[j
].desc_cksum
);
121 swab32s(&buf
[j
].file_cksum
);
126 /* re-calculate of real numslots */
127 numslots
= buf
[i
].size
/ sizeof(struct fis_image_desc
);
132 printk(KERN_NOTICE
"No RedBoot partition table detected in %s\n",
138 for (i
= 0; i
< numslots
; i
++) {
139 struct fis_list
*new_fl
, **prev
;
141 if (buf
[i
].name
[0] == 0xff) {
142 if (buf
[i
].name
[1] == 0xff) {
148 if (!redboot_checksum(&buf
[i
]))
151 new_fl
= kmalloc(sizeof(struct fis_list
), GFP_KERNEL
);
152 namelen
+= strlen(buf
[i
].name
)+1;
157 new_fl
->img
= &buf
[i
];
159 buf
[i
].flash_base
-= fis_origin
;
161 buf
[i
].flash_base
&= master
->size
-1;
164 /* I'm sure the JFFS2 code has done me permanent damage.
165 * I now think the following is _normal_
168 while(*prev
&& (*prev
)->img
->flash_base
< new_fl
->img
->flash_base
)
169 prev
= &(*prev
)->next
;
170 new_fl
->next
= *prev
;
175 #ifdef CONFIG_MTD_REDBOOT_PARTS_UNALLOCATED
176 if (fl
->img
->flash_base
) {
178 nulllen
= sizeof(nullstring
);
181 for (tmp_fl
= fl
; tmp_fl
->next
; tmp_fl
= tmp_fl
->next
) {
182 if (tmp_fl
->img
->flash_base
+ tmp_fl
->img
->size
+ master
->erasesize
<= tmp_fl
->next
->img
->flash_base
) {
184 nulllen
= sizeof(nullstring
);
188 parts
= kzalloc(sizeof(*parts
)*nrparts
+ nulllen
+ namelen
, GFP_KERNEL
);
195 nullname
= (char *)&parts
[nrparts
];
196 #ifdef CONFIG_MTD_REDBOOT_PARTS_UNALLOCATED
198 strcpy(nullname
, nullstring
);
201 names
= nullname
+ nulllen
;
205 #ifdef CONFIG_MTD_REDBOOT_PARTS_UNALLOCATED
206 if (fl
->img
->flash_base
) {
207 parts
[0].name
= nullname
;
208 parts
[0].size
= fl
->img
->flash_base
;
213 for ( ; i
<nrparts
; i
++) {
214 parts
[i
].size
= fl
->img
->size
;
215 parts
[i
].offset
= fl
->img
->flash_base
;
216 parts
[i
].name
= names
;
218 strcpy(names
, fl
->img
->name
);
219 #ifdef CONFIG_MTD_REDBOOT_PARTS_READONLY
220 if (!memcmp(names
, "RedBoot", 8) ||
221 !memcmp(names
, "RedBoot config", 15) ||
222 !memcmp(names
, "FIS directory", 14)) {
223 parts
[i
].mask_flags
= MTD_WRITEABLE
;
226 names
+= strlen(names
)+1;
228 #ifdef CONFIG_MTD_REDBOOT_PARTS_UNALLOCATED
229 if(fl
->next
&& fl
->img
->flash_base
+ fl
->img
->size
+ master
->erasesize
<= fl
->next
->img
->flash_base
) {
231 parts
[i
].offset
= parts
[i
-1].size
+ parts
[i
-1].offset
;
232 parts
[i
].size
= fl
->next
->img
->flash_base
- parts
[i
].offset
;
233 parts
[i
].name
= nullname
;
244 struct fis_list
*old
= fl
;
252 static struct mtd_part_parser redboot_parser
= {
253 .owner
= THIS_MODULE
,
254 .parse_fn
= parse_redboot_partitions
,
258 static int __init
redboot_parser_init(void)
260 return register_mtd_parser(&redboot_parser
);
263 static void __exit
redboot_parser_exit(void)
265 deregister_mtd_parser(&redboot_parser
);
268 module_init(redboot_parser_init
);
269 module_exit(redboot_parser_exit
);
271 MODULE_LICENSE("GPL");
272 MODULE_AUTHOR("Red Hat, Inc. - David Woodhouse <dwmw2@cambridge.redhat.com>");
273 MODULE_DESCRIPTION("Parsing code for RedBoot Flash Image System (FIS) tables");