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#include "dev/ps2/device.hh"
45
46#include "base/logging.hh"
47#include "debug/PS2.hh"
48#include "dev/ps2/types.hh"
49#include "params/PS2Device.hh"
50
51PS2Device::PS2Device(const PS2DeviceParams *p)
52    : SimObject(p)
53{
54    inBuffer.reserve(16);
55}
56
57void
58PS2Device::serialize(CheckpointOut &cp) const
59{
60    std::vector<uint8_t> buffer(outBuffer.size());
61    std::copy(outBuffer.begin(), outBuffer.end(), buffer.begin());
62    arrayParamOut(cp, "outBuffer", buffer);
63
64    SERIALIZE_CONTAINER(inBuffer);
65}
66
67void
68PS2Device::unserialize(CheckpointIn &cp)
69{
70    std::vector<uint8_t> buffer;
71    arrayParamIn(cp, "outBuffer", buffer);
72    for (auto c : buffer)
73        outBuffer.push_back(c);
74
75    UNSERIALIZE_CONTAINER(inBuffer);
76}
77
78void
79PS2Device::hostRegDataAvailable(const std::function<void()> &c)
80{
81    fatal_if(dataAvailableCallback,
82             "A data pending callback has already been associated with this "
83             "PS/2 device.\n");
84
85    dataAvailableCallback = c;
86}
87
88uint8_t
89PS2Device::hostRead()
90{
91    uint8_t data = outBuffer.front();
92    outBuffer.pop_front();
93    return data;
94}
95
96void
97PS2Device::hostWrite(uint8_t c)
98{
99    DPRINTF(PS2, "PS2: Host -> device: %#x\n", c);
100    inBuffer.push_back(c);
101    if (recv(inBuffer))
102        inBuffer.clear();
103}
104
105void
106PS2Device::send(const uint8_t *data, size_t size)
107{
108    assert(data || size == 0);
109    while (size) {
110        DPRINTF(PS2, "PS2: Device -> host: %#x\n", *data);
111        outBuffer.push_back(*(data++));
112        size--;
113    }
114
115    // Registering a callback is optional.
116    if (dataAvailableCallback)
117        dataAvailableCallback();
118}
119
120void
121PS2Device::sendAck()
122{
123    send(Ps2::Ack);
124}
125