gem5  v22.1.0.0
example.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2021 Google, Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met: redistributions of source code must retain the above copyright
7  * notice, this list of conditions and the following disclaimer;
8  * redistributions in binary form must reproduce the above copyright
9  * notice, this list of conditions and the following disclaimer in the
10  * documentation and/or other materials provided with the distribution;
11  * neither the name of the copyright holders nor the names of its
12  * contributors may be used to endorse or promote products derived from
13  * this software without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef __ARCH_ARM_FASTMODEL_RESET_CONTROLLER_EXAMPLE_HH__
29 #define __ARCH_ARM_FASTMODEL_RESET_CONTROLLER_EXAMPLE_HH__
30 
31 #include <string>
32 
34 #include "dev/intpin.hh"
35 #include "dev/io_device.hh"
36 #include "dev/reg_bank.hh"
37 #include "mem/packet_access.hh"
38 #include "params/FastModelResetControllerExample.hh"
39 
40 namespace gem5
41 {
42 
43 namespace fastmodel
44 {
45 
47 {
48  private:
49  struct CorePins
50  {
54 
55  explicit CorePins(const std::string &);
56  };
57 
58  class Registers : public RegisterBankLE
59  {
60  private:
63 
68 
69  public:
70  Registers(const std::string &, Iris::BaseCPU *, CorePins *);
71  };
72 
75 
76  public:
77  using Params = FastModelResetControllerExampleParams;
78  explicit ResetControllerExample(const Params &);
79 
80  Tick read(PacketPtr pkt) override;
81  Tick write(PacketPtr pkt) override;
82  Port &getPort(const std::string &, PortID = InvalidPortID) override;
83 };
84 
85 } // namespace fastmodel
86 } // namespace gem5
87 
88 #endif // __ARCH_ARM_FASTMODEL_RESET_CONTROLLER_EXAMPLE_HH__
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:294
Ports are used to interface objects to each other.
Definition: port.hh:62
Registers(const std::string &, Iris::BaseCPU *, CorePins *)
Definition: example.cc:44
Port & getPort(const std::string &, PortID=InvalidPortID) override
Get a port with a given name and index.
Definition: example.cc:125
Tick write(PacketPtr pkt) override
Pure virtual function that the device must implement.
Definition: example.cc:111
FastModelResetControllerExampleParams Params
Definition: example.hh:77
Tick read(PacketPtr pkt) override
Pure virtual function that the device must implement.
Definition: example.cc:101
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
const PortID InvalidPortID
Definition: types.hh:246
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

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