xref: /openbmc/u-boot/include/fat.h (revision 518e2e1a)
1 /*
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 
30 #define CONFIG_SUPPORT_VFAT
31 
32 #define SECTOR_SIZE FS_BLOCK_SIZE
33 
34 #define FS_BLOCK_SIZE 512
35 
36 #if FS_BLOCK_SIZE != SECTOR_SIZE
37 #error FS_BLOCK_SIZE != SECTOR_SIZE - This code needs to be fixed!
38 #endif
39 
40 #define MAX_CLUSTSIZE	65536
41 #define DIRENTSPERBLOCK	(FS_BLOCK_SIZE/sizeof(dir_entry))
42 #define DIRENTSPERCLUST	((mydata->clust_size*SECTOR_SIZE)/sizeof(dir_entry))
43 
44 #define FATBUFBLOCKS	6
45 #define FATBUFSIZE	(FS_BLOCK_SIZE*FATBUFBLOCKS)
46 #define FAT12BUFSIZE	((FATBUFSIZE*2)/3)
47 #define FAT16BUFSIZE	(FATBUFSIZE/2)
48 #define FAT32BUFSIZE	(FATBUFSIZE/4)
49 
50 
51 /* Filesystem identifiers */
52 #define FAT12_SIGN	"FAT12   "
53 #define FAT16_SIGN	"FAT16   "
54 #define FAT32_SIGN	"FAT32   "
55 #define SIGNLEN		8
56 
57 /* File attributes */
58 #define ATTR_RO      1
59 #define ATTR_HIDDEN  2
60 #define ATTR_SYS     4
61 #define ATTR_VOLUME  8
62 #define ATTR_DIR     16
63 #define ATTR_ARCH    32
64 
65 #define ATTR_VFAT     (ATTR_RO | ATTR_HIDDEN | ATTR_SYS | ATTR_VOLUME)
66 
67 #define DELETED_FLAG	((char)0xe5) /* Marks deleted files when in name[0] */
68 #define aRING		0x05	     /* Used to represent '�' in name[0] */
69 
70 /* Indicates that the entry is the last long entry in a set of long
71  * dir entries
72  */
73 #define LAST_LONG_ENTRY_MASK	0x40
74 
75 /* Flags telling whether we should read a file or list a directory */
76 #define LS_NO	0
77 #define LS_YES	1
78 #define LS_DIR	1
79 #define LS_ROOT	2
80 
81 #ifdef DEBUG
82 #define FAT_DPRINT(args...)	printf(args)
83 #else
84 #define FAT_DPRINT(args...)
85 #endif
86 #define FAT_ERROR(arg)		printf(arg)
87 
88 #define ISDIRDELIM(c)   ((c) == '/' || (c) == '\\')
89 
90 #define FSTYPE_NONE	(-1)
91 
92 #if defined(__linux__) && defined(__KERNEL__)
93 #define FAT2CPU16	le16_to_cpu
94 #define FAT2CPU32	le32_to_cpu
95 #else
96 #if __LITTLE_ENDIAN
97 #define FAT2CPU16(x)	(x)
98 #define FAT2CPU32(x)	(x)
99 #else
100 #define FAT2CPU16(x)	((((x) & 0x00ff) << 8) | (((x) & 0xff00) >> 8))
101 #define FAT2CPU32(x)	((((x) & 0x000000ff) << 24)  |	\
102 	 		 (((x) & 0x0000ff00) << 8)  |	\
103 			 (((x) & 0x00ff0000) >> 8)  |	\
104 			 (((x) & 0xff000000) >> 24))
105 #endif
106 #endif
107 
108 #define TOLOWER(c)	if((c) >= 'A' && (c) <= 'Z'){(c)+=('a' - 'A');}
109 #define START(dent)	(FAT2CPU16((dent)->start) \
110 			+ (mydata->fatsize != 32 ? 0 : \
111 			  (FAT2CPU16((dent)->starthi) << 16)))
112 
113 
114 typedef struct boot_sector {
115 	__u8	ignored[3];	/* Bootstrap code */
116 	char	system_id[8];	/* Name of fs */
117 	__u8	sector_size[2];	/* Bytes/sector */
118 	__u8	cluster_size;	/* Sectors/cluster */
119 	__u16	reserved;	/* Number of reserved sectors */
120 	__u8	fats;		/* Number of FATs */
121 	__u8	dir_entries[2];	/* Number of root directory entries */
122 	__u8	sectors[2];	/* Number of sectors */
123 	__u8	media;		/* Media code */
124 	__u16	fat_length;	/* Sectors/FAT */
125 	__u16	secs_track;	/* Sectors/track */
126 	__u16	heads;		/* Number of heads */
127 	__u32	hidden;		/* Number of hidden sectors */
128 	__u32	total_sect;	/* Number of sectors (if sectors == 0) */
129 
130 	/* FAT32 only */
131 	__u32	fat32_length;	/* Sectors/FAT */
132 	__u16	flags;		/* Bit 8: fat mirroring, low 4: active fat */
133 	__u8	version[2];	/* Filesystem version */
134 	__u32	root_cluster;	/* First cluster in root directory */
135 	__u16	info_sector;	/* Filesystem info sector */
136 	__u16	backup_boot;	/* Backup boot sector */
137 	__u16	reserved2[6];	/* Unused */
138 } boot_sector;
139 
140 typedef struct volume_info
141 {
142 	__u8 drive_number;	/* BIOS drive number */
143 	__u8 reserved;		/* Unused */
144 	__u8 ext_boot_sign;	/* 0x29 if fields below exist (DOS 3.3+) */
145 	__u8 volume_id[4];	/* Volume ID number */
146 	char volume_label[11];	/* Volume label */
147 	char fs_type[8];	/* Typically FAT12, FAT16, or FAT32 */
148 	/* Boot code comes next, all but 2 bytes to fill up sector */
149 	/* Boot sign comes last, 2 bytes */
150 } volume_info;
151 
152 typedef struct dir_entry {
153 	char	name[8],ext[3];	/* Name and extension */
154 	__u8	attr;		/* Attribute bits */
155 	__u8	lcase;		/* Case for base and extension */
156 	__u8	ctime_ms;	/* Creation time, milliseconds */
157 	__u16	ctime;		/* Creation time */
158 	__u16	cdate;		/* Creation date */
159 	__u16	adate;		/* Last access date */
160 	__u16	starthi;	/* High 16 bits of cluster in FAT32 */
161 	__u16	time,date,start;/* Time, date and first cluster */
162 	__u32	size;		/* File size in bytes */
163 } dir_entry;
164 
165 typedef struct dir_slot {
166 	__u8    id;		/* Sequence number for slot */
167 	__u8    name0_4[10];	/* First 5 characters in name */
168 	__u8    attr;		/* Attribute byte */
169 	__u8    reserved;	/* Unused */
170 	__u8    alias_checksum;/* Checksum for 8.3 alias */
171 	__u8    name5_10[12];	/* 6 more characters in name */
172 	__u16   start;		/* Unused */
173 	__u8    name11_12[4];	/* Last 2 characters in name */
174 } dir_slot;
175 
176 /* Private filesystem parameters */
177 typedef struct {
178 	int	fatsize;	/* Size of FAT in bits */
179 	__u16	fatlength;	/* Length of FAT in sectors */
180 	__u16	fat_sect;	/* Starting sector of the FAT */
181 	__u16	rootdir_sect;	/* Start sector of root directory */
182 	__u16	clust_size;	/* Size of clusters in sectors */
183 	short	data_begin;	/* The sector of the first cluster, can be negative */
184 	__u8	fatbuf[FATBUFSIZE]; /* Current FAT buffer */
185 	int	fatbufnum;	/* Used by get_fatent, init to -1 */
186 } fsdata;
187 
188 typedef int	(file_detectfs_func)(void);
189 typedef int	(file_ls_func)(const char *dir);
190 typedef long	(file_read_func)(const char *filename, void *buffer,
191 				 unsigned long maxsize);
192 
193 struct filesystem {
194 	file_detectfs_func *detect;
195 	file_ls_func	   *ls;
196 	file_read_func	   *read;
197 	const char	    name[12];
198 };
199 
200 /* FAT tables */
201 file_detectfs_func	file_fat_detectfs;
202 file_ls_func		file_fat_ls;
203 file_read_func		file_fat_read;
204 
205 /* Currently this doesn't check if the dir exists or is valid... */
206 int file_cd(const char *path);
207 int file_fat_detectfs(void);
208 int file_fat_ls(const char *dir);
209 long file_fat_read(const char *filename, void *buffer, unsigned long maxsize);
210 const char *file_getfsname(int idx);
211 int fat_register_device(block_dev_desc_t *dev_desc, int part_no);
212 
213 #endif /* _FAT_H_ */
214