[J-u-boot.git] / include / ext_common.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * (C) Copyright 2011 - 2012 Samsung Electronics
 * EXT4 filesystem implementation in Uboot by
 * Uma Shankar <[email protected]>
 * Manjunatha C Achar <[email protected]>
 *
 * Data structures and headers for ext4 support have been taken from
 * ext2 ls load support in Uboot
 *
 * (C) Copyright 2004
 * esd gmbh <www.esd-electronics.com>
 * Reinhard Arlt <[email protected]>
 *
 * based on code from grub2 fs/ext2.c and fs/fshelp.c by
 * GRUB  --  GRand Unified Bootloader
 * Copyright (C) 2003, 2004  Free Software Foundation, Inc.
 */

#ifndef __EXT_COMMON__
#define __EXT_COMMON__

#include <compiler.h>

struct cmd_tbl;

#define SECTOR_SIZE		0x200
#define LOG2_SECTOR_SIZE	9

/* Magic value used to identify an ext2 filesystem.  */
#define	EXT2_MAGIC			0xEF53
/* Amount of indirect blocks in an inode.  */
#define INDIRECT_BLOCKS			12
/* Maximum lenght of a pathname.  */
#define EXT2_PATH_MAX				4096
/* Maximum nesting of symlinks, used to prevent a loop.  */
#define	EXT2_MAX_SYMLINKCNT		8
/* Maximum file name length */
#define EXT2_NAME_LEN 255

/*
 * Revision levels
 */
#define EXT2_GOOD_OLD_REV	0	/* The good old (original) format */
#define EXT2_DYNAMIC_REV	1	/* V2 format w/ dynamic inode sizes */

#define EXT2_GOOD_OLD_INODE_SIZE 128

/* Filetype used in directory entry.  */
#define	FILETYPE_UNKNOWN		0
#define	FILETYPE_REG			1
#define	FILETYPE_DIRECTORY		2
#define	FILETYPE_SYMLINK		7

/* Filetype information as used in inodes.  */
#define FILETYPE_INO_MASK		0170000
#define FILETYPE_INO_REG		0100000
#define FILETYPE_INO_DIRECTORY		0040000
#define FILETYPE_INO_SYMLINK		0120000
#define EXT2_ROOT_INO			2 /* Root inode */
#define EXT2_BOOT_LOADER_INO		5 /* Boot loader inode */

/* First non-reserved inode for old ext2 filesystems */
#define EXT2_GOOD_OLD_FIRST_INO	11

/* The size of an ext2 block in bytes.  */
#define EXT2_BLOCK_SIZE(data)	   (1 << LOG2_BLOCK_SIZE(data))

/* Log2 size of ext2 block in bytes.  */
#define LOG2_BLOCK_SIZE(data)	   (le32_to_cpu		   \
				    (data->sblock.log2_block_size) \
				    + EXT2_MIN_BLOCK_LOG_SIZE)

#define EXT2_FT_DIR	2
#define SUCCESS	1

/* Macro-instructions used to manage several block sizes  */
#define EXT2_MIN_BLOCK_LOG_SIZE	10 /* 1024 */
#define EXT2_MAX_BLOCK_LOG_SIZE	16 /* 65536 */
#define EXT2_MIN_BLOCK_SIZE		(1 << EXT2_MIN_BLOCK_LOG_SIZE)
#define EXT2_MAX_BLOCK_SIZE		(1 << EXT2_MAX_BLOCK_LOG_SIZE)

/* The ext2 superblock.  */
struct ext2_sblock {
	__le32 total_inodes;
	__le32 total_blocks;
	__le32 reserved_blocks;
	__le32 free_blocks;
	__le32 free_inodes;
	__le32 first_data_block;
	__le32 log2_block_size;
	__le32 log2_fragment_size;
	__le32 blocks_per_group;
	__le32 fragments_per_group;
	__le32 inodes_per_group;
	__le32 mtime;
	__le32 utime;
	__le16 mnt_count;
	__le16 max_mnt_count;
	__le16 magic;
	__le16 fs_state;
	__le16 error_handling;
	__le16 minor_revision_level;
	__le32 lastcheck;
	__le32 checkinterval;
	__le32 creator_os;
	__le32 revision_level;
	__le16 uid_reserved;
	__le16 gid_reserved;
	__le32 first_inode;
	__le16 inode_size;
	__le16 block_group_number;
	__le32 feature_compatibility;
	__le32 feature_incompat;
	__le32 feature_ro_compat;
	__le32 unique_id[4];
	char volume_name[16];
	char last_mounted_on[64];
	__le32 compression_info;
	uint8_t prealloc_blocks;
	uint8_t prealloc_dir_blocks;
	__le16 reserved_gdt_blocks;
	uint8_t journal_uuid[16];
	__le32 journal_inode;
	__le32 journal_dev;
	__le32 last_orphan;
	__le32 hash_seed[4];
	uint8_t default_hash_version;
	uint8_t journal_backup_type;
	__le16 descriptor_size;
	__le32 default_mount_options;
	__le32 first_meta_block_group;
	__le32 mkfs_time;
	__le32 journal_blocks[17];
	__le32 total_blocks_high;
	__le32 reserved_blocks_high;
	__le32 free_blocks_high;
	__le16 min_extra_inode_size;
	__le16 want_extra_inode_size;
	__le32 flags;
	__le16 raid_stride;
	__le16 mmp_interval;
	__le64 mmp_block;
	__le32 raid_stripe_width;
	uint8_t log2_groups_per_flex;
	uint8_t checksum_type;
};

struct ext2_block_group {
	__le32 block_id;	/* Blocks bitmap block */
	__le32 inode_id;	/* Inodes bitmap block */
	__le32 inode_table_id;	/* Inodes table block */
	__le16 free_blocks;	/* Free blocks count */
	__le16 free_inodes;	/* Free inodes count */
	__le16 used_dir_cnt;	/* Directories count */
	__le16 bg_flags;
	__le32 bg_exclude_bitmap;
	__le16 bg_block_id_csum;
	__le16 bg_inode_id_csum;
	__le16 bg_itable_unused; /* Unused inodes count */
	__le16 bg_checksum;	/* crc16(s_uuid+group_num+group_desc)*/
	/* following fields only exist if descriptor size is 64 */
	__le32 block_id_high;
	__le32 inode_id_high;
	__le32 inode_table_id_high;
	__le16 free_blocks_high;
	__le16 free_inodes_high;
	__le16 used_dir_cnt_high;
	__le16 bg_itable_unused_high;
	__le32 bg_exclude_bitmap_high;
	__le16 bg_block_id_csum_high;
	__le16 bg_inode_id_csum_high;
	__le32 bg_reserved;
};

/* The ext2 inode. */
struct ext2_inode {
	__le16 mode;
	__le16 uid;
	__le32 size;
	__le32 atime;
	__le32 ctime;
	__le32 mtime;
	__le32 dtime;
	__le16 gid;
	__le16 nlinks;
	__le32 blockcnt;	/* Blocks of either 512 or block_size bytes */
	__le32 flags;
	__le32 osd1;
	union {
		struct datablocks {
			__le32 dir_blocks[INDIRECT_BLOCKS];
			__le32 indir_block;
			__le32 double_indir_block;
			__le32 triple_indir_block;
		} blocks;
		char symlink[60];
		char inline_data[60];
	} b;
	__le32 version;
	__le32 acl;
	__le32 size_high;	/* previously dir_acl, but never used */
	__le32 fragment_addr;
	__le32 osd2[3];
};

/* The header of an ext2 directory entry. */
struct ext2_dirent {
	__le32 inode;
	__le16 direntlen;
	__u8 namelen;
	__u8 filetype;
};

struct ext2fs_node {
	struct ext2_data *data;
	struct ext2_inode inode;
	int ino;
	int inode_read;
};

/* Information about a "mounted" ext2 filesystem. */
struct ext2_data {
	struct ext2_sblock sblock;
	struct ext2_inode *inode;
	struct ext2fs_node diropen;
};

extern lbaint_t part_offset;

int do_ext2ls(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
int do_ext2load(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
int do_ext4_load(struct cmd_tbl *cmdtp, int flag, int argc,
		 char *const argv[]);
int do_ext4_ls(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
int do_ext4_write(struct cmd_tbl *cmdtp, int flag, int argc,
		  char *const argv[]);
#endif
Commit	Line	Data
83d290c5	1	/* SPDX-License-Identifier: GPL-2.0+ */
a1596438 US	2	/*
	3	* (C) Copyright 2011 - 2012 Samsung Electronics
	4	* EXT4 filesystem implementation in Uboot by
	5	* Uma Shankar <[email protected]>
	6	* Manjunatha C Achar <[email protected]>
	7	*
	8	* Data structures and headers for ext4 support have been taken from
	9	* ext2 ls load support in Uboot
	10	*
	11	* (C) Copyright 2004
	12	* esd gmbh <www.esd-electronics.com>
	13	* Reinhard Arlt <[email protected]>
	14	*
	15	* based on code from grub2 fs/ext2.c and fs/fshelp.c by
	16	* GRUB -- GRand Unified Bootloader
	17	* Copyright (C) 2003, 2004 Free Software Foundation, Inc.
a1596438 US	18	*/
	19
	20	#ifndef __EXT_COMMON__
	21	#define __EXT_COMMON__
09140113	22
401d1c4f SG	23	#include <compiler.h>
401d1c4f SG	24
09140113 SG	25	struct cmd_tbl;
09140113 SG	26
a1596438	27	#define SECTOR_SIZE 0x200
1c9f8f64	28	#define LOG2_SECTOR_SIZE 9
a1596438 US	29
	30	/* Magic value used to identify an ext2 filesystem. */
	31	#define EXT2_MAGIC 0xEF53
	32	/* Amount of indirect blocks in an inode. */
	33	#define INDIRECT_BLOCKS 12
	34	/* Maximum lenght of a pathname. */
	35	#define EXT2_PATH_MAX 4096
	36	/* Maximum nesting of symlinks, used to prevent a loop. */
	37	#define EXT2_MAX_SYMLINKCNT 8
0bf3fec2 SA	38	/* Maximum file name length */
	39	#define EXT2_NAME_LEN 255
	40
	41	/*
	42	* Revision levels
	43	*/
	44	#define EXT2_GOOD_OLD_REV 0 /* The good old (original) format */
	45	#define EXT2_DYNAMIC_REV 1 /* V2 format w/ dynamic inode sizes */
	46
	47	#define EXT2_GOOD_OLD_INODE_SIZE 128
a1596438 US	48
	49	/* Filetype used in directory entry. */
	50	#define FILETYPE_UNKNOWN 0
	51	#define FILETYPE_REG 1
	52	#define FILETYPE_DIRECTORY 2
	53	#define FILETYPE_SYMLINK 7
	54
	55	/* Filetype information as used in inodes. */
	56	#define FILETYPE_INO_MASK 0170000
	57	#define FILETYPE_INO_REG 0100000
	58	#define FILETYPE_INO_DIRECTORY 0040000
	59	#define FILETYPE_INO_SYMLINK 0120000
	60	#define EXT2_ROOT_INO 2 /* Root inode */
0bf3fec2 SA	61	#define EXT2_BOOT_LOADER_INO 5 /* Boot loader inode */
	62
	63	/* First non-reserved inode for old ext2 filesystems */
	64	#define EXT2_GOOD_OLD_FIRST_INO 11
a1596438	65
a1596438 US	66	/* The size of an ext2 block in bytes. */
	67	#define EXT2_BLOCK_SIZE(data) (1 << LOG2_BLOCK_SIZE(data))
	68
a1596438	69	/* Log2 size of ext2 block in bytes. */
7f101be3	70	#define LOG2_BLOCK_SIZE(data) (le32_to_cpu \
50ce4c07 EE	71	(data->sblock.log2_block_size) \
50ce4c07 EE	72	+ EXT2_MIN_BLOCK_LOG_SIZE)
a1596438 US	73
	74	#define EXT2_FT_DIR 2
	75	#define SUCCESS 1
	76
	77	/* Macro-instructions used to manage several block sizes */
	78	#define EXT2_MIN_BLOCK_LOG_SIZE 10 /* 1024 */
	79	#define EXT2_MAX_BLOCK_LOG_SIZE 16 /* 65536 */
	80	#define EXT2_MIN_BLOCK_SIZE (1 << EXT2_MIN_BLOCK_LOG_SIZE)
	81	#define EXT2_MAX_BLOCK_SIZE (1 << EXT2_MAX_BLOCK_LOG_SIZE)
	82
	83	/* The ext2 superblock. */
	84	struct ext2_sblock {
2a0b7a97 MW	85	__le32 total_inodes;
	86	__le32 total_blocks;
	87	__le32 reserved_blocks;
	88	__le32 free_blocks;
	89	__le32 free_inodes;
	90	__le32 first_data_block;
	91	__le32 log2_block_size;
	92	__le32 log2_fragment_size;
	93	__le32 blocks_per_group;
	94	__le32 fragments_per_group;
	95	__le32 inodes_per_group;
	96	__le32 mtime;
	97	__le32 utime;
	98	__le16 mnt_count;
	99	__le16 max_mnt_count;
	100	__le16 magic;
	101	__le16 fs_state;
	102	__le16 error_handling;
	103	__le16 minor_revision_level;
	104	__le32 lastcheck;
	105	__le32 checkinterval;
	106	__le32 creator_os;
	107	__le32 revision_level;
	108	__le16 uid_reserved;
	109	__le16 gid_reserved;
	110	__le32 first_inode;
	111	__le16 inode_size;
	112	__le16 block_group_number;
	113	__le32 feature_compatibility;
	114	__le32 feature_incompat;
	115	__le32 feature_ro_compat;
	116	__le32 unique_id[4];
a1596438 US	117	char volume_name[16];
a1596438 US	118	char last_mounted_on[64];
2a0b7a97	119	__le32 compression_info;
3ee2f977 SB	120	uint8_t prealloc_blocks;
	121	uint8_t prealloc_dir_blocks;
	122	__le16 reserved_gdt_blocks;
	123	uint8_t journal_uuid[16];
	124	__le32 journal_inode;
	125	__le32 journal_dev;
	126	__le32 last_orphan;
	127	__le32 hash_seed[4];
	128	uint8_t default_hash_version;
	129	uint8_t journal_backup_type;
	130	__le16 descriptor_size;
	131	__le32 default_mount_options;
	132	__le32 first_meta_block_group;
	133	__le32 mkfs_time;
	134	__le32 journal_blocks[17];
	135	__le32 total_blocks_high;
	136	__le32 reserved_blocks_high;
	137	__le32 free_blocks_high;
	138	__le16 min_extra_inode_size;
	139	__le16 want_extra_inode_size;
	140	__le32 flags;
	141	__le16 raid_stride;
	142	__le16 mmp_interval;
	143	__le64 mmp_block;
	144	__le32 raid_stripe_width;
	145	uint8_t log2_groups_per_flex;
	146	uint8_t checksum_type;
a1596438 US	147	};
	148
	149	struct ext2_block_group {
2a0b7a97 MW	150	__le32 block_id; /* Blocks bitmap block */
	151	__le32 inode_id; /* Inodes bitmap block */
	152	__le32 inode_table_id; /* Inodes table block */
	153	__le16 free_blocks; /* Free blocks count */
	154	__le16 free_inodes; /* Free inodes count */
	155	__le16 used_dir_cnt; /* Directories count */
	156	__le16 bg_flags;
3ee2f977 SB	157	__le32 bg_exclude_bitmap;
	158	__le16 bg_block_id_csum;
	159	__le16 bg_inode_id_csum;
2a0b7a97	160	__le16 bg_itable_unused; /* Unused inodes count */
3ee2f977 SB	161	__le16 bg_checksum; /* crc16(s_uuid+group_num+group_desc)*/
	162	/* following fields only exist if descriptor size is 64 */
	163	__le32 block_id_high;
	164	__le32 inode_id_high;
	165	__le32 inode_table_id_high;
	166	__le16 free_blocks_high;
	167	__le16 free_inodes_high;
	168	__le16 used_dir_cnt_high;
	169	__le16 bg_itable_unused_high;
	170	__le32 bg_exclude_bitmap_high;
	171	__le16 bg_block_id_csum_high;
	172	__le16 bg_inode_id_csum_high;
	173	__le32 bg_reserved;
a1596438 US	174	};
	175
	176	/* The ext2 inode. */
	177	struct ext2_inode {
2a0b7a97 MW	178	__le16 mode;
	179	__le16 uid;
	180	__le32 size;
	181	__le32 atime;
	182	__le32 ctime;
	183	__le32 mtime;
	184	__le32 dtime;
	185	__le16 gid;
	186	__le16 nlinks;
3ee2f977	187	__le32 blockcnt; /* Blocks of either 512 or block_size bytes */
2a0b7a97 MW	188	__le32 flags;
2a0b7a97 MW	189	__le32 osd1;
a1596438 US	190	union {
a1596438 US	191	struct datablocks {
2a0b7a97 MW	192	__le32 dir_blocks[INDIRECT_BLOCKS];
	193	__le32 indir_block;
	194	__le32 double_indir_block;
	195	__le32 triple_indir_block;
a1596438 US	196	} blocks;
a1596438 US	197	char symlink[60];
3ee2f977	198	char inline_data[60];
a1596438	199	} b;
2a0b7a97 MW	200	__le32 version;
2a0b7a97 MW	201	__le32 acl;
3ee2f977	202	__le32 size_high; /* previously dir_acl, but never used */
2a0b7a97 MW	203	__le32 fragment_addr;
2a0b7a97 MW	204	__le32 osd2[3];
a1596438 US	205	};
	206
	207	/* The header of an ext2 directory entry. */
	208	struct ext2_dirent {
2a0b7a97 MW	209	__le32 inode;
	210	__le16 direntlen;
	211	__u8 namelen;
	212	__u8 filetype;
a1596438 US	213	};
	214
	215	struct ext2fs_node {
	216	struct ext2_data *data;
	217	struct ext2_inode inode;
	218	int ino;
	219	int inode_read;
	220	};
	221
	222	/* Information about a "mounted" ext2 filesystem. */
	223	struct ext2_data {
	224	struct ext2_sblock sblock;
	225	struct ext2_inode *inode;
	226	struct ext2fs_node diropen;
	227	};
	228
04735e9c	229	extern lbaint_t part_offset;
81180819	230
09140113 SG	231	int do_ext2ls(struct cmd_tbl cmdtp, int flag, int argc, char const argv[]);
	232	int do_ext2load(struct cmd_tbl cmdtp, int flag, int argc, char const argv[]);
	233	int do_ext4_load(struct cmd_tbl *cmdtp, int flag, int argc,
	234	char *const argv[]);
	235	int do_ext4_ls(struct cmd_tbl cmdtp, int flag, int argc, char const argv[]);
	236	int do_ext4_write(struct cmd_tbl *cmdtp, int flag, int argc,
	237	char *const argv[]);
a1596438	238	#endif