device.hh revision 12653
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_DEVICE_HH__ 4512653Sandreas.sandberg@arm.com#define __DEV_PS2_DEVICE_HH__ 4612653Sandreas.sandberg@arm.com 4712653Sandreas.sandberg@arm.com#include <deque> 4812653Sandreas.sandberg@arm.com 4912653Sandreas.sandberg@arm.com#include "sim/sim_object.hh" 5012653Sandreas.sandberg@arm.com 5112653Sandreas.sandberg@arm.comstruct PS2DeviceParams; 5212653Sandreas.sandberg@arm.com 5312653Sandreas.sandberg@arm.comclass PS2Device : public SimObject 5412653Sandreas.sandberg@arm.com{ 5512653Sandreas.sandberg@arm.com public: 5612653Sandreas.sandberg@arm.com PS2Device(const PS2DeviceParams *p); 5712653Sandreas.sandberg@arm.com 5812653Sandreas.sandberg@arm.com void serialize(CheckpointOut &cp) const override; 5912653Sandreas.sandberg@arm.com void unserialize(CheckpointIn &cp) override; 6012653Sandreas.sandberg@arm.com 6112653Sandreas.sandberg@arm.com public: /* Host interface */ 6212653Sandreas.sandberg@arm.com /** 6312653Sandreas.sandberg@arm.com * Register a data available callback into the PS/2 interface 6412653Sandreas.sandberg@arm.com * 6512653Sandreas.sandberg@arm.com * @param c Callback instance from host interface 6612653Sandreas.sandberg@arm.com */ 6712653Sandreas.sandberg@arm.com void hostRegDataAvailable(const std::function<void()> &c); 6812653Sandreas.sandberg@arm.com 6912653Sandreas.sandberg@arm.com /** 7012653Sandreas.sandberg@arm.com * Check if there is pending data from the PS/2 device. 7112653Sandreas.sandberg@arm.com * 7212653Sandreas.sandberg@arm.com * @return true if there is data pending that can be read using 7312653Sandreas.sandberg@arm.com * the readData() method. 7412653Sandreas.sandberg@arm.com */ 7512653Sandreas.sandberg@arm.com bool hostDataAvailable() const { return !outBuffer.empty(); } 7612653Sandreas.sandberg@arm.com 7712653Sandreas.sandberg@arm.com /** 7812653Sandreas.sandberg@arm.com * Read a character from the device. 7912653Sandreas.sandberg@arm.com * 8012653Sandreas.sandberg@arm.com * @return Character from the device's output buffer, undefined if 8112653Sandreas.sandberg@arm.com * no data is pending. 8212653Sandreas.sandberg@arm.com */ 8312653Sandreas.sandberg@arm.com uint8_t hostRead(); 8412653Sandreas.sandberg@arm.com 8512653Sandreas.sandberg@arm.com /** 8612653Sandreas.sandberg@arm.com * Transmit a character from the host interface to the device. 8712653Sandreas.sandberg@arm.com * 8812653Sandreas.sandberg@arm.com * @param c Received data. 8912653Sandreas.sandberg@arm.com */ 9012653Sandreas.sandberg@arm.com void hostWrite(uint8_t c); 9112653Sandreas.sandberg@arm.com 9212653Sandreas.sandberg@arm.com protected: /* Device interface */ 9312653Sandreas.sandberg@arm.com /** 9412653Sandreas.sandberg@arm.com * Data received from host. 9512653Sandreas.sandberg@arm.com */ 9612653Sandreas.sandberg@arm.com virtual void recv(uint8_t data) = 0; 9712653Sandreas.sandberg@arm.com 9812653Sandreas.sandberg@arm.com /** 9912653Sandreas.sandberg@arm.com * Send data from a PS/2 device to a host 10012653Sandreas.sandberg@arm.com * 10112653Sandreas.sandberg@arm.com * @param data Pointer to data array 10212653Sandreas.sandberg@arm.com * @param size Size of the data array 10312653Sandreas.sandberg@arm.com */ 10412653Sandreas.sandberg@arm.com void send(const uint8_t *data, size_t size); 10512653Sandreas.sandberg@arm.com void send(const std::vector<uint8_t> &data) { 10612653Sandreas.sandberg@arm.com send(data.data(), data.size()); 10712653Sandreas.sandberg@arm.com } 10812653Sandreas.sandberg@arm.com 10912653Sandreas.sandberg@arm.com /** 11012653Sandreas.sandberg@arm.com * Send a byte of data from a PS/2 device to a host 11112653Sandreas.sandberg@arm.com * 11212653Sandreas.sandberg@arm.com * @param data Byte to send 11312653Sandreas.sandberg@arm.com */ 11412653Sandreas.sandberg@arm.com void send(uint8_t data) { send(&data, 1); } 11512653Sandreas.sandberg@arm.com 11612653Sandreas.sandberg@arm.com /** Send an ACK byte to the host */ 11712653Sandreas.sandberg@arm.com void sendAck(); 11812653Sandreas.sandberg@arm.com 11912653Sandreas.sandberg@arm.com /** 12012653Sandreas.sandberg@arm.com * Output buffer size 12112653Sandreas.sandberg@arm.com * 12212653Sandreas.sandberg@arm.com * Device models may use this method to query the size of the 12312653Sandreas.sandberg@arm.com * output buffer to do rate limiting. 12412653Sandreas.sandberg@arm.com */ 12512653Sandreas.sandberg@arm.com size_t sendPending() const { return outBuffer.size(); } 12612653Sandreas.sandberg@arm.com 12712653Sandreas.sandberg@arm.com private: 12812653Sandreas.sandberg@arm.com /** Device -> host FIFO */ 12912653Sandreas.sandberg@arm.com std::deque<uint8_t> outBuffer; 13012653Sandreas.sandberg@arm.com 13112653Sandreas.sandberg@arm.com std::function<void()> dataAvailableCallback; 13212653Sandreas.sandberg@arm.com}; 13312653Sandreas.sandberg@arm.com 13412653Sandreas.sandberg@arm.com#endif // __DEV_PS2_HOUSE_HH__ 135