[people/ms/u-boot.git] / include / fat.h

/*
 * R/O (V)FAT 12/16/32 filesystem implementation by Marcus Sundberg
 *
 * 2002-07-28 - rjones@nexus-tech.net - ported to ppcboot v1.1.6
 * 2003-03-10 - kharris@nexus-tech.net - ported to u-boot
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#ifndef _FAT_H_
#define _FAT_H_

#include <asm/byteorder.h>

#define CONFIG_SUPPORT_VFAT
/* Maximum Long File Name length supported here is 128 UTF-16 code units */
#define VFAT_MAXLEN_BYTES	256 /* Maximum LFN buffer in bytes */
#define VFAT_MAXSEQ		9   /* Up to 9 of 13 2-byte UTF-16 entries */
#define PREFETCH_BLOCKS		2

#ifndef CONFIG_FS_FAT_MAX_CLUSTSIZE
#define CONFIG_FS_FAT_MAX_CLUSTSIZE 65536
#endif
#define MAX_CLUSTSIZE	CONFIG_FS_FAT_MAX_CLUSTSIZE

#define DIRENTSPERBLOCK	(mydata->sect_size / sizeof(dir_entry))
#define DIRENTSPERCLUST	((mydata->clust_size * mydata->sect_size) / \
			 sizeof(dir_entry))

#define FATBUFBLOCKS	6
#define FATBUFSIZE	(mydata->sect_size * FATBUFBLOCKS)
#define FAT12BUFSIZE	((FATBUFSIZE*2)/3)
#define FAT16BUFSIZE	(FATBUFSIZE/2)
#define FAT32BUFSIZE	(FATBUFSIZE/4)

/* Maximum number of entry for long file name according to spec */
#define MAX_LFN_SLOT	20

/* Filesystem identifiers */
#define FAT12_SIGN	"FAT12   "
#define FAT16_SIGN	"FAT16   "
#define FAT32_SIGN	"FAT32   "
#define SIGNLEN		8

/* File attributes */
#define ATTR_RO	1
#define ATTR_HIDDEN	2
#define ATTR_SYS	4
#define ATTR_VOLUME	8
#define ATTR_DIR	16
#define ATTR_ARCH	32

#define ATTR_VFAT	(ATTR_RO | ATTR_HIDDEN | ATTR_SYS | ATTR_VOLUME)

#define DELETED_FLAG	((char)0xe5) /* Marks deleted files when in name[0] */
#define aRING		0x05	     /* Used as special character in name[0] */

/*
 * Indicates that the entry is the last long entry in a set of long
 * dir entries
 */
#define LAST_LONG_ENTRY_MASK	0x40

/* Flags telling whether we should read a file or list a directory */
#define LS_NO		0
#define LS_YES		1
#define LS_DIR		1
#define LS_ROOT		2

#define ISDIRDELIM(c)	((c) == '/' || (c) == '\\')

#define FSTYPE_NONE	(-1)

#if defined(__linux__) && defined(__KERNEL__)
#define FAT2CPU16	le16_to_cpu
#define FAT2CPU32	le32_to_cpu
#else
#if __LITTLE_ENDIAN
#define FAT2CPU16(x)	(x)
#define FAT2CPU32(x)	(x)
#else
#define FAT2CPU16(x)	((((x) & 0x00ff) << 8) | (((x) & 0xff00) >> 8))
#define FAT2CPU32(x)	((((x) & 0x000000ff) << 24)  |	\
			 (((x) & 0x0000ff00) << 8)  |	\
			 (((x) & 0x00ff0000) >> 8)  |	\
			 (((x) & 0xff000000) >> 24))
#endif
#endif

#define START(dent)	(FAT2CPU16((dent)->start) \
			+ (mydata->fatsize != 32 ? 0 : \
			  (FAT2CPU16((dent)->starthi) << 16)))
#define IS_LAST_CLUST(x, fatsize) ((x) >= ((fatsize) != 32 ? \
					((fatsize) != 16 ? 0xff8 : 0xfff8) : \
					0xffffff8))
#define CHECK_CLUST(x, fatsize) ((x) <= 1 || \
				(x) >= ((fatsize) != 32 ? \
					((fatsize) != 16 ? 0xff0 : 0xfff0) : \
					0xffffff0))

typedef struct boot_sector {
	__u8	ignored[3];	/* Bootstrap code */
	char	system_id[8];	/* Name of fs */
	__u8	sector_size[2];	/* Bytes/sector */
	__u8	cluster_size;	/* Sectors/cluster */
	__u16	reserved;	/* Number of reserved sectors */
	__u8	fats;		/* Number of FATs */
	__u8	dir_entries[2];	/* Number of root directory entries */
	__u8	sectors[2];	/* Number of sectors */
	__u8	media;		/* Media code */
	__u16	fat_length;	/* Sectors/FAT */
	__u16	secs_track;	/* Sectors/track */
	__u16	heads;		/* Number of heads */
	__u32	hidden;		/* Number of hidden sectors */
	__u32	total_sect;	/* Number of sectors (if sectors == 0) */

	/* FAT32 only */
	__u32	fat32_length;	/* Sectors/FAT */
	__u16	flags;		/* Bit 8: fat mirroring, low 4: active fat */
	__u8	version[2];	/* Filesystem version */
	__u32	root_cluster;	/* First cluster in root directory */
	__u16	info_sector;	/* Filesystem info sector */
	__u16	backup_boot;	/* Backup boot sector */
	__u16	reserved2[6];	/* Unused */
} boot_sector;

typedef struct volume_info
{
	__u8 drive_number;	/* BIOS drive number */
	__u8 reserved;		/* Unused */
	__u8 ext_boot_sign;	/* 0x29 if fields below exist (DOS 3.3+) */
	__u8 volume_id[4];	/* Volume ID number */
	char volume_label[11];	/* Volume label */
	char fs_type[8];	/* Typically FAT12, FAT16, or FAT32 */
	/* Boot code comes next, all but 2 bytes to fill up sector */
	/* Boot sign comes last, 2 bytes */
} volume_info;

typedef struct dir_entry {
	char	name[8],ext[3];	/* Name and extension */
	__u8	attr;		/* Attribute bits */
	__u8	lcase;		/* Case for base and extension */
	__u8	ctime_ms;	/* Creation time, milliseconds */
	__u16	ctime;		/* Creation time */
	__u16	cdate;		/* Creation date */
	__u16	adate;		/* Last access date */
	__u16	starthi;	/* High 16 bits of cluster in FAT32 */
	__u16	time,date,start;/* Time, date and first cluster */
	__u32	size;		/* File size in bytes */
} dir_entry;

typedef struct dir_slot {
	__u8	id;		/* Sequence number for slot */
	__u8	name0_4[10];	/* First 5 characters in name */
	__u8	attr;		/* Attribute byte */
	__u8	reserved;	/* Unused */
	__u8	alias_checksum;/* Checksum for 8.3 alias */
	__u8	name5_10[12];	/* 6 more characters in name */
	__u16	start;		/* Unused */
	__u8	name11_12[4];	/* Last 2 characters in name */
} dir_slot;

/*
 * Private filesystem parameters
 *
 * Note: FAT buffer has to be 32 bit aligned
 * (see FAT32 accesses)
 */
typedef struct {
	__u8	*fatbuf;	/* Current FAT buffer */
	int	fatsize;	/* Size of FAT in bits */
	__u32	fatlength;	/* Length of FAT in sectors */
	__u16	fat_sect;	/* Starting sector of the FAT */
	__u8	fat_dirty;      /* Set if fatbuf has been modified */
	__u32	rootdir_sect;	/* Start sector of root directory */
	__u16	sect_size;	/* Size of sectors in bytes */
	__u16	clust_size;	/* Size of clusters in sectors */
	int	data_begin;	/* The sector of the first cluster, can be negative */
	int	fatbufnum;	/* Used by get_fatent, init to -1 */
} fsdata;

typedef int	(file_detectfs_func)(void);
typedef int	(file_ls_func)(const char *dir);
typedef int	(file_read_func)(const char *filename, void *buffer,
				 int maxsize);

struct filesystem {
	file_detectfs_func	*detect;
	file_ls_func		*ls;
	file_read_func		*read;
	const char		name[12];
};

/* FAT tables */
file_detectfs_func	file_fat_detectfs;
file_ls_func		file_fat_ls;
file_read_func		file_fat_read;

/* Currently this doesn't check if the dir exists or is valid... */
int file_cd(const char *path);
int file_fat_detectfs(void);
int file_fat_ls(const char *dir);
int fat_exists(const char *filename);
int fat_size(const char *filename, loff_t *size);
int file_fat_read_at(const char *filename, loff_t pos, void *buffer,
		     loff_t maxsize, loff_t *actread);
int file_fat_read(const char *filename, void *buffer, int maxsize);
const char *file_getfsname(int idx);
int fat_set_blk_dev(struct blk_desc *rbdd, disk_partition_t *info);
int fat_register_device(struct blk_desc *dev_desc, int part_no);

int file_fat_write(const char *filename, void *buf, loff_t offset, loff_t len,
		   loff_t *actwrite);
int fat_read_file(const char *filename, void *buf, loff_t offset, loff_t len,
		  loff_t *actread);
void fat_close(void);
#endif /* _FAT_H_ */
Commit	Line	Data
71f95118 WD	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	*
1a459660	7	* SPDX-License-Identifier: GPL-2.0+
71f95118 WD	8	*/
	9
	10	#ifndef _FAT_H_
	11	#define _FAT_H_
	12
5cf91d6b WD	13	#include <asm/byteorder.h>
5cf91d6b WD	14
71f95118	15	#define CONFIG_SUPPORT_VFAT
3831530d MZ	16	/* 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 */
025421ea	19	#define PREFETCH_BLOCKS 2
71f95118	20
4f0d1a2a SDPP	21	#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
ac497771 SS	26	#define DIRENTSPERBLOCK (mydata->sect_size / sizeof(dir_entry))
	27	#define DIRENTSPERCLUST ((mydata->clust_size * mydata->sect_size) / \
	28	sizeof(dir_entry))
71f95118 WD	29
71f95118 WD	30	#define FATBUFBLOCKS 6
ac497771	31	#define FATBUFSIZE (mydata->sect_size * FATBUFBLOCKS)
cd37d9e6	32	#define FAT12BUFSIZE ((FATBUFSIZE*2)/3)
71f95118 WD	33	#define FAT16BUFSIZE (FATBUFSIZE/2)
	34	#define FAT32BUFSIZE (FATBUFSIZE/4)
	35
7aa1a6b7 TFC	36	/* Maximum number of entry for long file name according to spec */
7aa1a6b7 TFC	37	#define MAX_LFN_SLOT 20
71f95118 WD	38
	39	/* Filesystem identifiers */
	40	#define FAT12_SIGN "FAT12 "
	41	#define FAT16_SIGN "FAT16 "
	42	#define FAT32_SIGN "FAT32 "
	43	#define SIGNLEN 8
	44
	45	/* File attributes */
7385c28e WD	46	#define ATTR_RO 1
	47	#define ATTR_HIDDEN 2
	48	#define ATTR_SYS 4
	49	#define ATTR_VOLUME 8
	50	#define ATTR_DIR 16
	51	#define ATTR_ARCH 32
71f95118	52
7385c28e	53	#define ATTR_VFAT (ATTR_RO \| ATTR_HIDDEN \| ATTR_SYS \| ATTR_VOLUME)
71f95118 WD	54
71f95118 WD	55	#define DELETED_FLAG ((char)0xe5) /* Marks deleted files when in name[0] */
3c2c2f42	56	#define aRING 0x05 /* Used as special character in name[0] */
71f95118	57
7385c28e WD	58	/*
7385c28e WD	59	* Indicates that the entry is the last long entry in a set of long
2d1a537d WD	60	* dir entries
	61	*/
	62	#define LAST_LONG_ENTRY_MASK 0x40
71f95118 WD	63
71f95118 WD	64	/* Flags telling whether we should read a file or list a directory */
7385c28e WD	65	#define LS_NO 0
	66	#define LS_YES 1
	67	#define LS_DIR 1
	68	#define LS_ROOT 2
71f95118	69
7385c28e	70	#define ISDIRDELIM(c) ((c) == '/' \|\| (c) == '\\')
71f95118 WD	71
	72	#define FSTYPE_NONE (-1)
	73
	74	#if defined(__linux__) && defined(__KERNEL__)
	75	#define FAT2CPU16 le16_to_cpu
	76	#define FAT2CPU32 le32_to_cpu
	77	#else
9fd5e31f	78	#if __LITTLE_ENDIAN
71f95118 WD	79	#define FAT2CPU16(x) (x)
	80	#define FAT2CPU32(x) (x)
	81	#else
	82	#define FAT2CPU16(x) ((((x) & 0x00ff) << 8) \| (((x) & 0xff00) >> 8))
	83	#define FAT2CPU32(x) ((((x) & 0x000000ff) << 24) \| \
53677ef1	84	(((x) & 0x0000ff00) << 8) \| \
71f95118 WD	85	(((x) & 0x00ff0000) >> 8) \| \
	86	(((x) & 0xff000000) >> 24))
	87	#endif
	88	#endif
	89
71f95118 WD	90	#define START(dent) (FAT2CPU16((dent)->start) \
	91	+ (mydata->fatsize != 32 ? 0 : \
	92	(FAT2CPU16((dent)->starthi) << 16)))
2e98f708 WJ	93	#define IS_LAST_CLUST(x, fatsize) ((x) >= ((fatsize) != 32 ? \
	94	((fatsize) != 16 ? 0xff8 : 0xfff8) : \
	95	0xffffff8))
8ce4e5c2	96	#define CHECK_CLUST(x, fatsize) ((x) <= 1 \|\| \
06118973 WJ	97	(x) >= ((fatsize) != 32 ? \
	98	((fatsize) != 16 ? 0xff0 : 0xfff0) : \
	99	0xffffff0))
71f95118 WD	100
	101	typedef struct boot_sector {
	102	__u8 ignored[3]; /* Bootstrap code */
	103	char system_id[8]; /* Name of fs */
	104	__u8 sector_size[2]; /* Bytes/sector */
	105	__u8 cluster_size; /* Sectors/cluster */
	106	__u16 reserved; /* Number of reserved sectors */
	107	__u8 fats; /* Number of FATs */
	108	__u8 dir_entries[2]; /* Number of root directory entries */
	109	__u8 sectors[2]; /* Number of sectors */
	110	__u8 media; /* Media code */
	111	__u16 fat_length; /* Sectors/FAT */
	112	__u16 secs_track; /* Sectors/track */
	113	__u16 heads; /* Number of heads */
	114	__u32 hidden; /* Number of hidden sectors */
	115	__u32 total_sect; /* Number of sectors (if sectors == 0) */
	116
	117	/* FAT32 only */
	118	__u32 fat32_length; /* Sectors/FAT */
	119	__u16 flags; /* Bit 8: fat mirroring, low 4: active fat */
	120	__u8 version[2]; /* Filesystem version */
	121	__u32 root_cluster; /* First cluster in root directory */
	122	__u16 info_sector; /* Filesystem info sector */
	123	__u16 backup_boot; /* Backup boot sector */
	124	__u16 reserved2[6]; /* Unused */
	125	} boot_sector;
	126
	127	typedef struct volume_info
	128	{
	129	__u8 drive_number; /* BIOS drive number */
	130	__u8 reserved; /* Unused */
	131	__u8 ext_boot_sign; /* 0x29 if fields below exist (DOS 3.3+) */
	132	__u8 volume_id[4]; /* Volume ID number */
	133	char volume_label[11]; /* Volume label */
	134	char fs_type[8]; /* Typically FAT12, FAT16, or FAT32 */
	135	/* Boot code comes next, all but 2 bytes to fill up sector */
	136	/* Boot sign comes last, 2 bytes */
	137	} volume_info;
	138
	139	typedef struct dir_entry {
	140	char name[8],ext[3]; /* Name and extension */
	141	__u8 attr; /* Attribute bits */
	142	__u8 lcase; /* Case for base and extension */
	143	__u8 ctime_ms; /* Creation time, milliseconds */
	144	__u16 ctime; /* Creation time */
	145	__u16 cdate; /* Creation date */
	146	__u16 adate; /* Last access date */
	147	__u16 starthi; /* High 16 bits of cluster in FAT32 */
	148	__u16 time,date,start;/* Time, date and first cluster */
	149	__u32 size; /* File size in bytes */
	150	} dir_entry;
	151
	152	typedef struct dir_slot {
7385c28e WD	153	__u8 id; /* Sequence number for slot */
	154	__u8 name0_4[10]; /* First 5 characters in name */
	155	__u8 attr; /* Attribute byte */
	156	__u8 reserved; /* Unused */
	157	__u8 alias_checksum;/* Checksum for 8.3 alias */
	158	__u8 name5_10[12]; /* 6 more characters in name */
	159	__u16 start; /* Unused */
	160	__u8 name11_12[4]; /* Last 2 characters in name */
71f95118 WD	161	} dir_slot;
71f95118 WD	162
7385c28e WD	163	/*
7385c28e WD	164	* Private filesystem parameters
80f0c0f5 WD	165	*
	166	* Note: FAT buffer has to be 32 bit aligned
	167	* (see FAT32 accesses)
	168	*/
71f95118	169	typedef struct {
ac497771	170	__u8 fatbuf; / Current FAT buffer */
71f95118	171	int fatsize; /* Size of FAT in bits */
1d90c3b4	172	__u32 fatlength; /* Length of FAT in sectors */
71f95118	173	__u16 fat_sect; /* Starting sector of the FAT */
3c0ed9c3	174	__u8 fat_dirty; /* Set if fatbuf has been modified */
1d90c3b4	175	__u32 rootdir_sect; /* Start sector of root directory */
ac497771	176	__u16 sect_size; /* Size of sectors in bytes */
71f95118	177	__u16 clust_size; /* Size of clusters in sectors */
1d90c3b4	178	int data_begin; /* The sector of the first cluster, can be negative */
71f95118 WD	179	int fatbufnum; /* Used by get_fatent, init to -1 */
	180	} fsdata;
	181
	182	typedef int (file_detectfs_func)(void);
	183	typedef int (file_ls_func)(const char *dir);
1ad0b98a SR	184	typedef int (file_read_func)(const char filename, void buffer,
1ad0b98a SR	185	int maxsize);
71f95118 WD	186
71f95118 WD	187	struct filesystem {
7385c28e WD	188	file_detectfs_func *detect;
	189	file_ls_func *ls;
	190	file_read_func *read;
	191	const char name[12];
71f95118 WD	192	};
	193
	194	/* FAT tables */
	195	file_detectfs_func file_fat_detectfs;
	196	file_ls_func file_fat_ls;
	197	file_read_func file_fat_read;
	198
	199	/* Currently this doesn't check if the dir exists or is valid... */
	200	int file_cd(const char *path);
	201	int file_fat_detectfs(void);
	202	int file_fat_ls(const char *dir);
b7b5f319	203	int fat_exists(const char *filename);
d455d878	204	int fat_size(const char filename, loff_t size);
1ad0b98a SR	205	int file_fat_read_at(const char filename, loff_t pos, void buffer,
	206	loff_t maxsize, loff_t *actread);
	207	int file_fat_read(const char filename, void buffer, int maxsize);
71f95118	208	const char *file_getfsname(int idx);
4101f687 SG	209	int fat_set_blk_dev(struct blk_desc rbdd, disk_partition_t info);
4101f687 SG	210	int fat_register_device(struct blk_desc *dev_desc, int part_no);
71f95118	211
1ad0b98a SR	212	int file_fat_write(const char filename, void buf, loff_t offset, loff_t len,
1ad0b98a SR	213	loff_t *actwrite);
d455d878 SR	214	int fat_read_file(const char filename, void buf, loff_t offset, loff_t len,
d455d878 SR	215	loff_t *actread);
e6d52415	216	void fat_close(void);
71f95118	217	#endif /* _FAT_H_ */