more verbose logging
[pandora-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 3430SDP board (OMAP3430) has been implemented
40 and tested. (Dec 2006)
41
42
43 Support for other OMAP boards can be added.
44  
45   
46 Directory Hierarchy:
47 ====================
48
49 - board         Board dependent files
50 - cpu           CPU specific files
51 - drivers       Commonly used device drivers
52 - lib           Libraries
53  
54 - cpu/arm1136 Files specific to ARM 1136 CPUs
55 - cpu/omap3 Files specific to ARM CortexA8 CPU
56
57  
58 - board/omap3430sdp
59                 Files specific to OMAP 3420sdp boards
60
61  
62 Software Configuration:
63 =======================
64
65 Configuration is usually done using C preprocessor defines. Configuration
66 depends on the combination of board and CPU type; all such information is
67 kept in a configuration file "include/configs/<board_name>.h".
68
69 Example: For a OMAP4 PandaBoard, all configuration settings are in
70 "include/configs/omap4430panda.h"
71   
72 For all supported boards there are ready-to-use default
73 configurations available; just type "make <board_name>_config".
74
75 Example: For a OMAP4 PandaBoard, type:
76
77         cd x-load
78         make omap4430panda_config
79
80 After a board has been configured, type "make" to build it supposing the
81 needed cross tools are in your path.
82
83  
84 Image Format:
85 =============
86
87 X-Loader expects OS boot loader (e.g. U-Boot) in Nand flash using
88 JFFS2 style ECC. 
89
90
91 Prepare Booting Nand Flash:
92 ===========================
93
94 After you have built x-load.bin for your board, you need to do the
95 followings to get it into Nand flash:
96
97 1. Use Texas Instruments IFT to sign x-load.bin. This results in a
98 signed image called x-load.bin.ift.
99 2. Use Texas Instruments FlashPrep to generate a .out file using
100 FlashWriterNand and specifying 0 as nand target address.
101 3. Use Texas instrumnets Code Composer Studio to run the .out file 
102 which flashes x-load.bin.ift to Nand flash.
103
104 Next you need to get your OS boot loader to Nand at the address your
105 X-Loader expects. For the H3 example, you can use U-Boot to flash U-Boot.
106 You can't use FlashWriterNand because it uses ROM code ECC style.  
107
108 Implemenation notes:
109 ====================
110 3430sdp support OneNAND booting
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132