2 * Copyright (c) 2008 The Regents of The University of Michigan
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.
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.
31 #ifndef __DEV_X86_I8042_HH__
32 #define __DEV_X86_I8042_HH__
34 #include "dev/io_device.hh"
35 #include "dev/x86/intdev.hh"
36 #include "params/I8042.hh"
48 std::queue<uint8_t> outBuffer;
50 static const uint16_t NoCommand = (uint16_t)(-1);
53 void bufferData(const uint8_t *data, int size);
61 PS2Device() : lastCommand(NoCommand)
66 return !outBuffer.empty();
71 uint8_t data = outBuffer.front();
76 virtual bool processData(uint8_t data) = 0;
79 class PS2Mouse : public PS2Device
82 static const uint8_t ID[];
96 EnableReporting = 0xF4,
97 DisableReporting = 0xF5,
98 DefaultsAndDisable = 0xF6,
106 Bitfield<4> twoToOne;
107 Bitfield<2> leftButton;
108 Bitfield<0> rightButton;
115 PS2Mouse() : PS2Device(), status(0), resolution(4), sampleRate(100)
118 bool processData(uint8_t data);
121 class PS2Keyboard : public PS2Device
124 static const uint8_t ID[];
129 DiagnosticEcho = 0xEE,
130 AlternateScanCodes = 0xF0,
132 TypematicInfo = 0xF3,
135 DefaultsAndDisable = 0xF6,
136 AllKeysToTypematic = 0xF7,
137 AllKeysToMakeRelease = 0xF8,
138 AllKeysToMake = 0xF9,
139 AllKeysToTypematicMakeRelease = 0xFA,
140 KeyToTypematic = 0xFB,
141 KeyToMakeRelease = 0xFC,
142 KeyToMakeOnly = 0xFD,
148 bool processData(uint8_t data);
151 class I8042 : public BasicPioDevice
156 GetCommandByte = 0x20,
157 ReadControllerRamBase = 0x20,
158 WriteCommandByte = 0x60,
159 WriteControllerRamBase = 0x60,
160 CheckForPassword = 0xA4,
162 CheckPassword = 0xA6,
167 InterfaceTest = 0xAB,
168 DiagnosticDump = 0xAC,
169 DisableKeyboard = 0xAD,
170 EnableKeyboard = 0xAE,
171 ReadInputPort = 0xC0,
172 ContinuousPollLow = 0xC1,
173 ContinuousPollHigh = 0xC2,
174 ReadOutputPort = 0xD0,
175 WriteOutputPort = 0xD1,
176 WriteKeyboardOutputBuff = 0xD2,
177 WriteMouseOutputBuff = 0xD3,
181 ReadTestInputs = 0xE0,
182 PulseOutputBitBase = 0xF0,
187 Bitfield<7> parityError;
189 Bitfield<5> mouseOutputFull;
190 Bitfield<4> keyboardUnlocked;
191 Bitfield<3> commandLast;
192 Bitfield<2> passedSelfTest;
193 Bitfield<1> inputFull;
194 Bitfield<0> outputFull;
195 EndBitUnion(StatusReg)
197 BitUnion8(CommandByte)
198 Bitfield<6> convertScanCodes;
199 Bitfield<5> disableMouse;
200 Bitfield<4> disableKeyboard;
201 Bitfield<2> passedSelfTest;
202 Bitfield<1> mouseFullInt;
203 Bitfield<0> keyboardFullInt;
204 EndBitUnion(CommandByte)
211 CommandByte commandByte;
215 static const uint16_t NoCommand = (uint16_t)(-1);
216 uint16_t lastCommand;
218 IntSourcePin *mouseIntPin;
219 IntSourcePin *keyboardIntPin;
222 PS2Keyboard keyboard;
224 void writeData(uint8_t newData, bool mouse = false);
225 uint8_t readDataOut();
228 typedef I8042Params Params;
233 return dynamic_cast<const Params *>(_params);
236 I8042(Params *p) : BasicPioDevice(p), latency(p->pio_latency),
237 dataPort(p->data_port), commandPort(p->command_port),
238 statusReg(0), commandByte(0), dataReg(0), lastCommand(NoCommand),
239 mouseIntPin(p->mouse_int_pin), keyboardIntPin(p->keyboard_int_pin)
241 statusReg.passedSelfTest = 1;
242 statusReg.commandLast = 1;
243 statusReg.keyboardUnlocked = 1;
245 commandByte.convertScanCodes = 1;
246 commandByte.passedSelfTest = 1;
247 commandByte.keyboardFullInt = 1;
250 void addressRanges(AddrRangeList &range_list);
252 Tick read(PacketPtr pkt);
254 Tick write(PacketPtr pkt);
257 }; // namespace X86ISA
259 #endif //__DEV_X86_I8042_HH__