touchkit.cc (12658:eaa132294582) touchkit.cc (12660:c5caca5f7d68)
1/*
2 * Copyright (c) 2010, 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) 2005 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: Ali Saidi
41 * William Wang
42 * Andreas Sandberg
43 */
44
45#include "dev/ps2/touchkit.hh"
46
47#include "base/logging.hh"
48#include "debug/PS2.hh"
1/*
2 * Copyright (c) 2010, 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) 2005 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: Ali Saidi
41 * William Wang
42 * Andreas Sandberg
43 */
44
45#include "dev/ps2/touchkit.hh"
46
47#include "base/logging.hh"
48#include "debug/PS2.hh"
49#include "dev/ps2.hh"
49#include "dev/ps2/types.hh"
50#include "params/PS2TouchKit.hh"
51
50#include "params/PS2TouchKit.hh"
51
52const uint8_t PS2TouchKit::ID[] = {0x00};
53
54PS2TouchKit::PS2TouchKit(const PS2TouchKitParams *p)
55 : PS2Device(p),
56 vnc(p->vnc),
57 enabled(false), touchKitEnabled(false)
58{
59 if (vnc)
60 vnc->setMouse(this);
61}
62
63void
64PS2TouchKit::serialize(CheckpointOut &cp) const
65{
66 PS2Device::serialize(cp);
67
68 SERIALIZE_SCALAR(enabled);
69 SERIALIZE_SCALAR(touchKitEnabled);
70}
71
72void
73PS2TouchKit::unserialize(CheckpointIn &cp)
74{
75 PS2Device::unserialize(cp);
76
77 UNSERIALIZE_SCALAR(enabled);
78 UNSERIALIZE_SCALAR(touchKitEnabled);
79}
80
81bool
82PS2TouchKit::recv(const std::vector<uint8_t> &data)
83{
84 switch (data[0]) {
52PS2TouchKit::PS2TouchKit(const PS2TouchKitParams *p)
53 : PS2Device(p),
54 vnc(p->vnc),
55 enabled(false), touchKitEnabled(false)
56{
57 if (vnc)
58 vnc->setMouse(this);
59}
60
61void
62PS2TouchKit::serialize(CheckpointOut &cp) const
63{
64 PS2Device::serialize(cp);
65
66 SERIALIZE_SCALAR(enabled);
67 SERIALIZE_SCALAR(touchKitEnabled);
68}
69
70void
71PS2TouchKit::unserialize(CheckpointIn &cp)
72{
73 PS2Device::unserialize(cp);
74
75 UNSERIALIZE_SCALAR(enabled);
76 UNSERIALIZE_SCALAR(touchKitEnabled);
77}
78
79bool
80PS2TouchKit::recv(const std::vector<uint8_t> &data)
81{
82 switch (data[0]) {
85 case Ps2::Ps2Reset:
83 case Ps2::Reset:
86 DPRINTF(PS2, "Resetting device.\n");
87 enabled = false;
88 touchKitEnabled = false;
89 sendAck();
90 send(Ps2::SelfTestPass);
91 return true;
92
84 DPRINTF(PS2, "Resetting device.\n");
85 enabled = false;
86 touchKitEnabled = false;
87 sendAck();
88 send(Ps2::SelfTestPass);
89 return true;
90
93 case Ps2::SetResolution:
94 case Ps2::SetRate:
95 case Ps2::SetStatusLed:
91 case Ps2::ReadID:
96 sendAck();
92 sendAck();
97 return data.size() == 2;
98
99 case Ps2::ReadId:
100 sendAck();
101 send((const uint8_t *)&ID, sizeof(ID));
93 send(Ps2::Mouse::ID);
102 return true;
103
94 return true;
95
104 case Ps2::TpReadId:
105 // We're not a trackpoint device, this should make the probe
106 // go away
107 sendAck();
108 send(0);
109 send(0);
110 sendAck();
111 return true;
112
113 case Ps2::SetScaling1_1:
114 case Ps2::SetScaling1_2:
115 sendAck();
116 return true;
117
118 case Ps2::Disable:
119 DPRINTF(PS2, "Disabling device.\n");
120 enabled = false;
121 sendAck();
122 return true;
123
124 case Ps2::Enable:
125 DPRINTF(PS2, "Enabling device.\n");
126 enabled = true;
127 sendAck();
128 return true;
129
96 case Ps2::Disable:
97 DPRINTF(PS2, "Disabling device.\n");
98 enabled = false;
99 sendAck();
100 return true;
101
102 case Ps2::Enable:
103 DPRINTF(PS2, "Enabling device.\n");
104 enabled = true;
105 sendAck();
106 return true;
107
130 case Ps2::SetDefaults:
108 case Ps2::DefaultsAndDisable:
131 DPRINTF(PS2, "Setting defaults and disabling device.\n");
132 enabled = false;
133 sendAck();
134 return true;
135
109 DPRINTF(PS2, "Setting defaults and disabling device.\n");
110 enabled = false;
111 sendAck();
112 return true;
113
136 case Ps2::StatusRequest:
114 case Ps2::Mouse::Scale1to1:
115 case Ps2::Mouse::Scale2to1:
137 sendAck();
116 sendAck();
117 return true;
118
119 case Ps2::Mouse::SetResolution:
120 case Ps2::Mouse::SampleRate:
121 sendAck();
122 return data.size() == 2;
123
124 case Ps2::Mouse::GetStatus:
125 sendAck();
138 send(0);
139 send(2); // default resolution
140 send(100); // default sample rate
141 return true;
142
126 send(0);
127 send(2); // default resolution
128 send(100); // default sample rate
129 return true;
130
143 case Ps2::TouchKitId:
131 case TpReadId:
132 // We're not a trackpoint device, this should make the probe
133 // go away
134 sendAck();
135 send(0);
136 send(0);
137 sendAck();
138 return true;
139
140 case TouchKitDiag:
144 return recvTouchKit(data);
145
146 default:
147 panic("Unknown byte received: %#x\n", data[0]);
148 }
149}
150
151bool
152PS2TouchKit::recvTouchKit(const std::vector<uint8_t> &data)
153{
154 // Ack all incoming bytes
155 sendAck();
156
157 // Packet format is: 0x0A SIZE CMD DATA
141 return recvTouchKit(data);
142
143 default:
144 panic("Unknown byte received: %#x\n", data[0]);
145 }
146}
147
148bool
149PS2TouchKit::recvTouchKit(const std::vector<uint8_t> &data)
150{
151 // Ack all incoming bytes
152 sendAck();
153
154 // Packet format is: 0x0A SIZE CMD DATA
158 assert(data[0] == Ps2::TouchKitId);
155 assert(data[0] == TouchKitDiag);
159 if (data.size() < 3 || data.size() - 2 < data[1])
160 return false;
161
162 const uint8_t len = data[1];
163 const uint8_t cmd = data[2];
164
165 // We have received at least one TouchKit diagnostic
166 // command. Enabled TouchKit reports.
167 touchKitEnabled = true;
168
169
170 switch (cmd) {
171 case TouchKitActive:
172 warn_if(len != 1, "Unexpected activate packet length: %u\n", len);
173 sendTouchKit('A');
174 return true;
175
176 default:
177 panic("Unimplemented touchscreen command: %#x\n", cmd);
178 }
179}
180
181void
182PS2TouchKit::sendTouchKit(const uint8_t *data, size_t size)
183{
156 if (data.size() < 3 || data.size() - 2 < data[1])
157 return false;
158
159 const uint8_t len = data[1];
160 const uint8_t cmd = data[2];
161
162 // We have received at least one TouchKit diagnostic
163 // command. Enabled TouchKit reports.
164 touchKitEnabled = true;
165
166
167 switch (cmd) {
168 case TouchKitActive:
169 warn_if(len != 1, "Unexpected activate packet length: %u\n", len);
170 sendTouchKit('A');
171 return true;
172
173 default:
174 panic("Unimplemented touchscreen command: %#x\n", cmd);
175 }
176}
177
178void
179PS2TouchKit::sendTouchKit(const uint8_t *data, size_t size)
180{
184 send(Ps2::TouchKitId);
181 send(TouchKitDiag);
185 send(size);
186 for (int i = 0; i < size; ++i)
187 send(data[i]);
188}
189
190
191void
192PS2TouchKit::mouseAt(uint16_t x, uint16_t y, uint8_t buttons)
193{
194 // If the driver hasn't initialized the device yet, no need to try and send
195 // it anything. Similarly we can get vnc mouse events orders of magnitude
196 // faster than m5 can process them. Only queue up two sets mouse movements
197 // and don't add more until those are processed.
198 if (!enabled || !touchKitEnabled || sendPending() > 10)
199 return;
200
201 // Convert screen coordinates to touchpad coordinates
202 const uint16_t _x = (2047.0 / vnc->videoWidth()) * x;
203 const uint16_t _y = (2047.0 / vnc->videoHeight()) * y;
204
205 const uint8_t resp[] = {
206 buttons,
207 (uint8_t)(_x >> 7), (uint8_t)(_x & 0x7f),
208 (uint8_t)(_y >> 7), (uint8_t)(_y & 0x7f),
209 };
210
211 send(resp, sizeof(resp));
212}
213
214PS2TouchKit *
215PS2TouchKitParams::create()
216{
217 return new PS2TouchKit(this);
218}
182 send(size);
183 for (int i = 0; i < size; ++i)
184 send(data[i]);
185}
186
187
188void
189PS2TouchKit::mouseAt(uint16_t x, uint16_t y, uint8_t buttons)
190{
191 // If the driver hasn't initialized the device yet, no need to try and send
192 // it anything. Similarly we can get vnc mouse events orders of magnitude
193 // faster than m5 can process them. Only queue up two sets mouse movements
194 // and don't add more until those are processed.
195 if (!enabled || !touchKitEnabled || sendPending() > 10)
196 return;
197
198 // Convert screen coordinates to touchpad coordinates
199 const uint16_t _x = (2047.0 / vnc->videoWidth()) * x;
200 const uint16_t _y = (2047.0 / vnc->videoHeight()) * y;
201
202 const uint8_t resp[] = {
203 buttons,
204 (uint8_t)(_x >> 7), (uint8_t)(_x & 0x7f),
205 (uint8_t)(_y >> 7), (uint8_t)(_y & 0x7f),
206 };
207
208 send(resp, sizeof(resp));
209}
210
211PS2TouchKit *
212PS2TouchKitParams::create()
213{
214 return new PS2TouchKit(this);
215}