Changeset 217

Timestamp:

Sep 19, 2012, 9:15:52 AM (12 years ago)

Author:

alain

Message:

Introducing comments in xml_parser.c

File:

• soft/giet_vm/xml/xml_parser.c (modified) (8 diffs)

soft/giet_vm/xml/xml_parser.c

@@ -5 +5 @@
 // Copyright (c) UPMC-LIP6
 ///////////////////////////////////////////////////////////////////////////////////////
-// This program translate an xml file containing a MAPPING_INFO data structure 
-// to a binary file that can be directly loaded in the boot ROM and used by the GIET.
-// The C strcutures are defined in the mapping_info.h file.
+// This program translate a "map.xml" source file to a binary file "map.bin" that 
+// can be directly loaded in the boot ROM and used by the GIET-VM operating system.
+//
+// This map.xml file contains :
+// 1) the multi-cluster/multi-processors hardware architecture description
+// 2) the various multi-threaded software applications
+// 3) the mapping directives bor both the tasks and the virtual segments.
+// The corresponding C structures are defined in the "mapping_info.h" file.
+// 
+// This program also generates the "hard_config.h" and the "giet_vsegs.ld" files,
+// required  to compile the GIET-VM code. 
 ///////////////////////////////////////////////////////////////////////////////////////
 
@@ -35 +43 @@
 #define MAX_PERIPHS             8192
 
-#define XML_PARSER_DEBUG        0
+#define XML_PARSER_DEBUG   0
 
 ///////////////////////////////////////////////////////////////////////////////////
@@ -2067 +2075 @@
 }
 
-
+//////////////////////////////////////////
 void file_write(int fdout, char* towrite)
 {
@@ -2078 +2086 @@
 }
 
+//////////////////////////////////////////////////
 void def_int_write(int fdout, char* def, int num)
 {
@@ -2083 +2092 @@
     sprintf(buf, "#define\t %s  %d\n", def, num);
     file_write(fdout, buf);
-
 }
 
+/////////////////////////////////////////////////
 void def_hex_write(int fdout, char* def, int num)
 {
@@ -2093 +2102 @@
 }
 
-///////////////////////////
+///////////////////////////////////////
 void  genHd( const char* file_path )
-///////////////////////////
+///////////////////////////////////////
 {
     int fdout = open_file(file_path);
 
-    char* prol = " /* AUTO GENRATED FILE */\n\n#ifndef _HD_CONFIG_H\n#define _HD_CONFIG_H\n\n";
+    char* prol = " /* Generated from the mapping_info file */\n\n#ifndef _HD_CONFIG_H\n#define _HD_CONFIG_H\n\n";
     file_write(fdout, prol);
 
     def_int_write(fdout, "CLUSTER_X"       , cluster_x);
     def_int_write(fdout, "CLUSTER_Y"       , cluster_y);
-    def_int_write(fdout, "NB_CLUSTERS"      , cluster_index);
+    def_int_write(fdout, "NB_CLUSTERS"     , cluster_index);
     def_hex_write(fdout, "CLUSTER_SIZE"    , ( ((unsigned long)1) << 32)/cluster_index);
-    def_int_write(fdout, "NB_PROCS_MAX"     , nb_proc_max);
+    def_int_write(fdout, "NB_PROCS_MAX"    , nb_proc_max);
     def_int_write(fdout, "NB_TIMERS_MAX"   , nb_timer_channel_max);
     def_int_write(fdout, "NB_DMAS_MAX"     , nb_dma_channel_max);
@@ -2123 +2132 @@
 }
 
+////////////////////////////////////////////////////////
 void ld_write(int fdout, char* seg, unsigned int addr)
 {
@@ -2131 +2141 @@
 }
 
-///////////////////////////
+///////////////////////////////////////
 void  genLd( const char* file_path )
-///////////////////////////
+///////////////////////////////////////
 {
     int fdout = open_file(file_path);
 
-    char* prol = "/* AUTO GENRATED FILE */\n\n";
+    char* prol = "/* Generated from the mapping_info file */\n\n";
     file_write(fdout, prol);