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