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/mouse.hh"
45
46#include "base/logging.hh"
47#include "debug/PS2.hh"
48#include "dev/ps2/types.hh"
49#include "params/PS2Mouse.hh"
50
51PS2Mouse::PS2Mouse(const PS2MouseParams *p)
52 : PS2Device(p),
53 status(0), resolution(4), sampleRate(100)
54{
55}
56
57bool
58PS2Mouse::recv(const std::vector<uint8_t> &data)
59{
60 switch (data[0]) {
61 case Ps2::ReadID:
62 DPRINTF(PS2, "Mouse ID requested.\n");
63 sendAck();
64 send(Ps2::Mouse::ID);
65 return true;
66 case Ps2::Disable:
67 DPRINTF(PS2, "Disabling data reporting.\n");
68 status.enabled = 0;
69 sendAck();
70 return true;
71 case Ps2::Enable:
72 DPRINTF(PS2, "Enabling data reporting.\n");
73 status.enabled = 1;
74 sendAck();
75 return true;
76 case Ps2::Resend:
77 panic("Mouse resend unimplemented.\n");
78 case Ps2::Reset:
79 DPRINTF(PS2, "Resetting the mouse.\n");
80 sampleRate = 100;
81 resolution = 4;
82 status.twoToOne = 0;
83 status.enabled = 0;
84 sendAck();
85 send(Ps2::SelfTestPass);
86 send(Ps2::Mouse::ID);
87 return true;
88
89 case Ps2::Mouse::Scale1to1:
90 DPRINTF(PS2, "Setting mouse scale to 1:1.\n");
91 status.twoToOne = 0;
92 sendAck();
93 return true;
94 case Ps2::Mouse::Scale2to1:
95 DPRINTF(PS2, "Setting mouse scale to 2:1.\n");
96 status.twoToOne = 1;
97 sendAck();
98 return true;
99 case Ps2::Mouse::SetResolution:
100 if (data.size() == 1) {
101 DPRINTF(PS2, "Setting mouse resolution.\n");
102 sendAck();
103 return false;
104 } else {
105 DPRINTF(PS2, "Mouse resolution set to %d.\n", data[1]);
106 resolution = data[1];
107 sendAck();
108 return true;
109 }
110 case Ps2::Mouse::GetStatus:
111 DPRINTF(PS2, "Getting mouse status.\n");
112 sendAck();
113 send((uint8_t *)&(status), 1);
114 send(&resolution, sizeof(resolution));
115 send(&sampleRate, sizeof(sampleRate));
116 return true;
117 case Ps2::Mouse::ReadData:
118 panic("Reading mouse data unimplemented.\n");
119 case Ps2::Mouse::ResetWrapMode:
120 panic("Resetting mouse wrap mode unimplemented.\n");
121 case Ps2::Mouse::WrapMode:
122 panic("Setting mouse wrap mode unimplemented.\n");
123 case Ps2::Mouse::RemoteMode:
124 panic("Setting mouse remote mode unimplemented.\n");
125 case Ps2::Mouse::SampleRate:
126 if (data.size() == 1) {
127 DPRINTF(PS2, "Setting mouse sample rate.\n");
128 sendAck();
129 return false;
130 } else {
131 DPRINTF(PS2, "Mouse sample rate %d samples "
132 "per second.\n", data[1]);
133 sampleRate = data[1];
134 sendAck();
135 return true;
136 }
137 case Ps2::DefaultsAndDisable:
138 DPRINTF(PS2, "Disabling and resetting mouse.\n");
139 sampleRate = 100;
140 resolution = 4;
141 status.twoToOne = 0;
142 status.enabled = 0;
143 sendAck();
144 return true;
145 default:
146 warn("Unknown mouse command %#02x.\n", data[0]);
147 send(Ps2::Resend);
148 return true;
149 }
150}
151
152void
153PS2Mouse::serialize(CheckpointOut &cp) const
154{
155 PS2Device::serialize(cp);
156
157 SERIALIZE_SCALAR(status);
158 SERIALIZE_SCALAR(resolution);
159 SERIALIZE_SCALAR(sampleRate);
160}
161
162void
163PS2Mouse::unserialize(CheckpointIn &cp)
164{
165 PS2Device::unserialize(cp);
166
167 UNSERIALIZE_SCALAR(status);
168 UNSERIALIZE_SCALAR(resolution);
169 UNSERIALIZE_SCALAR(sampleRate);
170}
171
172PS2Mouse *
173PS2MouseParams::create()
174{
175 return new PS2Mouse(this);
176}