112653Sandreas.sandberg@arm.com/*
212653Sandreas.sandberg@arm.com * Copyright (c) 2017-2018 ARM Limited
312653Sandreas.sandberg@arm.com * All rights reserved
412653Sandreas.sandberg@arm.com *
512653Sandreas.sandberg@arm.com * The license below extends only to copyright in the software and shall
612653Sandreas.sandberg@arm.com * not be construed as granting a license to any other intellectual
712653Sandreas.sandberg@arm.com * property including but not limited to intellectual property relating
812653Sandreas.sandberg@arm.com * to a hardware implementation of the functionality of the software
912653Sandreas.sandberg@arm.com * licensed hereunder.  You may use the software subject to the license
1012653Sandreas.sandberg@arm.com * terms below provided that you ensure that this notice is replicated
1112653Sandreas.sandberg@arm.com * unmodified and in its entirety in all distributions of the software,
1212653Sandreas.sandberg@arm.com * modified or unmodified, in source code or in binary form.
1312653Sandreas.sandberg@arm.com *
1412653Sandreas.sandberg@arm.com * Copyright (c) 2008 The Regents of The University of Michigan
1512653Sandreas.sandberg@arm.com * All rights reserved.
1612653Sandreas.sandberg@arm.com *
1712653Sandreas.sandberg@arm.com * Redistribution and use in source and binary forms, with or without
1812653Sandreas.sandberg@arm.com * modification, are permitted provided that the following conditions are
1912653Sandreas.sandberg@arm.com * met: redistributions of source code must retain the above copyright
2012653Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer;
2112653Sandreas.sandberg@arm.com * redistributions in binary form must reproduce the above copyright
2212653Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer in the
2312653Sandreas.sandberg@arm.com * documentation and/or other materials provided with the distribution;
2412653Sandreas.sandberg@arm.com * neither the name of the copyright holders nor the names of its
2512653Sandreas.sandberg@arm.com * contributors may be used to endorse or promote products derived from
2612653Sandreas.sandberg@arm.com * this software without specific prior written permission.
2712653Sandreas.sandberg@arm.com *
2812653Sandreas.sandberg@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
2912653Sandreas.sandberg@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
3012653Sandreas.sandberg@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
3112653Sandreas.sandberg@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
3212653Sandreas.sandberg@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
3312653Sandreas.sandberg@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
3412653Sandreas.sandberg@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
3512653Sandreas.sandberg@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
3612653Sandreas.sandberg@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
3712653Sandreas.sandberg@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
3812653Sandreas.sandberg@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
3912653Sandreas.sandberg@arm.com *
4012653Sandreas.sandberg@arm.com * Authors: Gabe Black
4112653Sandreas.sandberg@arm.com *          Andreas Sandberg
4212653Sandreas.sandberg@arm.com */
4312653Sandreas.sandberg@arm.com
4412653Sandreas.sandberg@arm.com#ifndef __DEV_PS2_MOUSE_HH__
4512653Sandreas.sandberg@arm.com#define __DEV_PS2_MOUSE_HH__
4612653Sandreas.sandberg@arm.com
4712653Sandreas.sandberg@arm.com#include "dev/ps2/device.hh"
4812653Sandreas.sandberg@arm.com
4912653Sandreas.sandberg@arm.comstruct PS2MouseParams;
5012653Sandreas.sandberg@arm.com
5112653Sandreas.sandberg@arm.comclass PS2Mouse : public PS2Device
5212653Sandreas.sandberg@arm.com{
5312653Sandreas.sandberg@arm.com  protected:
5412653Sandreas.sandberg@arm.com    BitUnion8(Status)
5512653Sandreas.sandberg@arm.com        Bitfield<6> remote;
5612653Sandreas.sandberg@arm.com        Bitfield<5> enabled;
5712653Sandreas.sandberg@arm.com        Bitfield<4> twoToOne;
5812653Sandreas.sandberg@arm.com        Bitfield<2> leftButton;
5912653Sandreas.sandberg@arm.com        Bitfield<0> rightButton;
6012653Sandreas.sandberg@arm.com    EndBitUnion(Status)
6112653Sandreas.sandberg@arm.com
6212653Sandreas.sandberg@arm.com    Status status;
6312653Sandreas.sandberg@arm.com    uint8_t resolution;
6412653Sandreas.sandberg@arm.com    uint8_t sampleRate;
6512653Sandreas.sandberg@arm.com
6612653Sandreas.sandberg@arm.com  public:
6712653Sandreas.sandberg@arm.com    PS2Mouse(const PS2MouseParams *p);
6812653Sandreas.sandberg@arm.com
6912653Sandreas.sandberg@arm.com    void serialize(CheckpointOut &cp) const override;
7012653Sandreas.sandberg@arm.com    void unserialize(CheckpointIn &cp) override;
7112653Sandreas.sandberg@arm.com
7212653Sandreas.sandberg@arm.com  protected: // PS2Device
7312656Sandreas.sandberg@arm.com    bool recv(const std::vector<uint8_t> &data) override;
7412653Sandreas.sandberg@arm.com};
7512653Sandreas.sandberg@arm.com
7612653Sandreas.sandberg@arm.com#endif // __DEV_PS2_MOUSE_hH__
7712653Sandreas.sandberg@arm.com
78