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