blob: 04c1b3cbf91ce21471879e56752b3f8daa7bbf9f [file] [log] [blame]
bellard80cabfa2004-03-14 12:20:30 +00001/*
2 * QEMU PC keyboard emulation
ths5fafdf22007-09-16 21:08:06 +00003 *
bellard80cabfa2004-03-14 12:20:30 +00004 * Copyright (c) 2003 Fabrice Bellard
ths5fafdf22007-09-16 21:08:06 +00005 *
bellard80cabfa2004-03-14 12:20:30 +00006 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
Markus Armbruster71e8a912019-08-12 07:23:38 +020024
Peter Maydell04308912016-01-26 18:17:30 +000025#include "qemu/osdep.h"
Volker Rümelind1e45662021-05-25 20:14:35 +020026#include "qemu/error-report.h"
Philippe Mathieu-Daudéc2e846b2018-06-26 17:50:40 +010027#include "qemu/log.h"
Volker Rümelind1e45662021-05-25 20:14:35 +020028#include "qemu/timer.h"
Bernhard Beschowb86ce7a2022-03-01 23:00:33 +010029#include "qapi/error.h"
Paolo Bonzini0d09e412013-02-05 17:06:20 +010030#include "hw/isa/isa.h"
Markus Armbrusterd6454272019-08-12 07:23:45 +020031#include "migration/vmstate.h"
Igor Mammedov68f01312022-06-08 09:53:12 -040032#include "hw/acpi/acpi_aml_interface.h"
Paolo Bonzini0d09e412013-02-05 17:06:20 +010033#include "hw/input/ps2.h"
Markus Armbruster64552b62019-08-12 07:23:42 +020034#include "hw/irq.h"
Philippe Mathieu-Daudé47973a22018-03-08 23:39:24 +010035#include "hw/input/i8042.h"
Volker Rümelinff6e1622021-05-25 20:14:34 +020036#include "hw/qdev-properties.h"
Markus Armbruster71e8a912019-08-12 07:23:38 +020037#include "sysemu/reset.h"
Markus Armbruster54d31232019-08-12 07:23:59 +020038#include "sysemu/runstate.h"
bellard80cabfa2004-03-14 12:20:30 +000039
Dr. David Alan Gilbert65b182c2018-10-16 12:22:32 +010040#include "trace.h"
bellard80cabfa2004-03-14 12:20:30 +000041
Mark Cave-Ayland32be0152022-06-24 14:40:33 +010042/* Keyboard Controller Commands */
43
44/* Read mode bits */
45#define KBD_CCMD_READ_MODE 0x20
46/* Write mode bits */
47#define KBD_CCMD_WRITE_MODE 0x60
48/* Get controller version */
49#define KBD_CCMD_GET_VERSION 0xA1
50/* Disable mouse interface */
51#define KBD_CCMD_MOUSE_DISABLE 0xA7
52/* Enable mouse interface */
53#define KBD_CCMD_MOUSE_ENABLE 0xA8
54/* Mouse interface test */
55#define KBD_CCMD_TEST_MOUSE 0xA9
56/* Controller self test */
57#define KBD_CCMD_SELF_TEST 0xAA
58/* Keyboard interface test */
59#define KBD_CCMD_KBD_TEST 0xAB
60/* Keyboard interface disable */
61#define KBD_CCMD_KBD_DISABLE 0xAD
62/* Keyboard interface enable */
63#define KBD_CCMD_KBD_ENABLE 0xAE
64/* read input port */
65#define KBD_CCMD_READ_INPORT 0xC0
66/* read output port */
67#define KBD_CCMD_READ_OUTPORT 0xD0
68/* write output port */
69#define KBD_CCMD_WRITE_OUTPORT 0xD1
70#define KBD_CCMD_WRITE_OBUF 0xD2
71/* Write to output buffer as if initiated by the auxiliary device */
72#define KBD_CCMD_WRITE_AUX_OBUF 0xD3
73/* Write the following byte to the mouse */
74#define KBD_CCMD_WRITE_MOUSE 0xD4
75/* HP vectra only ? */
76#define KBD_CCMD_DISABLE_A20 0xDD
77/* HP vectra only ? */
78#define KBD_CCMD_ENABLE_A20 0xDF
79/* Pulse bits 3-0 of the output port P2. */
80#define KBD_CCMD_PULSE_BITS_3_0 0xF0
81/* Pulse bit 0 of the output port P2 = CPU reset. */
82#define KBD_CCMD_RESET 0xFE
83/* Pulse no bits of the output port P2. */
84#define KBD_CCMD_NO_OP 0xFF
bellard80cabfa2004-03-14 12:20:30 +000085
bellard80cabfa2004-03-14 12:20:30 +000086/* Status Register Bits */
Mark Cave-Ayland32be0152022-06-24 14:40:33 +010087
88/* Keyboard output buffer full */
89#define KBD_STAT_OBF 0x01
90/* Keyboard input buffer full */
91#define KBD_STAT_IBF 0x02
92/* Self test successful */
93#define KBD_STAT_SELFTEST 0x04
94/* Last write was a command write (0=data) */
95#define KBD_STAT_CMD 0x08
96/* Zero if keyboard locked */
97#define KBD_STAT_UNLOCKED 0x10
98/* Mouse output buffer full */
99#define KBD_STAT_MOUSE_OBF 0x20
100/* General receive/xmit timeout */
101#define KBD_STAT_GTO 0x40
102/* Parity error */
103#define KBD_STAT_PERR 0x80
bellard80cabfa2004-03-14 12:20:30 +0000104
105/* Controller Mode Register Bits */
Mark Cave-Ayland32be0152022-06-24 14:40:33 +0100106
107/* Keyboard data generate IRQ1 */
108#define KBD_MODE_KBD_INT 0x01
109/* Mouse data generate IRQ12 */
110#define KBD_MODE_MOUSE_INT 0x02
111/* The system flag (?) */
112#define KBD_MODE_SYS 0x04
113/* The keylock doesn't affect the keyboard if set */
114#define KBD_MODE_NO_KEYLOCK 0x08
115/* Disable keyboard interface */
116#define KBD_MODE_DISABLE_KBD 0x10
117/* Disable mouse interface */
118#define KBD_MODE_DISABLE_MOUSE 0x20
119/* Scan code conversion to PC format */
120#define KBD_MODE_KCC 0x40
121#define KBD_MODE_RFU 0x80
bellard80cabfa2004-03-14 12:20:30 +0000122
Blue Swirl956a3e62010-05-22 07:59:01 +0000123/* Output Port Bits */
124#define KBD_OUT_RESET 0x01 /* 1=normal mode, 0=reset */
125#define KBD_OUT_A20 0x02 /* x86 only */
126#define KBD_OUT_OBF 0x10 /* Keyboard output buffer full */
127#define KBD_OUT_MOUSE_OBF 0x20 /* Mouse output buffer full */
128
Mark Cave-Ayland32be0152022-06-24 14:40:33 +0100129/*
130 * OSes typically write 0xdd/0xdf to turn the A20 line off and on.
Paolo Bonzinid13c0402014-12-22 08:55:19 +0100131 * We make the default value of the outport include these four bits,
132 * so that the subsection is rarely necessary.
133 */
134#define KBD_OUT_ONES 0xcc
135
Volker Rümelinf6f57a82021-05-25 20:14:39 +0200136#define KBD_PENDING_KBD_COMPAT 0x01
137#define KBD_PENDING_AUX_COMPAT 0x02
Volker Rümelinaa67a422021-05-25 20:14:37 +0200138#define KBD_PENDING_CTRL_KBD 0x04
139#define KBD_PENDING_CTRL_AUX 0x08
Volker Rümelinf6f57a82021-05-25 20:14:39 +0200140#define KBD_PENDING_KBD KBD_MODE_DISABLE_KBD /* 0x10 */
141#define KBD_PENDING_AUX KBD_MODE_DISABLE_MOUSE /* 0x20 */
bellard80cabfa2004-03-14 12:20:30 +0000142
Volker Rümelind1e45662021-05-25 20:14:35 +0200143#define KBD_MIGR_TIMER_PENDING 0x1
144
Volker Rümelinac9192b2021-05-25 20:14:36 +0200145#define KBD_OBSRC_KBD 0x01
146#define KBD_OBSRC_MOUSE 0x02
Volker Rümelinaa67a422021-05-25 20:14:37 +0200147#define KBD_OBSRC_CTRL 0x04
Volker Rümelinac9192b2021-05-25 20:14:36 +0200148
bellard80cabfa2004-03-14 12:20:30 +0000149
Mark Cave-Ayland32be0152022-06-24 14:40:33 +0100150/*
151 * XXX: not generating the irqs if KBD_MODE_DISABLE_KBD is set may be
152 * incorrect, but it avoids having to simulate exact delays
153 */
Volker Rümelinc3c4a962021-05-25 20:14:33 +0200154static void kbd_update_irq_lines(KBDState *s)
bellard80cabfa2004-03-14 12:20:30 +0000155{
thsb7678d92007-02-18 00:08:44 +0000156 int irq_kbd_level, irq_mouse_level;
bellard80cabfa2004-03-14 12:20:30 +0000157
thsb7678d92007-02-18 00:08:44 +0000158 irq_kbd_level = 0;
159 irq_mouse_level = 0;
Volker Rümelinc3c4a962021-05-25 20:14:33 +0200160
161 if (s->status & KBD_STAT_OBF) {
162 if (s->status & KBD_STAT_MOUSE_OBF) {
163 if (s->mode & KBD_MODE_MOUSE_INT) {
164 irq_mouse_level = 1;
165 }
166 } else {
167 if ((s->mode & KBD_MODE_KBD_INT) &&
168 !(s->mode & KBD_MODE_DISABLE_KBD)) {
169 irq_kbd_level = 1;
170 }
171 }
172 }
Mark Cave-Aylandc2b17472022-06-24 14:40:50 +0100173 qemu_set_irq(s->irqs[I8042_KBD_IRQ], irq_kbd_level);
174 qemu_set_irq(s->irqs[I8042_MOUSE_IRQ], irq_mouse_level);
Volker Rümelinc3c4a962021-05-25 20:14:33 +0200175}
176
Volker Rümelinff6e1622021-05-25 20:14:34 +0200177static void kbd_deassert_irq(KBDState *s)
178{
179 s->status &= ~(KBD_STAT_OBF | KBD_STAT_MOUSE_OBF);
180 s->outport &= ~(KBD_OUT_OBF | KBD_OUT_MOUSE_OBF);
181 kbd_update_irq_lines(s);
182}
183
Volker Rümeline4697fa2021-05-25 20:14:38 +0200184static uint8_t kbd_pending(KBDState *s)
185{
Volker Rümelinf6f57a82021-05-25 20:14:39 +0200186 if (s->extended_state) {
187 return s->pending & (~s->mode | ~(KBD_PENDING_KBD | KBD_PENDING_AUX));
188 } else {
189 return s->pending;
190 }
Volker Rümeline4697fa2021-05-25 20:14:38 +0200191}
192
Volker Rümelinc3c4a962021-05-25 20:14:33 +0200193/* update irq and KBD_STAT_[MOUSE_]OBF */
194static void kbd_update_irq(KBDState *s)
195{
Volker Rümeline4697fa2021-05-25 20:14:38 +0200196 uint8_t pending = kbd_pending(s);
197
bellard80cabfa2004-03-14 12:20:30 +0000198 s->status &= ~(KBD_STAT_OBF | KBD_STAT_MOUSE_OBF);
Blue Swirl956a3e62010-05-22 07:59:01 +0000199 s->outport &= ~(KBD_OUT_OBF | KBD_OUT_MOUSE_OBF);
Volker Rümeline4697fa2021-05-25 20:14:38 +0200200 if (pending) {
bellard80cabfa2004-03-14 12:20:30 +0000201 s->status |= KBD_STAT_OBF;
Blue Swirl956a3e62010-05-22 07:59:01 +0000202 s->outport |= KBD_OUT_OBF;
Volker Rümeline4697fa2021-05-25 20:14:38 +0200203 if (pending & KBD_PENDING_CTRL_KBD) {
Volker Rümelinaa67a422021-05-25 20:14:37 +0200204 s->obsrc = KBD_OBSRC_CTRL;
Volker Rümeline4697fa2021-05-25 20:14:38 +0200205 } else if (pending & KBD_PENDING_CTRL_AUX) {
Volker Rümelinaa67a422021-05-25 20:14:37 +0200206 s->status |= KBD_STAT_MOUSE_OBF;
207 s->outport |= KBD_OUT_MOUSE_OBF;
208 s->obsrc = KBD_OBSRC_CTRL;
Volker Rümeline4697fa2021-05-25 20:14:38 +0200209 } else if (pending & KBD_PENDING_KBD) {
Volker Rümelinaa67a422021-05-25 20:14:37 +0200210 s->obsrc = KBD_OBSRC_KBD;
211 } else {
bellard80cabfa2004-03-14 12:20:30 +0000212 s->status |= KBD_STAT_MOUSE_OBF;
Blue Swirl956a3e62010-05-22 07:59:01 +0000213 s->outport |= KBD_OUT_MOUSE_OBF;
Volker Rümelinac9192b2021-05-25 20:14:36 +0200214 s->obsrc = KBD_OBSRC_MOUSE;
bellard80cabfa2004-03-14 12:20:30 +0000215 }
216 }
Volker Rümelinc3c4a962021-05-25 20:14:33 +0200217 kbd_update_irq_lines(s);
bellard80cabfa2004-03-14 12:20:30 +0000218}
219
Volker Rümelinff6e1622021-05-25 20:14:34 +0200220static void kbd_safe_update_irq(KBDState *s)
221{
222 /*
223 * with KBD_STAT_OBF set, a call to kbd_read_data() will eventually call
224 * kbd_update_irq()
225 */
226 if (s->status & KBD_STAT_OBF) {
227 return;
228 }
Volker Rümelind1e45662021-05-25 20:14:35 +0200229 /* the throttle timer is pending and will call kbd_update_irq() */
230 if (s->throttle_timer && timer_pending(s->throttle_timer)) {
231 return;
232 }
Volker Rümeline4697fa2021-05-25 20:14:38 +0200233 if (kbd_pending(s)) {
Volker Rümelinff6e1622021-05-25 20:14:34 +0200234 kbd_update_irq(s);
235 }
236}
237
bellarddaa57962005-11-26 10:14:03 +0000238static void kbd_update_kbd_irq(void *opaque, int level)
bellard80cabfa2004-03-14 12:20:30 +0000239{
Volker Rümelinff6e1622021-05-25 20:14:34 +0200240 KBDState *s = opaque;
bellard80cabfa2004-03-14 12:20:30 +0000241
Volker Rümelinff6e1622021-05-25 20:14:34 +0200242 if (level) {
bellarddaa57962005-11-26 10:14:03 +0000243 s->pending |= KBD_PENDING_KBD;
Volker Rümelinff6e1622021-05-25 20:14:34 +0200244 } else {
bellarddaa57962005-11-26 10:14:03 +0000245 s->pending &= ~KBD_PENDING_KBD;
Volker Rümelinff6e1622021-05-25 20:14:34 +0200246 }
247 kbd_safe_update_irq(s);
bellard80cabfa2004-03-14 12:20:30 +0000248}
249
bellarddaa57962005-11-26 10:14:03 +0000250static void kbd_update_aux_irq(void *opaque, int level)
bellard80cabfa2004-03-14 12:20:30 +0000251{
Volker Rümelinff6e1622021-05-25 20:14:34 +0200252 KBDState *s = opaque;
bellarddaa57962005-11-26 10:14:03 +0000253
Volker Rümelinff6e1622021-05-25 20:14:34 +0200254 if (level) {
bellarddaa57962005-11-26 10:14:03 +0000255 s->pending |= KBD_PENDING_AUX;
Volker Rümelinff6e1622021-05-25 20:14:34 +0200256 } else {
bellarddaa57962005-11-26 10:14:03 +0000257 s->pending &= ~KBD_PENDING_AUX;
Volker Rümelinff6e1622021-05-25 20:14:34 +0200258 }
259 kbd_safe_update_irq(s);
bellard80cabfa2004-03-14 12:20:30 +0000260}
261
Volker Rümelind1e45662021-05-25 20:14:35 +0200262static void kbd_throttle_timeout(void *opaque)
263{
264 KBDState *s = opaque;
265
Volker Rümeline4697fa2021-05-25 20:14:38 +0200266 if (kbd_pending(s)) {
Volker Rümelind1e45662021-05-25 20:14:35 +0200267 kbd_update_irq(s);
268 }
269}
270
Alexander Grafd540bfe2012-10-08 13:30:08 +0200271static uint64_t kbd_read_status(void *opaque, hwaddr addr,
272 unsigned size)
bellard80cabfa2004-03-14 12:20:30 +0000273{
bellardb41a2cd2004-03-14 21:46:48 +0000274 KBDState *s = opaque;
bellard80cabfa2004-03-14 12:20:30 +0000275 int val;
276 val = s->status;
Dr. David Alan Gilbert65b182c2018-10-16 12:22:32 +0100277 trace_pckbd_kbd_read_status(val);
bellard80cabfa2004-03-14 12:20:30 +0000278 return val;
279}
280
bellarddaa57962005-11-26 10:14:03 +0000281static void kbd_queue(KBDState *s, int b, int aux)
282{
Volker Rümelinaa67a422021-05-25 20:14:37 +0200283 if (s->extended_state) {
284 s->cbdata = b;
285 s->pending &= ~KBD_PENDING_CTRL_KBD & ~KBD_PENDING_CTRL_AUX;
286 s->pending |= aux ? KBD_PENDING_CTRL_AUX : KBD_PENDING_CTRL_KBD;
287 kbd_safe_update_irq(s);
288 } else {
Mark Cave-Ayland9d1a4252022-07-12 22:52:49 +0100289 ps2_queue(aux ? PS2_DEVICE(&s->ps2mouse) : PS2_DEVICE(&s->ps2kbd), b);
Volker Rümelinaa67a422021-05-25 20:14:37 +0200290 }
291}
292
293static uint8_t kbd_dequeue(KBDState *s)
294{
295 uint8_t b = s->cbdata;
296
297 s->pending &= ~KBD_PENDING_CTRL_KBD & ~KBD_PENDING_CTRL_AUX;
Volker Rümeline4697fa2021-05-25 20:14:38 +0200298 if (kbd_pending(s)) {
Volker Rümelinaa67a422021-05-25 20:14:37 +0200299 kbd_update_irq(s);
300 }
301 return b;
bellarddaa57962005-11-26 10:14:03 +0000302}
303
Blue Swirl4b78a802011-01-06 18:24:35 +0000304static void outport_write(KBDState *s, uint32_t val)
Blue Swirl956a3e62010-05-22 07:59:01 +0000305{
Dr. David Alan Gilbert65b182c2018-10-16 12:22:32 +0100306 trace_pckbd_outport_write(val);
Blue Swirl956a3e62010-05-22 07:59:01 +0000307 s->outport = val;
Efimov Vasily3115b9e2016-06-22 15:24:51 +0300308 qemu_set_irq(s->a20_out, (val >> 1) & 1);
Blue Swirl956a3e62010-05-22 07:59:01 +0000309 if (!(val & 1)) {
Eric Blakecf83f142017-05-15 16:41:13 -0500310 qemu_system_reset_request(SHUTDOWN_CAUSE_GUEST_RESET);
Blue Swirl956a3e62010-05-22 07:59:01 +0000311 }
312}
313
Alexander Grafd540bfe2012-10-08 13:30:08 +0200314static void kbd_write_command(void *opaque, hwaddr addr,
315 uint64_t val, unsigned size)
bellard80cabfa2004-03-14 12:20:30 +0000316{
bellardb41a2cd2004-03-14 21:46:48 +0000317 KBDState *s = opaque;
bellard80cabfa2004-03-14 12:20:30 +0000318
Dr. David Alan Gilbert65b182c2018-10-16 12:22:32 +0100319 trace_pckbd_kbd_write_command(val);
Bernhard Kohl5ccaa4c2010-08-19 14:52:12 +0200320
Mark Cave-Ayland32be0152022-06-24 14:40:33 +0100321 /*
322 * Bits 3-0 of the output port P2 of the keyboard controller may be pulsed
Bernhard Kohl5ccaa4c2010-08-19 14:52:12 +0200323 * low for approximately 6 micro seconds. Bits 3-0 of the KBD_CCMD_PULSE
324 * command specify the output port bits to be pulsed.
325 * 0: Bit should be pulsed. 1: Bit should not be modified.
326 * The only useful version of this command is pulsing bit 0,
327 * which does a CPU reset.
328 */
Mark Cave-Ayland32be0152022-06-24 14:40:33 +0100329 if ((val & KBD_CCMD_PULSE_BITS_3_0) == KBD_CCMD_PULSE_BITS_3_0) {
330 if (!(val & 1)) {
Bernhard Kohl5ccaa4c2010-08-19 14:52:12 +0200331 val = KBD_CCMD_RESET;
Mark Cave-Ayland32be0152022-06-24 14:40:33 +0100332 } else {
Bernhard Kohl5ccaa4c2010-08-19 14:52:12 +0200333 val = KBD_CCMD_NO_OP;
Mark Cave-Ayland32be0152022-06-24 14:40:33 +0100334 }
Bernhard Kohl5ccaa4c2010-08-19 14:52:12 +0200335 }
336
Mark Cave-Ayland32be0152022-06-24 14:40:33 +0100337 switch (val) {
bellard80cabfa2004-03-14 12:20:30 +0000338 case KBD_CCMD_READ_MODE:
balrog889bec62008-07-19 14:16:20 +0000339 kbd_queue(s, s->mode, 0);
bellard80cabfa2004-03-14 12:20:30 +0000340 break;
341 case KBD_CCMD_WRITE_MODE:
342 case KBD_CCMD_WRITE_OBUF:
343 case KBD_CCMD_WRITE_AUX_OBUF:
344 case KBD_CCMD_WRITE_MOUSE:
345 case KBD_CCMD_WRITE_OUTPORT:
346 s->write_cmd = val;
347 break;
348 case KBD_CCMD_MOUSE_DISABLE:
349 s->mode |= KBD_MODE_DISABLE_MOUSE;
350 break;
351 case KBD_CCMD_MOUSE_ENABLE:
352 s->mode &= ~KBD_MODE_DISABLE_MOUSE;
Volker Rümelinf6f57a82021-05-25 20:14:39 +0200353 kbd_safe_update_irq(s);
bellard80cabfa2004-03-14 12:20:30 +0000354 break;
355 case KBD_CCMD_TEST_MOUSE:
356 kbd_queue(s, 0x00, 0);
357 break;
358 case KBD_CCMD_SELF_TEST:
359 s->status |= KBD_STAT_SELFTEST;
360 kbd_queue(s, 0x55, 0);
361 break;
362 case KBD_CCMD_KBD_TEST:
363 kbd_queue(s, 0x00, 0);
364 break;
365 case KBD_CCMD_KBD_DISABLE:
366 s->mode |= KBD_MODE_DISABLE_KBD;
bellard80cabfa2004-03-14 12:20:30 +0000367 break;
368 case KBD_CCMD_KBD_ENABLE:
369 s->mode &= ~KBD_MODE_DISABLE_KBD;
Volker Rümelinff6e1622021-05-25 20:14:34 +0200370 kbd_safe_update_irq(s);
bellard80cabfa2004-03-14 12:20:30 +0000371 break;
372 case KBD_CCMD_READ_INPORT:
Hervé Poussineauf1b7e0e2014-02-11 23:46:03 +0100373 kbd_queue(s, 0x80, 0);
bellard80cabfa2004-03-14 12:20:30 +0000374 break;
375 case KBD_CCMD_READ_OUTPORT:
Blue Swirl956a3e62010-05-22 07:59:01 +0000376 kbd_queue(s, s->outport, 0);
bellard80cabfa2004-03-14 12:20:30 +0000377 break;
bellard80cabfa2004-03-14 12:20:30 +0000378 case KBD_CCMD_ENABLE_A20:
Efimov Vasily3115b9e2016-06-22 15:24:51 +0300379 qemu_irq_raise(s->a20_out);
Blue Swirl956a3e62010-05-22 07:59:01 +0000380 s->outport |= KBD_OUT_A20;
bellard80cabfa2004-03-14 12:20:30 +0000381 break;
382 case KBD_CCMD_DISABLE_A20:
Efimov Vasily3115b9e2016-06-22 15:24:51 +0300383 qemu_irq_lower(s->a20_out);
Blue Swirl956a3e62010-05-22 07:59:01 +0000384 s->outport &= ~KBD_OUT_A20;
bellard80cabfa2004-03-14 12:20:30 +0000385 break;
bellard80cabfa2004-03-14 12:20:30 +0000386 case KBD_CCMD_RESET:
Eric Blakecf83f142017-05-15 16:41:13 -0500387 qemu_system_reset_request(SHUTDOWN_CAUSE_GUEST_RESET);
bellard80cabfa2004-03-14 12:20:30 +0000388 break;
Bernhard Kohl5ccaa4c2010-08-19 14:52:12 +0200389 case KBD_CCMD_NO_OP:
390 /* ignore that */
bellard80cabfa2004-03-14 12:20:30 +0000391 break;
392 default:
Philippe Mathieu-Daudéc2e846b2018-06-26 17:50:40 +0100393 qemu_log_mask(LOG_GUEST_ERROR,
394 "unsupported keyboard cmd=0x%02" PRIx64 "\n", val);
bellard80cabfa2004-03-14 12:20:30 +0000395 break;
396 }
397}
398
Alexander Grafd540bfe2012-10-08 13:30:08 +0200399static uint64_t kbd_read_data(void *opaque, hwaddr addr,
400 unsigned size)
bellard80cabfa2004-03-14 12:20:30 +0000401{
bellardb41a2cd2004-03-14 21:46:48 +0000402 KBDState *s = opaque;
bellard80cabfa2004-03-14 12:20:30 +0000403
Volker Rümelinac9192b2021-05-25 20:14:36 +0200404 if (s->status & KBD_STAT_OBF) {
Volker Rümelinff6e1622021-05-25 20:14:34 +0200405 kbd_deassert_irq(s);
Volker Rümelinac9192b2021-05-25 20:14:36 +0200406 if (s->obsrc & KBD_OBSRC_KBD) {
Volker Rümelind1e45662021-05-25 20:14:35 +0200407 if (s->throttle_timer) {
408 timer_mod(s->throttle_timer,
409 qemu_clock_get_us(QEMU_CLOCK_VIRTUAL) + 1000);
410 }
Mark Cave-Ayland652fbff2022-07-12 22:52:47 +0100411 s->obdata = ps2_read_data(PS2_DEVICE(&s->ps2kbd));
Volker Rümelinac9192b2021-05-25 20:14:36 +0200412 } else if (s->obsrc & KBD_OBSRC_MOUSE) {
Mark Cave-Ayland9d1a4252022-07-12 22:52:49 +0100413 s->obdata = ps2_read_data(PS2_DEVICE(&s->ps2mouse));
Volker Rümelinaa67a422021-05-25 20:14:37 +0200414 } else if (s->obsrc & KBD_OBSRC_CTRL) {
415 s->obdata = kbd_dequeue(s);
Volker Rümelinff6e1622021-05-25 20:14:34 +0200416 }
417 }
bellard80cabfa2004-03-14 12:20:30 +0000418
Volker Rümelinff6e1622021-05-25 20:14:34 +0200419 trace_pckbd_kbd_read_data(s->obdata);
420 return s->obdata;
bellard80cabfa2004-03-14 12:20:30 +0000421}
422
Alexander Grafd540bfe2012-10-08 13:30:08 +0200423static void kbd_write_data(void *opaque, hwaddr addr,
424 uint64_t val, unsigned size)
bellard80cabfa2004-03-14 12:20:30 +0000425{
bellardb41a2cd2004-03-14 21:46:48 +0000426 KBDState *s = opaque;
bellard80cabfa2004-03-14 12:20:30 +0000427
Dr. David Alan Gilbert65b182c2018-10-16 12:22:32 +0100428 trace_pckbd_kbd_write_data(val);
bellard80cabfa2004-03-14 12:20:30 +0000429
Mark Cave-Ayland32be0152022-06-24 14:40:33 +0100430 switch (s->write_cmd) {
bellard80cabfa2004-03-14 12:20:30 +0000431 case 0:
Mark Cave-Ayland652fbff2022-07-12 22:52:47 +0100432 ps2_write_keyboard(&s->ps2kbd, val);
Volker Rümelinf6f57a82021-05-25 20:14:39 +0200433 /* sending data to the keyboard reenables PS/2 communication */
434 s->mode &= ~KBD_MODE_DISABLE_KBD;
435 kbd_safe_update_irq(s);
bellard80cabfa2004-03-14 12:20:30 +0000436 break;
437 case KBD_CCMD_WRITE_MODE:
438 s->mode = val;
Mark Cave-Ayland652fbff2022-07-12 22:52:47 +0100439 ps2_keyboard_set_translation(&s->ps2kbd,
440 (s->mode & KBD_MODE_KCC) != 0);
Volker Rümelinff6e1622021-05-25 20:14:34 +0200441 /*
442 * a write to the mode byte interrupt enable flags directly updates
443 * the irq lines
444 */
445 kbd_update_irq_lines(s);
446 /*
447 * a write to the mode byte disable interface flags may raise
448 * an irq if there is pending data in the PS/2 queues.
449 */
450 kbd_safe_update_irq(s);
bellard80cabfa2004-03-14 12:20:30 +0000451 break;
452 case KBD_CCMD_WRITE_OBUF:
453 kbd_queue(s, val, 0);
454 break;
455 case KBD_CCMD_WRITE_AUX_OBUF:
456 kbd_queue(s, val, 1);
457 break;
458 case KBD_CCMD_WRITE_OUTPORT:
Blue Swirl4b78a802011-01-06 18:24:35 +0000459 outport_write(s, val);
bellard80cabfa2004-03-14 12:20:30 +0000460 break;
461 case KBD_CCMD_WRITE_MOUSE:
Mark Cave-Ayland9d1a4252022-07-12 22:52:49 +0100462 ps2_write_mouse(&s->ps2mouse, val);
Volker Rümelinf6f57a82021-05-25 20:14:39 +0200463 /* sending data to the mouse reenables PS/2 communication */
464 s->mode &= ~KBD_MODE_DISABLE_MOUSE;
465 kbd_safe_update_irq(s);
bellard80cabfa2004-03-14 12:20:30 +0000466 break;
467 default:
468 break;
469 }
470 s->write_cmd = 0;
471}
472
bellardd7d02e32004-06-20 12:58:36 +0000473static void kbd_reset(void *opaque)
bellard80cabfa2004-03-14 12:20:30 +0000474{
bellardd7d02e32004-06-20 12:58:36 +0000475 KBDState *s = opaque;
bellard80cabfa2004-03-14 12:20:30 +0000476
bellard80cabfa2004-03-14 12:20:30 +0000477 s->mode = KBD_MODE_KBD_INT | KBD_MODE_MOUSE_INT;
478 s->status = KBD_STAT_CMD | KBD_STAT_UNLOCKED;
Paolo Bonzinid13c0402014-12-22 08:55:19 +0100479 s->outport = KBD_OUT_RESET | KBD_OUT_A20 | KBD_OUT_ONES;
Volker Rümelinff6e1622021-05-25 20:14:34 +0200480 s->pending = 0;
481 kbd_deassert_irq(s);
Volker Rümelind1e45662021-05-25 20:14:35 +0200482 if (s->throttle_timer) {
483 timer_del(s->throttle_timer);
484 }
Pavel Dovgalyuka28fe7e2014-08-28 15:19:14 +0400485}
486
487static uint8_t kbd_outport_default(KBDState *s)
488{
Paolo Bonzinid13c0402014-12-22 08:55:19 +0100489 return KBD_OUT_RESET | KBD_OUT_A20 | KBD_OUT_ONES
Pavel Dovgalyuka28fe7e2014-08-28 15:19:14 +0400490 | (s->status & KBD_STAT_OBF ? KBD_OUT_OBF : 0)
491 | (s->status & KBD_STAT_MOUSE_OBF ? KBD_OUT_MOUSE_OBF : 0);
492}
493
494static int kbd_outport_post_load(void *opaque, int version_id)
495{
496 KBDState *s = opaque;
497 s->outport_present = true;
498 return 0;
499}
500
Pavel Dovgalyuka28fe7e2014-08-28 15:19:14 +0400501static bool kbd_outport_needed(void *opaque)
502{
503 KBDState *s = opaque;
504 return s->outport != kbd_outport_default(s);
505}
506
Juan Quintela5cd8cad2014-09-23 14:09:54 +0200507static const VMStateDescription vmstate_kbd_outport = {
508 .name = "pckbd_outport",
509 .version_id = 1,
510 .minimum_version_id = 1,
511 .post_load = kbd_outport_post_load,
512 .needed = kbd_outport_needed,
Richard Hendersonaf0f07d2023-12-21 14:16:14 +1100513 .fields = (const VMStateField[]) {
Juan Quintela5cd8cad2014-09-23 14:09:54 +0200514 VMSTATE_UINT8(outport, KBDState),
515 VMSTATE_END_OF_LIST()
516 }
517};
518
Volker Rümelind1e45662021-05-25 20:14:35 +0200519static int kbd_extended_state_pre_save(void *opaque)
520{
521 KBDState *s = opaque;
522
523 s->migration_flags = 0;
524 if (s->throttle_timer && timer_pending(s->throttle_timer)) {
525 s->migration_flags |= KBD_MIGR_TIMER_PENDING;
526 }
527
528 return 0;
529}
530
531static int kbd_extended_state_post_load(void *opaque, int version_id)
532{
533 KBDState *s = opaque;
534
535 if (s->migration_flags & KBD_MIGR_TIMER_PENDING) {
536 kbd_throttle_timeout(s);
537 }
Volker Rümelinac9192b2021-05-25 20:14:36 +0200538 s->extended_state_loaded = true;
Volker Rümelind1e45662021-05-25 20:14:35 +0200539
540 return 0;
541}
542
Volker Rümelinff6e1622021-05-25 20:14:34 +0200543static bool kbd_extended_state_needed(void *opaque)
544{
545 KBDState *s = opaque;
546
547 return s->extended_state;
548}
549
550static const VMStateDescription vmstate_kbd_extended_state = {
551 .name = "pckbd/extended_state",
Volker Rümelind1e45662021-05-25 20:14:35 +0200552 .post_load = kbd_extended_state_post_load,
553 .pre_save = kbd_extended_state_pre_save,
Volker Rümelinff6e1622021-05-25 20:14:34 +0200554 .needed = kbd_extended_state_needed,
Richard Hendersonaf0f07d2023-12-21 14:16:14 +1100555 .fields = (const VMStateField[]) {
Volker Rümelind1e45662021-05-25 20:14:35 +0200556 VMSTATE_UINT32(migration_flags, KBDState),
Volker Rümelinac9192b2021-05-25 20:14:36 +0200557 VMSTATE_UINT32(obsrc, KBDState),
Volker Rümelinff6e1622021-05-25 20:14:34 +0200558 VMSTATE_UINT8(obdata, KBDState),
Volker Rümelinaa67a422021-05-25 20:14:37 +0200559 VMSTATE_UINT8(cbdata, KBDState),
Volker Rümelinff6e1622021-05-25 20:14:34 +0200560 VMSTATE_END_OF_LIST()
561 }
562};
563
Volker Rümelinf6f57a82021-05-25 20:14:39 +0200564static int kbd_pre_save(void *opaque)
565{
566 KBDState *s = opaque;
567
568 if (s->extended_state) {
569 s->pending_tmp = s->pending;
570 } else {
571 s->pending_tmp = 0;
572 if (s->pending & KBD_PENDING_KBD) {
573 s->pending_tmp |= KBD_PENDING_KBD_COMPAT;
574 }
575 if (s->pending & KBD_PENDING_AUX) {
576 s->pending_tmp |= KBD_PENDING_AUX_COMPAT;
577 }
578 }
579 return 0;
580}
581
Volker Rümelinac9192b2021-05-25 20:14:36 +0200582static int kbd_pre_load(void *opaque)
583{
584 KBDState *s = opaque;
585
Volker Rümelin9d74e6c2021-05-25 20:14:41 +0200586 s->outport_present = false;
Volker Rümelinac9192b2021-05-25 20:14:36 +0200587 s->extended_state_loaded = false;
588 return 0;
589}
590
Pavel Dovgalyuka28fe7e2014-08-28 15:19:14 +0400591static int kbd_post_load(void *opaque, int version_id)
592{
593 KBDState *s = opaque;
594 if (!s->outport_present) {
595 s->outport = kbd_outport_default(s);
596 }
Volker Rümelinf6f57a82021-05-25 20:14:39 +0200597 s->pending = s->pending_tmp;
Volker Rümelinac9192b2021-05-25 20:14:36 +0200598 if (!s->extended_state_loaded) {
599 s->obsrc = s->status & KBD_STAT_OBF ?
600 (s->status & KBD_STAT_MOUSE_OBF ? KBD_OBSRC_MOUSE : KBD_OBSRC_KBD) :
601 0;
Volker Rümelinf6f57a82021-05-25 20:14:39 +0200602 if (s->pending & KBD_PENDING_KBD_COMPAT) {
603 s->pending |= KBD_PENDING_KBD;
604 }
605 if (s->pending & KBD_PENDING_AUX_COMPAT) {
606 s->pending |= KBD_PENDING_AUX;
607 }
Volker Rümelinac9192b2021-05-25 20:14:36 +0200608 }
Volker Rümelinf6f57a82021-05-25 20:14:39 +0200609 /* clear all unused flags */
610 s->pending &= KBD_PENDING_CTRL_KBD | KBD_PENDING_CTRL_AUX |
611 KBD_PENDING_KBD | KBD_PENDING_AUX;
Pavel Dovgalyuka28fe7e2014-08-28 15:19:14 +0400612 return 0;
bellard80cabfa2004-03-14 12:20:30 +0000613}
614
Juan Quintela3c619b52009-09-10 03:04:41 +0200615static const VMStateDescription vmstate_kbd = {
616 .name = "pckbd",
617 .version_id = 3,
618 .minimum_version_id = 3,
Volker Rümelinac9192b2021-05-25 20:14:36 +0200619 .pre_load = kbd_pre_load,
Pavel Dovgalyuka28fe7e2014-08-28 15:19:14 +0400620 .post_load = kbd_post_load,
Volker Rümelinf6f57a82021-05-25 20:14:39 +0200621 .pre_save = kbd_pre_save,
Richard Hendersonaf0f07d2023-12-21 14:16:14 +1100622 .fields = (const VMStateField[]) {
Juan Quintela3c619b52009-09-10 03:04:41 +0200623 VMSTATE_UINT8(write_cmd, KBDState),
624 VMSTATE_UINT8(status, KBDState),
625 VMSTATE_UINT8(mode, KBDState),
Volker Rümelinf6f57a82021-05-25 20:14:39 +0200626 VMSTATE_UINT8(pending_tmp, KBDState),
Juan Quintela3c619b52009-09-10 03:04:41 +0200627 VMSTATE_END_OF_LIST()
Pavel Dovgalyuka28fe7e2014-08-28 15:19:14 +0400628 },
Richard Hendersonaf0f07d2023-12-21 14:16:14 +1100629 .subsections = (const VMStateDescription * const []) {
Juan Quintela5cd8cad2014-09-23 14:09:54 +0200630 &vmstate_kbd_outport,
Volker Rümelinff6e1622021-05-25 20:14:34 +0200631 &vmstate_kbd_extended_state,
Juan Quintela5cd8cad2014-09-23 14:09:54 +0200632 NULL
Juan Quintela3c619b52009-09-10 03:04:41 +0200633 }
634};
bellard675376f2004-07-10 13:39:53 +0000635
thsb92bb992007-04-16 17:20:48 +0000636/* Memory mapped interface */
Peter Maydell58765032018-06-15 14:57:13 +0100637static uint64_t kbd_mm_readfn(void *opaque, hwaddr addr, unsigned size)
thsb92bb992007-04-16 17:20:48 +0000638{
639 KBDState *s = opaque;
640
Mark Cave-Ayland32be0152022-06-24 14:40:33 +0100641 if (addr & s->mask) {
Alexander Grafd540bfe2012-10-08 13:30:08 +0200642 return kbd_read_status(s, 0, 1) & 0xff;
Mark Cave-Ayland32be0152022-06-24 14:40:33 +0100643 } else {
Alexander Grafd540bfe2012-10-08 13:30:08 +0200644 return kbd_read_data(s, 0, 1) & 0xff;
Mark Cave-Ayland32be0152022-06-24 14:40:33 +0100645 }
thsb92bb992007-04-16 17:20:48 +0000646}
647
Peter Maydell58765032018-06-15 14:57:13 +0100648static void kbd_mm_writefn(void *opaque, hwaddr addr,
649 uint64_t value, unsigned size)
thsb92bb992007-04-16 17:20:48 +0000650{
651 KBDState *s = opaque;
652
Mark Cave-Ayland32be0152022-06-24 14:40:33 +0100653 if (addr & s->mask) {
Alexander Grafd540bfe2012-10-08 13:30:08 +0200654 kbd_write_command(s, 0, value & 0xff, 1);
Mark Cave-Ayland32be0152022-06-24 14:40:33 +0100655 } else {
Alexander Grafd540bfe2012-10-08 13:30:08 +0200656 kbd_write_data(s, 0, value & 0xff, 1);
Mark Cave-Ayland32be0152022-06-24 14:40:33 +0100657 }
thsb92bb992007-04-16 17:20:48 +0000658}
659
Peter Maydell58765032018-06-15 14:57:13 +0100660
Richard Hendersondbff76a2011-08-10 15:28:17 -0700661static const MemoryRegionOps i8042_mmio_ops = {
Peter Maydell58765032018-06-15 14:57:13 +0100662 .read = kbd_mm_readfn,
663 .write = kbd_mm_writefn,
664 .valid.min_access_size = 1,
665 .valid.max_access_size = 4,
Richard Hendersondbff76a2011-08-10 15:28:17 -0700666 .endianness = DEVICE_NATIVE_ENDIAN,
thsb92bb992007-04-16 17:20:48 +0000667};
668
Mark Cave-Aylandcb663a82022-06-24 14:41:04 +0100669static void i8042_mmio_set_kbd_irq(void *opaque, int n, int level)
670{
671 MMIOKBDState *s = I8042_MMIO(opaque);
672 KBDState *ks = &s->kbd;
673
674 kbd_update_kbd_irq(ks, level);
675}
676
677static void i8042_mmio_set_mouse_irq(void *opaque, int n, int level)
678{
679 MMIOKBDState *s = I8042_MMIO(opaque);
680 KBDState *ks = &s->kbd;
681
682 kbd_update_aux_irq(ks, level);
683}
684
Mark Cave-Ayland57f6c3a2022-06-24 14:40:37 +0100685static void i8042_mmio_reset(DeviceState *dev)
686{
687 MMIOKBDState *s = I8042_MMIO(dev);
688 KBDState *ks = &s->kbd;
689
690 kbd_reset(ks);
691}
692
Mark Cave-Aylandf4de68d2022-06-24 14:40:40 +0100693static void i8042_mmio_realize(DeviceState *dev, Error **errp)
694{
695 MMIOKBDState *s = I8042_MMIO(dev);
696 KBDState *ks = &s->kbd;
697
698 memory_region_init_io(&s->region, OBJECT(dev), &i8042_mmio_ops, ks,
699 "i8042", s->size);
700
701 sysbus_init_mmio(SYS_BUS_DEVICE(dev), &s->region);
Mark Cave-Ayland75877e92022-06-24 14:40:44 +0100702
Mark Cave-Ayland652fbff2022-07-12 22:52:47 +0100703 if (!sysbus_realize(SYS_BUS_DEVICE(&ks->ps2kbd), errp)) {
704 return;
705 }
706
Mark Cave-Ayland9d1a4252022-07-12 22:52:49 +0100707 if (!sysbus_realize(SYS_BUS_DEVICE(&ks->ps2mouse), errp)) {
708 return;
709 }
710
Mark Cave-Ayland652fbff2022-07-12 22:52:47 +0100711 qdev_connect_gpio_out(DEVICE(&ks->ps2kbd), PS2_DEVICE_IRQ,
Mark Cave-Aylandcb663a82022-06-24 14:41:04 +0100712 qdev_get_gpio_in_named(dev, "ps2-kbd-input-irq",
713 0));
Mark Cave-Ayland652fbff2022-07-12 22:52:47 +0100714
Mark Cave-Ayland9d1a4252022-07-12 22:52:49 +0100715 qdev_connect_gpio_out(DEVICE(&ks->ps2mouse), PS2_DEVICE_IRQ,
Mark Cave-Aylandcb663a82022-06-24 14:41:04 +0100716 qdev_get_gpio_in_named(dev, "ps2-mouse-input-irq",
717 0));
Mark Cave-Aylandf4de68d2022-06-24 14:40:40 +0100718}
719
Mark Cave-Ayland47fc7412022-06-24 14:40:41 +0100720static void i8042_mmio_init(Object *obj)
721{
722 MMIOKBDState *s = I8042_MMIO(obj);
723 KBDState *ks = &s->kbd;
724
725 ks->extended_state = true;
Mark Cave-Aylandcb663a82022-06-24 14:41:04 +0100726
Mark Cave-Ayland652fbff2022-07-12 22:52:47 +0100727 object_initialize_child(obj, "ps2kbd", &ks->ps2kbd, TYPE_PS2_KBD_DEVICE);
Mark Cave-Ayland9d1a4252022-07-12 22:52:49 +0100728 object_initialize_child(obj, "ps2mouse", &ks->ps2mouse,
729 TYPE_PS2_MOUSE_DEVICE);
Mark Cave-Ayland652fbff2022-07-12 22:52:47 +0100730
Mark Cave-Aylandcb663a82022-06-24 14:41:04 +0100731 qdev_init_gpio_out(DEVICE(obj), ks->irqs, 2);
732 qdev_init_gpio_in_named(DEVICE(obj), i8042_mmio_set_kbd_irq,
733 "ps2-kbd-input-irq", 1);
734 qdev_init_gpio_in_named(DEVICE(obj), i8042_mmio_set_mouse_irq,
735 "ps2-mouse-input-irq", 1);
Mark Cave-Ayland47fc7412022-06-24 14:40:41 +0100736}
737
Mark Cave-Aylandd4f5b4d2022-06-24 14:40:38 +0100738static Property i8042_mmio_properties[] = {
739 DEFINE_PROP_UINT64("mask", MMIOKBDState, kbd.mask, UINT64_MAX),
Mark Cave-Ayland7b9fff22022-06-24 14:40:39 +0100740 DEFINE_PROP_UINT32("size", MMIOKBDState, size, -1),
Mark Cave-Aylandd4f5b4d2022-06-24 14:40:38 +0100741 DEFINE_PROP_END_OF_LIST(),
742};
743
Mark Cave-Aylandabcacb22022-07-12 22:52:46 +0100744static const VMStateDescription vmstate_kbd_mmio = {
745 .name = "pckbd-mmio",
746 .version_id = 1,
747 .minimum_version_id = 1,
Richard Hendersonaf0f07d2023-12-21 14:16:14 +1100748 .fields = (const VMStateField[]) {
Mark Cave-Aylandabcacb22022-07-12 22:52:46 +0100749 VMSTATE_STRUCT(kbd, MMIOKBDState, 0, vmstate_kbd, KBDState),
750 VMSTATE_END_OF_LIST()
751 }
752};
753
Mark Cave-Ayland150ee012022-06-24 14:40:36 +0100754static void i8042_mmio_class_init(ObjectClass *klass, void *data)
755{
756 DeviceClass *dc = DEVICE_CLASS(klass);
757
Mark Cave-Aylandf4de68d2022-06-24 14:40:40 +0100758 dc->realize = i8042_mmio_realize;
Peter Maydelle3d08142024-09-13 15:31:44 +0100759 device_class_set_legacy_reset(dc, i8042_mmio_reset);
Mark Cave-Aylandabcacb22022-07-12 22:52:46 +0100760 dc->vmsd = &vmstate_kbd_mmio;
Mark Cave-Aylandd4f5b4d2022-06-24 14:40:38 +0100761 device_class_set_props(dc, i8042_mmio_properties);
Mark Cave-Ayland150ee012022-06-24 14:40:36 +0100762 set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
763}
764
Mark Cave-Ayland150ee012022-06-24 14:40:36 +0100765static const TypeInfo i8042_mmio_info = {
766 .name = TYPE_I8042_MMIO,
767 .parent = TYPE_SYS_BUS_DEVICE,
Mark Cave-Ayland47fc7412022-06-24 14:40:41 +0100768 .instance_init = i8042_mmio_init,
Mark Cave-Ayland150ee012022-06-24 14:40:36 +0100769 .instance_size = sizeof(MMIOKBDState),
770 .class_init = i8042_mmio_class_init
771};
772
Marc-André Lureau0fe4bb32019-10-17 17:06:05 +0200773void i8042_isa_mouse_fake_event(ISAKBDState *isa)
Blue Swirl956a3e62010-05-22 07:59:01 +0000774{
Andreas Färbera2e0b862013-04-27 22:18:47 +0200775 KBDState *s = &isa->kbd;
Blue Swirl956a3e62010-05-22 07:59:01 +0000776
Mark Cave-Ayland9d1a4252022-07-12 22:52:49 +0100777 ps2_mouse_fake_event(&s->ps2mouse);
Blue Swirl956a3e62010-05-22 07:59:01 +0000778}
779
Blue Swirld05ac8f2009-12-04 20:44:44 +0000780static const VMStateDescription vmstate_kbd_isa = {
Juan Quintelabe73cfe2009-12-02 12:36:46 +0100781 .name = "pckbd",
782 .version_id = 3,
783 .minimum_version_id = 3,
Richard Hendersonaf0f07d2023-12-21 14:16:14 +1100784 .fields = (const VMStateField[]) {
Juan Quintelabe73cfe2009-12-02 12:36:46 +0100785 VMSTATE_STRUCT(kbd, ISAKBDState, 0, vmstate_kbd, KBDState),
786 VMSTATE_END_OF_LIST()
787 }
788};
789
Richard Hendersondbff76a2011-08-10 15:28:17 -0700790static const MemoryRegionOps i8042_data_ops = {
Alexander Grafd540bfe2012-10-08 13:30:08 +0200791 .read = kbd_read_data,
792 .write = kbd_write_data,
793 .impl = {
794 .min_access_size = 1,
795 .max_access_size = 1,
796 },
797 .endianness = DEVICE_LITTLE_ENDIAN,
Richard Hendersondbff76a2011-08-10 15:28:17 -0700798};
799
800static const MemoryRegionOps i8042_cmd_ops = {
Alexander Grafd540bfe2012-10-08 13:30:08 +0200801 .read = kbd_read_status,
802 .write = kbd_write_command,
803 .impl = {
804 .min_access_size = 1,
805 .max_access_size = 1,
806 },
807 .endianness = DEVICE_LITTLE_ENDIAN,
Richard Hendersondbff76a2011-08-10 15:28:17 -0700808};
809
Mark Cave-Ayland6eb252d2022-06-24 14:41:07 +0100810static void i8042_set_kbd_irq(void *opaque, int n, int level)
811{
812 ISAKBDState *s = I8042(opaque);
813 KBDState *ks = &s->kbd;
814
815 kbd_update_kbd_irq(ks, level);
816}
817
818static void i8042_set_mouse_irq(void *opaque, int n, int level)
819{
820 ISAKBDState *s = I8042(opaque);
821 KBDState *ks = &s->kbd;
822
823 kbd_update_aux_irq(ks, level);
824}
825
826
Mark Cave-Ayland55870d62022-06-24 14:41:06 +0100827static void i8042_reset(DeviceState *dev)
828{
829 ISAKBDState *s = I8042(dev);
830 KBDState *ks = &s->kbd;
831
832 kbd_reset(ks);
833}
834
Andreas Färberdb895a12012-11-25 02:37:14 +0100835static void i8042_initfn(Object *obj)
Gerd Hoffmannda85ccf2009-07-31 12:30:15 +0200836{
Andreas Färberdb895a12012-11-25 02:37:14 +0100837 ISAKBDState *isa_s = I8042(obj);
838 KBDState *s = &isa_s->kbd;
839
Paolo Bonzini1437c942013-06-06 21:25:08 -0400840 memory_region_init_io(isa_s->io + 0, obj, &i8042_data_ops, s,
841 "i8042-data", 1);
842 memory_region_init_io(isa_s->io + 1, obj, &i8042_cmd_ops, s,
843 "i8042-cmd", 1);
Efimov Vasily3115b9e2016-06-22 15:24:51 +0300844
Mark Cave-Ayland652fbff2022-07-12 22:52:47 +0100845 object_initialize_child(obj, "ps2kbd", &s->ps2kbd, TYPE_PS2_KBD_DEVICE);
Mark Cave-Ayland9d1a4252022-07-12 22:52:49 +0100846 object_initialize_child(obj, "ps2mouse", &s->ps2mouse,
847 TYPE_PS2_MOUSE_DEVICE);
Mark Cave-Ayland652fbff2022-07-12 22:52:47 +0100848
Efimov Vasily3115b9e2016-06-22 15:24:51 +0300849 qdev_init_gpio_out_named(DEVICE(obj), &s->a20_out, I8042_A20_LINE, 1);
Mark Cave-Ayland6eb252d2022-06-24 14:41:07 +0100850
851 qdev_init_gpio_out(DEVICE(obj), s->irqs, 2);
852 qdev_init_gpio_in_named(DEVICE(obj), i8042_set_kbd_irq,
853 "ps2-kbd-input-irq", 1);
854 qdev_init_gpio_in_named(DEVICE(obj), i8042_set_mouse_irq,
855 "ps2-mouse-input-irq", 1);
Andreas Färberdb895a12012-11-25 02:37:14 +0100856}
857
858static void i8042_realizefn(DeviceState *dev, Error **errp)
859{
860 ISADevice *isadev = ISA_DEVICE(dev);
Andreas Färbera2e0b862013-04-27 22:18:47 +0200861 ISAKBDState *isa_s = I8042(dev);
Richard Hendersondbff76a2011-08-10 15:28:17 -0700862 KBDState *s = &isa_s->kbd;
Gerd Hoffmannda85ccf2009-07-31 12:30:15 +0200863
Bernhard Beschowb86ce7a2022-03-01 23:00:33 +0100864 if (isa_s->kbd_irq >= ISA_NUM_IRQS) {
865 error_setg(errp, "Maximum value for \"kbd-irq\" is: %u",
866 ISA_NUM_IRQS - 1);
867 return;
868 }
869
870 if (isa_s->mouse_irq >= ISA_NUM_IRQS) {
871 error_setg(errp, "Maximum value for \"mouse-irq\" is: %u",
872 ISA_NUM_IRQS - 1);
873 return;
874 }
875
Mark Cave-Ayland6eb252d2022-06-24 14:41:07 +0100876 isa_connect_gpio_out(isadev, I8042_KBD_IRQ, isa_s->kbd_irq);
877 isa_connect_gpio_out(isadev, I8042_MOUSE_IRQ, isa_s->mouse_irq);
Gerd Hoffmannda85ccf2009-07-31 12:30:15 +0200878
Andreas Färberdb895a12012-11-25 02:37:14 +0100879 isa_register_ioport(isadev, isa_s->io + 0, 0x60);
880 isa_register_ioport(isadev, isa_s->io + 1, 0x64);
Gerd Hoffmannda85ccf2009-07-31 12:30:15 +0200881
Mark Cave-Ayland652fbff2022-07-12 22:52:47 +0100882 if (!sysbus_realize(SYS_BUS_DEVICE(&s->ps2kbd), errp)) {
883 return;
884 }
885
886 qdev_connect_gpio_out(DEVICE(&s->ps2kbd), PS2_DEVICE_IRQ,
Mark Cave-Ayland6eb252d2022-06-24 14:41:07 +0100887 qdev_get_gpio_in_named(dev, "ps2-kbd-input-irq",
888 0));
Mark Cave-Ayland652fbff2022-07-12 22:52:47 +0100889
Mark Cave-Ayland9d1a4252022-07-12 22:52:49 +0100890 if (!sysbus_realize(SYS_BUS_DEVICE(&s->ps2mouse), errp)) {
891 return;
892 }
893
894 qdev_connect_gpio_out(DEVICE(&s->ps2mouse), PS2_DEVICE_IRQ,
Mark Cave-Ayland6eb252d2022-06-24 14:41:07 +0100895 qdev_get_gpio_in_named(dev, "ps2-mouse-input-irq",
896 0));
Mark Cave-Ayland9d1a4252022-07-12 22:52:49 +0100897
Volker Rümelind1e45662021-05-25 20:14:35 +0200898 if (isa_s->kbd_throttle && !isa_s->kbd.extended_state) {
899 warn_report(TYPE_I8042 ": can't enable kbd-throttle without"
900 " extended-state, disabling kbd-throttle");
901 } else if (isa_s->kbd_throttle) {
902 s->throttle_timer = timer_new_us(QEMU_CLOCK_VIRTUAL,
903 kbd_throttle_timeout, s);
904 }
Gerd Hoffmannda85ccf2009-07-31 12:30:15 +0200905}
906
Igor Mammedov68f01312022-06-08 09:53:12 -0400907static void i8042_build_aml(AcpiDevAmlIf *adev, Aml *scope)
Gerd Hoffmanndf0f3d12020-06-19 11:18:59 +0200908{
Igor Mammedov68f01312022-06-08 09:53:12 -0400909 ISAKBDState *isa_s = I8042(adev);
Gerd Hoffmanndf0f3d12020-06-19 11:18:59 +0200910 Aml *kbd;
911 Aml *mou;
912 Aml *crs;
913
914 crs = aml_resource_template();
915 aml_append(crs, aml_io(AML_DECODE16, 0x0060, 0x0060, 0x01, 0x01));
916 aml_append(crs, aml_io(AML_DECODE16, 0x0064, 0x0064, 0x01, 0x01));
Bernhard Beschowb86ce7a2022-03-01 23:00:33 +0100917 aml_append(crs, aml_irq_no_flags(isa_s->kbd_irq));
Gerd Hoffmanndf0f3d12020-06-19 11:18:59 +0200918
919 kbd = aml_device("KBD");
920 aml_append(kbd, aml_name_decl("_HID", aml_eisaid("PNP0303")));
921 aml_append(kbd, aml_name_decl("_STA", aml_int(0xf)));
922 aml_append(kbd, aml_name_decl("_CRS", crs));
923
924 crs = aml_resource_template();
Bernhard Beschowb86ce7a2022-03-01 23:00:33 +0100925 aml_append(crs, aml_irq_no_flags(isa_s->mouse_irq));
Gerd Hoffmanndf0f3d12020-06-19 11:18:59 +0200926
927 mou = aml_device("MOU");
928 aml_append(mou, aml_name_decl("_HID", aml_eisaid("PNP0F13")));
929 aml_append(mou, aml_name_decl("_STA", aml_int(0xf)));
930 aml_append(mou, aml_name_decl("_CRS", crs));
931
932 aml_append(scope, kbd);
933 aml_append(scope, mou);
934}
935
Volker Rümelinff6e1622021-05-25 20:14:34 +0200936static Property i8042_properties[] = {
937 DEFINE_PROP_BOOL("extended-state", ISAKBDState, kbd.extended_state, true),
Volker Rümelind1e45662021-05-25 20:14:35 +0200938 DEFINE_PROP_BOOL("kbd-throttle", ISAKBDState, kbd_throttle, false),
Bernhard Beschowb86ce7a2022-03-01 23:00:33 +0100939 DEFINE_PROP_UINT8("kbd-irq", ISAKBDState, kbd_irq, 1),
940 DEFINE_PROP_UINT8("mouse-irq", ISAKBDState, mouse_irq, 12),
Volker Rümelinff6e1622021-05-25 20:14:34 +0200941 DEFINE_PROP_END_OF_LIST(),
942};
943
Anthony Liguori8f04ee02011-12-04 11:52:49 -0600944static void i8042_class_initfn(ObjectClass *klass, void *data)
945{
Anthony Liguori39bffca2011-12-07 21:34:16 -0600946 DeviceClass *dc = DEVICE_CLASS(klass);
Igor Mammedov68f01312022-06-08 09:53:12 -0400947 AcpiDevAmlIfClass *adevc = ACPI_DEV_AML_IF_CLASS(klass);
Andreas Färberdb895a12012-11-25 02:37:14 +0100948
Volker Rümelinff6e1622021-05-25 20:14:34 +0200949 device_class_set_props(dc, i8042_properties);
Peter Maydelle3d08142024-09-13 15:31:44 +0100950 device_class_set_legacy_reset(dc, i8042_reset);
Andreas Färberdb895a12012-11-25 02:37:14 +0100951 dc->realize = i8042_realizefn;
Anthony Liguori39bffca2011-12-07 21:34:16 -0600952 dc->vmsd = &vmstate_kbd_isa;
Igor Mammedov68f01312022-06-08 09:53:12 -0400953 adevc->build_dev_aml = i8042_build_aml;
kumar souravcbe9ed72019-01-25 20:44:40 +0530954 set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
Anthony Liguori8f04ee02011-12-04 11:52:49 -0600955}
956
Andreas Färber8c43a6f2013-01-10 16:19:07 +0100957static const TypeInfo i8042_info = {
Andreas Färbera2e0b862013-04-27 22:18:47 +0200958 .name = TYPE_I8042,
Anthony Liguori39bffca2011-12-07 21:34:16 -0600959 .parent = TYPE_ISA_DEVICE,
960 .instance_size = sizeof(ISAKBDState),
Andreas Färberdb895a12012-11-25 02:37:14 +0100961 .instance_init = i8042_initfn,
Anthony Liguori39bffca2011-12-07 21:34:16 -0600962 .class_init = i8042_class_initfn,
Igor Mammedov68f01312022-06-08 09:53:12 -0400963 .interfaces = (InterfaceInfo[]) {
964 { TYPE_ACPI_DEV_AML_IF },
965 { },
966 },
Gerd Hoffmannda85ccf2009-07-31 12:30:15 +0200967};
968
Andreas Färber83f7d432012-02-09 15:20:55 +0100969static void i8042_register_types(void)
Gerd Hoffmannda85ccf2009-07-31 12:30:15 +0200970{
Anthony Liguori39bffca2011-12-07 21:34:16 -0600971 type_register_static(&i8042_info);
Mark Cave-Ayland150ee012022-06-24 14:40:36 +0100972 type_register_static(&i8042_mmio_info);
Gerd Hoffmannda85ccf2009-07-31 12:30:15 +0200973}
Andreas Färber83f7d432012-02-09 15:20:55 +0100974
975type_init(i8042_register_types)