blob: 8ec91cda753ba562d9877a1d76a983b17150b5d3 [file] [log] [blame]
wdenk71f95112003-06-15 22:40:42 +00001/*
2 * R/O (V)FAT 12/16/32 filesystem implementation by Marcus Sundberg
3 *
4 * 2002-07-28 - rjones@nexus-tech.net - ported to ppcboot v1.1.6
5 * 2003-03-10 - kharris@nexus-tech.net - ported to u-boot
6 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02007 * SPDX-License-Identifier: GPL-2.0+
wdenk71f95112003-06-15 22:40:42 +00008 */
9
10#ifndef _FAT_H_
11#define _FAT_H_
12
wdenk5cf91d62004-04-23 20:32:05 +000013#include <asm/byteorder.h>
14
wdenk71f95112003-06-15 22:40:42 +000015#define CONFIG_SUPPORT_VFAT
Mikhail Zolotaryov38315302010-09-08 17:06:03 +030016/* Maximum Long File Name length supported here is 128 UTF-16 code units */
17#define VFAT_MAXLEN_BYTES 256 /* Maximum LFN buffer in bytes */
18#define VFAT_MAXSEQ 9 /* Up to 9 of 13 2-byte UTF-16 entries */
Sergei Shtylyov025421e2011-08-19 09:37:46 +000019#define PREFETCH_BLOCKS 2
wdenk71f95112003-06-15 22:40:42 +000020
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +053021#ifndef CONFIG_FS_FAT_MAX_CLUSTSIZE
22#define CONFIG_FS_FAT_MAX_CLUSTSIZE 65536
23#endif
24#define MAX_CLUSTSIZE CONFIG_FS_FAT_MAX_CLUSTSIZE
25
Sergei Shtylyovac497772011-08-08 09:38:33 +000026#define DIRENTSPERBLOCK (mydata->sect_size / sizeof(dir_entry))
27#define DIRENTSPERCLUST ((mydata->clust_size * mydata->sect_size) / \
28 sizeof(dir_entry))
wdenk71f95112003-06-15 22:40:42 +000029
30#define FATBUFBLOCKS 6
Sergei Shtylyovac497772011-08-08 09:38:33 +000031#define FATBUFSIZE (mydata->sect_size * FATBUFBLOCKS)
wdenkcd37d9e2004-02-10 00:03:41 +000032#define FAT12BUFSIZE ((FATBUFSIZE*2)/3)
wdenk71f95112003-06-15 22:40:42 +000033#define FAT16BUFSIZE (FATBUFSIZE/2)
34#define FAT32BUFSIZE (FATBUFSIZE/4)
35
36
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
62/* Flags telling whether we should read a file or list a directory */
Wolfgang Denk7385c282010-07-19 11:37:00 +020063#define LS_NO 0
64#define LS_YES 1
65#define LS_DIR 1
66#define LS_ROOT 2
wdenk71f95112003-06-15 22:40:42 +000067
Wolfgang Denk7385c282010-07-19 11:37:00 +020068#define ISDIRDELIM(c) ((c) == '/' || (c) == '\\')
wdenk71f95112003-06-15 22:40:42 +000069
70#define FSTYPE_NONE (-1)
71
72#if defined(__linux__) && defined(__KERNEL__)
73#define FAT2CPU16 le16_to_cpu
74#define FAT2CPU32 le32_to_cpu
75#else
wdenk9fd5e312003-12-07 23:55:12 +000076#if __LITTLE_ENDIAN
wdenk71f95112003-06-15 22:40:42 +000077#define FAT2CPU16(x) (x)
78#define FAT2CPU32(x) (x)
79#else
80#define FAT2CPU16(x) ((((x) & 0x00ff) << 8) | (((x) & 0xff00) >> 8))
81#define FAT2CPU32(x) ((((x) & 0x000000ff) << 24) | \
Wolfgang Denk53677ef2008-05-20 16:00:29 +020082 (((x) & 0x0000ff00) << 8) | \
wdenk71f95112003-06-15 22:40:42 +000083 (((x) & 0x00ff0000) >> 8) | \
84 (((x) & 0xff000000) >> 24))
85#endif
86#endif
87
wdenk71f95112003-06-15 22:40:42 +000088#define START(dent) (FAT2CPU16((dent)->start) \
89 + (mydata->fatsize != 32 ? 0 : \
90 (FAT2CPU16((dent)->starthi) << 16)))
Wu, Josh2e98f702014-05-08 16:14:06 +080091#define IS_LAST_CLUST(x, fatsize) ((x) >= ((fatsize) != 32 ? \
92 ((fatsize) != 16 ? 0xff8 : 0xfff8) : \
93 0xffffff8))
michael8ce4e5c2008-03-02 23:33:46 +010094#define CHECK_CLUST(x, fatsize) ((x) <= 1 || \
Wu, Josh06118972014-05-08 16:14:05 +080095 (x) >= ((fatsize) != 32 ? \
96 ((fatsize) != 16 ? 0xff0 : 0xfff0) : \
97 0xffffff0))
wdenk71f95112003-06-15 22:40:42 +000098
99typedef struct boot_sector {
100 __u8 ignored[3]; /* Bootstrap code */
101 char system_id[8]; /* Name of fs */
102 __u8 sector_size[2]; /* Bytes/sector */
103 __u8 cluster_size; /* Sectors/cluster */
104 __u16 reserved; /* Number of reserved sectors */
105 __u8 fats; /* Number of FATs */
106 __u8 dir_entries[2]; /* Number of root directory entries */
107 __u8 sectors[2]; /* Number of sectors */
108 __u8 media; /* Media code */
109 __u16 fat_length; /* Sectors/FAT */
110 __u16 secs_track; /* Sectors/track */
111 __u16 heads; /* Number of heads */
112 __u32 hidden; /* Number of hidden sectors */
113 __u32 total_sect; /* Number of sectors (if sectors == 0) */
114
115 /* FAT32 only */
116 __u32 fat32_length; /* Sectors/FAT */
117 __u16 flags; /* Bit 8: fat mirroring, low 4: active fat */
118 __u8 version[2]; /* Filesystem version */
119 __u32 root_cluster; /* First cluster in root directory */
120 __u16 info_sector; /* Filesystem info sector */
121 __u16 backup_boot; /* Backup boot sector */
122 __u16 reserved2[6]; /* Unused */
123} boot_sector;
124
125typedef struct volume_info
126{
127 __u8 drive_number; /* BIOS drive number */
128 __u8 reserved; /* Unused */
129 __u8 ext_boot_sign; /* 0x29 if fields below exist (DOS 3.3+) */
130 __u8 volume_id[4]; /* Volume ID number */
131 char volume_label[11]; /* Volume label */
132 char fs_type[8]; /* Typically FAT12, FAT16, or FAT32 */
133 /* Boot code comes next, all but 2 bytes to fill up sector */
134 /* Boot sign comes last, 2 bytes */
135} volume_info;
136
137typedef struct dir_entry {
138 char name[8],ext[3]; /* Name and extension */
139 __u8 attr; /* Attribute bits */
140 __u8 lcase; /* Case for base and extension */
141 __u8 ctime_ms; /* Creation time, milliseconds */
142 __u16 ctime; /* Creation time */
143 __u16 cdate; /* Creation date */
144 __u16 adate; /* Last access date */
145 __u16 starthi; /* High 16 bits of cluster in FAT32 */
146 __u16 time,date,start;/* Time, date and first cluster */
147 __u32 size; /* File size in bytes */
148} dir_entry;
149
150typedef struct dir_slot {
Wolfgang Denk7385c282010-07-19 11:37:00 +0200151 __u8 id; /* Sequence number for slot */
152 __u8 name0_4[10]; /* First 5 characters in name */
153 __u8 attr; /* Attribute byte */
154 __u8 reserved; /* Unused */
155 __u8 alias_checksum;/* Checksum for 8.3 alias */
156 __u8 name5_10[12]; /* 6 more characters in name */
157 __u16 start; /* Unused */
158 __u8 name11_12[4]; /* Last 2 characters in name */
wdenk71f95112003-06-15 22:40:42 +0000159} dir_slot;
160
Wolfgang Denk7385c282010-07-19 11:37:00 +0200161/*
162 * Private filesystem parameters
Wolfgang Denk80f0c0f2006-08-14 22:05:26 +0200163 *
164 * Note: FAT buffer has to be 32 bit aligned
165 * (see FAT32 accesses)
166 */
wdenk71f95112003-06-15 22:40:42 +0000167typedef struct {
Sergei Shtylyovac497772011-08-08 09:38:33 +0000168 __u8 *fatbuf; /* Current FAT buffer */
wdenk71f95112003-06-15 22:40:42 +0000169 int fatsize; /* Size of FAT in bits */
Aaron Williams1d90c3b2012-05-19 07:20:40 +0000170 __u32 fatlength; /* Length of FAT in sectors */
wdenk71f95112003-06-15 22:40:42 +0000171 __u16 fat_sect; /* Starting sector of the FAT */
Stefan BrĂ¼ns3c0ed9c2016-09-11 22:51:40 +0200172 __u8 fat_dirty; /* Set if fatbuf has been modified */
Aaron Williams1d90c3b2012-05-19 07:20:40 +0000173 __u32 rootdir_sect; /* Start sector of root directory */
Sergei Shtylyovac497772011-08-08 09:38:33 +0000174 __u16 sect_size; /* Size of sectors in bytes */
wdenk71f95112003-06-15 22:40:42 +0000175 __u16 clust_size; /* Size of clusters in sectors */
Aaron Williams1d90c3b2012-05-19 07:20:40 +0000176 int data_begin; /* The sector of the first cluster, can be negative */
wdenk71f95112003-06-15 22:40:42 +0000177 int fatbufnum; /* Used by get_fatent, init to -1 */
178} fsdata;
179
180typedef int (file_detectfs_func)(void);
181typedef int (file_ls_func)(const char *dir);
Suriyan Ramasami1ad0b982014-11-17 14:39:35 -0800182typedef int (file_read_func)(const char *filename, void *buffer,
183 int maxsize);
wdenk71f95112003-06-15 22:40:42 +0000184
185struct filesystem {
Wolfgang Denk7385c282010-07-19 11:37:00 +0200186 file_detectfs_func *detect;
187 file_ls_func *ls;
188 file_read_func *read;
189 const char name[12];
wdenk71f95112003-06-15 22:40:42 +0000190};
191
192/* FAT tables */
193file_detectfs_func file_fat_detectfs;
194file_ls_func file_fat_ls;
195file_read_func file_fat_read;
196
197/* Currently this doesn't check if the dir exists or is valid... */
198int file_cd(const char *path);
199int file_fat_detectfs(void);
200int file_fat_ls(const char *dir);
Stephen Warrenb7b5f312014-02-03 13:21:10 -0700201int fat_exists(const char *filename);
Suriyan Ramasamid455d872014-11-17 14:39:38 -0800202int fat_size(const char *filename, loff_t *size);
Suriyan Ramasami1ad0b982014-11-17 14:39:35 -0800203int file_fat_read_at(const char *filename, loff_t pos, void *buffer,
204 loff_t maxsize, loff_t *actread);
205int file_fat_read(const char *filename, void *buffer, int maxsize);
wdenk71f95112003-06-15 22:40:42 +0000206const char *file_getfsname(int idx);
Simon Glass4101f682016-02-29 15:25:34 -0700207int fat_set_blk_dev(struct blk_desc *rbdd, disk_partition_t *info);
208int fat_register_device(struct blk_desc *dev_desc, int part_no);
wdenk71f95112003-06-15 22:40:42 +0000209
Suriyan Ramasami1ad0b982014-11-17 14:39:35 -0800210int file_fat_write(const char *filename, void *buf, loff_t offset, loff_t len,
211 loff_t *actwrite);
Suriyan Ramasamid455d872014-11-17 14:39:38 -0800212int fat_read_file(const char *filename, void *buf, loff_t offset, loff_t len,
213 loff_t *actread);
Simon Glasse6d52412012-12-26 09:53:33 +0000214void fat_close(void);
wdenk71f95112003-06-15 22:40:42 +0000215#endif /* _FAT_H_ */