2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2018 Aleph One Ltd.
6 * Created by Charles Manning <charles@aleph1.co.uk>
7 * Nick Bane modifications flagged NCB
8 * Endian handling patches by James Ng.
9 * mkyaffs2image hacks by NCB
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
19 * Makes a YAFFS2 file system image that can be used to load up a file system.
20 * Uses default Linux MTD layout - search for "NAND LAYOUT" to change.
26 #include <sys/types.h>
33 #include "yaffs_ecc.h"
34 #include "yaffs_guts.h"
36 #include "yaffs_packedtags2.h"
38 unsigned yaffs_trace_mask=0;
40 #define MAX_OBJECTS 10000
42 // Adjust these to match your NAND LAYOUT:
43 #define chunkSize 2048
45 #define pagesPerBlock 64
57 static objItem obj_list[MAX_OBJECTS];
58 static int obj_id = YAFFS_NOBJECT_BUCKETS + 1;
60 static int n_obj, nDirectories, nPages;
65 static int savedErrno;
67 static int convert_endian = 0;
69 static void fatal(const char *fn)
76 static int warn(const char *fn)
84 static int obj_compare(const void *a, const void * b)
91 if(oa->dev < ob->dev) return -1;
92 if(oa->dev > ob->dev) return 1;
93 if(oa->ino < ob->ino) return -1;
94 if(oa->ino > ob->ino) return 1;
100 static void add_obj_to_list(dev_t dev, ino_t ino, int obj)
102 if(n_obj < MAX_OBJECTS)
104 obj_list[n_obj].dev = dev;
105 obj_list[n_obj].ino = ino;
106 obj_list[n_obj].obj = obj;
108 qsort(obj_list,n_obj,sizeof(objItem),obj_compare);
113 // oops! not enough space in the object array
114 fprintf(stderr,"Not enough space in object array\n");
120 static int find_obj_in_list(dev_t dev, ino_t ino)
130 i = bsearch(&test,obj_list,n_obj,sizeof(objItem),obj_compare);
140 /* This little function converts a little endian tag to a big endian tag.
141 * NOTE: The tag is not usable after this other than calculating the CRC
144 static void little_to_big_endian(struct yaffs_ext_tags *tagsPtr)
147 union yaffs_tags_union * tags = (union yaffs_tags_union* )tagsPtr; // Work in bytes.
148 union yaffs_tags_union temp;
150 memset(&temp, 0, sizeof(temp));
151 // Ick, I hate magic numbers.
152 temp.as_bytes[0] = ((tags->as_bytes[2] & 0x0F) << 4) | ((tags->as_bytes[1] & 0xF0) >> 4);
153 temp.as_bytes[1] = ((tags->as_bytes[1] & 0x0F) << 4) | ((tags->as_bytes[0] & 0xF0) >> 4);
154 temp.as_bytes[2] = ((tags->as_bytes[0] & 0x0F) << 4) | ((tags->as_bytes[2] & 0x30) >> 2) | ((tags->as_bytes[3] & 0xC0) >> 6);
155 temp.as_bytes[3] = ((tags->as_bytes[3] & 0x3F) << 2) | ((tags->as_bytes[2] & 0xC0) >> 6);
156 temp.as_bytes[4] = ((tags->as_bytes[6] & 0x03) << 6) | ((tags->as_bytes[5] & 0xFC) >> 2);
157 temp.as_bytes[5] = ((tags->as_bytes[5] & 0x03) << 6) | ((tags->as_bytes[4] & 0xFC) >> 2);
158 temp.as_bytes[6] = ((tags->as_bytes[4] & 0x03) << 6) | (tags->as_bytes[7] & 0x3F);
159 temp.as_bytes[7] = (tags->as_bytes[6] & 0xFC) | ((tags->as_bytes[7] & 0xC0) >> 6);
162 tags->as_bytes[0] = temp.as_bytes[0];
163 tags->as_bytes[1] = temp.as_bytes[1];
164 tags->as_bytes[2] = temp.as_bytes[2];
165 tags->as_bytes[3] = temp.as_bytes[3];
166 tags->as_bytes[4] = temp.as_bytes[4];
167 tags->as_bytes[5] = temp.as_bytes[5];
168 tags->as_bytes[6] = temp.as_bytes[6];
169 tags->as_bytes[7] = temp.as_bytes[7];
173 static void shuffle_oob(char *spareData, struct yaffs_packed_tags2 *pt)
175 assert(sizeof(*pt) <= spareSize);
176 // NAND LAYOUT: For non-trivial OOB orderings, here would be a good place to shuffle.
177 memcpy(spareData, pt, sizeof(*pt));
180 static int write_chunk(u8 *data, u32 id, u32 chunk_id, u32 n_bytes)
182 struct yaffs_ext_tags t;
183 struct yaffs_packed_tags2 pt;
184 char spareData[spareSize];
186 if (write(outFile,data,chunkSize) != chunkSize)
189 memset(&t, 0, sizeof(t));
191 t.chunk_id = chunk_id;
192 // t.serial_number = 0;
193 t.serial_number = 1; // **CHECK**
197 t.seq_number = YAFFS_LOWEST_SEQUENCE_NUMBER;
199 // added NCB **CHECK**
204 little_to_big_endian(&t);
209 memset(&pt, 0, sizeof(pt));
210 yaffs_pack_tags2(&pt,&t,1);
212 memset(spareData, 0xff, sizeof(spareData));
213 shuffle_oob(spareData, &pt);
215 if (write(outFile,spareData,sizeof(spareData)) != sizeof(spareData))
220 #define SWAP32(x) ((((x) & 0x000000FF) << 24) | \
221 (((x) & 0x0000FF00) << 8 ) | \
222 (((x) & 0x00FF0000) >> 8 ) | \
223 (((x) & 0xFF000000) >> 24))
225 #define SWAP16(x) ((((x) & 0x00FF) << 8) | \
226 (((x) & 0xFF00) >> 8))
228 // This one is easier, since the types are more standard. No funky shifts here.
229 static void object_header_little_to_big_endian(struct yaffs_obj_hdr* oh)
231 oh->type = SWAP32(oh->type); // GCC makes enums 32 bits.
232 oh->parent_obj_id = SWAP32(oh->parent_obj_id); // int
233 oh->sum_no_longer_used = SWAP16(oh->sum_no_longer_used); // u16 - Not used, but done for completeness.
234 // name = skip. Char array. Not swapped.
235 oh->yst_mode = SWAP32(oh->yst_mode);
238 oh->yst_uid = SWAP32(oh->yst_uid);
239 oh->yst_gid = SWAP32(oh->yst_gid);
240 oh->yst_atime = SWAP32(oh->yst_atime);
241 oh->yst_mtime = SWAP32(oh->yst_mtime);
242 oh->yst_ctime = SWAP32(oh->yst_ctime);
244 oh->file_size_low = SWAP32(oh->file_size_low); // Aiee. An int... signed, at that!
245 oh->file_size_high = SWAP32(oh->file_size_high); // Aiee. An int... signed, at that!
246 oh->equiv_id = SWAP32(oh->equiv_id);
247 // alias - char array.
248 oh->yst_rdev = SWAP32(oh->yst_rdev);
250 oh->win_ctime[0] = SWAP32(oh->win_ctime[0]);
251 oh->win_ctime[1] = SWAP32(oh->win_ctime[1]);
252 oh->win_atime[0] = SWAP32(oh->win_atime[0]);
253 oh->win_atime[1] = SWAP32(oh->win_atime[1]);
254 oh->win_mtime[0] = SWAP32(oh->win_mtime[0]);
255 oh->win_mtime[1] = SWAP32(oh->win_mtime[1]);
257 oh->reserved[0] = SWAP32(oh->reserved[0]);
258 oh->reserved[1] = SWAP32(oh->reserved[1]);
260 oh->inband_shadowed_obj_id = SWAP32(oh->inband_shadowed_obj_id);
261 oh->inband_is_shrink = SWAP32(oh->inband_is_shrink);
262 oh->shadows_obj = SWAP32(oh->shadows_obj);
263 oh->is_shrink = SWAP32(oh->is_shrink);
267 static int write_object_header(int id, enum yaffs_obj_type t, struct stat *s, int parent, const char *name, int equivalentObj, const char * alias)
272 struct yaffs_obj_hdr *oh = (struct yaffs_obj_hdr *)bytes;
274 memset(bytes,0xff,sizeof(bytes));
278 oh->parent_obj_id = parent;
280 if (strlen(name)+1 > sizeof(oh->name))
282 errno = ENAMETOOLONG;
283 return warn("object name");
285 memset(oh->name,0,sizeof(oh->name));
286 strcpy(oh->name,name);
289 if(t != YAFFS_OBJECT_TYPE_HARDLINK)
291 oh->yst_mode = s->st_mode;
292 oh->yst_uid = s->st_uid;
293 // NCB 12/9/02 oh->yst_gid = s->yst_uid;
294 oh->yst_gid = s->st_gid;
295 oh->yst_atime = s->st_atime;
296 oh->yst_mtime = s->st_mtime;
297 oh->yst_ctime = s->st_ctime;
298 oh->yst_rdev = s->st_rdev;
301 if(t == YAFFS_OBJECT_TYPE_FILE)
303 oh->file_size_low = s->st_size;
304 oh->file_size_high = (s->st_size >> 32);
307 if(t == YAFFS_OBJECT_TYPE_HARDLINK)
309 oh->equiv_id = equivalentObj;
312 if(t == YAFFS_OBJECT_TYPE_SYMLINK)
314 if (strlen(alias)+1 > sizeof(oh->alias))
316 errno = ENAMETOOLONG;
317 return warn("object alias");
319 memset(oh->alias,0,sizeof(oh->alias));
320 strcpy(oh->alias,alias);
325 object_header_little_to_big_endian(oh);
328 return write_chunk(bytes,id,0,0xffff);
332 static void pad_image(void)
334 u8 data[chunkSize + spareSize];
335 int padPages = (nPages % pagesPerBlock);
339 memset(data, 0xff, sizeof(data));
340 for (padPages = pagesPerBlock-padPages; padPages; padPages--)
342 if (write(outFile, data, sizeof(data)) != sizeof(data))
348 static int process_directory(int parent, const char *path)
352 struct dirent *entry;
363 while((entry = readdir(dir)) != NULL)
366 /* Ignore . and .. */
367 if(strcmp(entry->d_name,".") &&
368 strcmp(entry->d_name,".."))
375 if (snprintf(full_name,sizeof(full_name),"%s/%s",path,entry->d_name) >= (int)sizeof(full_name))
381 if (lstat(full_name,&stats) < 0)
387 if(S_ISLNK(stats.st_mode) ||
388 S_ISREG(stats.st_mode) ||
389 S_ISDIR(stats.st_mode) ||
390 S_ISFIFO(stats.st_mode) ||
391 S_ISBLK(stats.st_mode) ||
392 S_ISCHR(stats.st_mode) ||
393 S_ISSOCK(stats.st_mode))
399 printf("Object %d, %s is a ",newObj,full_name);
401 /* We're going to create an object for it */
402 if((equivalentObj = find_obj_in_list(stats.st_dev, stats.st_ino)) > 0)
404 /* we need to make a hard link */
405 printf("hard link to object %d\n",equivalentObj);
406 write_object_header(newObj, YAFFS_OBJECT_TYPE_HARDLINK, &stats, parent, entry->d_name, equivalentObj, NULL);
411 add_obj_to_list(stats.st_dev,stats.st_ino,newObj);
413 if(S_ISLNK(stats.st_mode))
418 memset(symname,0, sizeof(symname));
420 if (readlink(full_name,symname,sizeof(symname) -1) < 0)
426 printf("symlink to \"%s\"\n",symname);
427 write_object_header(newObj, YAFFS_OBJECT_TYPE_SYMLINK, &stats, parent, entry->d_name, -1, symname);
430 else if(S_ISREG(stats.st_mode))
433 if(write_object_header(newObj, YAFFS_OBJECT_TYPE_FILE, &stats, parent, entry->d_name, -1, NULL) == 0)
440 h = open(full_name,O_RDONLY);
443 memset(bytes,0xff,sizeof(bytes));
444 while((n_bytes = read(h,bytes,sizeof(bytes))) > 0)
447 write_chunk(bytes,newObj,chunk,n_bytes);
448 memset(bytes,0xff,sizeof(bytes));
453 printf("%d data chunks written\n",chunk);
464 else if(S_ISSOCK(stats.st_mode))
467 write_object_header(newObj, YAFFS_OBJECT_TYPE_SPECIAL, &stats, parent, entry->d_name, -1, NULL);
469 else if(S_ISFIFO(stats.st_mode))
472 write_object_header(newObj, YAFFS_OBJECT_TYPE_SPECIAL, &stats, parent, entry->d_name, -1, NULL);
474 else if(S_ISCHR(stats.st_mode))
476 printf("character device\n");
477 write_object_header(newObj, YAFFS_OBJECT_TYPE_SPECIAL, &stats, parent, entry->d_name, -1, NULL);
479 else if(S_ISBLK(stats.st_mode))
481 printf("block device\n");
482 write_object_header(newObj, YAFFS_OBJECT_TYPE_SPECIAL, &stats, parent, entry->d_name, -1, NULL);
484 else if(S_ISDIR(stats.st_mode))
486 printf("directory\n");
487 if (write_object_header(newObj, YAFFS_OBJECT_TYPE_DIRECTORY, &stats, parent, entry->d_name, -1, NULL) == 0)
488 process_directory(newObj,full_name);
494 fprintf(stderr, "%s: unhandled type\n", full_name);
508 int main(int argc, char *argv[])
512 printf("mkyaffs2image: image building tool for YAFFS2 built "__DATE__"\n");
516 printf("usage: mkyaffs2image dir image_file [convert]\n");
517 printf(" dir the directory tree to be converted\n");
518 printf(" image_file the output file to hold the image\n");
519 printf(" 'convert' produce a big-endian image from a little-endian machine\n");
523 if ((argc == 4) && (!strncmp(argv[3], "convert", strlen("convert"))))
528 if(stat(argv[1],&stats) < 0)
530 printf("Could not stat %s\n",argv[1]);
534 if(!S_ISDIR(stats.st_mode))
536 printf(" %s is not a directory\n",argv[1]);
540 outFile = open(argv[2],O_CREAT | O_TRUNC | O_WRONLY, S_IREAD | S_IWRITE);
545 printf("Could not open output file %s\n",argv[2]);
549 printf("Processing directory %s into image file %s\n",argv[1],argv[2]);
550 process_directory(YAFFS_OBJECTID_ROOT,argv[1]);
559 perror("operation incomplete");
563 printf("Operation complete.\n"
564 "%d objects in %d directories\n"
565 "%d NAND pages\n",n_obj, nDirectories, nPages);