equivalent tiles: added documentation to read_arch_xml_arch.cpp

Signed-off-by: Alessandro Comodi <[email protected]>

Author: acomodi

libs/libarchfpga/src/read_xml_arch_file.cpp

@@ -302,7 +302,7 @@ void XmlReadArch(const char *ArchFile, const bool timing_enabled,
         Next = get_single_child(architecture, "tiles", loc_data);
         ProcessTilesTags(Next, Types, *NumTypes, *arch, arch_def_fc, loc_data);
 
-		/* Process directs */
+        /* Process directs */
         Next = get_single_child(architecture, "directlist", loc_data, OPTIONAL);
         if (Next) {
             ProcessDirects(Next, &(arch->Directs), &(arch->num_directs),
@@ -2816,7 +2816,24 @@ static void ProcessTilesTags(pugi::xml_node Node,
 	}
 }
 
-/* TODO Add documentation */
+/* Processes the equivalent tiles defined in the XML arch definition
+ * <tiles>
+ *   <tile name="LAB">
+ *     <mode name="MLAB">
+ *       <map .../>
+ *       <map .../>
+ *       <map .../>
+ *     </mode>
+ *   </tile>
+ * </tiles>
+ *
+ * In particular this function parses the `modes` (if they exist) of each tile
+ * and adds the equivalent tile information to the t_type_descriptor relative to
+ * the current tile.
+ * It populates the following t_type_descriptor members:
+ *     - num_equivalent_tiles;
+ *     - equivalent_tiles.
+ */
 static void ProcessTileExtraModes(pugi::xml_node Node,
 		t_type_descriptor *Type,
 		t_type_descriptor **Types,
@@ -2848,7 +2865,11 @@ static void ProcessTileExtraModes(pugi::xml_node Node,
 	}
 }
 
-/* TODO: Add documentation */
+/* Processes the pin_mapping of each equivalent tile.
+ * It goes through each mode and populates the following t_type_descriptor memebrs:
+ *     - equivalent_tile_pin_mapping;
+ *     - equivalent_tile_inverse_pin_mapping.
+ */
 static void ProcessTileExtraModePinMapping(pugi::xml_node Node,
 		t_type_descriptor *Type,
 		t_type_descriptor *EquivalentType,