Add more descriptive comment for using the yaffs commands.
[yaffs2.git] / direct / u-boot / fs / yaffs2 / yaffs_uboot_glue.c
1 /*
2  * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
3  *
4  * Copyright (C) 2002-2007 Aleph One Ltd.
5  *   for Toby Churchill Ltd and Brightstar Engineering
6  *
7  * Created by Charles Manning <charles@aleph1.co.uk>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License version 2 as
11  * published by the Free Software Foundation.
12  */
13
14 /*
15  * yaffscfg.c  The configuration for the "direct" use of yaffs.
16  *
17  * This is set up for u-boot.
18  *
19  * This version now uses the ydevconfig mechanism to set up partitions.
20  */
21
22 #include <common.h>
23
24 #include <config.h>
25 #include "nand.h"
26 #include "yaffscfg.h"
27 #include "yaffsfs.h"
28 #include "yaffs_packedtags2.h"
29 #include "yaffs_mtdif.h"
30 #include "yaffs_mtdif2.h"
31 #if 0
32 #include <errno.h>
33 #else
34 #include "malloc.h"
35 #endif
36
37 unsigned yaffs_trace_mask = 0x0; /* Disable logging */
38 static int yaffs_errno = 0;
39
40
41
42
43 void yaffs_bug_fn(const char *fn, int n)
44 {
45         printf("yaffs bug at %s:%d\n", fn, n);
46 }
47
48 void *yaffsfs_malloc(size_t x)
49 {
50         return malloc(x);
51 }
52
53 void yaffsfs_free(void *x)
54 {
55         free(x);
56 }
57
58 void yaffsfs_SetError(int err)
59 {
60         //Do whatever to set error
61         yaffs_errno = err;
62 }
63
64 int yaffsfs_GetLastError(void)
65 {
66         return yaffs_errno;
67 }
68
69
70 int yaffsfs_GetError(void)
71 {
72         return yaffs_errno;
73 }
74
75 void yaffsfs_Lock(void)
76 {
77 }
78
79 void yaffsfs_Unlock(void)
80 {
81 }
82
83 __u32 yaffsfs_CurrentTime(void)
84 {
85         return 0;
86 }
87
88 void *yaffs_malloc(size_t size)
89 {
90         return malloc(size);
91 }
92
93 void yaffs_free(void *ptr)
94 {
95         free(ptr);
96 }
97
98 void yaffsfs_LocalInitialisation(void)
99 {
100         // Define locking semaphore.
101 }
102
103
104 static const char * yaffs_file_type_str(struct yaffs_stat *stat)
105 {
106         switch(stat->st_mode & S_IFMT) {
107                 case S_IFREG: return "regular file";
108                 case S_IFDIR: return "directory";
109                 case S_IFLNK: return "symlink";
110                 default: return "unknown";
111         }
112 }
113
114 static const char * yaffs_error_str(void)
115 {
116         int error = yaffsfs_GetLastError();
117
118         if(error < 0)
119                 error = -error;
120
121         switch (error) {
122                 case EBUSY: return "Busy";
123                 case ENODEV: return "No such device";
124                 case EINVAL: return "Invalid parameter";
125                 case ENFILE: return "Too many open files";
126                 case EBADF:  return "Bad handle";
127                 case EACCES: return "Wrong permissions";
128                 case EXDEV:  return "Not on same device";
129                 case ENOENT: return "No such entry";
130                 case ENOSPC: return "Device full";
131                 case EROFS:  return "Read only file system";
132                 case ERANGE: return "Range error";
133                 case ENOTEMPTY: return "Not empty";
134                 case ENAMETOOLONG: return "Name too long";
135                 case ENOMEM: return "Out of memory";
136                 case EFAULT: return "Fault";
137                 case EEXIST: return "Name exists";
138                 case ENOTDIR: return "Not a directory";
139                 case EISDIR: return "Not permitted on a directory";
140                 case ELOOP:  return "Symlink loop";
141                 case 0: return "No error";
142                 default: return "Unknown error";
143         }
144 }
145
146 extern nand_info_t nand_info[];
147
148 void cmd_yaffs_tracemask(unsigned set, unsigned mask)
149 {
150         if(set)
151                 yaffs_trace_mask = mask;
152
153         printf("yaffs trace mask: %08x\n",yaffs_trace_mask);
154 }
155
156 static int yaffs_regions_overlap(int a, int b, int x, int y)
157 {
158         return
159                 (a <= x && x <= b) ||
160                 (a <= y && y <= b) ||
161                 (x <= a && a <= y) ||
162                 (x <= b && b <= y);
163 }
164
165 void cmd_yaffs_devconfig(char *_mp, int flash_dev, int start_block, int end_block)
166 {
167         struct mtd_info *mtd = NULL;
168         struct yaffs_dev *dev = NULL;
169         struct yaffs_dev *chk;
170         char *mp = NULL;
171         struct nand_chip *chip;
172
173         dev = calloc(1, sizeof(*dev));
174         mp = strdup(_mp);
175
176         mtd = &nand_info[flash_dev];
177
178         if(!dev || !mp) {
179                 /* Alloc error */
180                 printf("Failed to allocate memory\n");
181                 goto err;
182         }
183
184         if(flash_dev >= CONFIG_SYS_MAX_NAND_DEVICE) {
185                 printf("Flash device invalid\n");
186         }
187         
188         if(end_block == 0)
189                 end_block = mtd->size / mtd->erasesize - 1;
190
191         if(end_block < start_block) {
192                 printf("Bad start/end\n");
193                 goto err;
194         }
195
196         chip =  mtd->priv;
197
198         /* Check for any conflicts */
199         yaffs_dev_rewind();
200         while(1) {
201                 chk = yaffs_next_dev();
202                 if(!chk)
203                         break;
204                 if(strcmp(chk->param.name, mp) == 0) {
205                         printf("Mount point name already used\n");
206                         goto err;
207                 }
208                 if(chk->driver_context == mtd &&
209                         yaffs_regions_overlap(
210                                 chk->param.start_block, chk->param.end_block,
211                                 start_block, end_block)) {
212                         printf("Region overlaps with partition %s\n",
213                                 chk->param.name);
214                         goto err;
215                 }
216
217         }
218
219         /* Seems sane, so configure */
220         memset(dev, 0, sizeof(*dev));
221         dev->param.name = mp;
222         dev->driver_context = mtd;
223         dev->param.start_block = start_block;
224         dev->param.end_block = end_block;
225         dev->param.chunks_per_block = mtd->erasesize / mtd->writesize;
226         dev->param.total_bytes_per_chunk = mtd->writesize;
227         dev->param.is_yaffs2 = 1;
228         dev->param.use_nand_ecc = 1;
229         dev->param.n_reserved_blocks = 5;
230         if (chip->ecc.layout->oobavail < sizeof(struct yaffs_packed_tags2))
231                 dev->param.inband_tags =1;
232         dev->param.n_caches = 10;
233         dev->param.write_chunk_tags_fn = nandmtd2_write_chunk_tags;
234         dev->param.read_chunk_tags_fn = nandmtd2_read_chunk_tags;
235         dev->param.erase_fn = nandmtd_EraseBlockInNAND;
236         dev->param.initialise_flash_fn = nandmtd_InitialiseNAND;
237         dev->param.bad_block_fn = nandmtd2_MarkNANDBlockBad;
238         dev->param.query_block_fn = nandmtd2_QueryNANDBlock;
239
240         yaffs_add_device(dev);
241
242         printf("Configures yaffs mount %s: dev %d start block %d, end block %d %s\n",
243                 mp, flash_dev, start_block, end_block, 
244                 dev->param.inband_tags ? "using inband tags" : "");
245         return;
246
247 err:
248         free(dev);
249         free(mp);
250 }
251
252 void cmd_yaffs_dev_ls(void)
253 {
254         struct yaffs_dev *dev;
255         int flash_dev;
256         int free_space;
257
258         yaffs_dev_rewind();
259
260         while(1) {
261                 dev = yaffs_next_dev();
262                 if(!dev)
263                         return;
264                 flash_dev = ((unsigned) dev->driver_context - (unsigned) nand_info)/
265                                 sizeof(nand_info[0]);
266                 printf("%-10s %5d 0x%05x 0x%05x %s",
267                         dev->param.name, flash_dev,
268                         dev->param.start_block, dev->param.end_block,
269                         dev->param.inband_tags ? "using inband tags, " : "");
270
271                 free_space = yaffs_freespace(dev->param.name);
272                 if(free_space < 0)
273                         printf("not mounted\n");
274                 else
275                         printf("free 0x%x\n", free_space);
276
277         }
278 }
279
280 void make_a_file(char *yaffsName,char bval,int sizeOfFile)
281 {
282         int outh;
283         int i;
284         unsigned char buffer[100];
285
286         outh = yaffs_open(yaffsName, O_CREAT | O_RDWR | O_TRUNC, S_IREAD | S_IWRITE);
287         if (outh < 0)
288         {
289                 printf("Error opening file: %d. %s\n", outh, yaffs_error_str());
290                 return;
291         }
292
293         memset(buffer,bval,100);
294
295         do{
296                 i = sizeOfFile;
297                 if(i > 100) i = 100;
298                 sizeOfFile -= i;
299
300                 yaffs_write(outh,buffer,i);
301
302         } while (sizeOfFile > 0);
303
304
305         yaffs_close(outh);
306 }
307
308 void read_a_file(char *fn)
309 {
310         int h;
311         int i = 0;
312         unsigned char b;
313
314         h = yaffs_open(fn, O_RDWR,0);
315         if(h<0)
316         {
317                 printf("File not found\n");
318                 return;
319         }
320
321         while(yaffs_read(h,&b,1)> 0)
322         {
323                 printf("%02x ",b);
324                 i++;
325                 if(i > 32)
326                 {
327                    printf("\n");
328                    i = 0;;
329                  }
330         }
331         printf("\n");
332         yaffs_close(h);
333 }
334
335 void cmd_yaffs_mount(char *mp)
336 {
337         int retval = yaffs_mount(mp);
338         if( retval < 0)
339                 printf("Error mounting %s, return value: %d, %s\n", mp,
340                         yaffsfs_GetError(), yaffs_error_str());
341 }
342
343
344 void cmd_yaffs_umount(char *mp)
345 {
346         if( yaffs_unmount(mp) == -1)
347                 printf("Error umounting %s, return value: %d, %s\n", mp,
348                         yaffsfs_GetError(), yaffs_error_str());
349 }
350
351 void cmd_yaffs_write_file(char *yaffsName,char bval,int sizeOfFile)
352 {
353         make_a_file(yaffsName,bval,sizeOfFile);
354 }
355
356
357 void cmd_yaffs_read_file(char *fn)
358 {
359         read_a_file(fn);
360 }
361
362
363 void cmd_yaffs_mread_file(char *fn, char *addr)
364 {
365         int h;
366         struct yaffs_stat s;
367
368         yaffs_stat(fn,&s);
369
370         printf ("Copy %s to 0x%p... ", fn, addr);
371         h = yaffs_open(fn, O_RDWR,0);
372         if(h<0)
373         {
374                 printf("File not found\n");
375                 return;
376         }
377
378         yaffs_read(h,addr,(int)s.st_size);
379         printf("\t[DONE]\n");
380
381         yaffs_close(h);
382 }
383
384
385 void cmd_yaffs_mwrite_file(char *fn, char *addr, int size)
386 {
387         int outh;
388
389         outh = yaffs_open(fn, O_CREAT | O_RDWR | O_TRUNC, S_IREAD | S_IWRITE);
390         if (outh < 0)
391         {
392                 printf("Error opening file: %d, %s\n", outh, yaffs_error_str());
393         }
394
395         yaffs_write(outh,addr,size);
396
397         yaffs_close(outh);
398 }
399
400
401 void cmd_yaffs_ls(const char *mountpt, int longlist)
402 {
403         int i;
404         yaffs_DIR *d;
405         yaffs_dirent *de;
406         struct yaffs_stat stat;
407         char tempstr[255];
408
409         d = yaffs_opendir(mountpt);
410
411         if(!d) {
412                 printf("opendir failed, %s\n", yaffs_error_str());
413                 return;
414         }
415
416         for(i = 0; (de = yaffs_readdir(d)) != NULL; i++) {
417                 if (longlist) {
418                         sprintf(tempstr, "%s/%s", mountpt, de->d_name);
419                         yaffs_lstat(tempstr, &stat);
420                         printf("%-25s\t%7ld",
421                                         de->d_name,
422                                         (long)stat.st_size);
423                         printf(" %5d %s\n",
424                                         stat.st_ino,
425                                         yaffs_file_type_str(&stat));
426                 } else {
427                         printf("%s\n",de->d_name);
428                 }
429         }
430
431         yaffs_closedir(d);
432 }
433
434
435 void cmd_yaffs_mkdir(const char *dir)
436 {
437         int retval = yaffs_mkdir(dir, 0);
438
439         if ( retval < 0)
440                 printf("yaffs_mkdir returning error: %d, %s\n",
441                         retval, yaffs_error_str());
442 }
443
444 void cmd_yaffs_rmdir(const char *dir)
445 {
446         int retval = yaffs_rmdir(dir);
447
448         if ( retval < 0)
449                 printf("yaffs_rmdir returning error: %d, %s\n",
450                         retval, yaffs_error_str());
451 }
452
453 void cmd_yaffs_rm(const char *path)
454 {
455         int retval = yaffs_unlink(path);
456
457         if ( retval < 0)
458                 printf("yaffs_unlink returning error: %d, %s\n",
459                         retval, yaffs_error_str());
460 }
461
462 void cmd_yaffs_mv(const char *oldPath, const char *newPath)
463 {
464         int retval = yaffs_rename(newPath, oldPath);
465
466         if ( retval < 0)
467                 printf("yaffs_unlink returning error: %d, %s\n",
468                         retval, yaffs_error_str());
469 }