gem5  v22.0.0.1
mouse.hh
Go to the documentation of this file.
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 
41 #ifndef __DEV_PS2_MOUSE_HH__
42 #define __DEV_PS2_MOUSE_HH__
43 
44 #include "base/bitunion.hh"
45 #include "dev/ps2/device.hh"
46 
47 namespace gem5
48 {
49 
50 struct PS2MouseParams;
51 
52 namespace ps2
53 {
54 
55 class PS2Mouse : public Device
56 {
57  protected:
58  BitUnion8(Status)
59  Bitfield<6> remote;
60  Bitfield<5> enabled;
61  Bitfield<4> twoToOne;
62  Bitfield<2> leftButton;
63  Bitfield<0> rightButton;
64  EndBitUnion(Status)
65 
66  Status status;
67  uint8_t resolution;
68  uint8_t sampleRate;
69 
70  public:
71  PS2Mouse(const PS2MouseParams &p);
72 
73  void serialize(CheckpointOut &cp) const override;
74  void unserialize(CheckpointIn &cp) override;
75 
76  protected: // from Device
77  bool recv(const std::vector<uint8_t> &data) override;
78 };
79 
80 } // namespace ps2
81 } // namespace gem5
82 
83 #endif // __DEV_PS2_MOUSE_hH__
84 
gem5::ps2::PS2Mouse::sampleRate
uint8_t sampleRate
Definition: mouse.hh:68
data
const char data[]
Definition: circlebuf.test.cc:48
gem5::ps2::PS2Mouse
Definition: mouse.hh:55
gem5::CheckpointIn
Definition: serialize.hh:68
std::vector< uint8_t >
gem5::ps2::PS2Mouse::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: mouse.cc:168
gem5::ps2::PS2Mouse::PS2Mouse
PS2Mouse(const PS2MouseParams &p)
Definition: mouse.cc:56
gem5::VegaISA::p
Bitfield< 54 > p
Definition: pagetable.hh:70
bitunion.hh
gem5::ps2::PS2Mouse::resolution
uint8_t resolution
Definition: mouse.hh:67
gem5::ps2::PS2Mouse::enabled
Bitfield< 5 > enabled
Definition: mouse.hh:60
gem5::ps2::PS2Mouse::recv
bool recv(const std::vector< uint8_t > &data) override
Data received from host.
Definition: mouse.cc:63
device.hh
gem5::ps2::PS2Mouse::EndBitUnion
EndBitUnion(Status) Status status
gem5::ps2::PS2Mouse::leftButton
Bitfield< 2 > leftButton
Definition: mouse.hh:62
gem5::ps2::Device
Definition: device.hh:60
gem5::ps2::PS2Mouse::twoToOne
Bitfield< 4 > twoToOne
Definition: mouse.hh:61
gem5::ps2::PS2Mouse::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: mouse.cc:158
gem5::CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:66
gem5::ps2::PS2Mouse::rightButton
Bitfield< 0 > rightButton
Definition: mouse.hh:63
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: gpu_translation_state.hh:37
gem5::ps2::PS2Mouse::BitUnion8
BitUnion8(Status) Bitfield< 6 > remote
gem5::ArmISA::status
Bitfield< 5, 0 > status
Definition: misc_types.hh:423

Generated on Sat Jun 18 2022 08:12:25 for gem5 by doxygen 1.8.17