source: trunk/softs/tsar_boot/README.txt @ 395

Last change on this file since 395 was 390, checked in by cfuguet, 11 years ago

Reactivating commented command in the Makefile of the tsar_boot

File size: 2.9 KB
Line 
1TSAR BOOT LOADER
2
3Files:
4===============================================================================
5src/        Source files
6            The entry point of this boot loader is the file reset.S
7
8include/    Header files
9
10conf/       Platform specific files and ldscript examples.
11            For each platform, we must define a new directory.
12
13      --->  defs_platform.h:
14
15             This file is mandatory. This file defines the
16             NB_PROCS per cluster, the NB_CLUSTERS and the base address of
17             the TTY, IOC and XICU devices.
18             It defines also:
19              -> CACHE_COHERENCE
20                 This constant is used by the boot_ioc_read function to know
21                 if the buffer used to store the blocks from the block_device
22                 must be invalidated in the dcache after the transfert has
23                 finished.
24                                 0 means invalidation must be made.
25
26              -> INSTRUMENTATION
27                 Set value different to 0 if some instrumentation of the
28                 bootloader is needed.
29
30              -> CACHE_LINE_SIZE
31                 This constant defines the size in bytes of a cache line.
32
33              -> IRQ_PER_PROC
34                 This constant is used to know how many XICU irq outputs are
35                 connected to each processor.
36
37      --->  platform_soclib.dts:
38
39             Device tree file. It is mandatory if compiling
40             for a SOCLIB platform. If the application to execute does not use
41             a device tree file, create an empty one.
42
43      --->  platform_fpga.dts:
44
45             Device tree file. It is mandatory if compiling
46             for a FPGA platform. If the application to execute does not use
47             a device tree file, create an empty one.
48
49      --->  ldscript:
50
51             LD script defining the segments of this boot loader.
52             We define two segments:
53                seg_stack_base: Base address of the stack used by processor 0
54                during the boot process.
55
56                seg_boot_base: Base address of the code and data defined for
57                this loader
58           
59Makefile    Makefile for compile the boot loader.
60            Arguments to pass:
61
62             ---> PLATFORM_DIR=<platform_dir>
63   
64                   Defines the directory where to find the plateform specific
65                   files
66
67             ---> SOCLIB=1
68
69                   If using SOCLIB, define this flag to use the SOCLIB device
70                   drivers
71
72             ---> SYSCLK_FREQ=<value hz>
73
74                   If not SOCLIB platform, this flag allows us to choose the
75                   CLK frequency used in the hardware platform (i.e. FPGA).
76                   This information is used to configurate the SPI device
77                   which allow us to drive a SD card device.
78
79              i.e. make PLATFORM_DIR=conf/<platform_dir> SYSCLK_FREQ=50000000
80                   make PLATFORM_DIR=conf/<platform_dir> SOCLIB=1
Note: See TracBrowser for help on using the repository browser.