1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
/*
* Copyright (c) 2017-2018 ARM Limited
* All rights reserved
*
* The license below extends only to copyright in the software and shall
* not be construed as granting a license to any other intellectual
* property including but not limited to intellectual property relating
* to a hardware implementation of the functionality of the software
* licensed hereunder. You may use the software subject to the license
* terms below provided that you ensure that this notice is replicated
* unmodified and in its entirety in all distributions of the software,
* modified or unmodified, in source code or in binary form.
*
* Copyright (c) 2008 The Regents of The University of Michigan
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met: redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer;
* redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution;
* neither the name of the copyright holders nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Authors: Gabe Black
* Andreas Sandberg
*/
#ifndef __DEV_PS2_DEVICE_HH__
#define __DEV_PS2_DEVICE_HH__
#include <deque>
#include "sim/sim_object.hh"
struct PS2DeviceParams;
class PS2Device : public SimObject
{
public:
PS2Device(const PS2DeviceParams *p);
void serialize(CheckpointOut &cp) const override;
void unserialize(CheckpointIn &cp) override;
public: /* Host interface */
/**
* Register a data available callback into the PS/2 interface
*
* @param c Callback instance from host interface
*/
void hostRegDataAvailable(const std::function<void()> &c);
/**
* Check if there is pending data from the PS/2 device.
*
* @return true if there is data pending that can be read using
* the readData() method.
*/
bool hostDataAvailable() const { return !outBuffer.empty(); }
/**
* Read a character from the device.
*
* @return Character from the device's output buffer, undefined if
* no data is pending.
*/
uint8_t hostRead();
/**
* Transmit a character from the host interface to the device.
*
* @param c Received data.
*/
void hostWrite(uint8_t c);
protected: /* Device interface */
/**
* Data received from host.
*/
virtual void recv(uint8_t data) = 0;
/**
* Send data from a PS/2 device to a host
*
* @param data Pointer to data array
* @param size Size of the data array
*/
void send(const uint8_t *data, size_t size);
void send(const std::vector<uint8_t> &data) {
send(data.data(), data.size());
}
/**
* Send a byte of data from a PS/2 device to a host
*
* @param data Byte to send
*/
void send(uint8_t data) { send(&data, 1); }
/** Send an ACK byte to the host */
void sendAck();
/**
* Output buffer size
*
* Device models may use this method to query the size of the
* output buffer to do rate limiting.
*/
size_t sendPending() const { return outBuffer.size(); }
private:
/** Device -> host FIFO */
std::deque<uint8_t> outBuffer;
std::function<void()> dataAvailableCallback;
};
#endif // __DEV_PS2_HOUSE_HH__
|
