fs/fat/fat.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * fat.c
   4  *
   5  * R/O (V)FAT 12/16/32 filesystem implementation by Marcus Sundberg
   6  *
   7  * 2002-07-28 - rjones@nexus-tech.net - ported to ppcboot v1.1.6
   8  * 2003-03-10 - kharris@nexus-tech.net - ported to uboot
   9  */
  10
  11 #include <common.h>
  12 #include <blk.h>
  13 #include <config.h>
  14 #include <exports.h>
  15 #include <fat.h>
  16 #include <fs.h>
  17 #include <asm/byteorder.h>
  18 #include <part.h>
  19 #include <malloc.h>
  20 #include <memalign.h>
  21 #include <linux/compiler.h>
  22 #include <linux/ctype.h>
  23
  24 /*
  25  * Convert a string to lowercase.  Converts at most 'len' characters,
  26  * 'len' may be larger than the length of 'str' if 'str' is NULL
  27  * terminated.
  28  */
  29 static void downcase(char *str, size_t len)
  30 {
  31         while (*str != '\0' && len--) {
  32                 *str = tolower(*str);
  33                 str++;
  34         }
  35 }
  36
  37 static struct blk_desc *cur_dev;
  38 static disk_partition_t cur_part_info;
  39
  40 #define DOS_BOOT_MAGIC_OFFSET   0x1fe
  41 #define DOS_FS_TYPE_OFFSET      0x36
  42 #define DOS_FS32_TYPE_OFFSET    0x52
  43
  44 static int disk_read(__u32 block, __u32 nr_blocks, void *buf)
  45 {
  46         ulong ret;
  47
  48         if (!cur_dev)
  49                 return -1;
  50
  51         ret = blk_dread(cur_dev, cur_part_info.start + block, nr_blocks, buf);
  52
  53         if (ret != nr_blocks)
  54                 return -1;
  55
  56         return ret;
  57 }
  58
  59 int fat_set_blk_dev(struct blk_desc *dev_desc, disk_partition_t *info)
  60 {
  61         ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, dev_desc->blksz);
  62
  63         cur_dev = dev_desc;
  64         cur_part_info = *info;
  65
  66         /* Make sure it has a valid FAT header */
  67         if (disk_read(0, 1, buffer) != 1) {
  68                 cur_dev = NULL;
  69                 return -1;
  70         }
  71
  72         /* Check if it's actually a DOS volume */
  73         if (memcmp(buffer + DOS_BOOT_MAGIC_OFFSET, "\x55\xAA", 2)) {
  74                 cur_dev = NULL;
  75                 return -1;
  76         }
  77
  78         /* Check for FAT12/FAT16/FAT32 filesystem */
  79         if (!memcmp(buffer + DOS_FS_TYPE_OFFSET, "FAT", 3))
  80                 return 0;
  81         if (!memcmp(buffer + DOS_FS32_TYPE_OFFSET, "FAT32", 5))
  82                 return 0;
  83
  84         cur_dev = NULL;
  85         return -1;
  86 }
  87
  88 int fat_register_device(struct blk_desc *dev_desc, int part_no)
  89 {
  90         disk_partition_t info;
  91
  92         /* First close any currently found FAT filesystem */
  93         cur_dev = NULL;
  94
  95         /* Read the partition table, if present */
  96         if (part_get_info(dev_desc, part_no, &info)) {
  97                 if (part_no != 0) {
  98                         printf("** Partition %d not valid on device %d **\n",
  99                                         part_no, dev_desc->devnum);
 100                         return -1;
 101                 }
 102
 103                 info.start = 0;
 104                 info.size = dev_desc->lba;
 105                 info.blksz = dev_desc->blksz;
 106                 info.name[0] = 0;
 107                 info.type[0] = 0;
 108                 info.bootable = 0;
 109 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
 110                 info.uuid[0] = 0;
 111 #endif
 112         }
 113
 114         return fat_set_blk_dev(dev_desc, &info);
 115 }
 116
 117 /*
 118  * Extract zero terminated short name from a directory entry.
 119  */
 120 static void get_name(dir_entry *dirent, char *s_name)
 121 {
 122         char *ptr;
 123
 124         memcpy(s_name, dirent->name, 8);
 125         s_name[8] = '\0';
 126         ptr = s_name;
 127         while (*ptr && *ptr != ' ')
 128                 ptr++;
 129         if (dirent->lcase & CASE_LOWER_BASE)
 130                 downcase(s_name, (unsigned)(ptr - s_name));
 131         if (dirent->ext[0] && dirent->ext[0] != ' ') {
 132                 *ptr++ = '.';
 133                 memcpy(ptr, dirent->ext, 3);
 134                 if (dirent->lcase & CASE_LOWER_EXT)
 135                         downcase(ptr, 3);
 136                 ptr[3] = '\0';
 137                 while (*ptr && *ptr != ' ')
 138                         ptr++;
 139         }
 140         *ptr = '\0';
 141         if (*s_name == DELETED_FLAG)
 142                 *s_name = '\0';
 143         else if (*s_name == aRING)
 144                 *s_name = DELETED_FLAG;
 145 }
 146
 147 static int flush_dirty_fat_buffer(fsdata *mydata);
 148
 149 #if !CONFIG_IS_ENABLED(FAT_WRITE)
 150 /* Stub for read only operation */
 151 int flush_dirty_fat_buffer(fsdata *mydata)
 152 {
 153         (void)(mydata);
 154         return 0;
 155 }
 156 #endif
 157
 158 /*
 159  * Get the entry at index 'entry' in a FAT (12/16/32) table.
 160  * On failure 0x00 is returned.
 161  */
 162 static __u32 get_fatent(fsdata *mydata, __u32 entry)
 163 {
 164         __u32 bufnum;
 165         __u32 offset, off8;
 166         __u32 ret = 0x00;
 167
 168         if (CHECK_CLUST(entry, mydata->fatsize)) {
 169                 printf("Error: Invalid FAT entry: 0x%08x\n", entry);
 170                 return ret;
 171         }
 172
 173         switch (mydata->fatsize) {
 174         case 32:
 175                 bufnum = entry / FAT32BUFSIZE;
 176                 offset = entry - bufnum * FAT32BUFSIZE;
 177                 break;
 178         case 16:
 179                 bufnum = entry / FAT16BUFSIZE;
 180                 offset = entry - bufnum * FAT16BUFSIZE;
 181                 break;
 182         case 12:
 183                 bufnum = entry / FAT12BUFSIZE;
 184                 offset = entry - bufnum * FAT12BUFSIZE;
 185                 break;
 186
 187         default:
 188                 /* Unsupported FAT size */
 189                 return ret;
 190         }
 191
 192         debug("FAT%d: entry: 0x%08x = %d, offset: 0x%04x = %d\n",
 193                mydata->fatsize, entry, entry, offset, offset);
 194
 195         /* Read a new block of FAT entries into the cache. */
 196         if (bufnum != mydata->fatbufnum) {
 197                 __u32 getsize = FATBUFBLOCKS;
 198                 __u8 *bufptr = mydata->fatbuf;
 199                 __u32 fatlength = mydata->fatlength;
 200                 __u32 startblock = bufnum * FATBUFBLOCKS;
 201
 202                 /* Cap length if fatlength is not a multiple of FATBUFBLOCKS */
 203                 if (startblock + getsize > fatlength)
 204                         getsize = fatlength - startblock;
 205
 206                 startblock += mydata->fat_sect; /* Offset from start of disk */
 207
 208                 /* Write back the fatbuf to the disk */
 209                 if (flush_dirty_fat_buffer(mydata) < 0)
 210                         return -1;
 211
 212                 if (disk_read(startblock, getsize, bufptr) < 0) {
 213                         debug("Error reading FAT blocks\n");
 214                         return ret;
 215                 }
 216                 mydata->fatbufnum = bufnum;
 217         }
 218
 219         /* Get the actual entry from the table */
 220         switch (mydata->fatsize) {
 221         case 32:
 222                 ret = FAT2CPU32(((__u32 *) mydata->fatbuf)[offset]);
 223                 break;
 224         case 16:
 225                 ret = FAT2CPU16(((__u16 *) mydata->fatbuf)[offset]);
 226                 break;
 227         case 12:
 228                 off8 = (offset * 3) / 2;
 229                 /* fatbut + off8 may be unaligned, read in byte granularity */
 230                 ret = mydata->fatbuf[off8] + (mydata->fatbuf[off8 + 1] << 8);
 231
 232                 if (offset & 0x1)
 233                         ret >>= 4;
 234                 ret &= 0xfff;
 235         }
 236         debug("FAT%d: ret: 0x%08x, entry: 0x%08x, offset: 0x%04x\n",
 237                mydata->fatsize, ret, entry, offset);
 238
 239         return ret;
 240 }
 241
 242 /*
 243  * Read at most 'size' bytes from the specified cluster into 'buffer'.
 244  * Return 0 on success, -1 otherwise.
 245  */
 246 static int
 247 get_cluster(fsdata *mydata, __u32 clustnum, __u8 *buffer, unsigned long size)
 248 {
 249         __u32 idx = 0;
 250         __u32 startsect;
 251         int ret;
 252
 253         if (clustnum > 0) {
 254                 startsect = clust_to_sect(mydata, clustnum);
 255         } else {
 256                 startsect = mydata->rootdir_sect;
 257         }
 258
 259         debug("gc - clustnum: %d, startsect: %d\n", clustnum, startsect);
 260
 261         if ((unsigned long)buffer & (ARCH_DMA_MINALIGN - 1)) {
 262                 ALLOC_CACHE_ALIGN_BUFFER(__u8, tmpbuf, mydata->sect_size);
 263
 264                 debug("FAT: Misaligned buffer address (%p)\n", buffer);
 265
 266                 while (size >= mydata->sect_size) {
 267                         ret = disk_read(startsect++, 1, tmpbuf);
 268                         if (ret != 1) {
 269                                 debug("Error reading data (got %d)\n", ret);
 270                                 return -1;
 271                         }
 272
 273                         memcpy(buffer, tmpbuf, mydata->sect_size);
 274                         buffer += mydata->sect_size;
 275                         size -= mydata->sect_size;
 276                 }
 277         } else {
 278                 idx = size / mydata->sect_size;
 279                 ret = disk_read(startsect, idx, buffer);
 280                 if (ret != idx) {
 281                         debug("Error reading data (got %d)\n", ret);
 282                         return -1;
 283                 }
 284                 startsect += idx;
 285                 idx *= mydata->sect_size;
 286                 buffer += idx;
 287                 size -= idx;
 288         }
 289         if (size) {
 290                 ALLOC_CACHE_ALIGN_BUFFER(__u8, tmpbuf, mydata->sect_size);
 291
 292                 ret = disk_read(startsect, 1, tmpbuf);
 293                 if (ret != 1) {
 294                         debug("Error reading data (got %d)\n", ret);
 295                         return -1;
 296                 }
 297
 298                 memcpy(buffer, tmpbuf, size);
 299         }
 300
 301         return 0;
 302 }
 303
 304 /*
 305  * Read at most 'maxsize' bytes from 'pos' in the file associated with 'dentptr'
 306  * into 'buffer'.
 307  * Update the number of bytes read in *gotsize or return -1 on fatal errors.
 308  */
 309 __u8 get_contents_vfatname_block[MAX_CLUSTSIZE]
 310         __aligned(ARCH_DMA_MINALIGN);
 311
 312 static int get_contents(fsdata *mydata, dir_entry *dentptr, loff_t pos,
 313                         __u8 *buffer, loff_t maxsize, loff_t *gotsize)
 314 {
 315         loff_t filesize = FAT2CPU32(dentptr->size);
 316         unsigned int bytesperclust = mydata->clust_size * mydata->sect_size;
 317         __u32 curclust = START(dentptr);
 318         __u32 endclust, newclust;
 319         loff_t actsize;
 320
 321         *gotsize = 0;
 322         debug("Filesize: %llu bytes\n", filesize);
 323
 324         if (pos >= filesize) {
 325                 debug("Read position past EOF: %llu\n", pos);
 326                 return 0;
 327         }
 328
 329         if (maxsize > 0 && filesize > pos + maxsize)
 330                 filesize = pos + maxsize;
 331
 332         debug("%llu bytes\n", filesize);
 333
 334         actsize = bytesperclust;
 335
 336         /* go to cluster at pos */
 337         while (actsize <= pos) {
 338                 curclust = get_fatent(mydata, curclust);
 339                 if (CHECK_CLUST(curclust, mydata->fatsize)) {
 340                         debug("curclust: 0x%x\n", curclust);
 341                         debug("Invalid FAT entry\n");
 342                         return 0;
 343                 }
 344                 actsize += bytesperclust;
 345         }
 346
 347         /* actsize > pos */
 348         actsize -= bytesperclust;
 349         filesize -= actsize;
 350         pos -= actsize;
 351
 352         /* align to beginning of next cluster if any */
 353         if (pos) {
 354                 actsize = min(filesize, (loff_t)bytesperclust);
 355                 if (get_cluster(mydata, curclust, get_contents_vfatname_block,
 356                                 (int)actsize) != 0) {
 357                         printf("Error reading cluster\n");
 358                         return -1;
 359                 }
 360                 filesize -= actsize;
 361                 actsize -= pos;
 362                 memcpy(buffer, get_contents_vfatname_block + pos, actsize);
 363                 *gotsize += actsize;
 364                 if (!filesize)
 365                         return 0;
 366                 buffer += actsize;
 367
 368                 curclust = get_fatent(mydata, curclust);
 369                 if (CHECK_CLUST(curclust, mydata->fatsize)) {
 370                         debug("curclust: 0x%x\n", curclust);
 371                         debug("Invalid FAT entry\n");
 372                         return 0;
 373                 }
 374         }
 375
 376         actsize = bytesperclust;
 377         endclust = curclust;
 378
 379         do {
 380                 /* search for consecutive clusters */
 381                 while (actsize < filesize) {
 382                         newclust = get_fatent(mydata, endclust);
 383                         if ((newclust - 1) != endclust)
 384                                 goto getit;
 385                         if (CHECK_CLUST(newclust, mydata->fatsize)) {
 386                                 debug("curclust: 0x%x\n", newclust);
 387                                 debug("Invalid FAT entry\n");
 388                                 return 0;
 389                         }
 390                         endclust = newclust;
 391                         actsize += bytesperclust;
 392                 }
 393
 394                 /* get remaining bytes */
 395                 actsize = filesize;
 396                 if (get_cluster(mydata, curclust, buffer, (int)actsize) != 0) {
 397                         printf("Error reading cluster\n");
 398                         return -1;
 399                 }
 400                 *gotsize += actsize;
 401                 return 0;
 402 getit:
 403                 if (get_cluster(mydata, curclust, buffer, (int)actsize) != 0) {
 404                         printf("Error reading cluster\n");
 405                         return -1;
 406                 }
 407                 *gotsize += (int)actsize;
 408                 filesize -= actsize;
 409                 buffer += actsize;
 410
 411                 curclust = get_fatent(mydata, endclust);
 412                 if (CHECK_CLUST(curclust, mydata->fatsize)) {
 413                         debug("curclust: 0x%x\n", curclust);
 414                         printf("Invalid FAT entry\n");
 415                         return 0;
 416                 }
 417                 actsize = bytesperclust;
 418                 endclust = curclust;
 419         } while (1);
 420 }
 421
 422 /*
 423  * Extract the file name information from 'slotptr' into 'l_name',
 424  * starting at l_name[*idx].
 425  * Return 1 if terminator (zero byte) is found, 0 otherwise.
 426  */
 427 static int slot2str(dir_slot *slotptr, char *l_name, int *idx)
 428 {
 429         int j;
 430
 431         for (j = 0; j <= 8; j += 2) {
 432                 l_name[*idx] = slotptr->name0_4[j];
 433                 if (l_name[*idx] == 0x00)
 434                         return 1;
 435                 (*idx)++;
 436         }
 437         for (j = 0; j <= 10; j += 2) {
 438                 l_name[*idx] = slotptr->name5_10[j];
 439                 if (l_name[*idx] == 0x00)
 440                         return 1;
 441                 (*idx)++;
 442         }
 443         for (j = 0; j <= 2; j += 2) {
 444                 l_name[*idx] = slotptr->name11_12[j];
 445                 if (l_name[*idx] == 0x00)
 446                         return 1;
 447                 (*idx)++;
 448         }
 449
 450         return 0;
 451 }
 452
 453 /* Calculate short name checksum */
 454 static __u8 mkcksum(const char name[8], const char ext[3])
 455 {
 456         int i;
 457
 458         __u8 ret = 0;
 459
 460         for (i = 0; i < 8; i++)
 461                 ret = (((ret & 1) << 7) | ((ret & 0xfe) >> 1)) + name[i];
 462         for (i = 0; i < 3; i++)
 463                 ret = (((ret & 1) << 7) | ((ret & 0xfe) >> 1)) + ext[i];
 464
 465         return ret;
 466 }
 467
 468 /*
 469  * Read boot sector and volume info from a FAT filesystem
 470  */
 471 static int
 472 read_bootsectandvi(boot_sector *bs, volume_info *volinfo, int *fatsize)
 473 {
 474         __u8 *block;
 475         volume_info *vistart;
 476         int ret = 0;
 477
 478         if (cur_dev == NULL) {
 479                 debug("Error: no device selected\n");
 480                 return -1;
 481         }
 482
 483         block = malloc_cache_aligned(cur_dev->blksz);
 484         if (block == NULL) {
 485                 debug("Error: allocating block\n");
 486                 return -1;
 487         }
 488
 489         if (disk_read(0, 1, block) < 0) {
 490                 debug("Error: reading block\n");
 491                 goto fail;
 492         }
 493
 494         memcpy(bs, block, sizeof(boot_sector));
 495         bs->reserved = FAT2CPU16(bs->reserved);
 496         bs->fat_length = FAT2CPU16(bs->fat_length);
 497         bs->secs_track = FAT2CPU16(bs->secs_track);
 498         bs->heads = FAT2CPU16(bs->heads);
 499         bs->total_sect = FAT2CPU32(bs->total_sect);
 500
 501         /* FAT32 entries */
 502         if (bs->fat_length == 0) {
 503                 /* Assume FAT32 */
 504                 bs->fat32_length = FAT2CPU32(bs->fat32_length);
 505                 bs->flags = FAT2CPU16(bs->flags);
 506                 bs->root_cluster = FAT2CPU32(bs->root_cluster);
 507                 bs->info_sector = FAT2CPU16(bs->info_sector);
 508                 bs->backup_boot = FAT2CPU16(bs->backup_boot);
 509                 vistart = (volume_info *)(block + sizeof(boot_sector));
 510                 *fatsize = 32;
 511         } else {
 512                 vistart = (volume_info *)&(bs->fat32_length);
 513                 *fatsize = 0;
 514         }
 515         memcpy(volinfo, vistart, sizeof(volume_info));
 516
 517         if (*fatsize == 32) {
 518                 if (strncmp(FAT32_SIGN, vistart->fs_type, SIGNLEN) == 0)
 519                         goto exit;
 520         } else {
 521                 if (strncmp(FAT12_SIGN, vistart->fs_type, SIGNLEN) == 0) {
 522                         *fatsize = 12;
 523                         goto exit;
 524                 }
 525                 if (strncmp(FAT16_SIGN, vistart->fs_type, SIGNLEN) == 0) {
 526                         *fatsize = 16;
 527                         goto exit;
 528                 }
 529         }
 530
 531         debug("Error: broken fs_type sign\n");
 532 fail:
 533         ret = -1;
 534 exit:
 535         free(block);
 536         return ret;
 537 }
 538
 539 static int get_fs_info(fsdata *mydata)
 540 {
 541         boot_sector bs;
 542         volume_info volinfo;
 543         int ret;
 544
 545         ret = read_bootsectandvi(&bs, &volinfo, &mydata->fatsize);
 546         if (ret) {
 547                 debug("Error: reading boot sector\n");
 548                 return ret;
 549         }
 550
 551         if (mydata->fatsize == 32) {
 552                 mydata->fatlength = bs.fat32_length;
 553                 mydata->total_sect = bs.total_sect;
 554         } else {
 555                 mydata->fatlength = bs.fat_length;
 556                 mydata->total_sect = (bs.sectors[1] << 8) + bs.sectors[0];
 557                 if (!mydata->total_sect)
 558                         mydata->total_sect = bs.total_sect;
 559         }
 560         if (!mydata->total_sect) /* unlikely */
 561                 mydata->total_sect = (u32)cur_part_info.size;
 562
 563         mydata->fats = bs.fats;
 564         mydata->fat_sect = bs.reserved;
 565
 566         mydata->rootdir_sect = mydata->fat_sect + mydata->fatlength * bs.fats;
 567
 568         mydata->sect_size = (bs.sector_size[1] << 8) + bs.sector_size[0];
 569         mydata->clust_size = bs.cluster_size;
 570         if (mydata->sect_size != cur_part_info.blksz) {
 571                 printf("Error: FAT sector size mismatch (fs=%hu, dev=%lu)\n",
 572                                 mydata->sect_size, cur_part_info.blksz);
 573                 return -1;
 574         }
 575         if (mydata->clust_size == 0) {
 576                 printf("Error: FAT cluster size not set\n");
 577                 return -1;
 578         }
 579         if ((unsigned int)mydata->clust_size * mydata->sect_size >
 580             MAX_CLUSTSIZE) {
 581                 printf("Error: FAT cluster size too big (cs=%u, max=%u)\n",
 582                        (unsigned int)mydata->clust_size * mydata->sect_size,
 583                        MAX_CLUSTSIZE);
 584                 return -1;
 585         }
 586
 587         if (mydata->fatsize == 32) {
 588                 mydata->data_begin = mydata->rootdir_sect -
 589                                         (mydata->clust_size * 2);
 590                 mydata->root_cluster = bs.root_cluster;
 591         } else {
 592                 mydata->rootdir_size = ((bs.dir_entries[1]  * (int)256 +
 593                                          bs.dir_entries[0]) *
 594                                          sizeof(dir_entry)) /
 595                                          mydata->sect_size;
 596                 mydata->data_begin = mydata->rootdir_sect +
 597                                         mydata->rootdir_size -
 598                                         (mydata->clust_size * 2);
 599                 mydata->root_cluster =
 600                         sect_to_clust(mydata, mydata->rootdir_sect);
 601         }
 602
 603         mydata->fatbufnum = -1;
 604         mydata->fat_dirty = 0;
 605         mydata->fatbuf = malloc_cache_aligned(FATBUFSIZE);
 606         if (mydata->fatbuf == NULL) {
 607                 debug("Error: allocating memory\n");
 608                 return -1;
 609         }
 610
 611         debug("FAT%d, fat_sect: %d, fatlength: %d\n",
 612                mydata->fatsize, mydata->fat_sect, mydata->fatlength);
 613         debug("Rootdir begins at cluster: %d, sector: %d, offset: %x\n"
 614                "Data begins at: %d\n",
 615                mydata->root_cluster,
 616                mydata->rootdir_sect,
 617                mydata->rootdir_sect * mydata->sect_size, mydata->data_begin);
 618         debug("Sector size: %d, cluster size: %d\n", mydata->sect_size,
 619               mydata->clust_size);
 620
 621         return 0;
 622 }
 623
 624
 625 /*
 626  * Directory iterator, to simplify filesystem traversal
 627  *
 628  * Implements an iterator pattern to traverse directory tables,
 629  * transparently handling directory tables split across multiple
 630  * clusters, and the difference between FAT12/FAT16 root directory
 631  * (contiguous) and subdirectories + FAT32 root (chained).
 632  *
 633  * Rough usage:
 634  *
 635  *   for (fat_itr_root(&itr, fsdata); fat_itr_next(&itr); ) {
 636  *      // to traverse down to a subdirectory pointed to by
 637  *      // current iterator position:
 638  *      fat_itr_child(&itr, &itr);
 639  *   }
 640  *
 641  * For more complete example, see fat_itr_resolve()
 642  */
 643
 644 typedef struct {
 645         fsdata    *fsdata;        /* filesystem parameters */
 646         unsigned   start_clust;   /* first cluster */
 647         unsigned   clust;         /* current cluster */
 648         unsigned   next_clust;    /* next cluster if remaining == 0 */
 649         int        last_cluster;  /* set once we've read last cluster */
 650         int        is_root;       /* is iterator at root directory */
 651         int        remaining;     /* remaining dent's in current cluster */
 652
 653         /* current iterator position values: */
 654         dir_entry *dent;          /* current directory entry */
 655         char       l_name[VFAT_MAXLEN_BYTES];    /* long (vfat) name */
 656         char       s_name[14];    /* short 8.3 name */
 657         char      *name;          /* l_name if there is one, else s_name */
 658
 659         /* storage for current cluster in memory: */
 660         u8         block[MAX_CLUSTSIZE] __aligned(ARCH_DMA_MINALIGN);
 661 } fat_itr;
 662
 663 static int fat_itr_isdir(fat_itr *itr);
 664
 665 /**
 666  * fat_itr_root() - initialize an iterator to start at the root
 667  * directory
 668  *
 669  * @itr: iterator to initialize
 670  * @fsdata: filesystem data for the partition
 671  * @return 0 on success, else -errno
 672  */
 673 static int fat_itr_root(fat_itr *itr, fsdata *fsdata)
 674 {
 675         if (get_fs_info(fsdata))
 676                 return -ENXIO;
 677
 678         itr->fsdata = fsdata;
 679         itr->start_clust = 0;
 680         itr->clust = fsdata->root_cluster;
 681         itr->next_clust = fsdata->root_cluster;
 682         itr->dent = NULL;
 683         itr->remaining = 0;
 684         itr->last_cluster = 0;
 685         itr->is_root = 1;
 686
 687         return 0;
 688 }
 689
 690 /**
 691  * fat_itr_child() - initialize an iterator to descend into a sub-
 692  * directory
 693  *
 694  * Initializes 'itr' to iterate the contents of the directory at
 695  * the current cursor position of 'parent'.  It is an error to
 696  * call this if the current cursor of 'parent' is pointing at a
 697  * regular file.
 698  *
 699  * Note that 'itr' and 'parent' can be the same pointer if you do
 700  * not need to preserve 'parent' after this call, which is useful
 701  * for traversing directory structure to resolve a file/directory.
 702  *
 703  * @itr: iterator to initialize
 704  * @parent: the iterator pointing at a directory entry in the
 705  *    parent directory of the directory to iterate
 706  */
 707 static void fat_itr_child(fat_itr *itr, fat_itr *parent)
 708 {
 709         fsdata *mydata = parent->fsdata;  /* for silly macros */
 710         unsigned clustnum = START(parent->dent);
 711
 712         assert(fat_itr_isdir(parent));
 713
 714         itr->fsdata = parent->fsdata;
 715         itr->start_clust = clustnum;
 716         if (clustnum > 0) {
 717                 itr->clust = clustnum;
 718                 itr->next_clust = clustnum;
 719                 itr->is_root = 0;
 720         } else {
 721                 itr->clust = parent->fsdata->root_cluster;
 722                 itr->next_clust = parent->fsdata->root_cluster;
 723                 itr->is_root = 1;
 724         }
 725         itr->dent = NULL;
 726         itr->remaining = 0;
 727         itr->last_cluster = 0;
 728 }
 729
 730 static void *next_cluster(fat_itr *itr)
 731 {
 732         fsdata *mydata = itr->fsdata;  /* for silly macros */
 733         int ret;
 734         u32 sect;
 735
 736         /* have we reached the end? */
 737         if (itr->last_cluster)
 738                 return NULL;
 739
 740         sect = clust_to_sect(itr->fsdata, itr->next_clust);
 741
 742         debug("FAT read(sect=%d), clust_size=%d, DIRENTSPERBLOCK=%zd\n",
 743               sect, itr->fsdata->clust_size, DIRENTSPERBLOCK);
 744
 745         /*
 746          * NOTE: do_fat_read_at() had complicated logic to deal w/
 747          * vfat names that span multiple clusters in the fat16 case,
 748          * which get_dentfromdir() probably also needed (and was
 749          * missing).  And not entirely sure what fat32 didn't have
 750          * the same issue..  We solve that by only caring about one
 751          * dent at a time and iteratively constructing the vfat long
 752          * name.
 753          */
 754         ret = disk_read(sect, itr->fsdata->clust_size,
 755                         itr->block);
 756         if (ret < 0) {
 757                 debug("Error: reading block\n");
 758                 return NULL;
 759         }
 760
 761         itr->clust = itr->next_clust;
 762         if (itr->is_root && itr->fsdata->fatsize != 32) {
 763                 itr->next_clust++;
 764                 sect = clust_to_sect(itr->fsdata, itr->next_clust);
 765                 if (sect - itr->fsdata->rootdir_sect >=
 766                     itr->fsdata->rootdir_size) {
 767                         debug("nextclust: 0x%x\n", itr->next_clust);
 768                         itr->last_cluster = 1;
 769                 }
 770         } else {
 771                 itr->next_clust = get_fatent(itr->fsdata, itr->next_clust);
 772                 if (CHECK_CLUST(itr->next_clust, itr->fsdata->fatsize)) {
 773                         debug("nextclust: 0x%x\n", itr->next_clust);
 774                         itr->last_cluster = 1;
 775                 }
 776         }
 777
 778         return itr->block;
 779 }
 780
 781 static dir_entry *next_dent(fat_itr *itr)
 782 {
 783         if (itr->remaining == 0) {
 784                 struct dir_entry *dent = next_cluster(itr);
 785                 unsigned nbytes = itr->fsdata->sect_size *
 786                         itr->fsdata->clust_size;
 787
 788                 /* have we reached the last cluster? */
 789                 if (!dent) {
 790                         /* a sign for no more entries left */
 791                         itr->dent = NULL;
 792                         return NULL;
 793                 }
 794
 795                 itr->remaining = nbytes / sizeof(dir_entry) - 1;
 796                 itr->dent = dent;
 797         } else {
 798                 itr->remaining--;
 799                 itr->dent++;
 800         }
 801
 802         /* have we reached the last valid entry? */
 803         if (itr->dent->name[0] == 0)
 804                 return NULL;
 805
 806         return itr->dent;
 807 }
 808
 809 static dir_entry *extract_vfat_name(fat_itr *itr)
 810 {
 811         struct dir_entry *dent = itr->dent;
 812         int seqn = itr->dent->name[0] & ~LAST_LONG_ENTRY_MASK;
 813         u8 chksum, alias_checksum = ((dir_slot *)dent)->alias_checksum;
 814         int n = 0;
 815
 816         while (seqn--) {
 817                 char buf[13];
 818                 int idx = 0;
 819
 820                 slot2str((dir_slot *)dent, buf, &idx);
 821
 822                 if (n + idx >= sizeof(itr->l_name))
 823                         return NULL;
 824
 825                 /* shift accumulated long-name up and copy new part in: */
 826                 memmove(itr->l_name + idx, itr->l_name, n);
 827                 memcpy(itr->l_name, buf, idx);
 828                 n += idx;
 829
 830                 dent = next_dent(itr);
 831                 if (!dent)
 832                         return NULL;
 833         }
 834
 835         itr->l_name[n] = '\0';
 836
 837         chksum = mkcksum(dent->name, dent->ext);
 838
 839         /* checksum mismatch could mean deleted file, etc.. skip it: */
 840         if (chksum != alias_checksum) {
 841                 debug("** chksum=%x, alias_checksum=%x, l_name=%s, s_name=%8s.%3s\n",
 842                       chksum, alias_checksum, itr->l_name, dent->name, dent->ext);
 843                 return NULL;
 844         }
 845
 846         return dent;
 847 }
 848
 849 /**
 850  * fat_itr_next() - step to the next entry in a directory
 851  *
 852  * Must be called once on a new iterator before the cursor is valid.
 853  *
 854  * @itr: the iterator to iterate
 855  * @return boolean, 1 if success or 0 if no more entries in the
 856  *    current directory
 857  */
 858 static int fat_itr_next(fat_itr *itr)
 859 {
 860         dir_entry *dent;
 861
 862         itr->name = NULL;
 863
 864         while (1) {
 865                 dent = next_dent(itr);
 866                 if (!dent)
 867                         return 0;
 868
 869                 if (dent->name[0] == DELETED_FLAG ||
 870                     dent->name[0] == aRING)
 871                         continue;
 872
 873                 if (dent->attr & ATTR_VOLUME) {
 874                         if ((dent->attr & ATTR_VFAT) == ATTR_VFAT &&
 875                             (dent->name[0] & LAST_LONG_ENTRY_MASK)) {
 876                                 dent = extract_vfat_name(itr);
 877                                 if (!dent)
 878                                         continue;
 879                                 itr->name = itr->l_name;
 880                                 break;
 881                         } else {
 882                                 /* Volume label or VFAT entry, skip */
 883                                 continue;
 884                         }
 885                 }
 886
 887                 break;
 888         }
 889
 890         get_name(dent, itr->s_name);
 891         if (!itr->name)
 892                 itr->name = itr->s_name;
 893
 894         return 1;
 895 }
 896
 897 /**
 898  * fat_itr_isdir() - is current cursor position pointing to a directory
 899  *
 900  * @itr: the iterator
 901  * @return true if cursor is at a directory
 902  */
 903 static int fat_itr_isdir(fat_itr *itr)
 904 {
 905         return !!(itr->dent->attr & ATTR_DIR);
 906 }
 907
 908 /*
 909  * Helpers:
 910  */
 911
 912 #define TYPE_FILE 0x1
 913 #define TYPE_DIR  0x2
 914 #define TYPE_ANY  (TYPE_FILE | TYPE_DIR)
 915
 916 /**
 917  * fat_itr_resolve() - traverse directory structure to resolve the
 918  * requested path.
 919  *
 920  * Traverse directory structure to the requested path.  If the specified
 921  * path is to a directory, this will descend into the directory and
 922  * leave it iterator at the start of the directory.  If the path is to a
 923  * file, it will leave the iterator in the parent directory with current
 924  * cursor at file's entry in the directory.
 925  *
 926  * @itr: iterator initialized to root
 927  * @path: the requested path
 928  * @type: bitmask of allowable file types
 929  * @return 0 on success or -errno
 930  */
 931 static int fat_itr_resolve(fat_itr *itr, const char *path, unsigned type)
 932 {
 933         const char *next;
 934
 935         /* chomp any extra leading slashes: */
 936         while (path[0] && ISDIRDELIM(path[0]))
 937                 path++;
 938
 939         /* are we at the end? */
 940         if (strlen(path) == 0) {
 941                 if (!(type & TYPE_DIR))
 942                         return -ENOENT;
 943                 return 0;
 944         }
 945
 946         /* find length of next path entry: */
 947         next = path;
 948         while (next[0] && !ISDIRDELIM(next[0]))
 949                 next++;
 950
 951         if (itr->is_root) {
 952                 /* root dir doesn't have "." nor ".." */
 953                 if ((((next - path) == 1) && !strncmp(path, ".", 1)) ||
 954                     (((next - path) == 2) && !strncmp(path, "..", 2))) {
 955                         /* point back to itself */
 956                         itr->clust = itr->fsdata->root_cluster;
 957                         itr->next_clust = itr->fsdata->root_cluster;
 958                         itr->dent = NULL;
 959                         itr->remaining = 0;
 960                         itr->last_cluster = 0;
 961
 962                         if (next[0] == 0) {
 963                                 if (type & TYPE_DIR)
 964                                         return 0;
 965                                 else
 966                                         return -ENOENT;
 967                         }
 968
 969                         return fat_itr_resolve(itr, next, type);
 970                 }
 971         }
 972
 973         while (fat_itr_next(itr)) {
 974                 int match = 0;
 975                 unsigned n = max(strlen(itr->name), (size_t)(next - path));
 976
 977                 /* check both long and short name: */
 978                 if (!strncasecmp(path, itr->name, n))
 979                         match = 1;
 980                 else if (itr->name != itr->s_name &&
 981                          !strncasecmp(path, itr->s_name, n))
 982                         match = 1;
 983
 984                 if (!match)
 985                         continue;
 986
 987                 if (fat_itr_isdir(itr)) {
 988                         /* recurse into directory: */
 989                         fat_itr_child(itr, itr);
 990                         return fat_itr_resolve(itr, next, type);
 991                 } else if (next[0]) {
 992                         /*
 993                          * If next is not empty then we have a case
 994                          * like: /path/to/realfile/nonsense
 995                          */
 996                         debug("bad trailing path: %s\n", next);
 997                         return -ENOENT;
 998                 } else if (!(type & TYPE_FILE)) {
 999                         return -ENOTDIR;
1000                 } else {
1001                         return 0;
1002                 }
1003         }
1004
1005         return -ENOENT;
1006 }
1007
1008 int file_fat_detectfs(void)
1009 {
1010         boot_sector bs;
1011         volume_info volinfo;
1012         int fatsize;
1013         char vol_label[12];
1014
1015         if (cur_dev == NULL) {
1016                 printf("No current device\n");
1017                 return 1;
1018         }
1019
1020 #if defined(CONFIG_IDE) || \
1021     defined(CONFIG_SATA) || \
1022     defined(CONFIG_SCSI) || \
1023     defined(CONFIG_CMD_USB) || \
1024     defined(CONFIG_MMC)
1025         printf("Interface:  ");
1026         switch (cur_dev->if_type) {
1027         case IF_TYPE_IDE:
1028                 printf("IDE");
1029                 break;
1030         case IF_TYPE_SATA:
1031                 printf("SATA");
1032                 break;
1033         case IF_TYPE_SCSI:
1034                 printf("SCSI");
1035                 break;
1036         case IF_TYPE_ATAPI:
1037                 printf("ATAPI");
1038                 break;
1039         case IF_TYPE_USB:
1040                 printf("USB");
1041                 break;
1042         case IF_TYPE_DOC:
1043                 printf("DOC");
1044                 break;
1045         case IF_TYPE_MMC:
1046                 printf("MMC");
1047                 break;
1048         default:
1049                 printf("Unknown");
1050         }
1051
1052         printf("\n  Device %d: ", cur_dev->devnum);
1053         dev_print(cur_dev);
1054 #endif
1055
1056         if (read_bootsectandvi(&bs, &volinfo, &fatsize)) {
1057                 printf("\nNo valid FAT fs found\n");
1058                 return 1;
1059         }
1060
1061         memcpy(vol_label, volinfo.volume_label, 11);
1062         vol_label[11] = '\0';
1063         volinfo.fs_type[5] = '\0';
1064
1065         printf("Filesystem: %s \"%s\"\n", volinfo.fs_type, vol_label);
1066
1067         return 0;
1068 }
1069
1070 int fat_exists(const char *filename)
1071 {
1072         fsdata fsdata;
1073         fat_itr *itr;
1074         int ret;
1075
1076         itr = malloc_cache_aligned(sizeof(fat_itr));
1077         if (!itr)
1078                 return 0;
1079         ret = fat_itr_root(itr, &fsdata);
1080         if (ret)
1081                 goto out;
1082
1083         ret = fat_itr_resolve(itr, filename, TYPE_ANY);
1084         free(fsdata.fatbuf);
1085 out:
1086         free(itr);
1087         return ret == 0;
1088 }
1089
1090 int fat_size(const char *filename, loff_t *size)
1091 {
1092         fsdata fsdata;
1093         fat_itr *itr;
1094         int ret;
1095
1096         itr = malloc_cache_aligned(sizeof(fat_itr));
1097         if (!itr)
1098                 return -ENOMEM;
1099         ret = fat_itr_root(itr, &fsdata);
1100         if (ret)
1101                 goto out_free_itr;
1102
1103         ret = fat_itr_resolve(itr, filename, TYPE_FILE);
1104         if (ret) {
1105                 /*
1106                  * Directories don't have size, but fs_size() is not
1107                  * expected to fail if passed a directory path:
1108                  */
1109                 free(fsdata.fatbuf);
1110                 fat_itr_root(itr, &fsdata);
1111                 if (!fat_itr_resolve(itr, filename, TYPE_DIR)) {
1112                         *size = 0;
1113                         ret = 0;
1114                 }
1115                 goto out_free_both;
1116         }
1117
1118         *size = FAT2CPU32(itr->dent->size);
1119 out_free_both:
1120         free(fsdata.fatbuf);
1121 out_free_itr:
1122         free(itr);
1123         return ret;
1124 }
1125
1126 int file_fat_read_at(const char *filename, loff_t pos, void *buffer,
1127                      loff_t maxsize, loff_t *actread)
1128 {
1129         fsdata fsdata;
1130         fat_itr *itr;
1131         int ret;
1132
1133         itr = malloc_cache_aligned(sizeof(fat_itr));
1134         if (!itr)
1135                 return -ENOMEM;
1136         ret = fat_itr_root(itr, &fsdata);
1137         if (ret)
1138                 goto out_free_itr;
1139
1140         ret = fat_itr_resolve(itr, filename, TYPE_FILE);
1141         if (ret)
1142                 goto out_free_both;
1143
1144         debug("reading %s at pos %llu\n", filename, pos);
1145         ret = get_contents(&fsdata, itr->dent, pos, buffer, maxsize, actread);
1146
1147 out_free_both:
1148         free(fsdata.fatbuf);
1149 out_free_itr:
1150         free(itr);
1151         return ret;
1152 }
1153
1154 int file_fat_read(const char *filename, void *buffer, int maxsize)
1155 {
1156         loff_t actread;
1157         int ret;
1158
1159         ret =  file_fat_read_at(filename, 0, buffer, maxsize, &actread);
1160         if (ret)
1161                 return ret;
1162         else
1163                 return actread;
1164 }
1165
1166 int fat_read_file(const char *filename, void *buf, loff_t offset, loff_t len,
1167                   loff_t *actread)
1168 {
1169         int ret;
1170
1171         ret = file_fat_read_at(filename, offset, buf, len, actread);
1172         if (ret)
1173                 printf("** Unable to read file %s **\n", filename);
1174
1175         return ret;
1176 }
1177
1178 typedef struct {
1179         struct fs_dir_stream parent;
1180         struct fs_dirent dirent;
1181         fsdata fsdata;
1182         fat_itr itr;
1183 } fat_dir;
1184
1185 int fat_opendir(const char *filename, struct fs_dir_stream **dirsp)
1186 {
1187         fat_dir *dir;
1188         int ret;
1189
1190         dir = malloc_cache_aligned(sizeof(*dir));
1191         if (!dir)
1192                 return -ENOMEM;
1193         memset(dir, 0, sizeof(*dir));
1194
1195         ret = fat_itr_root(&dir->itr, &dir->fsdata);
1196         if (ret)
1197                 goto fail_free_dir;
1198
1199         ret = fat_itr_resolve(&dir->itr, filename, TYPE_DIR);
1200         if (ret)
1201                 goto fail_free_both;
1202
1203         *dirsp = (struct fs_dir_stream *)dir;
1204         return 0;
1205
1206 fail_free_both:
1207         free(dir->fsdata.fatbuf);
1208 fail_free_dir:
1209         free(dir);
1210         return ret;
1211 }
1212
1213 int fat_readdir(struct fs_dir_stream *dirs, struct fs_dirent **dentp)
1214 {
1215         fat_dir *dir = (fat_dir *)dirs;
1216         struct fs_dirent *dent = &dir->dirent;
1217
1218         if (!fat_itr_next(&dir->itr))
1219                 return -ENOENT;
1220
1221         memset(dent, 0, sizeof(*dent));
1222         strcpy(dent->name, dir->itr.name);
1223
1224         if (fat_itr_isdir(&dir->itr)) {
1225                 dent->type = FS_DT_DIR;
1226         } else {
1227                 dent->type = FS_DT_REG;
1228                 dent->size = FAT2CPU32(dir->itr.dent->size);
1229         }
1230
1231         *dentp = dent;
1232
1233         return 0;
1234 }
1235
1236 void fat_closedir(struct fs_dir_stream *dirs)
1237 {
1238         fat_dir *dir = (fat_dir *)dirs;
1239         free(dir->fsdata.fatbuf);
1240         free(dir);
1241 }
1242
1243 void fat_close(void)
1244 {
1245 }