Fix reading FAT32 root dirs that span >1 cluster
[x-loader:kishorekadiyalas-x-loader.git] / README
1 #
2 # (C) Copyright 2004-2006 Texas Instruments
3 #
4 # Some cut/paste from U-Boot README
5 # (C) Copyright 2000 - 2004
6 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7 #
8 # See file CREDITS for list of people who contributed to this
9 # project.
10 #
11 # This program is free software; you can redistribute it and/or
12 # modify it under the terms of the GNU General Public License as
13 # published by the Free Software Foundation; either version 2 of
14 # the License, or (at your option) any later version.
15 #
16 # This program is distributed in the hope that it will be useful,
17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 # GNU General Public License for more details.
20 #
21 # You should have received a copy of the GNU General Public License
22 # along with this program; if not, write to the Free Software
23 # Foundation, Inc., 59 Temple Place, Suite 330, Boston,
24 # MA 02111-1307 USA
25 #
26
27 Summary:
28 ========
29
30 This directory contains the source code for X-Loader, an initial program
31 loader for Embedded boards based on OMAP processors. X-Loader can be
32 signed by Texas Instruments IFT and installed to Nand flash to achieve
33 Nand booting.
34
35
36 Status:
37 =======
38
39 The support for Texas Instruments H3 board (OMAP1710) has been implemented
40 and tested. (May 2004)
41 The support for Texas Instruments H4 board (OMAP2420) has been implemented
42 and tested. (Nov 2004)
43 The support for Texas Instruments 2430SDP board (OMAP2430) has been implemented
44 and tested. (Jul 2006)
45 The support for Texas Instruments 3430SDP board (OMAP3430) has been implemented
46 and tested. (Dec 2006)
47
48
49 Support for other OMAP boards can be added.
50  
51   
52 Directory Hierarchy:
53 ====================
54
55 - board         Board dependent files
56 - cpu           CPU specific files
57 - drivers       Commonly used device drivers
58 - lib           Libraries
59  
60 - cpu/arm926ejs Files specific to ARM 926 CPUs
61 - cpu/arm1136 Files specific to ARM 1136 CPUs
62 - cpu/omap3 Files specific to ARM CortexA8 CPU
63
64  
65 - board/omap1710h3
66                 Files specific to OMAP 1710 H3 boards
67 - board/omap2420h4
68                 Files specific to OMAP 2420 H4 boards
69 - board/omap2430sdp
70                 Files specific to OMAP 2430 2430sdp boards
71 - board/omap3430sdp
72                 Files specific to OMAP 3420sdp boards
73
74  
75 Software Configuration:
76 =======================
77
78 Configuration is usually done using C preprocessor defines. Configuration
79 depends on the combination of board and CPU type; all such information is
80 kept in a configuration file "include/configs/<board_name>.h".
81
82 Example: For a H3 module, all configuration settings are in
83 "include/configs/omap1710h3.h".
84   
85 For all supported boards there are ready-to-use default
86 configurations available; just type "make <board_name>_config".
87
88 Example: For a H3 module type:
89
90         cd x-load
91         make omap1710h3_config
92
93 After a board has been configured, type "make" to build it supposing the
94 needed cross tools are in your path.
95
96  
97 Image Format:
98 =============
99
100 X-Loader expects OS boot loader (e.g. U-Boot) in Nand flash using
101 JFFS2 style ECC. 
102
103
104 Prepare Booting Nand Flash:
105 ===========================
106
107 After you have built x-load.bin for your board, you need to do the
108 followings to get it into Nand flash:
109
110 1. Use Texas Instruments IFT to sign x-load.bin. This results in a
111 signed image called x-load.bin.ift.
112 2. Use Texas Instruments FlashPrep to generate a .out file using
113 FlashWriterNand and specifying 0 as nand target address.
114 3. Use Texas instrumnets Code Composer Studio to run the .out file 
115 which flashes x-load.bin.ift to Nand flash.
116
117 Next you need to get your OS boot loader to Nand at the address your
118 X-Loader expects. For the H3 example, you can use U-Boot to flash U-Boot.
119 You can't use FlashWriterNand because it uses ROM code ECC style.  
120
121
122 More Information
123 ================
124
125 OMAP1710 NAND Booting Design Document has more information.
126
127 Implemenation notes:
128 ====================
129 H3, H4 support NAND flash booting
130 2430sdp & 3430sdp support OneNAND booting
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152