Changes between Version 14 and Version 15 of Writing Rules/Caba


Ignore:
Timestamp:
Mar 28, 2007, 2:50:20 PM (18 years ago)
Author:
Nicolas Pouillon
Comment:

Separate guidelines

Legend:

Unmodified
Added
Removed
Modified

  • Writing Rules/Caba

    v14 v15  
    77
    88This manual describes the modeling rules for writing "cycle-accurate / bit-accurate" SystemC simulation models for SoCLib. Models complying with those rules can be used with the "standard" OSCI simulation engine (SystemC 2.x), but can be used also with others simulation engines, such as [SystemCass SystemCASS], which is optimized for such models.
     9
     10Besides you may also want to follow some [WritingRules/NamingGuidelines naming guidelines] that increase code readability.
    911
    1012Those modeling rules are based on the "Synchronous Communicating Finite State Machines" theory. The idea is to force the "event driven" SystemC simulation engine to run as a cycle based simulator.
    … …  
    113115
    114116Any hardware component using the memory map should have a constant reference to the mapping table as constructor argument.
    115 
    116 = Naming conventions =
    117 
    118 The following conventions are not mandatory, but can help to read the code.
    119  * All port names should be prefixed with `p_`
    120  * All internal register names should be prefixed with `r_`
    121  * All member variables should be prefixed with `m_`
    122 
    123 These rules can help understanding variables semantics or
    124 having a [wiki:EditorUtils/EmacsHighlight better syntax highlight].
    125117
    126118= Component ressources =