Add MAD boot example for SCBP6618X
[keystone-rtos/mcsdk-tools.git] / boot_loader / examples / mad / docs / README.txt
1 Introduction:
3 A simple example using MAD tools to link NDK Client image (running on Core 0) and Hello World image (running on 
4 non-zero Cores) into a BBLOB image with MAD loader. The BBLOB image can be loaded by IBL via TFTP and the MAD loader will
5 boot NDK Client on Core 0 and Hello World on non-zero Cores.
8 Directory structure:
10 docs           - directory contains the README.txt
11 mad_helloworld - directory contains the Hello World example
12 utils          - directory contains utilities used with this example (e.g. MAD tool configurations)
15 Steps to build the Hello World example:
17 1. Import the mad_helloworld CCS project from tools\boot_loader\examples\mad\mad_helloworld\scbp6618x directory. (in CCSv5, 
18    Project->Import Existing CCS/CCE Eclipse Projects)
20 2. Clean the mad_helloworld project and re-build the project, after build is completed, mad_helloworld_scbp6618x.out and 
21 will be generated under tools\boot_loader\examples\mad\mad_helloworld\scbp6618x\Debug directory
22    (for little endian build) or tools\boot_loader\examples\mad\mad_helloworld\scbp6618x\DebugBE directory (for big enidan build).
25 Steps to build the NDK Client example:
27 1. Import the NDK Client CCS project from examples\ndk\client\scbp6618x directory. (in CCSv5, 
28    Project->Import Existing CCS/CCE Eclipse Projects)
30 2. Clean the NDK Client project and re-build the project, after build is completed, client_scbp6618x.out and 
31 will be generated under examples\ndk\client\scbp6618x\Debug directory
32    (for little endian build) or examples\ndk\client\scbp6618x\DebugBE directory (for big enidan build).
35 Multicore booting using MAD utilities (2.0.1+ feature)
37 The detailed information on the Multicore Application Deployment a.k.a MAD utility is provided in MAD user guide page. 
38 The BIOS MCSDK installation provides MAD tool in <MCSDK INSTALL DIR>\tools\boot_loader\mad-utils. This package contains 
39 necessary tools to link multiple applications to a single bootable image. 
41 The NDK Client and Hello World should have following updates to create a MAD image: 
43 1. The master (NDK Client) and slave (Hello World) images are linked with --dynamic and --relocatable options. 
44 2. The MAD config files (both little and big endians) used to link the master and slave programs are provided in 
45    tools\boot_loader\examples\mad\utils\scbp6618x\config-files. Following are few items to note on the config file. 
46    * maptoolCfg_scbp6618x_windows_#e.json has the directory and file name information for the tools 
47    * deployment_template_scbp6618x_windows_#e.json has the deployment configuration (it has device name, partition 
48      and application information). 
49    * For C66x devices, the physical address is 36 bits and virtual address is 32 bits 
50    * The secNamePat element string is a regular expression string 
51    * The sections bss, neardata, rodata must be placed in one partition and in the order it is shown here 
52 3. The build script tools\boot_loader\examples\mad\utils\scbp6618xl\build_mad_image_#e.bat can be used to re-create the image,
53    customer may need to modify the script to set the PATH of the Code Gen and Python tools installed.
54 4. The bootable image is placed in tools\boot_loader\examples\mad\utils\scbp6618x\images 
57 Booting the application image using IBL 
59    Please refer to tools\boot_loader\ibl\doc\scbp6618-instructions.txt, after the IBL boots the application image, 
60    Core 0 will be running NDK client server and print out the server IP address to the UART console, non-zero cores
61    will be running the Hello World and write 0xBABEFACE to the last word of local L2 memory (0x8ffffc for C6670).
63    To verify the IBL booting, customer can set the pin 8 to "off" on dip switch S1 to print the DSP UART output and 
64    use TELNET to connect to ARM to send the commands.
66 Notes:
67 1. Please refer to the MAD Utilities User's Guide ( for 
68    more details.
69 2. Please refer to the Image Processing User's Guide 
70    ( for more details.