Merge branch 'ext4'
[platform/kernel/u-boot.git] / doc / README.ext4
1 This patch series adds support for ext4 ls,load and write features in uboot
2 Journaling is supported for write feature.
3
4 To Enable ext2 ls and load commands, modify the board specific config file with
5 #define CONFIG_CMD_EXT2
6
7 To Enable ext4 ls and load commands, modify the board specific config file with
8 #define CONFIG_CMD_EXT4
9
10 To enable ext4 write command, modify the board specific config file with
11 #define CONFIG_CMD_EXT4
12 #define CONFIG_CMD_EXT4_WRITE
13
14 Steps to test:
15
16 1. After applying the patch, ext4 specific commands can be seen
17    in the boot loader prompt using
18         UBOOT #help
19
20         ext4load- load binary file from a Ext4 file system
21         ext4ls  - list files in a directory (default /)
22         ext4write- create a file in ext4 formatted partition
23
24 2. To list the files in ext4 formatted partition, execute
25         ext4ls <interface> <dev[:part]> [directory]
26         For example:
27         UBOOT #ext4ls mmc 0:5 /usr/lib
28
29 3. To read and load a file from an ext4 formatted partition to RAM, execute
30         ext4load <interface> <dev[:part]> [addr] [filename] [bytes]
31         For example:
32         UBOOT #ext4load mmc 2:2 0x30007fc0 uImage
33
34 4. To write a file to a ext4 formatted partition.
35         a) First load a file to RAM at a particular address for example 0x30007fc0.
36         Now execute ext4write command
37         ext4write <interface> <dev[:part]> [filename] [Address] [sizebytes]
38         For example:
39         UBOOT #ext4write mmc 2:2 /boot/uImage 0x30007fc0 6183120
40         (here 6183120 is the size of the file to be written)
41         Note: Absolute path is required for the file to be written
42
43 References :
44         -- ext4 implementation in Linux Kernel
45         -- Uboot existing ext2 load and ls implementation
46         -- Journaling block device JBD2 implementation in linux Kernel