utils/mkyaffs.c

   1 /*
   2  * YAFFS: Yet another FFS. A NAND-flash specific file system.
   3  * mkyaffs.c Format a chunk of NAND for YAFFS.
   4  *
   5  * Copyright (C) 2002 Aleph One Ltd.
   6  *   for Toby Churchill Ltd and Brightstar Engineering
   7  *
   8  * Created by Charles Manning <charles@aleph1.co.uk>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License version 2 as
  12  * published by the Free Software Foundation.
  13  *
  14  *  Acknowledgement:
  15  *  This file is crafted from nandtest.c by  Miguel Freitas (miguel@cetuc.puc-rio.br)
  16  *  and Steven J. Hill (sjhill@cotw.com)
  17  *
  18  * Overview:
  19  * Formatting a YAFFS device is very simple. Just erase all undamaged blocks.
  20  * NB Don't erase blocks maked as damaged.
  21  */
  22
  23 #define _GNU_SOURCE
  24 #include <ctype.h>
  25 #include <fcntl.h>
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <time.h>
  29 #include <unistd.h>
  30 #include <sys/stat.h>
  31 #include <sys/ioctl.h>
  32 #include <sys/types.h>
  33 #include <asm/types.h>
  34 #include <linux/config.h>
  35 #include <linux/mtd/mtd.h>
  36
  37 const char *mkyaffs_c_version = "$Id: mkyaffs.c,v 1.6 2003-03-11 05:16:53 charles Exp $";
  38
  39 // countBits is a quick way of counting the number of bits in a byte.
  40 // ie. countBits[n] holds the number of 1 bits in a byte with the value n.
  41
  42 static const char countBits[256] =
  43 {
  44 0,1,1,2,1,2,2,3,1,2,2,3,2,3,3,4,
  45 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
  46 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
  47 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
  48 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
  49 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
  50 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
  51 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
  52 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
  53 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
  54 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
  55 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
  56 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
  57 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
  58 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
  59 4,5,5,6,5,6,6,7,5,6,6,7,6,7,7,8
  60 };
  61
  62 /*
  63  * Buffer arrays used for running tests
  64  */
  65
  66 unsigned char oobbuf[16];
  67 unsigned char imgpage[528];
  68
  69 /*
  70  * OOB layout
  71  */
  72
  73 struct nand_oobinfo yaffs_oobinfo = {
  74         useecc: 1,
  75         eccpos: {8, 9, 10, 13, 14, 15}
  76 };
  77
  78 struct nand_oobinfo yaffs_noeccinfo = {
  79         useecc: 0,
  80 };
  81
  82
  83 /*
  84  * Main program
  85  */
  86 int main(int argc, char **argv)
  87 {
  88         unsigned long addr;
  89         unsigned long offset;
  90         int fd;
  91         int img=-1;
  92         int optcnt = 1;
  93         int usemtdecc = 0;
  94         int imglen = 0;
  95         struct mtd_oob_buf oob = {0, 16, (unsigned char *) &oobbuf};
  96         mtd_info_t meminfo;
  97         erase_info_t erase;
  98         struct nand_oobinfo oobsel;
  99
 100         if (strcmp (argv[optcnt], "-e") == 0) {
 101                 optcnt++;
 102                 usemtdecc = 1;
 103         }
 104
 105         /* Make sure a device was specified */
 106         if(argc < (optcnt + 2)) {
 107                 printf("usage: %s -e <mtdname> <image name>\n", argv[0]);
 108                 exit(1);
 109         }
 110
 111         if((img = open(argv[optcnt + 1],O_RDONLY)) == -1) {
 112                 perror("opening image file");
 113                 exit(1);
 114         }
 115
 116         if(img >= 0){
 117            imglen = lseek(img,0,SEEK_END);
 118            if(imglen %528){
 119                 printf("Image not a multiple of 528 bytes\n");
 120                 exit(1);
 121            }
 122         }
 123
 124         lseek(img,0,SEEK_SET);
 125
 126         /* Open the device */
 127         if((fd = open(argv[optcnt], O_RDWR)) == -1) {
 128                 perror("opening flash");
 129                 exit(1);
 130         }
 131
 132         /* Fill in MTD device capability structure */
 133         if(ioctl(fd, MEMGETINFO, &meminfo) != 0) {
 134                 perror("MEMGETINFO");
 135                 close(fd);
 136                 exit(1);
 137         }
 138
 139         // set the appropriate oob layout selector
 140         oobsel = usemtdecc ? yaffs_oobinfo : yaffs_noeccinfo;
 141         if (ioctl (fd, MEMSETOOBSEL, &oobsel) != 0) {
 142                 perror ("MEMSETOOBSEL");
 143                 close (fd);
 144                 exit (1);
 145         }
 146
 147         /* Make sure device page sizes are valid */
 148         if( !(meminfo.oobsize == 16 && meminfo.oobblock == 512))
 149         {
 150                 printf("Unknown flash (not normal NAND)\n");
 151                 close(fd);
 152                 exit(1);
 153         }
 154
 155         if(imglen >= 0 &&
 156            (imglen/528 +32)*512 > meminfo.size){
 157                 printf("Image is too big for NAND\n");
 158                 exit(1);
 159         }
 160
 161
 162         printf("Erasing and programming NAND\n");
 163         for(addr = 0; addr < meminfo.size; addr += meminfo.erasesize)
 164         {
 165                 /* Read the OOB data to determine if the block is valid.
 166                  * If the block is damaged, then byte 5 of the OOB data will
 167                  * have at least 2 zero bits.
 168                  */
 169                 oob.start = addr;
 170                 oob.length = 16;
 171                 oob.ptr = oobbuf;
 172                 if (ioctl(fd, MEMREADOOB, &oob) != 0)
 173                 {
 174                         perror("ioctl(MEMREADOOB)");
 175                         close(fd);
 176                         exit(1);
 177                 }
 178
 179                 if(countBits[oobbuf[5]] < 7)
 180                 {
 181                         printf("Block at 0x08%lx is damaged and is not being formatted\n",addr);
 182                 }
 183                 else
 184                 {
 185                         /* Erase this block */
 186                         erase.start = addr;
 187                         erase.length = meminfo.erasesize;
 188                         printf("Erasing block at 0x08%lx\n",addr);
 189                         if(ioctl(fd, MEMERASE, &erase) != 0)
 190                         {
 191                                 perror("\nMTD Erase failure\n");
 192                                 close(fd);
 193                                 exit(1);
 194                         }
 195
 196                         /* Do some programming, but not in the first block */
 197
 198                         if(addr){
 199                                 for(offset = 0; offset <meminfo.erasesize; offset+=512)
 200                                 {
 201                                         if(read(img,imgpage,528) == 528){
 202                                                 if (usemtdecc) {
 203                                                         imgpage[512+8] = 0xff;
 204                                                         imgpage[512+9] = 0xff;
 205                                                         imgpage[512+10] = 0xff;
 206                                                         imgpage[512+13] = 0xff;
 207                                                         imgpage[512+14] = 0xff;
 208                                                         imgpage[512+15] = 0xff;
 209                                                 }
 210                                                 oob.start = addr+offset;
 211                                                 oob.length=16;
 212                                                 oob.ptr=&imgpage[512];
 213                                                 ioctl(fd,MEMWRITEOOB,&oob);
 214
 215                                                 lseek(fd,addr+offset,SEEK_SET);
 216                                                 write(fd,imgpage,512);
 217                                         }
 218                                 }
 219                         }
 220
 221                 }
 222
 223         }
 224
 225
 226
 227         /* All the tests succeeded */
 228         printf("OK\n");
 229         close(fd);
 230         return 0;
 231 }
 232