blob: cc85b063952cc40d395a026c75bb4d038f1937fe [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 *
7 * See file CREDITS for list of people who contributed to this
8 * project.
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation; either version 2 of
13 * the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
23 * MA 02111-1307 USA
24 *
25 */
26
27#ifndef _FAT_H_
28#define _FAT_H_
29
wdenk5cf91d62004-04-23 20:32:05 +000030#include <asm/byteorder.h>
31
wdenk71f95112003-06-15 22:40:42 +000032#define CONFIG_SUPPORT_VFAT
Mikhail Zolotaryov38315302010-09-08 17:06:03 +030033/* Maximum Long File Name length supported here is 128 UTF-16 code units */
34#define VFAT_MAXLEN_BYTES 256 /* Maximum LFN buffer in bytes */
35#define VFAT_MAXSEQ 9 /* Up to 9 of 13 2-byte UTF-16 entries */
Sergei Shtylyov025421e2011-08-19 09:37:46 +000036#define PREFETCH_BLOCKS 2
wdenk71f95112003-06-15 22:40:42 +000037
38#define MAX_CLUSTSIZE 65536
Sergei Shtylyovac497772011-08-08 09:38:33 +000039#define DIRENTSPERBLOCK (mydata->sect_size / sizeof(dir_entry))
40#define DIRENTSPERCLUST ((mydata->clust_size * mydata->sect_size) / \
41 sizeof(dir_entry))
wdenk71f95112003-06-15 22:40:42 +000042
43#define FATBUFBLOCKS 6
Sergei Shtylyovac497772011-08-08 09:38:33 +000044#define FATBUFSIZE (mydata->sect_size * FATBUFBLOCKS)
wdenkcd37d9e2004-02-10 00:03:41 +000045#define FAT12BUFSIZE ((FATBUFSIZE*2)/3)
wdenk71f95112003-06-15 22:40:42 +000046#define FAT16BUFSIZE (FATBUFSIZE/2)
47#define FAT32BUFSIZE (FATBUFSIZE/4)
48
49
50/* Filesystem identifiers */
51#define FAT12_SIGN "FAT12 "
52#define FAT16_SIGN "FAT16 "
53#define FAT32_SIGN "FAT32 "
54#define SIGNLEN 8
55
56/* File attributes */
Wolfgang Denk7385c282010-07-19 11:37:00 +020057#define ATTR_RO 1
58#define ATTR_HIDDEN 2
59#define ATTR_SYS 4
60#define ATTR_VOLUME 8
61#define ATTR_DIR 16
62#define ATTR_ARCH 32
wdenk71f95112003-06-15 22:40:42 +000063
Wolfgang Denk7385c282010-07-19 11:37:00 +020064#define ATTR_VFAT (ATTR_RO | ATTR_HIDDEN | ATTR_SYS | ATTR_VOLUME)
wdenk71f95112003-06-15 22:40:42 +000065
66#define DELETED_FLAG ((char)0xe5) /* Marks deleted files when in name[0] */
Remy Bohmer3c2c2f42008-11-27 22:30:27 +010067#define aRING 0x05 /* Used as special character in name[0] */
wdenk71f95112003-06-15 22:40:42 +000068
Wolfgang Denk7385c282010-07-19 11:37:00 +020069/*
70 * Indicates that the entry is the last long entry in a set of long
wdenk2d1a5372004-02-23 19:30:57 +000071 * dir entries
72 */
73#define LAST_LONG_ENTRY_MASK 0x40
wdenk71f95112003-06-15 22:40:42 +000074
75/* Flags telling whether we should read a file or list a directory */
Wolfgang Denk7385c282010-07-19 11:37:00 +020076#define LS_NO 0
77#define LS_YES 1
78#define LS_DIR 1
79#define LS_ROOT 2
wdenk71f95112003-06-15 22:40:42 +000080
Wolfgang Denk7385c282010-07-19 11:37:00 +020081#define ISDIRDELIM(c) ((c) == '/' || (c) == '\\')
wdenk71f95112003-06-15 22:40:42 +000082
83#define FSTYPE_NONE (-1)
84
85#if defined(__linux__) && defined(__KERNEL__)
86#define FAT2CPU16 le16_to_cpu
87#define FAT2CPU32 le32_to_cpu
88#else
wdenk9fd5e312003-12-07 23:55:12 +000089#if __LITTLE_ENDIAN
wdenk71f95112003-06-15 22:40:42 +000090#define FAT2CPU16(x) (x)
91#define FAT2CPU32(x) (x)
92#else
93#define FAT2CPU16(x) ((((x) & 0x00ff) << 8) | (((x) & 0xff00) >> 8))
94#define FAT2CPU32(x) ((((x) & 0x000000ff) << 24) | \
Wolfgang Denk53677ef2008-05-20 16:00:29 +020095 (((x) & 0x0000ff00) << 8) | \
wdenk71f95112003-06-15 22:40:42 +000096 (((x) & 0x00ff0000) >> 8) | \
97 (((x) & 0xff000000) >> 24))
98#endif
99#endif
100
101#define TOLOWER(c) if((c) >= 'A' && (c) <= 'Z'){(c)+=('a' - 'A');}
Donggeun Kimc30a15e2011-10-24 21:15:28 +0000102#define TOUPPER(c) if ((c) >= 'a' && (c) <= 'z') \
103 (c) -= ('a' - 'A');
wdenk71f95112003-06-15 22:40:42 +0000104#define START(dent) (FAT2CPU16((dent)->start) \
105 + (mydata->fatsize != 32 ? 0 : \
106 (FAT2CPU16((dent)->starthi) << 16)))
michael8ce4e5c2008-03-02 23:33:46 +0100107#define CHECK_CLUST(x, fatsize) ((x) <= 1 || \
108 (x) >= ((fatsize) != 32 ? 0xfff0 : 0xffffff0))
wdenk71f95112003-06-15 22:40:42 +0000109
110typedef struct boot_sector {
111 __u8 ignored[3]; /* Bootstrap code */
112 char system_id[8]; /* Name of fs */
113 __u8 sector_size[2]; /* Bytes/sector */
114 __u8 cluster_size; /* Sectors/cluster */
115 __u16 reserved; /* Number of reserved sectors */
116 __u8 fats; /* Number of FATs */
117 __u8 dir_entries[2]; /* Number of root directory entries */
118 __u8 sectors[2]; /* Number of sectors */
119 __u8 media; /* Media code */
120 __u16 fat_length; /* Sectors/FAT */
121 __u16 secs_track; /* Sectors/track */
122 __u16 heads; /* Number of heads */
123 __u32 hidden; /* Number of hidden sectors */
124 __u32 total_sect; /* Number of sectors (if sectors == 0) */
125
126 /* FAT32 only */
127 __u32 fat32_length; /* Sectors/FAT */
128 __u16 flags; /* Bit 8: fat mirroring, low 4: active fat */
129 __u8 version[2]; /* Filesystem version */
130 __u32 root_cluster; /* First cluster in root directory */
131 __u16 info_sector; /* Filesystem info sector */
132 __u16 backup_boot; /* Backup boot sector */
133 __u16 reserved2[6]; /* Unused */
134} boot_sector;
135
136typedef struct volume_info
137{
138 __u8 drive_number; /* BIOS drive number */
139 __u8 reserved; /* Unused */
140 __u8 ext_boot_sign; /* 0x29 if fields below exist (DOS 3.3+) */
141 __u8 volume_id[4]; /* Volume ID number */
142 char volume_label[11]; /* Volume label */
143 char fs_type[8]; /* Typically FAT12, FAT16, or FAT32 */
144 /* Boot code comes next, all but 2 bytes to fill up sector */
145 /* Boot sign comes last, 2 bytes */
146} volume_info;
147
148typedef struct dir_entry {
149 char name[8],ext[3]; /* Name and extension */
150 __u8 attr; /* Attribute bits */
151 __u8 lcase; /* Case for base and extension */
152 __u8 ctime_ms; /* Creation time, milliseconds */
153 __u16 ctime; /* Creation time */
154 __u16 cdate; /* Creation date */
155 __u16 adate; /* Last access date */
156 __u16 starthi; /* High 16 bits of cluster in FAT32 */
157 __u16 time,date,start;/* Time, date and first cluster */
158 __u32 size; /* File size in bytes */
159} dir_entry;
160
161typedef struct dir_slot {
Wolfgang Denk7385c282010-07-19 11:37:00 +0200162 __u8 id; /* Sequence number for slot */
163 __u8 name0_4[10]; /* First 5 characters in name */
164 __u8 attr; /* Attribute byte */
165 __u8 reserved; /* Unused */
166 __u8 alias_checksum;/* Checksum for 8.3 alias */
167 __u8 name5_10[12]; /* 6 more characters in name */
168 __u16 start; /* Unused */
169 __u8 name11_12[4]; /* Last 2 characters in name */
wdenk71f95112003-06-15 22:40:42 +0000170} dir_slot;
171
Wolfgang Denk7385c282010-07-19 11:37:00 +0200172/*
173 * Private filesystem parameters
Wolfgang Denk80f0c0f2006-08-14 22:05:26 +0200174 *
175 * Note: FAT buffer has to be 32 bit aligned
176 * (see FAT32 accesses)
177 */
wdenk71f95112003-06-15 22:40:42 +0000178typedef struct {
Sergei Shtylyovac497772011-08-08 09:38:33 +0000179 __u8 *fatbuf; /* Current FAT buffer */
wdenk71f95112003-06-15 22:40:42 +0000180 int fatsize; /* Size of FAT in bits */
Aaron Williams1d90c3b2012-05-19 07:20:40 +0000181 __u32 fatlength; /* Length of FAT in sectors */
wdenk71f95112003-06-15 22:40:42 +0000182 __u16 fat_sect; /* Starting sector of the FAT */
Aaron Williams1d90c3b2012-05-19 07:20:40 +0000183 __u32 rootdir_sect; /* Start sector of root directory */
Sergei Shtylyovac497772011-08-08 09:38:33 +0000184 __u16 sect_size; /* Size of sectors in bytes */
wdenk71f95112003-06-15 22:40:42 +0000185 __u16 clust_size; /* Size of clusters in sectors */
Aaron Williams1d90c3b2012-05-19 07:20:40 +0000186 int data_begin; /* The sector of the first cluster, can be negative */
wdenk71f95112003-06-15 22:40:42 +0000187 int fatbufnum; /* Used by get_fatent, init to -1 */
188} fsdata;
189
190typedef int (file_detectfs_func)(void);
191typedef int (file_ls_func)(const char *dir);
192typedef long (file_read_func)(const char *filename, void *buffer,
193 unsigned long maxsize);
194
195struct filesystem {
Wolfgang Denk7385c282010-07-19 11:37:00 +0200196 file_detectfs_func *detect;
197 file_ls_func *ls;
198 file_read_func *read;
199 const char name[12];
wdenk71f95112003-06-15 22:40:42 +0000200};
201
202/* FAT tables */
203file_detectfs_func file_fat_detectfs;
204file_ls_func file_fat_ls;
205file_read_func file_fat_read;
206
207/* Currently this doesn't check if the dir exists or is valid... */
208int file_cd(const char *path);
209int file_fat_detectfs(void);
210int file_fat_ls(const char *dir);
Benoît Thébaudeau1170e632012-09-18 08:14:56 +0000211long file_fat_read_at(const char *filename, unsigned long pos, void *buffer,
212 unsigned long maxsize);
wdenk71f95112003-06-15 22:40:42 +0000213long file_fat_read(const char *filename, void *buffer, unsigned long maxsize);
214const char *file_getfsname(int idx);
wdenk7205e402003-09-10 22:30:53 +0000215int fat_register_device(block_dev_desc_t *dev_desc, int part_no);
wdenk71f95112003-06-15 22:40:42 +0000216
Donggeun Kimc30a15e2011-10-24 21:15:28 +0000217int file_fat_write(const char *filename, void *buffer, unsigned long maxsize);
wdenk71f95112003-06-15 22:40:42 +0000218#endif /* _FAT_H_ */