gem5  v21.1.0.2
device.cc
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 #include "dev/ps2/device.hh"
42 
43 #include <algorithm>
44 
45 #include "base/logging.hh"
46 #include "base/trace.hh"
47 #include "debug/PS2.hh"
48 #include "dev/ps2/types.hh"
49 #include "params/PS2Device.hh"
50 #include "sim/serialize.hh"
51 
52 namespace gem5
53 {
54 
55 namespace ps2
56 {
57 
58 Device::Device(const PS2DeviceParams &p)
59  : SimObject(p)
60 {
61  inBuffer.reserve(16);
62 }
63 
64 void
66 {
67  std::vector<uint8_t> buffer(outBuffer.size());
68  std::copy(outBuffer.begin(), outBuffer.end(), buffer.begin());
69  arrayParamOut(cp, "outBuffer", buffer);
70 
72 }
73 
74 void
76 {
77  std::vector<uint8_t> buffer;
78  arrayParamIn(cp, "outBuffer", buffer);
79  for (auto c : buffer)
80  outBuffer.push_back(c);
81 
83 }
84 
85 void
86 Device::hostRegDataAvailable(const std::function<void()> &c)
87 {
89  "A data pending callback has already been associated with this "
90  "PS/2 device.\n");
91 
93 }
94 
95 uint8_t
97 {
98  uint8_t data = outBuffer.front();
99  outBuffer.pop_front();
100  return data;
101 }
102 
103 void
105 {
106  DPRINTF(PS2, "PS2: Host -> device: %#x\n", c);
107  inBuffer.push_back(c);
108  if (recv(inBuffer))
109  inBuffer.clear();
110 }
111 
112 void
113 Device::send(const uint8_t *data, size_t size)
114 {
115  assert(data || size == 0);
116  while (size) {
117  DPRINTF(PS2, "PS2: Device -> host: %#x\n", *data);
118  outBuffer.push_back(*(data++));
119  size--;
120  }
121 
122  // Registering a callback is optional.
125 }
126 
127 void
129 {
130  send(Ack);
131 }
132 
133 } // namespace ps2
134 } // namespace gem5
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
types.hh
data
const char data[]
Definition: circlebuf.test.cc:48
serialize.hh
UNSERIALIZE_CONTAINER
#define UNSERIALIZE_CONTAINER(member)
Definition: serialize.hh:634
gem5::ps2::Device::recv
virtual bool recv(const std::vector< uint8_t > &data)=0
Data received from host.
gem5::CheckpointIn
Definition: serialize.hh:68
std::vector< uint8_t >
gem5::ps2::Ack
@ Ack
Definition: types.hh:68
gem5::ps2::Device::hostWrite
void hostWrite(uint8_t c)
Transmit a character from the host interface to the device.
Definition: device.cc:104
DPRINTF
#define DPRINTF(x,...)
Definition: trace.hh:186
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
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
gem5::ArmISA::c
Bitfield< 29 > c
Definition: misc_types.hh:53
device.hh
gem5::arrayParamOut
decltype(std::begin(std::declval< const T & >()), std::end(std::declval< const T & >()), void()) arrayParamOut(CheckpointOut &os, const std::string &name, const T &param)
Definition: serialize.hh:409
SERIALIZE_CONTAINER
#define SERIALIZE_CONTAINER(member)
Definition: serialize.hh:626
logging.hh
gem5::CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:66
trace.hh
gem5::ps2::Device::inBuffer
std::vector< uint8_t > inBuffer
Host -> device buffer.
Definition: device.hh:149
gem5::arrayParamIn
void arrayParamIn(CheckpointIn &cp, const std::string &name, CircleBuf< T > &param)
Definition: circlebuf.hh:257
gem5::ps2::Device::sendAck
void sendAck()
Send an ACK byte to the host.
Definition: device.cc:128
fatal_if
#define fatal_if(cond,...)
Conditional fatal macro that checks the supplied condition and only causes a fatal error if the condi...
Definition: logging.hh:225
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::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