gem5  v22.1.0.0
rtc.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021 Huawei International
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions are
16  * met: redistributions of source code must retain the above copyright
17  * notice, this list of conditions and the following disclaimer;
18  * redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution;
21  * neither the name of the copyright holders nor the names of its
22  * contributors may be used to endorse or promote products derived from
23  * this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #include "dev/riscv/rtc.hh"
39 
40 #include "dev/mc146818.hh"
41 #include "params/RiscvRTC.hh"
42 
43 namespace gem5
44 {
45 
46 RiscvRTC::RiscvRTC(const Params &params) :
47  SimObject(params),
48  rtc(this, params.name, params.time, params.bcd,
49  params.frequency, params.port_int_pin_connection_count)
50 {
51 }
52 
53 RiscvRTC::RTC::RTC(EventManager *em, const std::string &n,
54  const struct tm time, bool bcd, Tick frequency, int int_pin_count) :
55  MC146818(em, n, time, bcd, frequency)
56 {
57  for (int i = 0; i < int_pin_count; i++) {
58  intPin.emplace_back(new IntSourcePin<RTC>(
59  csprintf("%s.int_pin[%d]", n, i), i, this));
60  }
61 }
62 
63 void
65 {
66  for (auto &pin: intPin) {
67  pin->raise();
68  pin->lower();
69  }
70 }
71 
72 Port &
73 RiscvRTC::getPort(const std::string &if_name, PortID idx)
74 {
75  if (if_name == "int_pin")
76  return *rtc.intPin.at(idx);
77  else
78  panic("Getting invalid port " + if_name);
79 }
80 
81 void
83 {
84  rtc.startup();
85 }
86 
87 void
89 {
90  // Serialize the timer
91  rtc.serialize("rtc", cp);
92 }
93 
94 void
96 {
97  // Serialize the timer
98  rtc.unserialize("rtc", cp);
99 }
100 
101 } // namespace gem5
Real-Time Clock (MC146818)
Definition: mc146818.hh:42
virtual void startup()
Start ticking.
Definition: mc146818.cc:124
void serialize(const std::string &base, CheckpointOut &cp) const
Serialize this object to the given output stream.
Definition: mc146818.cc:266
void unserialize(const std::string &base, CheckpointIn &cp)
Reconstruct the state of this object from a checkpoint.
Definition: mc146818.cc:286
Ports are used to interface objects to each other.
Definition: port.hh:62
RTC(EventManager *em, const std::string &n, const struct tm time, bool bcd, Tick frequency, int int_pin_count)
Definition: rtc.cc:53
void handleEvent()
Definition: rtc.cc:64
std::vector< std::unique_ptr< IntSource > > intPin
Definition: rtc.hh:63
gem5::RiscvRTC::RTC rtc
RiscvRTCParams Params
Definition: rtc.hh:72
Port & getPort(const std::string &if_name, PortID idx=InvalidPortID) override
Get a port with a given name and index.
Definition: rtc.cc:73
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: rtc.cc:88
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: rtc.cc:95
RiscvRTC(const Params &params)
Definition: rtc.cc:46
void startup() override
startup() is the final initialization call before simulation.
Definition: rtc.cc:82
Abstract superclass for simulation objects.
Definition: sim_object.hh:148
#define panic(...)
This implements a cprintf based panic() function.
Definition: logging.hh:178
Bitfield< 31 > n
Definition: misc_types.hh:462
Bitfield< 7 > i
Definition: misc_types.hh:67
Bitfield< 32 > tm
Definition: misc.hh:112
Bitfield< 2 > em
Definition: misc.hh:607
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
std::ostream CheckpointOut
Definition: serialize.hh:66
int16_t PortID
Port index/ID type, and a symbolic name for an invalid port id.
Definition: types.hh:245
uint64_t Tick
Tick count type.
Definition: types.hh:58
std::string csprintf(const char *format, const Args &...args)
Definition: cprintf.hh:161
const std::string & name()
Definition: trace.cc:49

Generated on Wed Dec 21 2022 10:22:34 for gem5 by doxygen 1.9.1