Changes between Version 3 and Version 4 of Writing Rules/General

Timestamp:

Apr 27, 2007, 12:18:38 AM (17 years ago)

Author:

Nicolas Pouillon

Comment:

Formatting, typos, cosmetic changes

Writing Rules/General

@@ -5 +5 @@
 [[PageOutline]]
 
-= A) Naming conventions =
+= Naming conventions =
 
-'''namespaces'''
+== Namespaces ==
 
 SystemC being build upon C++, we use the C++ namespace constructs, to create unambiguous names.
@@ -14 +14 @@
  * `soclib::common`
  * `soclib::caba`
- *`soclib::tlmt`
+ * `soclib::tlmt`
  
-'''variables'''
+== Variables ==
 
 The following conventions have been defined :
@@ -23 +23 @@
  * All component member variable names should be prefixed with `m_`
 
-= B) VCI initiators and targets indexation =
+= VCI initiators and targets indexation =
 
 In a VCI-based architecture, all initiators and targets must be indexed. Initiators and targets have different address spaces.
- * The target index is used by interconnect components : those components decode the VCI address MSB bits to get the target index and route the VCI command packets.
- * The initiator index is used by the interconnect components to route the VCI response packets : the initiator index is the VCI SRCID value.
+ * The target index is used by interconnect components to route the VCI command packets : the target index is decoded from VCI ADDRESS MSBs.
+ * The initiator index is used by the interconnect components to route the VCI response packets : the initiator index is the VCI RSRCID.
 
 Indexes can be :
  * a simple scalar index, in  case of a ''flat'' interconnect.
- * a composite index, in case of a ''clusterised'' architecture, using a two level hierarchical interconnect. Each component is identified by two scalars: cluster_index, local_index. 
+ * a composite index, in case of a ''clusterised'' architecture, using a two-level (or more) hierarchical interconnect.
 
-The `common/int_tab.h`file defines an utility class storing a list of indexes : All indexes must be declared as IntTabs.
+[source:trunk/soclib/systemc/include/common/int_tab.h "include/common/int_tab.h"] defines an utility class storing a list of indexes.
 
-= C) Endianness =
+All indexes must be declared as IntTabs.
 
-All SoCLib targets components respect the little-endianness convention.
-In case of write, the bytes transfers are fully controlled by the VCI BE bits :
- * If the VCI word is larger than one byte, the LSB bits of the VCI ADDRESS are ignored, and the VCI ADDRESS is only used to address the selected VCI word.
- *  the selected bytes are specified the VCI BE field, and the BE0 bit is always associated to the Byte 0 of the VCI WDATA field.
- 
+= Endianness =
+
+All SoCLib targets components are little-endian.
+In case of write, the bytes positions are fully controlled by the VCI BE bits :
+ * LSBs of the VCI ADDRESS are ignored, and the VCI ADDRESS is only used to select a VCI cell (a word in memory).
+ * Bytes are selected by the VCI BE field, and the BE![0] bit is always associated to the Byte 0 of the VCI WDATA field (ie WDATA![7:0]).