i8042.hh revision 10905
1/* 2 * Copyright (c) 2008 The Regents of The University of Michigan 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are 7 * met: redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer; 9 * redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution; 12 * neither the name of the copyright holders nor the names of its 13 * contributors may be used to endorse or promote products derived from 14 * this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * 28 * Authors: Gabe Black 29 */ 30 31#ifndef __DEV_X86_I8042_HH__ 32#define __DEV_X86_I8042_HH__ 33 34#include <queue> 35 36#include "dev/x86/intdev.hh" 37#include "dev/io_device.hh" 38#include "params/I8042.hh" 39 40namespace X86ISA 41{ 42 43class IntPin; 44 45class PS2Device 46{ 47 protected: 48 std::queue<uint8_t> outBuffer; 49 50 static const uint16_t NoCommand = (uint16_t)(-1); 51 52 uint16_t lastCommand; 53 void bufferData(const uint8_t *data, int size); 54 void ack(); 55 void nack(); 56 57 public: 58 virtual ~PS2Device() 59 {}; 60 61 PS2Device() : lastCommand(NoCommand) 62 {} 63 64 bool hasData() 65 { 66 return !outBuffer.empty(); 67 } 68 69 uint8_t getData() 70 { 71 uint8_t data = outBuffer.front(); 72 outBuffer.pop(); 73 return data; 74 } 75 76 virtual bool processData(uint8_t data) = 0; 77}; 78 79class PS2Mouse : public PS2Device 80{ 81 protected: 82 static const uint8_t ID[]; 83 84 enum Command 85 { 86 Scale1to1 = 0xE6, 87 Scale2to1 = 0xE7, 88 SetResolution = 0xE8, 89 GetStatus = 0xE9, 90 ReadData = 0xEB, 91 ResetWrapMode = 0xEC, 92 WrapMode = 0xEE, 93 RemoteMode = 0xF0, 94 ReadID = 0xF2, 95 SampleRate = 0xF3, 96 EnableReporting = 0xF4, 97 DisableReporting = 0xF5, 98 DefaultsAndDisable = 0xF6, 99 Resend = 0xFE, 100 Reset = 0xFF 101 }; 102 103 BitUnion8(Status) 104 Bitfield<6> remote; 105 Bitfield<5> enabled; 106 Bitfield<4> twoToOne; 107 Bitfield<2> leftButton; 108 Bitfield<0> rightButton; 109 EndBitUnion(Status) 110 111 Status status; 112 uint8_t resolution; 113 uint8_t sampleRate; 114 public: 115 PS2Mouse() : PS2Device(), status(0), resolution(4), sampleRate(100) 116 {} 117 118 bool processData(uint8_t data); 119 120 void serialize(const std::string &base, CheckpointOut &cp); 121 void unserialize(const std::string &base, CheckpointIn &cp); 122}; 123 124class PS2Keyboard : public PS2Device 125{ 126 protected: 127 static const uint8_t ID[]; 128 129 enum Command 130 { 131 LEDWrite = 0xED, 132 DiagnosticEcho = 0xEE, 133 AlternateScanCodes = 0xF0, 134 ReadID = 0xF2, 135 TypematicInfo = 0xF3, 136 Enable = 0xF4, 137 Disable = 0xF5, 138 DefaultsAndDisable = 0xF6, 139 AllKeysToTypematic = 0xF7, 140 AllKeysToMakeRelease = 0xF8, 141 AllKeysToMake = 0xF9, 142 AllKeysToTypematicMakeRelease = 0xFA, 143 KeyToTypematic = 0xFB, 144 KeyToMakeRelease = 0xFC, 145 KeyToMakeOnly = 0xFD, 146 Resend = 0xFE, 147 Reset = 0xFF 148 }; 149 150 public: 151 bool processData(uint8_t data); 152 153 void serialize(const std::string &base, CheckpointOut &cp); 154 void unserialize(const std::string &base, CheckpointIn &cp); 155}; 156 157class I8042 : public BasicPioDevice 158{ 159 protected: 160 enum Command 161 { 162 GetCommandByte = 0x20, 163 ReadControllerRamBase = 0x20, 164 WriteCommandByte = 0x60, 165 WriteControllerRamBase = 0x60, 166 CheckForPassword = 0xA4, 167 LoadPassword = 0xA5, 168 CheckPassword = 0xA6, 169 DisableMouse = 0xA7, 170 EnableMouse = 0xA8, 171 TestMouse = 0xA9, 172 SelfTest = 0xAA, 173 InterfaceTest = 0xAB, 174 DiagnosticDump = 0xAC, 175 DisableKeyboard = 0xAD, 176 EnableKeyboard = 0xAE, 177 ReadInputPort = 0xC0, 178 ContinuousPollLow = 0xC1, 179 ContinuousPollHigh = 0xC2, 180 ReadOutputPort = 0xD0, 181 WriteOutputPort = 0xD1, 182 WriteKeyboardOutputBuff = 0xD2, 183 WriteMouseOutputBuff = 0xD3, 184 WriteToMouse = 0xD4, 185 DisableA20 = 0xDD, 186 EnableA20 = 0xDF, 187 ReadTestInputs = 0xE0, 188 PulseOutputBitBase = 0xF0, 189 SystemReset = 0xFE 190 }; 191 192 BitUnion8(StatusReg) 193 Bitfield<7> parityError; 194 Bitfield<6> timeout; 195 Bitfield<5> mouseOutputFull; 196 Bitfield<4> keyboardUnlocked; 197 Bitfield<3> commandLast; 198 Bitfield<2> passedSelfTest; 199 Bitfield<1> inputFull; 200 Bitfield<0> outputFull; 201 EndBitUnion(StatusReg) 202 203 BitUnion8(CommandByte) 204 Bitfield<6> convertScanCodes; 205 Bitfield<5> disableMouse; 206 Bitfield<4> disableKeyboard; 207 Bitfield<2> passedSelfTest; 208 Bitfield<1> mouseFullInt; 209 Bitfield<0> keyboardFullInt; 210 EndBitUnion(CommandByte) 211 212 Tick latency; 213 Addr dataPort; 214 Addr commandPort; 215 216 StatusReg statusReg; 217 CommandByte commandByte; 218 219 uint8_t dataReg; 220 221 static const uint16_t NoCommand = (uint16_t)(-1); 222 uint16_t lastCommand; 223 224 IntSourcePin *mouseIntPin; 225 IntSourcePin *keyboardIntPin; 226 227 PS2Mouse mouse; 228 PS2Keyboard keyboard; 229 230 void writeData(uint8_t newData, bool mouse = false); 231 uint8_t readDataOut(); 232 233 public: 234 typedef I8042Params Params; 235 236 const Params * 237 params() const 238 { 239 return dynamic_cast<const Params *>(_params); 240 } 241 242 I8042(Params *p); 243 244 AddrRangeList getAddrRanges() const; 245 246 Tick read(PacketPtr pkt); 247 248 Tick write(PacketPtr pkt); 249 250 void serializeOld(CheckpointOut &cp) M5_ATTR_OVERRIDE; 251 void unserialize(CheckpointIn &cp) M5_ATTR_OVERRIDE; 252}; 253 254} // namespace X86ISA 255 256#endif //__DEV_X86_I8042_HH__ 257