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