adding link between ifaces and clk

[blast.git] / AbstractInterface.h

diff --git a/AbstractInterface.h b/AbstractInterface.h
index 166fdbeb9d313b876ba33304aff88648b3dede5f..0e167dbc0039d992d4b7ec81a3ecaa6f51fcc655 100644 (file)
--- a/AbstractInterface.h
+++ b/AbstractInterface.h
@@ -30,6 +30,7 @@ public :
   enum IfaceDirection { AnyDirection = 0, Input = 1, Output = 2, InOut = 3 };  
   enum IfaceVHDLContext {AnyContext = 0, Entity = 1, Component = 2, Instance = 3, Signal = 4 };
   enum IfaceVHDLFlags { NoComma = 1 };
+  enum IfaceClockName { NoName = 0, ClockName, ParameterName };
 
   static int getIntDirection(QString str);
   static int getIntPurpose(QString str);
@@ -53,6 +54,9 @@ public :
   QString getDirectionString();  
   inline AbstractBlock *getOwner() { return owner;}
   inline AbstractInterface* getAssociatedIface() { return associatedIface; }
+  inline QString getClockIface() { return clkIface; }
+  inline int getClockIfaceType() { return clkIfaceType; }
+
 
   double getDoubleWidth() throw(QException);
   
@@ -67,6 +71,7 @@ public :
   void setPurpose(int _purpose);
   void setDirection(int _direction);
   bool setAssociatedIface(AbstractInterface* iface);
+  bool setClockIface(QString name);
   
   // testers
   virtual bool isReferenceInterface();
@@ -99,6 +104,17 @@ protected:
    * (NB: a test is done in the method to prevent the other case).
    */
   AbstractInterface* associatedIface;
+  /*!
+   * \brief clkIface represents the clock interface that is used in processes modifying this interface. It is only relevant for
+   * Data interfaces and clock outputs (that comes from a clkrstgen). Since Control interfaces are automatically associated to a
+   * Data interface, clkIface is "" for them. Wishbone interfaces
+   * In general, blocks have a single
+   * clock interface which is by default automatically connected to the main clock dispatched by the clkrstgen block in top group.
+   * Nevertheless, the designer has the possibility to connect the block taht owns this interface to another clkrstgen block.  Moreover,
+   * some blocks may have several clocks, e.g. dual port RAMs, FIFOs.
+   */
+  QString clkIface;
+  int clkIfaceType; // 0 for not affected, 1 for clock input name, 2 for user param name
   
   
 };