mouse.hh revision 12653 
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_MOUSE_HH__
45#define __DEV_PS2_MOUSE_HH__
46
47#include "dev/ps2/device.hh"
48
49struct PS2MouseParams;
50
51class PS2Mouse : public PS2Device
52{
53  protected:
54    static const uint8_t ID[];
55
56    enum Command
57    {
58        Scale1to1 = 0xE6,
59        Scale2to1 = 0xE7,
60        SetResolution = 0xE8,
61        GetStatus = 0xE9,
62        ReadData = 0xEB,
63        ResetWrapMode = 0xEC,
64        WrapMode = 0xEE,
65        RemoteMode = 0xF0,
66        ReadID = 0xF2,
67        SampleRate = 0xF3,
68        EnableReporting = 0xF4,
69        DisableReporting = 0xF5,
70        DefaultsAndDisable = 0xF6,
71        Resend = 0xFE,
72        Reset = 0xFF
73    };
74    static const uint16_t NoCommand = (uint16_t)(-1);
75
76    BitUnion8(Status)
77        Bitfield<6> remote;
78        Bitfield<5> enabled;
79        Bitfield<4> twoToOne;
80        Bitfield<2> leftButton;
81        Bitfield<0> rightButton;
82    EndBitUnion(Status)
83
84    uint16_t lastCommand;
85
86    Status status;
87    uint8_t resolution;
88    uint8_t sampleRate;
89
90  public:
91    PS2Mouse(const PS2MouseParams *p);
92
93    void serialize(CheckpointOut &cp) const override;
94    void unserialize(CheckpointIn &cp) override;
95
96  protected: // PS2Device
97    void recv(uint8_t data) override;
98};
99
100#endif // __DEV_PS2_MOUSE_hH__
101
102