keyboard.hh revision 12654:749de33b7af6 
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#ifndef __DEV_PS2_KEYBOARD_HH__
45#define __DEV_PS2_KEYBOARD_HH__
46
47#include "base/vnc/vncinput.hh"
48#include "dev/ps2/device.hh"
49
50struct PS2KeyboardParams;
51
52class PS2Keyboard : public PS2Device, VncKeyboard
53{
54  protected:
55    static const uint8_t ID[];
56
57    enum Command
58    {
59        LEDWrite = 0xED,
60        DiagnosticEcho = 0xEE,
61        AlternateScanCodes = 0xF0,
62        ReadID = 0xF2,
63        TypematicInfo = 0xF3,
64        Enable = 0xF4,
65        Disable = 0xF5,
66        DefaultsAndDisable = 0xF6,
67        AllKeysToTypematic = 0xF7,
68        AllKeysToMakeRelease = 0xF8,
69        AllKeysToMake = 0xF9,
70        AllKeysToTypematicMakeRelease = 0xFA,
71        KeyToTypematic = 0xFB,
72        KeyToMakeRelease = 0xFC,
73        KeyToMakeOnly = 0xFD,
74        Resend = 0xFE,
75        Reset = 0xFF
76    };
77    static const uint16_t NoCommand = (uint16_t)(-1);
78
79
80    uint16_t lastCommand;
81
82    /** is the shift key currently down */
83    bool shiftDown;
84
85    /** Is the device enabled? */
86    bool enabled;
87
88  public:
89    PS2Keyboard(const PS2KeyboardParams *p);
90
91    void serialize(CheckpointOut &cp) const override;
92    void unserialize(CheckpointIn &cp) override;
93
94  protected: // PS2Device
95    void recv(uint8_t data) override;
96
97  public: // VncKeyboard
98    void keyPress(uint32_t key, bool down) override;
99};
100
101#endif // __DEV_PS2_KEYBOARD_hH__
102
103