blob: d96edfd0576cefaacbd7900d7287caf420f1ce78 [file] [log] [blame]
Uma Shankar71014b62012-05-25 21:21:44 +05301/*
2 * (C) Copyright 2011 - 2012 Samsung Electronics
3 * EXT4 filesystem implementation in Uboot by
4 * Uma Shankar <uma.shankar@samsung.com>
5 * Manjunatha C Achar <a.manjunatha@samsung.com>
6 *
7 * Ext4 Extent data structures are taken from original ext4 fs code
8 * as found in the linux kernel.
9 *
10 * Copyright (c) 2003-2006, Cluster File Systems, Inc, info@clusterfs.com
11 * Written by Alex Tomas <alex@clusterfs.com>
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2 as
15 * published by the Free Software Foundation.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 */
26
27#ifndef __EXT4__
28#define __EXT4__
29#include <ext_common.h>
30
Simon Glass655306c2020-05-10 11:39:58 -060031struct disk_partition;
32
Stefan Brüns57db8992016-09-06 04:36:45 +020033#define EXT4_INDEX_FL 0x00001000 /* Inode uses hash tree index */
Sean Andersond90fa0b2023-10-14 16:47:50 -040034#define EXT4_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
Uma Shankar71014b62012-05-25 21:21:44 +053035#define EXT4_EXTENTS_FL 0x00080000 /* Inode uses extents */
36#define EXT4_EXT_MAGIC 0xf30a
37#define EXT4_FEATURE_RO_COMPAT_GDT_CSUM 0x0010
Sébastien Szymanskif7d49682019-03-22 09:33:52 +010038#define EXT4_FEATURE_RO_COMPAT_METADATA_CSUM 0x0400
Uma Shankar71014b62012-05-25 21:21:44 +053039#define EXT4_FEATURE_INCOMPAT_EXTENTS 0x0040
Tom Rini44720652016-07-22 17:59:11 -040040#define EXT4_FEATURE_INCOMPAT_64BIT 0x0080
Uma Shankar71014b62012-05-25 21:21:44 +053041#define EXT4_INDIRECT_BLOCKS 12
42
43#define EXT4_BG_INODE_UNINIT 0x0001
44#define EXT4_BG_BLOCK_UNINIT 0x0002
45#define EXT4_BG_INODE_ZEROED 0x0004
46
47/*
48 * ext4_inode has i_block array (60 bytes total).
49 * The first 12 bytes store ext4_extent_header;
50 * the remainder stores an array of ext4_extent.
51 */
52
53/*
54 * This is the extent on-disk structure.
55 * It's used at the bottom of the tree.
56 */
57struct ext4_extent {
58 __le32 ee_block; /* first logical block extent covers */
59 __le16 ee_len; /* number of blocks covered by extent */
60 __le16 ee_start_hi; /* high 16 bits of physical block */
61 __le32 ee_start_lo; /* low 32 bits of physical block */
62};
63
64/*
65 * This is index on-disk structure.
66 * It's used at all the levels except the bottom.
67 */
68struct ext4_extent_idx {
69 __le32 ei_block; /* index covers logical blocks from 'block' */
70 __le32 ei_leaf_lo; /* pointer to the physical block of the next *
71 * level. leaf or next index could be there */
72 __le16 ei_leaf_hi; /* high 16 bits of physical block */
73 __u16 ei_unused;
74};
75
76/* Each block (leaves and indexes), even inode-stored has header. */
77struct ext4_extent_header {
78 __le16 eh_magic; /* probably will support different formats */
79 __le16 eh_entries; /* number of valid entries */
80 __le16 eh_max; /* capacity of store in entries */
81 __le16 eh_depth; /* has tree real underlying blocks? */
82 __le32 eh_generation; /* generation of the tree */
83};
84
85struct ext_filesystem {
86 /* Total Sector of partition */
87 uint64_t total_sect;
88 /* Block size of partition */
89 uint32_t blksz;
90 /* Inode size of partition */
91 uint32_t inodesz;
92 /* Sectors per Block */
93 uint32_t sect_perblk;
Stefan Brünsb2c28a22016-09-17 02:10:07 +020094 /* Group Descriptor size */
95 uint16_t gdsize;
Uma Shankar71014b62012-05-25 21:21:44 +053096 /* Group Descriptor Block Number */
97 uint32_t gdtable_blkno;
98 /* Total block groups of partition */
99 uint32_t no_blkgrp;
100 /* No of blocks required for bgdtable */
101 uint32_t no_blk_pergdt;
102 /* Superblock */
103 struct ext2_sblock *sb;
104 /* Block group descritpor table */
Uma Shankar71014b62012-05-25 21:21:44 +0530105 char *gdtable;
106
107 /* Block Bitmap Related */
108 unsigned char **blk_bmaps;
109 long int curr_blkno;
110 uint16_t first_pass_bbmap;
111
112 /* Inode Bitmap Related */
113 unsigned char **inode_bmaps;
114 int curr_inode_no;
115 uint16_t first_pass_ibmap;
116
117 /* Journal Related */
118
119 /* Block Device Descriptor */
Simon Glasse3394752016-02-29 15:25:34 -0700120 struct blk_desc *dev_desc;
Uma Shankar71014b62012-05-25 21:21:44 +0530121};
122
Stephen Warren02d6ca72019-01-30 12:58:05 -0700123struct ext_block_cache {
124 char *buf;
125 lbaint_t block;
126 int size;
127};
128
Uma Shankar71014b62012-05-25 21:21:44 +0530129extern struct ext2_data *ext4fs_root;
130extern struct ext2fs_node *ext4fs_file;
131
Stephen Warren4f8662d2012-10-22 06:43:50 +0000132#if defined(CONFIG_EXT4_WRITE)
Uma Shankara74a99a2012-05-25 21:22:49 +0530133extern struct ext2_inode *g_parent_inode;
134extern int gd_index;
135extern int gindex;
136
137int ext4fs_init(void);
138void ext4fs_deinit(void);
Stefan Brüns278f5d32016-09-06 04:36:41 +0200139int ext4fs_filename_unlink(char *filename);
Jean-Jacques Hiblotd1921362019-02-13 12:15:24 +0100140int ext4fs_write(const char *fname, const char *buffer,
Jean-Jacques Hiblot448dd272019-02-13 12:15:25 +0100141 unsigned long sizebytes, int type);
Suriyan Ramasamib3a2d5a2014-11-17 14:39:36 -0800142int ext4_write_file(const char *filename, void *buf, loff_t offset, loff_t len,
143 loff_t *actwrite);
Jean-Jacques Hiblot448dd272019-02-13 12:15:25 +0100144int ext4fs_create_link(const char *target, const char *fname);
Uma Shankara74a99a2012-05-25 21:22:49 +0530145#endif
146
Uma Shankar71014b62012-05-25 21:21:44 +0530147struct ext_filesystem *get_fs(void);
Suriyan Ramasamib3a2d5a2014-11-17 14:39:36 -0800148int ext4fs_open(const char *filename, loff_t *len);
Stefan Brünsdb5862d2016-11-06 18:33:57 +0100149int ext4fs_read(char *buf, loff_t offset, loff_t len, loff_t *actread);
Sean Andersonab125f52023-11-08 12:51:09 -0500150int ext4fs_mount(void);
Uma Shankar71014b62012-05-25 21:21:44 +0530151void ext4fs_close(void);
Łukasz Majewski900db5d2014-05-06 09:36:05 +0200152void ext4fs_reinit_global(void);
Uma Shankar71014b62012-05-25 21:21:44 +0530153int ext4fs_ls(const char *dirname);
Stephen Warren12d6d0c2014-02-03 13:21:09 -0700154int ext4fs_exists(const char *filename);
Suriyan Ramasami96171fb2014-11-17 14:39:38 -0800155int ext4fs_size(const char *filename, loff_t *size);
Uma Shankar71014b62012-05-25 21:21:44 +0530156void ext4fs_free_node(struct ext2fs_node *node, struct ext2fs_node *currroot);
Frederic Leroye7ee0282013-06-26 18:11:25 +0200157int ext4fs_devread(lbaint_t sector, int byte_offset, int byte_len, char *buf);
Simon Glassc1c4a8f2020-05-10 11:39:57 -0600158void ext4fs_set_blk_dev(struct blk_desc *rbdd, struct disk_partition *info);
Stephen Warren02d6ca72019-01-30 12:58:05 -0700159long int read_allocated_block(struct ext2_inode *inode, int fileblock,
160 struct ext_block_cache *cache);
Simon Glasse3394752016-02-29 15:25:34 -0700161int ext4fs_probe(struct blk_desc *fs_dev_desc,
Simon Glassc1c4a8f2020-05-10 11:39:57 -0600162 struct disk_partition *fs_partition);
Suriyan Ramasami96171fb2014-11-17 14:39:38 -0800163int ext4_read_file(const char *filename, void *buf, loff_t offset, loff_t len,
164 loff_t *actread);
Egbert Eich7b1b2552013-05-01 01:13:19 +0000165int ext4_read_superblock(char *buffer);
Christian Gmeiner9f9eec32014-11-12 14:35:04 +0100166int ext4fs_uuid(char *uuid_str);
Stephen Warren02d6ca72019-01-30 12:58:05 -0700167void ext_cache_init(struct ext_block_cache *cache);
168void ext_cache_fini(struct ext_block_cache *cache);
169int ext_cache_read(struct ext_block_cache *cache, lbaint_t block, int size);
Uma Shankar71014b62012-05-25 21:21:44 +0530170#endif