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