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 * Authors: Gabe Black
41 * Andreas Sandberg
42 */
43
44#ifndef __DEV_PS2_DEVICE_HH__
45#define __DEV_PS2_DEVICE_HH__
46
47#include <deque>
48
49#include "sim/sim_object.hh"
50
51struct PS2DeviceParams;
52
53class PS2Device : public SimObject
54{
55 public:
56 PS2Device(const PS2DeviceParams *p);
57
58 void serialize(CheckpointOut &cp) const override;
59 void unserialize(CheckpointIn &cp) override;
60
61 public: /* Host interface */
62 /**
63 * Register a data available callback into the PS/2 interface
64 *
65 * @param c Callback instance from host interface
66 */
67 void hostRegDataAvailable(const std::function<void()> &c);
68
69 /**
70 * Check if there is pending data from the PS/2 device.
71 *
72 * @return true if there is data pending that can be read using
73 * the readData() method.
74 */
75 bool hostDataAvailable() const { return !outBuffer.empty(); }
76
77 /**
78 * Read a character from the device.
79 *
80 * @return Character from the device's output buffer, undefined if
81 * no data is pending.
82 */
83 uint8_t hostRead();
84
85 /**
86 * Transmit a character from the host interface to the device.
87 *
88 * @param c Received data.
89 */
90 void hostWrite(uint8_t c);
91
92 protected: /* Device interface */
93 /**
94 * Data received from host.
95 */
96 virtual void recv(uint8_t data) = 0;
97
98 /**
99 * Send data from a PS/2 device to a host
100 *
101 * @param data Pointer to data array
102 * @param size Size of the data array
103 */
104 void send(const uint8_t *data, size_t size);
105 void send(const std::vector<uint8_t> &data) {
106 send(data.data(), data.size());
107 }
108
109 /**
110 * Send a byte of data from a PS/2 device to a host
111 *
112 * @param data Byte to send
113 */
114 void send(uint8_t data) { send(&data, 1); }
115
116 /** Send an ACK byte to the host */
117 void sendAck();
118
119 /**
120 * Output buffer size
121 *
122 * Device models may use this method to query the size of the
123 * output buffer to do rate limiting.
124 */
125 size_t sendPending() const { return outBuffer.size(); }
126
127 private:
128 /** Device -> host FIFO */
129 std::deque<uint8_t> outBuffer;
130
131 std::function<void()> dataAvailableCallback;
132};
133
134#endif // __DEV_PS2_HOUSE_HH__