[thirdparty/u-boot.git] / include / fat.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * 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
 */

#ifndef _FAT_H_
#define _FAT_H_

#include <asm/byteorder.h>
#include <fs.h>

/* 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

#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

#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;

/* see dir_entry::lcase: */
#define CASE_LOWER_BASE	8	/* base (name) is lower case */
#define CASE_LOWER_EXT	16	/* extension is lower case */

typedef struct dir_entry {
	char	name[8],ext[3];	/* Name and extension */
	__u8	attr;		/* Attribute bits */
	__u8	lcase;		/* Case for name and ext (CASE_LOWER_x) */
	__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 */
	int	rootdir_size;	/* Size of root dir for non-FAT32 */
	__u32	root_cluster;	/* First cluster of root dir for FAT32 */
	u32	total_sect;	/* Number of sectors */
	int	fats;		/* Number of FATs */
} fsdata;

static inline u32 clust_to_sect(fsdata *fsdata, u32 clust)
{
	return fsdata->data_begin + clust * fsdata->clust_size;
}

static inline u32 sect_to_clust(fsdata *fsdata, int sect)
{
	return (sect - fsdata->data_begin) / fsdata->clust_size;
}

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