Core: Add some documentation about the sim clocks.
This commit is contained in:
parent
8dcbf8576e
commit
974a776b31
|
@ -32,6 +32,10 @@
|
||||||
#ifndef __SIM_CORE_HH__
|
#ifndef __SIM_CORE_HH__
|
||||||
#define __SIM_CORE_HH__
|
#define __SIM_CORE_HH__
|
||||||
|
|
||||||
|
/** @file This header provides some core simulator functionality such as time
|
||||||
|
* information, output directory and exit events
|
||||||
|
*/
|
||||||
|
|
||||||
#include <string>
|
#include <string>
|
||||||
|
|
||||||
#include "base/types.hh"
|
#include "base/types.hh"
|
||||||
|
@ -44,32 +48,49 @@ inline void curTick(Tick newVal) { _curTick = newVal; }
|
||||||
|
|
||||||
const Tick retryTime = 1000;
|
const Tick retryTime = 1000;
|
||||||
|
|
||||||
|
/// These are variables that are set based on the simulator frequency
|
||||||
|
///@{
|
||||||
namespace SimClock {
|
namespace SimClock {
|
||||||
/// The simulated frequency of curTick().
|
extern Tick Frequency; ///< The number of ticks that equal one second
|
||||||
extern Tick Frequency;
|
|
||||||
|
|
||||||
namespace Float {
|
namespace Float {
|
||||||
extern double s;
|
|
||||||
extern double ms;
|
|
||||||
extern double us;
|
|
||||||
extern double ns;
|
|
||||||
extern double ps;
|
|
||||||
|
|
||||||
extern double Hz;
|
/** These variables equal the number of ticks in the unit of time they're
|
||||||
extern double kHz;
|
* named after in a double.
|
||||||
extern double MHz;
|
* @{
|
||||||
extern double GHZ;
|
*/
|
||||||
|
extern double s; ///< second
|
||||||
|
extern double ms; ///< millisecond
|
||||||
|
extern double us; ///< microsecond
|
||||||
|
extern double ns; ///< nanosecond
|
||||||
|
extern double ps; ///< picosecond
|
||||||
|
/** @} */
|
||||||
|
|
||||||
|
/** These variables the inverse of above. They're all < 1.
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
extern double Hz; ///< Hz
|
||||||
|
extern double kHz; ///< kHz
|
||||||
|
extern double MHz; ///< MHz
|
||||||
|
extern double GHZ; ///< GHz
|
||||||
|
/** @}*/
|
||||||
} // namespace Float
|
} // namespace Float
|
||||||
|
|
||||||
|
/** These variables equal the number of ticks in the unit of time they're
|
||||||
|
* named after in a 64 bit integer.
|
||||||
|
*
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
namespace Int {
|
namespace Int {
|
||||||
extern Tick s;
|
extern Tick s; ///< second
|
||||||
extern Tick ms;
|
extern Tick ms; ///< millisecond
|
||||||
extern Tick us;
|
extern Tick us; ///< microsecond
|
||||||
extern Tick ns;
|
extern Tick ns; ///< nanosecond
|
||||||
extern Tick ps;
|
extern Tick ps; ///< picosecond
|
||||||
|
/** @} */
|
||||||
} // namespace Int
|
} // namespace Int
|
||||||
} // namespace SimClock
|
} // namespace SimClock
|
||||||
|
/** @} */
|
||||||
void setClockFrequency(Tick ticksPerSecond);
|
void setClockFrequency(Tick ticksPerSecond);
|
||||||
|
|
||||||
void setOutputDir(const std::string &dir);
|
void setOutputDir(const std::string &dir);
|
||||||
|
|
Loading…
Reference in a new issue