gem5  v21.1.0.2
device.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2018 ARM Limited
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  * Copyright (c) 2008 The Regents of The University of Michigan
15  * All rights reserved.
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted provided that the following conditions are
19  * met: redistributions of source code must retain the above copyright
20  * notice, this list of conditions and the following disclaimer;
21  * redistributions in binary form must reproduce the above copyright
22  * notice, this list of conditions and the following disclaimer in the
23  * documentation and/or other materials provided with the distribution;
24  * neither the name of the copyright holders nor the names of its
25  * contributors may be used to endorse or promote products derived from
26  * this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39  */
40 
41 #ifndef __DEV_PS2_DEVICE_HH__
42 #define __DEV_PS2_DEVICE_HH__
43 
44 #include <cstdint>
45 #include <deque>
46 #include <functional>
47 #include <vector>
48 
49 #include "base/compiler.hh"
50 #include "sim/sim_object.hh"
51 
52 namespace gem5
53 {
54 
55 struct PS2DeviceParams;
56 
57 namespace ps2
58 {
59 
60 class Device : public SimObject
61 {
62  public:
63  Device(const PS2DeviceParams &p);
64 
65  void serialize(CheckpointOut &cp) const override;
66  void unserialize(CheckpointIn &cp) override;
67 
68  public: /* Host interface */
74  void hostRegDataAvailable(const std::function<void()> &c);
75 
82  bool hostDataAvailable() const { return !outBuffer.empty(); }
83 
90  uint8_t hostRead();
91 
97  void hostWrite(uint8_t c);
98 
99  protected: /* Device interface */
113  virtual bool recv(const std::vector<uint8_t> &data) = 0;
114 
121  void send(const uint8_t *data, size_t size);
123  send(data.data(), data.size());
124  }
125 
131  void send(uint8_t data) { send(&data, 1); }
132 
134  void sendAck();
135 
142  size_t sendPending() const { return outBuffer.size(); }
143 
144  private:
147 
150 
151  std::function<void()> dataAvailableCallback;
152 };
153 
154 } // namespace ps2
155 } // namespace gem5
156 
158 
159 #endif // __DEV_PS2_HOUSE_HH__
gem5::ps2::Device::send
void send(const uint8_t *data, size_t size)
Send data from a PS/2 device to a host.
Definition: device.cc:113
data
const char data[]
Definition: circlebuf.test.cc:48
gem5::ps2::Device::recv
virtual bool recv(const std::vector< uint8_t > &data)=0
Data received from host.
gem5::CheckpointIn
Definition: serialize.hh:68
gem5::ps2::Device::send
void send(const std::vector< uint8_t > &data)
Definition: device.hh:122
std::vector< uint8_t >
gem5::ps2::Device::sendPending
size_t sendPending() const
Output buffer size.
Definition: device.hh:142
gem5::ps2::Device::hostWrite
void hostWrite(uint8_t c)
Transmit a character from the host interface to the device.
Definition: device.cc:104
sim_object.hh
gem5::ps2::Device::hostDataAvailable
bool hostDataAvailable() const
Check if there is pending data from the PS/2 device.
Definition: device.hh:82
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::ps2::Device::dataAvailableCallback
std::function< void()> dataAvailableCallback
Definition: device.hh:151
gem5::ps2::Device::Device
Device(const PS2DeviceParams &p)
Definition: device.cc:58
gem5::ps2::Device::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: device.cc:65
gem5::ps2::Device::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: device.cc:75
compiler.hh
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
gem5::ArmISA::c
Bitfield< 29 > c
Definition: misc_types.hh:53
gem5::ps2::Device
Definition: device.hh:60
std::deque< uint8_t >
gem5::CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:66
gem5::ps2::Device::inBuffer
std::vector< uint8_t > inBuffer
Host -> device buffer.
Definition: device.hh:149
gem5::ps2::Device::sendAck
void sendAck()
Send an ACK byte to the host.
Definition: device.cc:128
GEM5_DEPRECATED_CLASS
GEM5_DEPRECATED_CLASS(PS2Device, gem5::ps2::Device)
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::ps2::Device::outBuffer
std::deque< uint8_t > outBuffer
Device -> host FIFO.
Definition: device.hh:146
gem5::ps2::Device::hostRead
uint8_t hostRead()
Read a character from the device.
Definition: device.cc:96
gem5::ps2::Device::send
void send(uint8_t data)
Send a byte of data from a PS/2 device to a host.
Definition: device.hh:131
gem5::ps2::Device::hostRegDataAvailable
void hostRegDataAvailable(const std::function< void()> &c)
Register a data available callback into the PS/2 interface.
Definition: device.cc:86

Generated on Tue Sep 21 2021 12:25:00 for gem5 by doxygen 1.8.17