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

Last change on this file since 389 was 388, checked in by cfuguet, 11 years ago

Modifications in tsar/trunk/softs/tsar_boot:

  • Improving the boot_ioc_read when using a SD card in FPGA platform.
  • Adding some instrumentation on the SD card driver (under preprocessor conditional directives).
  • Including Doxyfile for generate documentation using doxygen.
  • Improving the Makefile to include doc generation.
File size: 2.8 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              -> CACHE_LINE_SIZE
27                 This constant defines the size in bytes of a cache line.
28
29              -> IRQ_PER_PROC
30                 This constant is used to know how many XICU irq outputs are
31                 connected to each processor.
32
33      --->  platform_soclib.dts:
34
35             Device tree file. It is mandatory if compiling
36             for a SOCLIB platform. If the application to execute does not use
37             a device tree file, create an empty one.
38
39      --->  platform_fpga.dts:
40
41             Device tree file. It is mandatory if compiling
42             for a FPGA platform. If the application to execute does not use
43             a device tree file, create an empty one.
44
45      --->  ldscript:
46
47             LD script defining the segments of this boot loader.
48             We define two segments:
49                seg_stack_base: Base address of the stack used by processor 0
50                during the boot process.
51
52                seg_boot_base: Base address of the code and data defined for
53                this loader
54           
55Makefile    Makefile for compile the boot loader.
56            Arguments to pass:
57
58             ---> PLATFORM_DIR=<platform_dir>
59   
60                   Defines the directory where to find the plateform specific
61                   files
62
63             ---> SOCLIB=1
64
65                   If using SOCLIB, define this flag to use the SOCLIB device
66                   drivers
67
68             ---> SYSCLK_FREQ=<value hz>
69
70                   If not SOCLIB platform, this flag allows us to choose the
71                   CLK frequency used in the hardware platform (i.e. FPGA).
72                   This information is used to configurate the SPI device
73                   which allow us to drive a SD card device.
74
75              i.e. make PLATFORM_DIR=conf/<platform_dir> SYSCLK_FREQ=50000000
76                   make PLATFORM_DIR=conf/<platform_dir> SOCLIB=1
Note: See TracBrowser for help on using the repository browser.