Changes between Version 19 and Version 20 of Writing Rules/Caba

Timestamp:

Sep 7, 2007, 5:28:27 PM (17 years ago)

Author:

alain

Comment:

--

Writing Rules/Caba

@@ -39 +39 @@
 will communicate through a "flat", shared address space, and all system interconnect will respect the VCI advanced standard. Therefore, most SoCLib components have  VCI interfaces :
 
-[[Image(WritingRules:mandatory.png, nolink)]]
-
-All SoCLib hardware components having a VCI interface is called a ''VCI component'', and must include 
+Any SoCLib hardware components having a VCI interface is called a ''VCI component'', and must include 
 at least one of the the two following files, defining the VCI advanced ports :
  * [source:trunk/soclib/systemc/include/caba/interface/vci_target.h caba/interface/vci_target.h]
@@ -64 +62 @@
 }}}
 
-[[Image(WritingRules:mandatory.png, nolink)]]
-
 The SystemC top cell defining the system architecture must include the following file, defining the advanced VCI signals :
  * [source:trunk/soclib/systemc/include/caba/interface/vci_signals.h caba/interface/vci_signals.h].
 
-[[Image(WritingRules:guideline.png, nolink)]]
-
 A SoCLib hardware component that has no VCI interface should use a dedicated VCI  wrapper in order to be connected to the VCI interconnect.
 
 == B3) Address space segmentation ==
 
-[[Image(WritingRules:guideline.png, nolink)]]
 In a shared memory architecture, the address space segmentation (or memory map) is a global characteristic of the system. 
 This memory map must be defined by the system designer, and is used by both software, and hardware components.
@@ -85 +78 @@
    command packet. Therefore, the base address and size of the segment allocated to a given
    VCI target must be ''known'' by this target.
- * A cache controller supporting uncached segments must contain a ''cacheability table''
+ * A cache controller supporting uncached segments can contain a ''cacheability table''
    addressed by the VCI address MSB bits.
-
-[[Image(WritingRules:guideline.png, nolink)]]
 
 In order to simplify the memory map definition, and the hardware component configuration, a
@@ -109 +100 @@
 == B4) Component definition ==
 
-[[Image(WritingRules:guideline.png, nolink)]]
-
 The component ''XXX.h'' file contains the following informations
 
@@ -143 +132 @@
 '''Structural parameters definition'''
 
-All structural parameters must be be defined as member variables. The values are generally defined by a constructor argument.
+All structural parameters should be be defined as member variables. The values are generally defined by a constructor argument.
 Instance name is stored in [source:trunk/soclib/systemc/include/common/base_module.h soclib::common::BaseModule], inherited by
 [source:trunk/soclib/systemc/include/caba/util/base_module.h soclib::caba::BaseModule].