00001 // 00002 // Copyright (c) 2005-2008 Kenichi Watanabe. 00003 // Copyright (c) 2005-2008 Yasuhiro Watari. 00004 // Copyright (c) 2005-2008 Hironori Ichibayashi. 00005 // Copyright (c) 2008-2009 Kazuo Horio. 00006 // Copyright (c) 2009-2013 Naruki Kurata. 00007 // Copyright (c) 2005-2013 Ryota Shioya. 00008 // Copyright (c) 2005-2013 Masahiro Goshima. 00009 // 00010 // This software is provided 'as-is', without any express or implied 00011 // warranty. In no event will the authors be held liable for any damages 00012 // arising from the use of this software. 00013 // 00014 // Permission is granted to anyone to use this software for any purpose, 00015 // including commercial applications, and to alter it and redistribute it 00016 // freely, subject to the following restrictions: 00017 // 00018 // 1. The origin of this software must not be misrepresented; you must not 00019 // claim that you wrote the original software. If you use this software 00020 // in a product, an acknowledgment in the product documentation would be 00021 // appreciated but is not required. 00022 // 00023 // 2. Altered source versions must be plainly marked as such, and must not be 00024 // misrepresented as being the original software. 00025 // 00026 // 3. This notice may not be removed or altered from any source 00027 // distribution. 00028 // 00029 // 00030 00031 00032 #ifndef SIM_TIME_WHEEL_CLOCKED_RESOURCE_IF_H 00033 #define SIM_TIME_WHEEL_CLOCKED_RESOURCE_IF_H 00034 00035 #include "Types.h" 00036 #include "Sim/ResourcePriority.h" 00037 00038 namespace Onikiri 00039 { 00040 // 00041 class ClockedResourceIF 00042 { 00043 public: 00044 00045 virtual ~ClockedResourceIF(){}; 00046 00047 // 00048 // --- These methods corresponds to 1-cycle behavior. 00049 // 00050 // Decide what to do in Evaluate(), and update those in Update(). 00051 // 00052 00053 // Beginning of a cycle 00054 virtual void Begin() = 0; 00055 00056 // Evaluate and decide to stall this cycle. 00057 // Processes with side-effects must not be done in this method. 00058 virtual void Evaluate() = 0; 00059 00060 // Transition from Prepare and Process. 00061 // Processes with side-effects must not be done in this method. 00062 virtual void Transition() = 0; 00063 00064 // Update resources. 00065 // This method is not called when a module is stalled. 00066 // Processes observing other resources must not be done in this method. 00067 virtual void Update() = 0; 00068 00069 // End of a cycle 00070 // Processes that observes other resources must not be done in this method. 00071 virtual void End() = 0; 00072 00073 00074 // Trigger Update() for internal user. 00075 virtual void TriggerUpdate() = 0; 00076 00077 00078 // This method can be called only in Evaluate(). 00079 virtual void StallThisCycle( ) = 0; 00080 00081 // This method can be called in any phases. 00082 virtual void StallNextCycle( int cycle ) = 0; 00083 00084 // Cancel a stall period set by StallNextCycle. 00085 virtual void CacnelStallPeriod() = 0; 00086 00087 // Get a priority of this resource. 00088 // Priority constants are defined in "Sim/ResourcePriority.h". 00089 virtual int GetPriority() const = 0; 00090 00091 // For debug 00092 virtual void SetParent( ClockedResourceIF* parent ) = 0; 00093 virtual const char* Who() const = 0; 00094 00095 }; 00096 00097 }; // namespace Onikiri 00098 00099 #endif // SIM_TIME_WHEEL_CLOCKED_RESOURCE_IF_H 00100