[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 - [email protected] - ported to ppcboot v1.1.6
 * 2003-03-10 - [email protected] - ported to u-boot
 */

#ifndef _FAT_H_
#define _FAT_H_

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

struct disk_partition;

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

struct nameext {
	char name[8];
	char ext[3];
};

typedef struct dir_entry {
	struct nameext nameext;	/* 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;

struct fat_itr;
typedef struct fat_itr fat_itr;

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, struct disk_partition *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);
void *fat_next_cluster(fat_itr *itr, unsigned int *nbytes);

/**
 * fat_uuid() - get FAT volume ID
 *
 * The FAT volume ID returned in @uuid_str as hexadecimal number in XXXX-XXXX
 * format.
 *
 * @uuid_str:	caller allocated buffer of at least 10 bytes for the volume ID
 * Return:	0 on success
 */
int fat_uuid(char *uuid_str);

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