blob: b9f273f381f10b6cb5f680c3d771842a268cdfad [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
wdenk71f95112003-06-15 22:40:42 +00002/*
3 * R/O (V)FAT 12/16/32 filesystem implementation by Marcus Sundberg
4 *
5 * 2002-07-28 - rjones@nexus-tech.net - ported to ppcboot v1.1.6
6 * 2003-03-10 - kharris@nexus-tech.net - ported to u-boot
wdenk71f95112003-06-15 22:40:42 +00007 */
8
9#ifndef _FAT_H_
10#define _FAT_H_
11
Rob Clark89191d62017-09-09 13:15:58 -040012#include <fs.h>
Heinrich Schuchardtd236e822020-11-22 09:19:52 +010013#include <asm/byteorder.h>
14#include <asm/cache.h>
wdenk5cf91d62004-04-23 20:32:05 +000015
Simon Glasse6f6f9e2020-05-10 11:39:58 -060016struct disk_partition;
17
Mikhail Zolotaryov38315302010-09-08 17:06:03 +030018/* Maximum Long File Name length supported here is 128 UTF-16 code units */
19#define VFAT_MAXLEN_BYTES 256 /* Maximum LFN buffer in bytes */
20#define VFAT_MAXSEQ 9 /* Up to 9 of 13 2-byte UTF-16 entries */
Sergei Shtylyov025421e2011-08-19 09:37:46 +000021#define PREFETCH_BLOCKS 2
wdenk71f95112003-06-15 22:40:42 +000022
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +053023#define MAX_CLUSTSIZE CONFIG_FS_FAT_MAX_CLUSTSIZE
24
Sergei Shtylyovac497772011-08-08 09:38:33 +000025#define DIRENTSPERCLUST ((mydata->clust_size * mydata->sect_size) / \
26 sizeof(dir_entry))
wdenk71f95112003-06-15 22:40:42 +000027
28#define FATBUFBLOCKS 6
Sergei Shtylyovac497772011-08-08 09:38:33 +000029#define FATBUFSIZE (mydata->sect_size * FATBUFBLOCKS)
wdenkcd37d9e2004-02-10 00:03:41 +000030#define FAT12BUFSIZE ((FATBUFSIZE*2)/3)
wdenk71f95112003-06-15 22:40:42 +000031#define FAT16BUFSIZE (FATBUFSIZE/2)
32#define FAT32BUFSIZE (FATBUFSIZE/4)
33
Tien Fong Chee7aa1a6b2016-07-27 23:08:56 -070034/* Maximum number of entry for long file name according to spec */
35#define MAX_LFN_SLOT 20
wdenk71f95112003-06-15 22:40:42 +000036
37/* Filesystem identifiers */
38#define FAT12_SIGN "FAT12 "
39#define FAT16_SIGN "FAT16 "
40#define FAT32_SIGN "FAT32 "
41#define SIGNLEN 8
42
43/* File attributes */
Wolfgang Denk7385c282010-07-19 11:37:00 +020044#define ATTR_RO 1
45#define ATTR_HIDDEN 2
46#define ATTR_SYS 4
47#define ATTR_VOLUME 8
48#define ATTR_DIR 16
49#define ATTR_ARCH 32
wdenk71f95112003-06-15 22:40:42 +000050
Wolfgang Denk7385c282010-07-19 11:37:00 +020051#define ATTR_VFAT (ATTR_RO | ATTR_HIDDEN | ATTR_SYS | ATTR_VOLUME)
wdenk71f95112003-06-15 22:40:42 +000052
53#define DELETED_FLAG ((char)0xe5) /* Marks deleted files when in name[0] */
Remy Bohmer3c2c2f42008-11-27 22:30:27 +010054#define aRING 0x05 /* Used as special character in name[0] */
wdenk71f95112003-06-15 22:40:42 +000055
Wolfgang Denk7385c282010-07-19 11:37:00 +020056/*
57 * Indicates that the entry is the last long entry in a set of long
wdenk2d1a5372004-02-23 19:30:57 +000058 * dir entries
59 */
60#define LAST_LONG_ENTRY_MASK 0x40
wdenk71f95112003-06-15 22:40:42 +000061
Wolfgang Denk7385c282010-07-19 11:37:00 +020062#define ISDIRDELIM(c) ((c) == '/' || (c) == '\\')
wdenk71f95112003-06-15 22:40:42 +000063
64#define FSTYPE_NONE (-1)
65
66#if defined(__linux__) && defined(__KERNEL__)
67#define FAT2CPU16 le16_to_cpu
68#define FAT2CPU32 le32_to_cpu
69#else
wdenk9fd5e312003-12-07 23:55:12 +000070#if __LITTLE_ENDIAN
wdenk71f95112003-06-15 22:40:42 +000071#define FAT2CPU16(x) (x)
72#define FAT2CPU32(x) (x)
73#else
74#define FAT2CPU16(x) ((((x) & 0x00ff) << 8) | (((x) & 0xff00) >> 8))
75#define FAT2CPU32(x) ((((x) & 0x000000ff) << 24) | \
Wolfgang Denk53677ef2008-05-20 16:00:29 +020076 (((x) & 0x0000ff00) << 8) | \
wdenk71f95112003-06-15 22:40:42 +000077 (((x) & 0x00ff0000) >> 8) | \
78 (((x) & 0xff000000) >> 24))
79#endif
80#endif
81
wdenk71f95112003-06-15 22:40:42 +000082#define START(dent) (FAT2CPU16((dent)->start) \
83 + (mydata->fatsize != 32 ? 0 : \
84 (FAT2CPU16((dent)->starthi) << 16)))
Wu, Josh2e98f702014-05-08 16:14:06 +080085#define IS_LAST_CLUST(x, fatsize) ((x) >= ((fatsize) != 32 ? \
86 ((fatsize) != 16 ? 0xff8 : 0xfff8) : \
87 0xffffff8))
michael8ce4e5c2008-03-02 23:33:46 +010088#define CHECK_CLUST(x, fatsize) ((x) <= 1 || \
Wu, Josh06118972014-05-08 16:14:05 +080089 (x) >= ((fatsize) != 32 ? \
90 ((fatsize) != 16 ? 0xff0 : 0xfff0) : \
91 0xffffff0))
wdenk71f95112003-06-15 22:40:42 +000092
93typedef struct boot_sector {
94 __u8 ignored[3]; /* Bootstrap code */
95 char system_id[8]; /* Name of fs */
96 __u8 sector_size[2]; /* Bytes/sector */
97 __u8 cluster_size; /* Sectors/cluster */
98 __u16 reserved; /* Number of reserved sectors */
99 __u8 fats; /* Number of FATs */
100 __u8 dir_entries[2]; /* Number of root directory entries */
101 __u8 sectors[2]; /* Number of sectors */
102 __u8 media; /* Media code */
103 __u16 fat_length; /* Sectors/FAT */
104 __u16 secs_track; /* Sectors/track */
105 __u16 heads; /* Number of heads */
106 __u32 hidden; /* Number of hidden sectors */
107 __u32 total_sect; /* Number of sectors (if sectors == 0) */
108
109 /* FAT32 only */
110 __u32 fat32_length; /* Sectors/FAT */
111 __u16 flags; /* Bit 8: fat mirroring, low 4: active fat */
112 __u8 version[2]; /* Filesystem version */
113 __u32 root_cluster; /* First cluster in root directory */
114 __u16 info_sector; /* Filesystem info sector */
115 __u16 backup_boot; /* Backup boot sector */
116 __u16 reserved2[6]; /* Unused */
117} boot_sector;
118
119typedef struct volume_info
120{
121 __u8 drive_number; /* BIOS drive number */
122 __u8 reserved; /* Unused */
123 __u8 ext_boot_sign; /* 0x29 if fields below exist (DOS 3.3+) */
124 __u8 volume_id[4]; /* Volume ID number */
125 char volume_label[11]; /* Volume label */
126 char fs_type[8]; /* Typically FAT12, FAT16, or FAT32 */
127 /* Boot code comes next, all but 2 bytes to fill up sector */
128 /* Boot sign comes last, 2 bytes */
129} volume_info;
130
Rob Clark21a24c32017-09-09 13:15:59 -0400131/* see dir_entry::lcase: */
132#define CASE_LOWER_BASE 8 /* base (name) is lower case */
133#define CASE_LOWER_EXT 16 /* extension is lower case */
134
wdenk71f95112003-06-15 22:40:42 +0000135typedef struct dir_entry {
136 char name[8],ext[3]; /* Name and extension */
137 __u8 attr; /* Attribute bits */
Rob Clark21a24c32017-09-09 13:15:59 -0400138 __u8 lcase; /* Case for name and ext (CASE_LOWER_x) */
wdenk71f95112003-06-15 22:40:42 +0000139 __u8 ctime_ms; /* Creation time, milliseconds */
140 __u16 ctime; /* Creation time */
141 __u16 cdate; /* Creation date */
142 __u16 adate; /* Last access date */
143 __u16 starthi; /* High 16 bits of cluster in FAT32 */
144 __u16 time,date,start;/* Time, date and first cluster */
145 __u32 size; /* File size in bytes */
146} dir_entry;
147
148typedef struct dir_slot {
Wolfgang Denk7385c282010-07-19 11:37:00 +0200149 __u8 id; /* Sequence number for slot */
150 __u8 name0_4[10]; /* First 5 characters in name */
151 __u8 attr; /* Attribute byte */
152 __u8 reserved; /* Unused */
153 __u8 alias_checksum;/* Checksum for 8.3 alias */
154 __u8 name5_10[12]; /* 6 more characters in name */
155 __u16 start; /* Unused */
156 __u8 name11_12[4]; /* Last 2 characters in name */
wdenk71f95112003-06-15 22:40:42 +0000157} dir_slot;
158
Wolfgang Denk7385c282010-07-19 11:37:00 +0200159/*
160 * Private filesystem parameters
Wolfgang Denk80f0c0f2006-08-14 22:05:26 +0200161 *
162 * Note: FAT buffer has to be 32 bit aligned
163 * (see FAT32 accesses)
164 */
wdenk71f95112003-06-15 22:40:42 +0000165typedef struct {
Sergei Shtylyovac497772011-08-08 09:38:33 +0000166 __u8 *fatbuf; /* Current FAT buffer */
wdenk71f95112003-06-15 22:40:42 +0000167 int fatsize; /* Size of FAT in bits */
Aaron Williams1d90c3b2012-05-19 07:20:40 +0000168 __u32 fatlength; /* Length of FAT in sectors */
wdenk71f95112003-06-15 22:40:42 +0000169 __u16 fat_sect; /* Starting sector of the FAT */
Stefan BrĂ¼ns3c0ed9c2016-09-11 22:51:40 +0200170 __u8 fat_dirty; /* Set if fatbuf has been modified */
Aaron Williams1d90c3b2012-05-19 07:20:40 +0000171 __u32 rootdir_sect; /* Start sector of root directory */
Sergei Shtylyovac497772011-08-08 09:38:33 +0000172 __u16 sect_size; /* Size of sectors in bytes */
wdenk71f95112003-06-15 22:40:42 +0000173 __u16 clust_size; /* Size of clusters in sectors */
Aaron Williams1d90c3b2012-05-19 07:20:40 +0000174 int data_begin; /* The sector of the first cluster, can be negative */
wdenk71f95112003-06-15 22:40:42 +0000175 int fatbufnum; /* Used by get_fatent, init to -1 */
Rob Clark45449982017-09-09 13:15:52 -0400176 int rootdir_size; /* Size of root dir for non-FAT32 */
Rob Clarkc6e3baa2017-09-09 13:15:53 -0400177 __u32 root_cluster; /* First cluster of root dir for FAT32 */
AKASHI Takahirof23101f2018-09-11 15:58:58 +0900178 u32 total_sect; /* Number of sectors */
179 int fats; /* Number of FATs */
wdenk71f95112003-06-15 22:40:42 +0000180} fsdata;
181
Heinrich Schuchardtd236e822020-11-22 09:19:52 +0100182struct fat_itr;
183typedef struct fat_itr fat_itr;
184
Rob Clarkc6e3baa2017-09-09 13:15:53 -0400185static inline u32 clust_to_sect(fsdata *fsdata, u32 clust)
186{
187 return fsdata->data_begin + clust * fsdata->clust_size;
188}
189
Seung-Woo Kim6e2151c2018-06-04 20:45:54 +0900190static inline u32 sect_to_clust(fsdata *fsdata, int sect)
Rob Clark265edc02017-09-09 13:16:00 -0400191{
192 return (sect - fsdata->data_begin) / fsdata->clust_size;
193}
194
wdenk71f95112003-06-15 22:40:42 +0000195int file_fat_detectfs(void);
Stephen Warrenb7b5f312014-02-03 13:21:10 -0700196int fat_exists(const char *filename);
Suriyan Ramasamid455d872014-11-17 14:39:38 -0800197int fat_size(const char *filename, loff_t *size);
Suriyan Ramasami1ad0b982014-11-17 14:39:35 -0800198int file_fat_read_at(const char *filename, loff_t pos, void *buffer,
199 loff_t maxsize, loff_t *actread);
200int file_fat_read(const char *filename, void *buffer, int maxsize);
Simon Glass05289792020-05-10 11:39:57 -0600201int fat_set_blk_dev(struct blk_desc *rbdd, struct disk_partition *info);
Simon Glass4101f682016-02-29 15:25:34 -0700202int fat_register_device(struct blk_desc *dev_desc, int part_no);
wdenk71f95112003-06-15 22:40:42 +0000203
Suriyan Ramasami1ad0b982014-11-17 14:39:35 -0800204int file_fat_write(const char *filename, void *buf, loff_t offset, loff_t len,
205 loff_t *actwrite);
Suriyan Ramasamid455d872014-11-17 14:39:38 -0800206int fat_read_file(const char *filename, void *buf, loff_t offset, loff_t len,
207 loff_t *actread);
Rob Clark89191d62017-09-09 13:15:58 -0400208int fat_opendir(const char *filename, struct fs_dir_stream **dirsp);
209int fat_readdir(struct fs_dir_stream *dirs, struct fs_dirent **dentp);
210void fat_closedir(struct fs_dir_stream *dirs);
AKASHI Takahirof8240ce2018-09-11 15:59:14 +0900211int fat_unlink(const char *filename);
AKASHI Takahiro31a18d52018-09-11 15:59:10 +0900212int fat_mkdir(const char *dirname);
Simon Glasse6d52412012-12-26 09:53:33 +0000213void fat_close(void);
Heinrich Schuchardtd236e822020-11-22 09:19:52 +0100214void *fat_next_cluster(fat_itr *itr, unsigned int *nbytes);
Heinrich Schuchardtc0029e42020-12-31 00:38:13 +0100215
216/**
217 * fat_uuid() - get FAT volume ID
218 *
219 * The FAT volume ID returned in @uuid_str as hexadecimal number in XXXX-XXXX
220 * format.
221 *
222 * @uuid_str: caller allocated buffer of at least 10 bytes for the volume ID
223 * Return: 0 on success
224 */
225int fat_uuid(char *uuid_str);
226
wdenk71f95112003-06-15 22:40:42 +0000227#endif /* _FAT_H_ */