summaryrefslogtreecommitdiff
path: root/src/systemc/ext/tlm_core/2/quantum/global_quantum.hh
diff options
context:
space:
mode:
authorGabe Black <gabeblack@google.com>2018-12-12 16:43:18 -0800
committerGabe Black <gabeblack@google.com>2019-01-09 01:35:21 +0000
commite345154b19939db37fb391111d4dad190c62e81c (patch)
tree2bb6f5a3fe3a13f447f8b179337afc20e11b3648 /src/systemc/ext/tlm_core/2/quantum/global_quantum.hh
parent8c560b6c80e641a1937d9af98cb75588ec4eac05 (diff)
downloadgem5-e345154b19939db37fb391111d4dad190c62e81c.tar.xz
systemc: Rename tlm_core header files to have a .hh extentension.
This makes those files more consistent with other headers in gem5. The top level headers (tlm and tlm.h) and the tlm_utils headers were left alone since the user might reasonably expect those to have a well known name. The tlm_core headers by comparison are an implementation detail, and users shouldn't include them directly by name. Change-Id: Ibc82e8159e47717c79d76f50ed96fdd619294a06 Reviewed-on: https://gem5-review.googlesource.com/c/15067 Reviewed-by: Anthony Gutierrez <anthony.gutierrez@amd.com> Maintainer: Anthony Gutierrez <anthony.gutierrez@amd.com>
Diffstat (limited to 'src/systemc/ext/tlm_core/2/quantum/global_quantum.hh')
-rw-r--r--src/systemc/ext/tlm_core/2/quantum/global_quantum.hh76
1 files changed, 76 insertions, 0 deletions
diff --git a/src/systemc/ext/tlm_core/2/quantum/global_quantum.hh b/src/systemc/ext/tlm_core/2/quantum/global_quantum.hh
new file mode 100644
index 000000000..5b6e267d1
--- /dev/null
+++ b/src/systemc/ext/tlm_core/2/quantum/global_quantum.hh
@@ -0,0 +1,76 @@
+/*****************************************************************************
+
+ Licensed to Accellera Systems Initiative Inc. (Accellera) under one or
+ more contributor license agreements. See the NOTICE file distributed
+ with this work for additional information regarding copyright ownership.
+ Accellera licenses this file to you under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with the
+ License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied. See the License for the specific language governing
+ permissions and limitations under the License.
+
+ *****************************************************************************/
+
+#ifndef __SYSTEMC_EXT_TLM_CORE_2_QUANTUM_GLOBAL_QUANTUM_HH__
+#define __SYSTEMC_EXT_TLM_CORE_2_QUANTUM_GLOBAL_QUANTUM_HH__
+
+#include <systemc>
+
+namespace tlm
+{
+
+//
+// tlm_global_quantum class
+//
+// The global quantum is the maximum time an initiator can run ahead of
+// SystemC time. All initiators should synchronize on timingpoints that
+// are multiples of the global quantum value.
+//
+// sc_set_time_resolution can only be called before the first
+// sc_time object is created. This means that after setting the
+// global quantum it will not be possible to call sc_set_time_resolution.
+// If sc_set_time_resolution must be called this must be done before
+// the global quantum is set.
+//
+
+class tlm_global_quantum
+{
+ public:
+ //
+ // Returns a reference to the tlm_global_quantum singleton
+ //
+ static tlm_global_quantum &instance();
+
+ public:
+
+ //
+ // Setter/getter for the global quantum
+ //
+ void set(const sc_core::sc_time &t) { m_global_quantum = t; }
+ const sc_core::sc_time &get() const { return m_global_quantum; }
+
+ //
+ // This function will calculate the maximum value for the next local
+ // quantum for an initiator. All initiators should synchronize on
+ // integer multiples of the global quantum value. The value for the
+ // local quantum of an initiator can be smaller, but should never be
+ // greater than the value returned by this method.
+ //
+ sc_core::sc_time compute_local_quantum();
+
+ protected:
+ tlm_global_quantum();
+
+ protected:
+ sc_core::sc_time m_global_quantum;
+};
+
+} // namespace tlm
+
+#endif /* __SYSTEMC_EXT_TLM_CORE_2_QUANTUM_GLOBAL_QUANTUM_HH__ */