Changeset 758 for trunk/softs/tsar_boot/README

Timestamp:

Jul 24, 2014, 3:19:18 PM (10 years ago)

Author:

cfuguet

Message:

tsar_boot: improving configuration infrastructure

• Using hard_config.h which respects the same sintax that the hard_config.h file of all TSAR platforms. This file can be then generated by the GIET-VM genmap tool or written manually.

• All peripheral drivers have been moved to a drivers directory and they are compiled as a static library. This allows GCC to only include in the final .ELF the object files of used peripherals and not all of them.

• Example hard_config.h and ldscripts have been introduced in the conf directory.

• Improving comments in all files

File:

• trunk/softs/tsar_boot/README (modified) (2 diffs)

trunk/softs/tsar_boot/README

@@ -1 @@
-TSAR BOOT LOADER
+\author: Cesar Fuguet
+\date  : July 24, 2014
+
+TSAR BOOT-LOADER
 
 Files:
-===============================================================================
 src/        Source files
             The entry point of this boot loader is the file reset.S
@@ -8 +10 @@
 include/    Header files
 
-conf/       Platform specific files and ldscript examples.
+driver/     Drivers source files and headers
+
+conf/       Platform specific files and ldscript
             For each platform, we must define a new directory.
+            Mandatory files:
 
-            - defs_platform.h:
+              - hard_config.h (can be generated using giet-vm genmap tool)
 
-              This file is mandatory. This file defines the NB_PROCS per
-              cluster, the NB_CLUSTERS and the base address of the TTY, IOC,
-              XICU and MEMC (config) devices. It defines also:
+              - ldscript
 
-                #define USE_IOB
+            Optional files:
 
-                  This constant is used by the boot_ioc_read function to know
-                  if the buffer used to store the blocks from the block_device
-                  must be invalidated in the memory cache after the transfert
-                  has finished.
+              - platform.dts (platform device tree)
 
-                #define CACHE_COHERENCE
+Makefile    Makefile to compile the boot loader.
+            Mandatory arguments:
 
-                  This constant is used by the boot_ioc_read function to know
-                  if the buffer used to store the blocks from the block_device
-                  must be invalidated in the dcache after the transfert has
-                  finished.
+              - PLATFORM_DIR=<platform_dir>
 
-                #define CACHE_LINE_SIZE
-                  
-                  This constant is mandatory if CACHE_COHERENCE=0 or USE_IOB=1
-                  This constant defines the size in bytes of a cache line.
-
-                #define RESET_DEBUG
-
-                  Set value to 1 to show some debug messages during loading 
-
-                #define IRQ_PER_PROC
-
-                  This constant is used to know how many XICU irq outputs are
-                  connected to each processor.
-
-            - platform_soclib.dts:
-
-              Device tree file. It is mandatory if compiling for a SOCLIB
-              platform and USE_DT=1.
-
-            - platform_fpga.dts:
-
-              Device tree file. It is mandatory if compiling for a FPGA
-              platform and USE_DT=1.
-
-            - ldscript:
-
-              LD script defining the segments of this boot loader.
-              We define two segments:
-
-                seg_stack_base:
-
-                  Base address of the stack used by processor 0 during the boot
-                  process. read-write data and bss will also be there.
-
-                seg_boot_base:
-                
-                  Base address of the code and read-only data defined for this
-                  loader
-            
-Makefile    Makefile to compile the boot loader. Arguments to pass:
-
-              PLATFORM_DIR=<platform_dir>
-    
                 Defines the directory where to find the plateform specific
                 files
 
-              SOCLIB=1
+           Optional arguments:
 
-                If using SOCLIB, define this flag to use the BLOCK DEVICE
-                driver and to choose the platform_soclib device tree.
+              - USE_DT=<value>
 
-              RAMDISK=1
-
-                If using SOCLIB, define this flag to use a RAMDISK instead of
-                BLOCK DEVICE (Set this flag when the SOCLIB flag is also set)
-
-              USE_DT=0
-
+                Value can be 1 or 0.
                 If a device tree file is not used, set this flag to 0. It is
                 set by default to 1.
 
-              e.g. make PLATFORM_DIR=<platform_conf> \
-                        SOCLIB=1 \
-                        USE_DT=0 \
-                        RAMDISK=0
+              - SYSTEM_CLK=<platform clock frequency>
+
+                Platform clock frequency in KHz
+
+              - DTS=<file.dts>
+
+                Platform device tree (by default is platform.dts)
+
+Examples:
+
+    make PLATFORM_DIR=<platform_dir> USE_DT=0
+
+        Compile for <platform_dir> and do not compile device tree file
+
+    make PLATFORM_DIR=<platform_dir> DTS=platform_fpga.dts SYSTEM_CLK=25000
+
+        Compile for <platform_dir> and compile the 'platform_dpga.dts'
+        device tree file. System clock frequency is 25 MHz
+
+    make PLATFORM_DIR=<platform_conf> SYSTEM_CLK=25000
+
+        Compile for <platform_dir> and compile the 'platform.dts'
+        device tree file (default name). System clock frequency is 25 MHz
+