Build: update setupenvLnx.sh to do error checking
[keystone-rtos/ibl.git] / doc / build_instructions.txt
1 =====================================================
2 C6x Bootloader Build Instructions
3 =====================================================
5 1) Supported EVM's:
6     - C6678 LC EVM
7     - C6670 LC EVM
8     - C6474 LC EVM
9     - C6474 Mezzanine EVM
10     - C6472 LC EVM
11     - C6457 LC EVM
12     - DSK6455 EVM
14 2) Supported ENDIAN
15     - big
16     - little
18 3) Required toolset
19     - TI CGEN compiler CGT_C6000_7.2.0
21    Requirements for building IBL on Windows:
22    For building on a Windows machine, a GNU development environment is
23    required. MinGW installation is required for this. 
24    MinGW project link: http://www.mingw.org/
25    MinGW installer can be obtained from the following link
26    http://sourceforge.net/projects/mingw/files/Automated%20MinGW%20Installer/mingw-get-inst/mingw-get-inst-20110316/mingw-get-inst-20110316.exe/download
27    While installing MinGW following options have to be chosen:
28     1.  MinGw Compiler Suite
29         -   C Compiler
30     2. MinGW Developer Toolkit 
31  
32 4) Build Instructions
34     - Change directory to ibl\src\make
35     - Modify the environment setup script to match the tool chain installation
36       directory:
37         For building in MINGW-MSYS Bash shell modify setupenvMsys.sh 
38         For building in Linux Bash shell modify setupenvLnx.sh 
39     - Set the environment variables:
40          On a Linux Bash shell run  "source setupenvLnx.sh"
41          On a MinGW-MSYS Bash shell "source setupenvMsys.sh"
42     - Following are the commands for building IBL:
43         For C6678 Low Cost EVM:
44         
45         make evm_c6678_i2c ENDIAN=little I2C_BUS_ADDR=0x51 
46         Output images:
47         IBL image: bin/i2crom_0x51_c6678_le.dat (CCS data format)
48                  : bin/i2crom_0x51_c6678_le.bin (raw binary)
50         make evm_c6678_i2c ENDIAN=big I2C_BUS_ADDR=0x51 
51         Output images:
52         IBL image: bin/i2crom_0x51_c6678_be.dat (CCS data format)
53                  : bin/i2crom_0x51_c6678_be.bin (raw binary)
55       
56         For C6670 Low Cost EVM:
57         
58         make evm_c6670_i2c ENDIAN=little I2C_BUS_ADDR=0x51 
59         Output images:
60         IBL image: bin/i2crom_0x51_c6670_le.dat (CCS data format)
61                  : bin/i2crom_0x51_c6670_le.bin (raw binary)
63         make evm_c6670_i2c ENDIAN=big I2C_BUS_ADDR=0x51 
64         Output images:
65         IBL image: bin/i2crom_0x51_c6670_be.dat (CCS data format)
66                  : bin/i2crom_0x51_c6670_be.bin (raw binary)
69         For C6474 LC EVM
71         make evm_c6474l ENDIAN=little 
72         Output images:
73         IBL image: bin/i2crom_0x50_c6474l_le.dat (CCS data format)
74                  : bin/i2crom_0x50_c6474l_le.bin (raw binary)
76         make evm_c6474l ENDIAN=big 
77         Output images:
78         IBL image: bin/i2crom_0x50_c6474l_be.dat (CCS data format)
79                  : bin/i2crom_0x50_c6474l_be.bin (raw binary)
81         For C6474 Mezzanine EVM
83         make evm_c6474 ENDIAN=little 
84         Output images:
85         IBL image: bin/i2crom_0x50_c6474_le.dat (CCS data format)
86                  : bin/i2crom_0x50_c6474_le.bin (raw binary)
88         make evm_c6474 ENDIAN=big 
89         Output images:
90         IBL image: bin/i2crom_0x50_c6474_be.dat (CCS data format)
91                  : bin/i2crom_0x50_c6474_be.bin (raw binary)
93         For C6472 LC EVM
95         make evm_c6472 ENDIAN=little 
96         Output images:
97         IBL image: bin/i2crom_0x50_c6472_le.dat (CCS data format)
98                  : bin/i2crom_0x50_c6472_le.bin (raw binary)
100         make evm_c6472 ENDIAN=big 
101         Output images:
102         IBL image: bin/i2crom_0x50_c6472_be.dat (CCS data format)
103                  : bin/i2crom_0x50_c6472_be.bin (raw binary)
105         For C6457 LC EVM
107         make evm_c6457 ENDIAN=little 
108         Output images:
109         IBL image: bin/i2crom_0x50_c6457_le.dat (CCS data format)
110                  : bin/i2crom_0x50_c6457_le.bin (raw binary)
112         make evm_c6457 ENDIAN=big 
113         Output images:
114         IBL image: bin/i2crom_0x50_c6457_be.dat (CCS data format)
115                  : bin/i2crom_0x50_c6457_be.bin (raw binary)
118         For DSK 6455 EVM
120         make evm_c6455 ENDIAN=little 
121         Output images:
122         IBL image: bin/i2crom_0x50_c6455_le.dat (CCS data format)
123                  : bin/i2crom_0x50_c6455_le.bin (raw binary)
125         make evm_c6455 ENDIAN=big 
126         Output images:
127         IBL image: bin/i2crom_0x50_c6455_be.dat (CCS data format)
128                  : bin/i2crom_0x50_c6455_be.bin (raw binary)
131         
134                  
137