keyboard.cc revision 12657:b0e98d6b4456 
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/keyboard.hh"
45
46#include "base/logging.hh"
47#include "debug/PS2.hh"
48#include "dev/ps2.hh"
49#include "params/PS2Keyboard.hh"
50
51const uint8_t PS2Keyboard::ID[] = {0xab, 0x83};
52
53PS2Keyboard::PS2Keyboard(const PS2KeyboardParams *p)
54    : PS2Device(p),
55      shiftDown(false),
56      enabled(false)
57{
58    if (p->vnc)
59        p->vnc->setKeyboard(this);
60}
61
62void
63PS2Keyboard::serialize(CheckpointOut &cp) const
64{
65    PS2Device::serialize(cp);
66    SERIALIZE_SCALAR(shiftDown);
67    SERIALIZE_SCALAR(enabled);
68}
69
70void
71PS2Keyboard::unserialize(CheckpointIn &cp)
72{
73    PS2Device::unserialize(cp);
74    UNSERIALIZE_SCALAR(shiftDown);
75    UNSERIALIZE_SCALAR(enabled);
76}
77
78bool
79PS2Keyboard::recv(const std::vector<uint8_t> &data)
80{
81    switch (data[0]) {
82      case LEDWrite:
83        if (data.size() == 1) {
84            DPRINTF(PS2, "Got LED write command.\n");
85            sendAck();
86            return false;
87        } else {
88            DPRINTF(PS2, "Setting LEDs: "
89                    "caps lock %s, num lock %s, scroll lock %s\n",
90                    bits(data[1], 2) ? "on" : "off",
91                    bits(data[1], 1) ? "on" : "off",
92                    bits(data[1], 0) ? "on" : "off");
93            sendAck();
94            return true;
95        }
96      case DiagnosticEcho:
97        panic("Keyboard diagnostic echo unimplemented.\n");
98      case AlternateScanCodes:
99        panic("Accessing alternate scan codes unimplemented.\n");
100      case ReadID:
101        DPRINTF(PS2, "Got keyboard read ID command.\n");
102        sendAck();
103        send((uint8_t *)&ID, sizeof(ID));
104        return true;
105      case TypematicInfo:
106        if (data.size() == 1) {
107            DPRINTF(PS2, "Setting typematic info.\n");
108            sendAck();
109            return false;
110        } else {
111            DPRINTF(PS2, "Setting typematic info to %#02x.\n", data[1]);
112            sendAck();
113            return true;
114        }
115      case Enable:
116        DPRINTF(PS2, "Enabling the keyboard.\n");
117        enabled = true;
118        sendAck();
119        return true;
120      case Disable:
121        DPRINTF(PS2, "Disabling the keyboard.\n");
122        enabled = false;
123        sendAck();
124        return true;
125      case DefaultsAndDisable:
126        DPRINTF(PS2, "Disabling and resetting the keyboard.\n");
127        enabled = false;
128        sendAck();
129        return true;
130      case Reset:
131        DPRINTF(PS2, "Resetting keyboard.\n");
132        sendAck();
133        enabled = true;
134        send(Ps2::SelfTestPass);
135        return true;
136      case AllKeysToTypematic:
137        panic("Setting all keys to typemantic unimplemented.\n");
138      case AllKeysToMakeRelease:
139        panic("Setting all keys to make/release unimplemented.\n");
140      case AllKeysToMake:
141        panic("Setting all keys to make unimplemented.\n");
142      case AllKeysToTypematicMakeRelease:
143        panic("Setting all keys to "
144                "typematic/make/release unimplemented.\n");
145      case KeyToTypematic:
146        panic("Setting a key to typematic unimplemented.\n");
147      case KeyToMakeRelease:
148        panic("Setting a key to make/release unimplemented.\n");
149      case KeyToMakeOnly:
150        panic("Setting key to make only unimplemented.\n");
151      case Resend:
152        panic("Keyboard resend unimplemented.\n");
153      default:
154        panic("Unknown keyboard command %#02x.\n", data[0]);
155    }
156}
157
158void
159PS2Keyboard::keyPress(uint32_t key, bool down)
160{
161    std::list<uint8_t> keys;
162
163    // convert the X11 keysym into ps2 codes and update the shift
164    // state (shiftDown)
165    Ps2::keySymToPs2(key, down, shiftDown, keys);
166
167    // Drop key presses if the keyboard hasn't been enabled by the
168    // host. We do that after translating the key code to ensure that
169    // we keep track of the shift state.
170    if (!enabled)
171        return;
172
173    // Insert into our queue of characters
174    for (uint8_t c : keys)
175        send(c);
176}
177
178
179PS2Keyboard *
180PS2KeyboardParams::create()
181{
182    return new PS2Keyboard(this);
183}
184