PR/Applications/HWSim/HWSim__PingPong__HWDef

changeset 27:fb4970a0c337 tip

fix up comment in main.c
author kshalle
date Wed, 25 Feb 2015 15:40:06 -0800
parents 0deed3ee0b02
children
files main.c
diffstat 1 files changed, 20 insertions(+), 2 deletions(-) [+]
line diff
     1.1 --- a/main.c	Wed Feb 25 15:20:16 2015 -0800
     1.2 +++ b/main.c	Wed Feb 25 15:40:06 2015 -0800
     1.3 @@ -16,9 +16,27 @@
     1.4  
     1.5  
     1.6  
     1.7 -/* This sample code shows
     1.8 +/*This Hello World sample code demonstrates the bare structure of an HWSim
     1.9 + * based simulator.
    1.10 + *The application code creates a netlist, which is populated with element
    1.11 + * structures and activity structures.
    1.12 + *The elements register activities, which represent triggered behaviors.
    1.13 + * During a run, the arrival of a communication on the inport of an 
    1.14 + * element triggers the registered activity, which in turn calls the
    1.15 + * activity's behavior function and its time-width calculation function.
    1.16 + *The behavior function can access and modify the state of the element,
    1.17 + * and it can send out communications on the elements outports.
    1.18 + *When a communication is sent, a separate function is called to calculate
    1.19 + * the time of flight of that communication.
    1.20   *
    1.21 - * 
    1.22 + *Commands of the HWSim langlet are invoked by calling a function.  Such
    1.23 + * functions have a name that begins with "HWSim__" for example,
    1.24 + * "HWSim__run_simulation" is a command to tell HWSim to perform a
    1.25 + * simulation run.
    1.26 + *
    1.27 + *Data structures that are defined by the HWSim langlet have names that
    1.28 + * begin with "HWSim", for example "HWSimNetlist" is a data structure 
    1.29 + * defined by the HWSim langlet.
    1.30   */
    1.31  
    1.32  int main(int argc, char **argv)