xref: /rk3399_rockchip-uboot/include/ext_common.h (revision 3ee2f977f3649bcc1d0de86356145e8e6999575a)
1a1596438SUma Shankar /*
2a1596438SUma Shankar  * (C) Copyright 2011 - 2012 Samsung Electronics
3a1596438SUma Shankar  * EXT4 filesystem implementation in Uboot by
4a1596438SUma Shankar  * Uma Shankar <uma.shankar@samsung.com>
5a1596438SUma Shankar  * Manjunatha C Achar <a.manjunatha@samsung.com>
6a1596438SUma Shankar  *
7a1596438SUma Shankar  * Data structures and headers for ext4 support have been taken from
8a1596438SUma Shankar  * ext2 ls load support in Uboot
9a1596438SUma Shankar  *
10a1596438SUma Shankar  * (C) Copyright 2004
11a1596438SUma Shankar  * esd gmbh <www.esd-electronics.com>
12a1596438SUma Shankar  * Reinhard Arlt <reinhard.arlt@esd-electronics.com>
13a1596438SUma Shankar  *
14a1596438SUma Shankar  * based on code from grub2 fs/ext2.c and fs/fshelp.c by
15a1596438SUma Shankar  * GRUB  --  GRand Unified Bootloader
16a1596438SUma Shankar  * Copyright (C) 2003, 2004  Free Software Foundation, Inc.
17a1596438SUma Shankar  *
181a459660SWolfgang Denk  * SPDX-License-Identifier:	GPL-2.0+
19a1596438SUma Shankar  */
20a1596438SUma Shankar 
21a1596438SUma Shankar #ifndef __EXT_COMMON__
22a1596438SUma Shankar #define __EXT_COMMON__
23a1596438SUma Shankar #include <command.h>
24a1596438SUma Shankar #define SECTOR_SIZE		0x200
25a1596438SUma Shankar 
26a1596438SUma Shankar /* Magic value used to identify an ext2 filesystem.  */
27a1596438SUma Shankar #define	EXT2_MAGIC			0xEF53
28a1596438SUma Shankar /* Amount of indirect blocks in an inode.  */
29a1596438SUma Shankar #define INDIRECT_BLOCKS			12
30a1596438SUma Shankar /* Maximum lenght of a pathname.  */
31a1596438SUma Shankar #define EXT2_PATH_MAX				4096
32a1596438SUma Shankar /* Maximum nesting of symlinks, used to prevent a loop.  */
33a1596438SUma Shankar #define	EXT2_MAX_SYMLINKCNT		8
34a1596438SUma Shankar 
35a1596438SUma Shankar /* Filetype used in directory entry.  */
36a1596438SUma Shankar #define	FILETYPE_UNKNOWN		0
37a1596438SUma Shankar #define	FILETYPE_REG			1
38a1596438SUma Shankar #define	FILETYPE_DIRECTORY		2
39a1596438SUma Shankar #define	FILETYPE_SYMLINK		7
40a1596438SUma Shankar 
41a1596438SUma Shankar /* Filetype information as used in inodes.  */
42a1596438SUma Shankar #define FILETYPE_INO_MASK		0170000
43a1596438SUma Shankar #define FILETYPE_INO_REG		0100000
44a1596438SUma Shankar #define FILETYPE_INO_DIRECTORY		0040000
45a1596438SUma Shankar #define FILETYPE_INO_SYMLINK		0120000
46a1596438SUma Shankar #define EXT2_ROOT_INO			2 /* Root inode */
47a1596438SUma Shankar 
48a1596438SUma Shankar /* The size of an ext2 block in bytes.  */
49a1596438SUma Shankar #define EXT2_BLOCK_SIZE(data)	   (1 << LOG2_BLOCK_SIZE(data))
50a1596438SUma Shankar 
51a1596438SUma Shankar /* Log2 size of ext2 block in bytes.  */
527f101be3SMichael Walle #define LOG2_BLOCK_SIZE(data)	   (le32_to_cpu		   \
5350ce4c07SEgbert Eich 				    (data->sblock.log2_block_size) \
5450ce4c07SEgbert Eich 				    + EXT2_MIN_BLOCK_LOG_SIZE)
55a1596438SUma Shankar 
56a1596438SUma Shankar #define EXT2_FT_DIR	2
57a1596438SUma Shankar #define SUCCESS	1
58a1596438SUma Shankar 
59a1596438SUma Shankar /* Macro-instructions used to manage several block sizes  */
60a1596438SUma Shankar #define EXT2_MIN_BLOCK_LOG_SIZE	10 /* 1024 */
61a1596438SUma Shankar #define EXT2_MAX_BLOCK_LOG_SIZE	16 /* 65536 */
62a1596438SUma Shankar #define EXT2_MIN_BLOCK_SIZE		(1 << EXT2_MIN_BLOCK_LOG_SIZE)
63a1596438SUma Shankar #define EXT2_MAX_BLOCK_SIZE		(1 << EXT2_MAX_BLOCK_LOG_SIZE)
64a1596438SUma Shankar 
65a1596438SUma Shankar /* The ext2 superblock.  */
66a1596438SUma Shankar struct ext2_sblock {
672a0b7a97SMichael Walle 	__le32 total_inodes;
682a0b7a97SMichael Walle 	__le32 total_blocks;
692a0b7a97SMichael Walle 	__le32 reserved_blocks;
702a0b7a97SMichael Walle 	__le32 free_blocks;
712a0b7a97SMichael Walle 	__le32 free_inodes;
722a0b7a97SMichael Walle 	__le32 first_data_block;
732a0b7a97SMichael Walle 	__le32 log2_block_size;
742a0b7a97SMichael Walle 	__le32 log2_fragment_size;
752a0b7a97SMichael Walle 	__le32 blocks_per_group;
762a0b7a97SMichael Walle 	__le32 fragments_per_group;
772a0b7a97SMichael Walle 	__le32 inodes_per_group;
782a0b7a97SMichael Walle 	__le32 mtime;
792a0b7a97SMichael Walle 	__le32 utime;
802a0b7a97SMichael Walle 	__le16 mnt_count;
812a0b7a97SMichael Walle 	__le16 max_mnt_count;
822a0b7a97SMichael Walle 	__le16 magic;
832a0b7a97SMichael Walle 	__le16 fs_state;
842a0b7a97SMichael Walle 	__le16 error_handling;
852a0b7a97SMichael Walle 	__le16 minor_revision_level;
862a0b7a97SMichael Walle 	__le32 lastcheck;
872a0b7a97SMichael Walle 	__le32 checkinterval;
882a0b7a97SMichael Walle 	__le32 creator_os;
892a0b7a97SMichael Walle 	__le32 revision_level;
902a0b7a97SMichael Walle 	__le16 uid_reserved;
912a0b7a97SMichael Walle 	__le16 gid_reserved;
922a0b7a97SMichael Walle 	__le32 first_inode;
932a0b7a97SMichael Walle 	__le16 inode_size;
942a0b7a97SMichael Walle 	__le16 block_group_number;
952a0b7a97SMichael Walle 	__le32 feature_compatibility;
962a0b7a97SMichael Walle 	__le32 feature_incompat;
972a0b7a97SMichael Walle 	__le32 feature_ro_compat;
982a0b7a97SMichael Walle 	__le32 unique_id[4];
99a1596438SUma Shankar 	char volume_name[16];
100a1596438SUma Shankar 	char last_mounted_on[64];
1012a0b7a97SMichael Walle 	__le32 compression_info;
102*3ee2f977SStefan Brüns 	uint8_t prealloc_blocks;
103*3ee2f977SStefan Brüns 	uint8_t prealloc_dir_blocks;
104*3ee2f977SStefan Brüns 	__le16 reserved_gdt_blocks;
105*3ee2f977SStefan Brüns 	uint8_t journal_uuid[16];
106*3ee2f977SStefan Brüns 	__le32 journal_inode;
107*3ee2f977SStefan Brüns 	__le32 journal_dev;
108*3ee2f977SStefan Brüns 	__le32 last_orphan;
109*3ee2f977SStefan Brüns 	__le32 hash_seed[4];
110*3ee2f977SStefan Brüns 	uint8_t default_hash_version;
111*3ee2f977SStefan Brüns 	uint8_t journal_backup_type;
112*3ee2f977SStefan Brüns 	__le16 descriptor_size;
113*3ee2f977SStefan Brüns 	__le32 default_mount_options;
114*3ee2f977SStefan Brüns 	__le32 first_meta_block_group;
115*3ee2f977SStefan Brüns 	__le32 mkfs_time;
116*3ee2f977SStefan Brüns 	__le32 journal_blocks[17];
117*3ee2f977SStefan Brüns 	__le32 total_blocks_high;
118*3ee2f977SStefan Brüns 	__le32 reserved_blocks_high;
119*3ee2f977SStefan Brüns 	__le32 free_blocks_high;
120*3ee2f977SStefan Brüns 	__le16 min_extra_inode_size;
121*3ee2f977SStefan Brüns 	__le16 want_extra_inode_size;
122*3ee2f977SStefan Brüns 	__le32 flags;
123*3ee2f977SStefan Brüns 	__le16 raid_stride;
124*3ee2f977SStefan Brüns 	__le16 mmp_interval;
125*3ee2f977SStefan Brüns 	__le64 mmp_block;
126*3ee2f977SStefan Brüns 	__le32 raid_stripe_width;
127*3ee2f977SStefan Brüns 	uint8_t log2_groups_per_flex;
128*3ee2f977SStefan Brüns 	uint8_t checksum_type;
129a1596438SUma Shankar };
130a1596438SUma Shankar 
131a1596438SUma Shankar struct ext2_block_group {
1322a0b7a97SMichael Walle 	__le32 block_id;	/* Blocks bitmap block */
1332a0b7a97SMichael Walle 	__le32 inode_id;	/* Inodes bitmap block */
1342a0b7a97SMichael Walle 	__le32 inode_table_id;	/* Inodes table block */
1352a0b7a97SMichael Walle 	__le16 free_blocks;	/* Free blocks count */
1362a0b7a97SMichael Walle 	__le16 free_inodes;	/* Free inodes count */
1372a0b7a97SMichael Walle 	__le16 used_dir_cnt;	/* Directories count */
1382a0b7a97SMichael Walle 	__le16 bg_flags;
139*3ee2f977SStefan Brüns 	__le32 bg_exclude_bitmap;
140*3ee2f977SStefan Brüns 	__le16 bg_block_id_csum;
141*3ee2f977SStefan Brüns 	__le16 bg_inode_id_csum;
1422a0b7a97SMichael Walle 	__le16 bg_itable_unused; /* Unused inodes count */
143*3ee2f977SStefan Brüns 	__le16 bg_checksum;	/* crc16(s_uuid+group_num+group_desc)*/
144*3ee2f977SStefan Brüns 	/* following fields only exist if descriptor size is 64 */
145*3ee2f977SStefan Brüns 	__le32 block_id_high;
146*3ee2f977SStefan Brüns 	__le32 inode_id_high;
147*3ee2f977SStefan Brüns 	__le32 inode_table_id_high;
148*3ee2f977SStefan Brüns 	__le16 free_blocks_high;
149*3ee2f977SStefan Brüns 	__le16 free_inodes_high;
150*3ee2f977SStefan Brüns 	__le16 used_dir_cnt_high;
151*3ee2f977SStefan Brüns 	__le16 bg_itable_unused_high;
152*3ee2f977SStefan Brüns 	__le32 bg_exclude_bitmap_high;
153*3ee2f977SStefan Brüns 	__le16 bg_block_id_csum_high;
154*3ee2f977SStefan Brüns 	__le16 bg_inode_id_csum_high;
155*3ee2f977SStefan Brüns 	__le32 bg_reserved;
156a1596438SUma Shankar };
157a1596438SUma Shankar 
158a1596438SUma Shankar /* The ext2 inode. */
159a1596438SUma Shankar struct ext2_inode {
1602a0b7a97SMichael Walle 	__le16 mode;
1612a0b7a97SMichael Walle 	__le16 uid;
1622a0b7a97SMichael Walle 	__le32 size;
1632a0b7a97SMichael Walle 	__le32 atime;
1642a0b7a97SMichael Walle 	__le32 ctime;
1652a0b7a97SMichael Walle 	__le32 mtime;
1662a0b7a97SMichael Walle 	__le32 dtime;
1672a0b7a97SMichael Walle 	__le16 gid;
1682a0b7a97SMichael Walle 	__le16 nlinks;
169*3ee2f977SStefan Brüns 	__le32 blockcnt;	/* Blocks of either 512 or block_size bytes */
1702a0b7a97SMichael Walle 	__le32 flags;
1712a0b7a97SMichael Walle 	__le32 osd1;
172a1596438SUma Shankar 	union {
173a1596438SUma Shankar 		struct datablocks {
1742a0b7a97SMichael Walle 			__le32 dir_blocks[INDIRECT_BLOCKS];
1752a0b7a97SMichael Walle 			__le32 indir_block;
1762a0b7a97SMichael Walle 			__le32 double_indir_block;
1772a0b7a97SMichael Walle 			__le32 triple_indir_block;
178a1596438SUma Shankar 		} blocks;
179a1596438SUma Shankar 		char symlink[60];
180*3ee2f977SStefan Brüns 		char inline_data[60];
181a1596438SUma Shankar 	} b;
1822a0b7a97SMichael Walle 	__le32 version;
1832a0b7a97SMichael Walle 	__le32 acl;
184*3ee2f977SStefan Brüns 	__le32 size_high;	/* previously dir_acl, but never used */
1852a0b7a97SMichael Walle 	__le32 fragment_addr;
1862a0b7a97SMichael Walle 	__le32 osd2[3];
187a1596438SUma Shankar };
188a1596438SUma Shankar 
189a1596438SUma Shankar /* The header of an ext2 directory entry. */
190a1596438SUma Shankar struct ext2_dirent {
1912a0b7a97SMichael Walle 	__le32 inode;
1922a0b7a97SMichael Walle 	__le16 direntlen;
1932a0b7a97SMichael Walle 	__u8 namelen;
1942a0b7a97SMichael Walle 	__u8 filetype;
195a1596438SUma Shankar };
196a1596438SUma Shankar 
197a1596438SUma Shankar struct ext2fs_node {
198a1596438SUma Shankar 	struct ext2_data *data;
199a1596438SUma Shankar 	struct ext2_inode inode;
200a1596438SUma Shankar 	int ino;
201a1596438SUma Shankar 	int inode_read;
202a1596438SUma Shankar };
203a1596438SUma Shankar 
204a1596438SUma Shankar /* Information about a "mounted" ext2 filesystem. */
205a1596438SUma Shankar struct ext2_data {
206a1596438SUma Shankar 	struct ext2_sblock sblock;
207a1596438SUma Shankar 	struct ext2_inode *inode;
208a1596438SUma Shankar 	struct ext2fs_node diropen;
209a1596438SUma Shankar };
210a1596438SUma Shankar 
21104735e9cSFrederic Leroy extern lbaint_t part_offset;
21281180819SRob Herring 
213a1596438SUma Shankar int do_ext2ls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
214a1596438SUma Shankar int do_ext2load(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
215a1596438SUma Shankar int do_ext4_load(cmd_tbl_t *cmdtp, int flag, int argc,
216a1596438SUma Shankar 					char *const argv[]);
217a1596438SUma Shankar int do_ext4_ls(cmd_tbl_t *cmdtp, int flag, int argc, char *const argv[]);
218ed34f34dSUma Shankar int do_ext4_write(cmd_tbl_t *cmdtp, int flag, int argc,
219ed34f34dSUma Shankar 				char *const argv[]);
220a1596438SUma Shankar #endif
221