annotate CircuitNetlistCreator.c @ 18:b0e9969d8d15

first runnable version (very buggy)
author hausers
date Mon, 20 Feb 2012 19:07:31 +0100
parents fa277c6ce6f2
children ba3883d39e62
rev   line source
Me@11 1 /*
Me@11 2 * Copyright 2011 OpenSourceStewardshipFoundation.org
Me@11 3 * Licensed under GNU General Public License version 2
Me@11 4 *
Me@11 5 * Author: seanhalle@yahoo.com
Me@11 6 *
Me@11 7 */
Me@14 8 #include "HWSim__PingPong__HWDef/HWSim__PingPong__HWDef.h"
Me@11 9
Me@14 10 /*'' is an expr resolves to an actual commPath struct instance
Me@11 11 */
Me@14 12 #define setCommPathValuesTo( commPath, fromElIdx, outPort, toElIdx, inPort,\
hausers@16 13 timeFnPtr, dataPtr)\
Me@11 14 do{\
Me@14 15 commPath->idxOfFromElem = fromElIdx; \
Me@14 16 commPath->idxOfFromOutPort = fromElIdx; \
Me@14 17 commPath->idxOfToElem = toElIdx; \
Me@14 18 commPath->idxOfToInPort = inPort; \
hausers@16 19 commPath->commTimeCalcFn = timeFnPtr;\
Me@14 20 commPath->archSpecCommPathData = dataPtr; \
Me@11 21 }while(0); //macro magic for namespace
hausers@12 22
hausers@12 23
hausers@18 24
Me@14 25 HWSimActivityType* createPingPongActivityType ();
hausers@12 26
Me@14 27 HWSimElem* createAPingPongElem (HWSimNetlist *netlist);
hausers@12 28
Me@11 29 /*This file constructs the netlist for the Hello World circuit, which is
Me@11 30 * used during design and implementation of the HWSim language
Me@11 31 *
Me@14 32 *It has two elements, each with one input port and one output port, and
Me@14 33 * a single activity-type.
Me@11 34 *
Me@14 35 *The elements are cross-coupled, so output port of one connects to input
Me@11 36 * port of the other. The input port has a single trigger, which fires
Me@14 37 * the one activity-type.
Me@11 38 *
Me@14 39 *The activity does nothing, except send a NULL message on the output port.
Me@14 40 *The activity-sim-time and communication-sim-time are both constants.
Me@11 41 *
Me@14 42 *Note that elements are generic. They are specialized by declaring
Me@11 43 * inports and outports, and by registering triggers that fire particular
Me@14 44 * activity-types.
Me@11 45 */
Me@11 46 HWSimNetlist *createPingPongNetlist()
Me@11 47 { HWSimNetlist *netlist;
Me@14 48 HWSimCommPath **commPaths;
Me@14 49 HWSimElem **elems;
Me@14 50 int32 numElems;
Me@14 51 int32 numCommPaths;
Me@11 52
Me@11 53 netlist = malloc( sizeof(HWSimNetlist) );
hausers@16 54 numElems= 2;
Me@14 55 elems = malloc( numElems * sizeof(HWSimElem) );
Me@14 56 netlist->numElems = numElems;
Me@14 57 netlist->elems = elems;
Me@14 58 netlist->numActivityTypes = 1;
Me@14 59 netlist->activityTypes = malloc(netlist->numActivityTypes*sizeof(HWSimActivityType*));
Me@14 60 netlist->activityTypes[PING_PONG_TYPE] = createPingPongActivityType();
Me@14 61 elems[0] = createAPingPongElem( netlist ); //use info from netlist
Me@14 62 elems[1] = createAPingPongElem( netlist );
Me@14 63 //on one of the elems, make reset trigger an action
hausers@17 64 //Stefan: FIXME
Me@14 65 elems[1]->inPorts[-1].triggeredActivityType =
Me@14 66 netlist->activityTypes[PING_PONG_TYPE]; //Connect elems together
Me@11 67
Me@14 68 /*OutPorts and InPorts may have many commPaths attached.
Me@14 69 * but an inPort only
Me@14 70 * has one kind of activity that all incoming communications trigger. That
Me@14 71 * activity can be zero time and then switch on the type of message then
Me@14 72 * end with a continuation, where the continuation activity is chosen by the
Me@11 73 * switch.
Me@14 74 *So, a commPath only connects an out port to an in port
Me@11 75 *The format is: sending TL-index, out-port, dest TL-index, in-port
Me@11 76 */
Me@14 77 numCommPaths = 2;
Me@14 78 commPaths = malloc( numCommPaths * sizeof(HWSimCommPath) );
Me@14 79 netlist->numCommPaths= numCommPaths;
Me@14 80 netlist->commPaths= commPaths;
Me@14 81 //TL 0, out-port 0 to TL 1, in-port 0
hausers@18 82 commPaths[0]= malloc(sizeof(HWSimCommPath));
hausers@16 83 setCommPathValuesTo(commPaths[0],0,0,1,0, commPath_TimeSpanCalc, NULL);
Me@14 84 //TL 1, out-port 0 to TL 0, in-port 0
hausers@18 85 commPaths[1]= malloc(sizeof(HWSimCommPath));
hausers@16 86 setCommPathValuesTo(commPaths[1], 1,0,0,0, commPath_TimeSpanCalc, NULL);
Me@14 87
Me@14 88 //TODO: decide how do in-out bidirectional commPaths -- thinking make it two
Me@14 89 // separate commPaths with guard between in-port and out-port
hausers@16 90
hausers@16 91 return netlist;
Me@11 92 }
Me@11 93
Me@14 94 //Stefan: copy netlist struct with VMS malloc after VMS initialized?
hausers@16 95 //Sean: yes, otherwise the user has to deal with VMS details.
hausers@16 96 // So we should do this in HWSim__make_netlist_simulatable ?
hausers@16 97 // If so, I can do this
Me@14 98 HWSimElem *
Me@14 99 createAPingPongElem( HWSimNetlist *netlist )
Me@14 100 { HWSimElem *TL;
Me@14 101 TL = malloc( sizeof(HWSimElem) );
Me@11 102 TL->numInPorts = 1;
Me@11 103 TL->numOutPorts = 1;
Me@11 104 TL->inPorts = HWSim_ext__make_inPortsArray( TL->numInPorts );
Me@14 105 TL->inPorts[-1].triggeredActivityType = IDLE_SPAN; //reset port
Me@14 106 TL->inPorts[0].triggeredActivityType = netlist->activityTypes[PING_PONG_TYPE];
hausers@16 107 return TL;
Me@11 108 }
Me@11 109
Me@14 110 HWSimActivityType *
Me@14 111 createPingPongActivityType( )
Me@14 112 { HWSimActivityType *pingPongActivityType;
Me@14 113 pingPongActivityType = malloc( sizeof(HWSimActivityType) );
Me@14 114 pingPongActivityType->behaviorFn = &pingPongElem_PingActivity_behavior;
Me@14 115 pingPongActivityType->timingFn = &pingPongElem_PingActivity_timing;
Me@14 116 return pingPongActivityType;
Me@11 117 }
hausers@12 118