i8042.cc (12514:09556145b380) i8042.cc (12653:4f6b6c1a8e2f)
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;

--- 29 unchanged lines hidden (view full) ---

38/**
39 * Note: For details on the implementation see
40 * https://wiki.osdev.org/%228042%22_PS/2_Controller
41 */
42
43// The 8042 has a whopping 32 bytes of internal RAM.
44const uint8_t RamSize = 32;
45const uint8_t NumOutputBits = 14;
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;

--- 29 unchanged lines hidden (view full) ---

38/**
39 * Note: For details on the implementation see
40 * https://wiki.osdev.org/%228042%22_PS/2_Controller
41 */
42
43// The 8042 has a whopping 32 bytes of internal RAM.
44const uint8_t RamSize = 32;
45const uint8_t NumOutputBits = 14;
46const uint8_t X86ISA::PS2Keyboard::ID[] = {0xab, 0x83};
47const uint8_t X86ISA::PS2Mouse::ID[] = {0x00};
48const uint8_t CommandAck = 0xfa;
49const uint8_t CommandNack = 0xfe;
50const uint8_t BatSuccessful = 0xaa;
51
52
53X86ISA::I8042::I8042(Params *p)
54 : BasicPioDevice(p, 0), // pioSize arg is dummy value... not used
55 latency(p->pio_latency),
56 dataPort(p->data_port), commandPort(p->command_port),
57 statusReg(0), commandByte(0), dataReg(0), lastCommand(NoCommand),
46
47
48X86ISA::I8042::I8042(Params *p)
49 : BasicPioDevice(p, 0), // pioSize arg is dummy value... not used
50 latency(p->pio_latency),
51 dataPort(p->data_port), commandPort(p->command_port),
52 statusReg(0), commandByte(0), dataReg(0), lastCommand(NoCommand),
58 mouseIntPin(p->mouse_int_pin), keyboardIntPin(p->keyboard_int_pin)
53 mouseIntPin(p->mouse_int_pin), keyboardIntPin(p->keyboard_int_pin),
54 mouse(p->mouse), keyboard(p->keyboard)
59{
55{
56 fatal_if(!mouse, "The i8042 model requires a mouse instance");
57 fatal_if(!keyboard, "The i8042 model requires a keyboard instance");
58
60 statusReg.passedSelfTest = 1;
61 statusReg.commandLast = 1;
62 statusReg.keyboardUnlocked = 1;
63
64 commandByte.convertScanCodes = 1;
65 commandByte.passedSelfTest = 1;
66 commandByte.keyboardFullInt = 1;
67}

--- 24 unchanged lines hidden (view full) ---

92 } else if (mouse && commandByte.mouseFullInt) {
93 DPRINTF(I8042, "Sending mouse interrupt.\n");
94 mouseIntPin->raise();
95 //This is a hack
96 mouseIntPin->lower();
97 }
98}
99
59 statusReg.passedSelfTest = 1;
60 statusReg.commandLast = 1;
61 statusReg.keyboardUnlocked = 1;
62
63 commandByte.convertScanCodes = 1;
64 commandByte.passedSelfTest = 1;
65 commandByte.keyboardFullInt = 1;
66}

--- 24 unchanged lines hidden (view full) ---

91 } else if (mouse && commandByte.mouseFullInt) {
92 DPRINTF(I8042, "Sending mouse interrupt.\n");
93 mouseIntPin->raise();
94 //This is a hack
95 mouseIntPin->lower();
96 }
97}
98
100void
101X86ISA::PS2Device::serialize(const std::string &base, CheckpointOut &cp) const
102{
103 paramOut(cp, base + ".lastCommand", lastCommand);
104
105 std::vector<uint8_t> buffer(outBuffer.size());
106 std::copy(outBuffer.begin(), outBuffer.end(), buffer.begin());
107 arrayParamOut(cp, base + ".outBuffer.elts", buffer);
108}
109
110void
111X86ISA::PS2Device::unserialize(const std::string &base, CheckpointIn &cp)
112{
113 paramIn(cp, base + ".lastCommand", lastCommand);
114
115 std::vector<uint8_t> buffer;
116 arrayParamIn(cp, base + ".outBuffer.elts", buffer);
117 assert(outBuffer.empty());
118 for (auto c : buffer)
119 outBuffer.push_back(c);
120}
121
122
123void
124X86ISA::PS2Device::ack()
125{
126 bufferData(&CommandAck, sizeof(CommandAck));
127}
128
129void
130X86ISA::PS2Device::nack()
131{
132 bufferData(&CommandNack, sizeof(CommandNack));
133}
134
135void
136X86ISA::PS2Device::bufferData(const uint8_t *data, int size)
137{
138 assert(data || size == 0);
139 while (size) {
140 outBuffer.push_back(*(data++));
141 size--;
142 }
143}
144
145uint8_t
146X86ISA::I8042::readDataOut()
147{
148 uint8_t data = dataReg;
149 statusReg.outputFull = 0;
150 statusReg.mouseOutputFull = 0;
99uint8_t
100X86ISA::I8042::readDataOut()
101{
102 uint8_t data = dataReg;
103 statusReg.outputFull = 0;
104 statusReg.mouseOutputFull = 0;
151 if (keyboard.hasData()) {
152 writeData(keyboard.getData(), false);
153 } else if (mouse.hasData()) {
154 writeData(mouse.getData(), true);
105 if (keyboard->hostDataAvailable()) {
106 writeData(keyboard->hostRead(), false);
107 } else if (mouse->hostDataAvailable()) {
108 writeData(mouse->hostRead(), true);
155 }
156 return data;
157}
158
109 }
110 return data;
111}
112
159bool
160X86ISA::PS2Keyboard::processData(uint8_t data)
161{
162 if (lastCommand != NoCommand) {
163 switch (lastCommand) {
164 case LEDWrite:
165 DPRINTF(I8042, "Setting LEDs: "
166 "caps lock %s, num lock %s, scroll lock %s\n",
167 bits(data, 2) ? "on" : "off",
168 bits(data, 1) ? "on" : "off",
169 bits(data, 0) ? "on" : "off");
170 ack();
171 lastCommand = NoCommand;
172 break;
173 case TypematicInfo:
174 DPRINTF(I8042, "Setting typematic info to %#02x.\n", data);
175 ack();
176 lastCommand = NoCommand;
177 break;
178 }
179 return hasData();
180 }
181 switch (data) {
182 case LEDWrite:
183 DPRINTF(I8042, "Got LED write command.\n");
184 ack();
185 lastCommand = LEDWrite;
186 break;
187 case DiagnosticEcho:
188 panic("Keyboard diagnostic echo unimplemented.\n");
189 case AlternateScanCodes:
190 panic("Accessing alternate scan codes unimplemented.\n");
191 case ReadID:
192 DPRINTF(I8042, "Got keyboard read ID command.\n");
193 ack();
194 bufferData((uint8_t *)&ID, sizeof(ID));
195 break;
196 case TypematicInfo:
197 DPRINTF(I8042, "Setting typematic info.\n");
198 ack();
199 lastCommand = TypematicInfo;
200 break;
201 case Enable:
202 DPRINTF(I8042, "Enabling the keyboard.\n");
203 ack();
204 break;
205 case Disable:
206 DPRINTF(I8042, "Disabling the keyboard.\n");
207 ack();
208 break;
209 case DefaultsAndDisable:
210 DPRINTF(I8042, "Disabling and resetting the keyboard.\n");
211 ack();
212 break;
213 case AllKeysToTypematic:
214 panic("Setting all keys to typemantic unimplemented.\n");
215 case AllKeysToMakeRelease:
216 panic("Setting all keys to make/release unimplemented.\n");
217 case AllKeysToMake:
218 panic("Setting all keys to make unimplemented.\n");
219 case AllKeysToTypematicMakeRelease:
220 panic("Setting all keys to "
221 "typematic/make/release unimplemented.\n");
222 case KeyToTypematic:
223 panic("Setting a key to typematic unimplemented.\n");
224 case KeyToMakeRelease:
225 panic("Setting a key to make/release unimplemented.\n");
226 case KeyToMakeOnly:
227 panic("Setting key to make only unimplemented.\n");
228 case Resend:
229 panic("Keyboard resend unimplemented.\n");
230 case Reset:
231 panic("Keyboard reset unimplemented.\n");
232 default:
233 panic("Unknown keyboard command %#02x.\n", data);
234 }
235 return hasData();
236}
237
238bool
239X86ISA::PS2Mouse::processData(uint8_t data)
240{
241 if (lastCommand != NoCommand) {
242 switch(lastCommand) {
243 case SetResolution:
244 DPRINTF(I8042, "Mouse resolution set to %d.\n", data);
245 resolution = data;
246 ack();
247 lastCommand = NoCommand;
248 break;
249 case SampleRate:
250 DPRINTF(I8042, "Mouse sample rate %d samples "
251 "per second.\n", data);
252 sampleRate = data;
253 ack();
254 lastCommand = NoCommand;
255 break;
256 default:
257 panic("Not expecting data for a mouse command.\n");
258 }
259 return hasData();
260 }
261 switch (data) {
262 case Scale1to1:
263 DPRINTF(I8042, "Setting mouse scale to 1:1.\n");
264 status.twoToOne = 0;
265 ack();
266 break;
267 case Scale2to1:
268 DPRINTF(I8042, "Setting mouse scale to 2:1.\n");
269 status.twoToOne = 1;
270 ack();
271 break;
272 case SetResolution:
273 DPRINTF(I8042, "Setting mouse resolution.\n");
274 lastCommand = SetResolution;
275 ack();
276 break;
277 case GetStatus:
278 DPRINTF(I8042, "Getting mouse status.\n");
279 ack();
280 bufferData((uint8_t *)&(status), 1);
281 bufferData(&resolution, sizeof(resolution));
282 bufferData(&sampleRate, sizeof(sampleRate));
283 break;
284 case ReadData:
285 panic("Reading mouse data unimplemented.\n");
286 case ResetWrapMode:
287 panic("Resetting mouse wrap mode unimplemented.\n");
288 case WrapMode:
289 panic("Setting mouse wrap mode unimplemented.\n");
290 case RemoteMode:
291 panic("Setting mouse remote mode unimplemented.\n");
292 case ReadID:
293 DPRINTF(I8042, "Mouse ID requested.\n");
294 ack();
295 bufferData(ID, sizeof(ID));
296 break;
297 case SampleRate:
298 DPRINTF(I8042, "Setting mouse sample rate.\n");
299 lastCommand = SampleRate;
300 ack();
301 break;
302 case DisableReporting:
303 DPRINTF(I8042, "Disabling data reporting.\n");
304 status.enabled = 0;
305 ack();
306 break;
307 case EnableReporting:
308 DPRINTF(I8042, "Enabling data reporting.\n");
309 status.enabled = 1;
310 ack();
311 break;
312 case DefaultsAndDisable:
313 DPRINTF(I8042, "Disabling and resetting mouse.\n");
314 sampleRate = 100;
315 resolution = 4;
316 status.twoToOne = 0;
317 status.enabled = 0;
318 ack();
319 break;
320 case Resend:
321 panic("Mouse resend unimplemented.\n");
322 case Reset:
323 DPRINTF(I8042, "Resetting the mouse.\n");
324 sampleRate = 100;
325 resolution = 4;
326 status.twoToOne = 0;
327 status.enabled = 0;
328 ack();
329 bufferData(&BatSuccessful, sizeof(BatSuccessful));
330 bufferData(ID, sizeof(ID));
331 break;
332 default:
333 warn("Unknown mouse command %#02x.\n", data);
334 nack();
335 break;
336 }
337 return hasData();
338}
339
340
341Tick
342X86ISA::I8042::read(PacketPtr pkt)
343{
344 assert(pkt->getSize() == 1);
345 Addr addr = pkt->getAddr();
346 if (addr == dataPort) {
347 uint8_t data = readDataOut();
348 //DPRINTF(I8042, "Read from data port got %#02x.\n", data);

--- 13 unchanged lines hidden (view full) ---

362{
363 assert(pkt->getSize() == 1);
364 Addr addr = pkt->getAddr();
365 uint8_t data = pkt->get<uint8_t>();
366 if (addr == dataPort) {
367 statusReg.commandLast = 0;
368 switch (lastCommand) {
369 case NoCommand:
113Tick
114X86ISA::I8042::read(PacketPtr pkt)
115{
116 assert(pkt->getSize() == 1);
117 Addr addr = pkt->getAddr();
118 if (addr == dataPort) {
119 uint8_t data = readDataOut();
120 //DPRINTF(I8042, "Read from data port got %#02x.\n", data);

--- 13 unchanged lines hidden (view full) ---

134{
135 assert(pkt->getSize() == 1);
136 Addr addr = pkt->getAddr();
137 uint8_t data = pkt->get<uint8_t>();
138 if (addr == dataPort) {
139 statusReg.commandLast = 0;
140 switch (lastCommand) {
141 case NoCommand:
370 if (keyboard.processData(data)) {
371 writeData(keyboard.getData(), false);
372 }
142 keyboard->hostWrite(data);
143 if (keyboard->hostDataAvailable())
144 writeData(keyboard->hostRead(), false);
373 break;
374 case WriteToMouse:
145 break;
146 case WriteToMouse:
375 if (mouse.processData(data)) {
376 writeData(mouse.getData(), true);
377 }
147 mouse->hostWrite(data);
148 if (mouse->hostDataAvailable())
149 writeData(mouse->hostRead(), true);
378 break;
379 case WriteCommandByte:
380 commandByte = data;
381 DPRINTF(I8042, "Got data %#02x for \"Write "
382 "command byte\" command.\n", data);
383 statusReg.passedSelfTest = (uint8_t)commandByte.passedSelfTest;
384 break;
385 case WriteMouseOutputBuff:

--- 119 unchanged lines hidden (view full) ---

505X86ISA::I8042::serialize(CheckpointOut &cp) const
506{
507 SERIALIZE_SCALAR(dataPort);
508 SERIALIZE_SCALAR(commandPort);
509 SERIALIZE_SCALAR(statusReg);
510 SERIALIZE_SCALAR(commandByte);
511 SERIALIZE_SCALAR(dataReg);
512 SERIALIZE_SCALAR(lastCommand);
150 break;
151 case WriteCommandByte:
152 commandByte = data;
153 DPRINTF(I8042, "Got data %#02x for \"Write "
154 "command byte\" command.\n", data);
155 statusReg.passedSelfTest = (uint8_t)commandByte.passedSelfTest;
156 break;
157 case WriteMouseOutputBuff:

--- 119 unchanged lines hidden (view full) ---

277X86ISA::I8042::serialize(CheckpointOut &cp) const
278{
279 SERIALIZE_SCALAR(dataPort);
280 SERIALIZE_SCALAR(commandPort);
281 SERIALIZE_SCALAR(statusReg);
282 SERIALIZE_SCALAR(commandByte);
283 SERIALIZE_SCALAR(dataReg);
284 SERIALIZE_SCALAR(lastCommand);
513 mouse.serialize("mouse", cp);
514 keyboard.serialize("keyboard", cp);
515}
516
517void
518X86ISA::I8042::unserialize(CheckpointIn &cp)
519{
520 UNSERIALIZE_SCALAR(dataPort);
521 UNSERIALIZE_SCALAR(commandPort);
522 UNSERIALIZE_SCALAR(statusReg);
523 UNSERIALIZE_SCALAR(commandByte);
524 UNSERIALIZE_SCALAR(dataReg);
525 UNSERIALIZE_SCALAR(lastCommand);
285}
286
287void
288X86ISA::I8042::unserialize(CheckpointIn &cp)
289{
290 UNSERIALIZE_SCALAR(dataPort);
291 UNSERIALIZE_SCALAR(commandPort);
292 UNSERIALIZE_SCALAR(statusReg);
293 UNSERIALIZE_SCALAR(commandByte);
294 UNSERIALIZE_SCALAR(dataReg);
295 UNSERIALIZE_SCALAR(lastCommand);
526 mouse.unserialize("mouse", cp);
527 keyboard.unserialize("keyboard", cp);
528}
529
296}
297
530void
531X86ISA::PS2Mouse::serialize(const std::string &base, CheckpointOut &cp) const
532{
533 PS2Device::serialize(base, cp);
534
535 paramOut(cp, base + ".status", status);
536 paramOut(cp, base + ".resolution", resolution);
537 paramOut(cp, base + ".sampleRate", sampleRate);
538}
539
540void
541X86ISA::PS2Mouse::unserialize(const std::string &base, CheckpointIn &cp)
542{
543 PS2Device::unserialize(base, cp);
544
545 paramIn(cp, base + ".status", status);
546 paramIn(cp, base + ".resolution", resolution);
547 paramIn(cp, base + ".sampleRate", sampleRate);
548}
549
550X86ISA::I8042 *
551I8042Params::create()
552{
553 return new X86ISA::I8042(this);
554}
298X86ISA::I8042 *
299I8042Params::create()
300{
301 return new X86ISA::I8042(this);
302}