touchkit.hh revision 12660 
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 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 * Authors: Andreas Sandberg
38 */
39
40#ifndef __DEV_PS2_TOUCHKIT_HH__
41#define __DEV_PS2_TOUCHKIT_HH__
42
43#include "base/vnc/vncinput.hh"
44#include "dev/ps2/device.hh"
45
46struct PS2TouchKitParams;
47
48class PS2TouchKit : public PS2Device, public VncMouse
49{
50  protected:
51    enum PS2Commands {
52        TpReadId = 0xE1,
53        TouchKitDiag = 0x0A,
54    };
55
56    enum TKCommands {
57        TouchKitActive = 'A',
58        TouchKitFWRev = 'D',
59        TouchKitCtrlType = 'E',
60    };
61
62  public:
63    PS2TouchKit(const PS2TouchKitParams *p);
64
65    void serialize(CheckpointOut &cp) const override;
66    void unserialize(CheckpointIn &cp) override;
67
68  protected: // PS2Device
69    bool recv(const std::vector<uint8_t> &data) override;
70
71  public: // VncMouse
72    void mouseAt(uint16_t x, uint16_t y, uint8_t buttons) override;
73
74  protected:
75    bool recvTouchKit(const std::vector<uint8_t> &data);
76    void sendTouchKit(const uint8_t *data, size_t size);
77    void sendTouchKit(uint8_t data) { sendTouchKit(&data, 1); }
78
79    /** The vnc server we're connected to (if any) */
80    VncInput *const vnc;
81
82    /** Is the device enabled? */
83    bool enabled;
84
85    /**
86     * Has the driver enabled TouchKit mode?  The model suppresses
87     * touch event generation until this is true.
88     */
89    bool touchKitEnabled;
90};
91
92#endif // __DEV_PS2_TOUCHKIT_HH__
93
94