blob: 67fcb3595f683b9d5fc8e361c921d4ecfe7b1241 [file] [log] [blame]
Michael Walle87a381e2011-03-07 23:32:37 +01001/*
2 * QEMU model of the Milkymist SoftUSB block.
3 *
4 * Copyright (c) 2010 Michael Walle <michael@walle.cc>
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 *
19 *
20 * Specification available at:
21 * not available yet
22 */
23
Peter Maydellea99dde2016-01-26 18:16:57 +000024#include "qemu/osdep.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010025#include "qapi/error.h"
Paolo Bonzini83c9f4c2013-02-04 15:40:22 +010026#include "hw/sysbus.h"
Markus Armbrusterd6454272019-08-12 07:23:45 +020027#include "migration/vmstate.h"
Michael Walle87a381e2011-03-07 23:32:37 +010028#include "trace.h"
Paolo Bonzini28ecbae2012-11-28 12:06:30 +010029#include "ui/console.h"
Paolo Bonzini0d09e412013-02-05 17:06:20 +010030#include "hw/input/hid.h"
Markus Armbruster64552b62019-08-12 07:23:42 +020031#include "hw/irq.h"
Markus Armbrustera27bd6c2019-08-12 07:23:51 +020032#include "hw/qdev-properties.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010033#include "qemu/error-report.h"
Markus Armbruster0b8fa322019-05-23 16:35:07 +020034#include "qemu/module.h"
Michael Walle87a381e2011-03-07 23:32:37 +010035
36enum {
37 R_CTRL = 0,
38 R_MAX
39};
40
41enum {
42 CTRL_RESET = (1<<0),
43};
44
45#define COMLOC_DEBUG_PRODUCE 0x1000
46#define COMLOC_DEBUG_BASE 0x1001
47#define COMLOC_MEVT_PRODUCE 0x1101
48#define COMLOC_MEVT_BASE 0x1102
49#define COMLOC_KEVT_PRODUCE 0x1142
50#define COMLOC_KEVT_BASE 0x1143
51
Andreas Färber2a052f62013-07-26 18:37:02 +020052#define TYPE_MILKYMIST_SOFTUSB "milkymist-softusb"
53#define MILKYMIST_SOFTUSB(obj) \
54 OBJECT_CHECK(MilkymistSoftUsbState, (obj), TYPE_MILKYMIST_SOFTUSB)
55
Michael Walle87a381e2011-03-07 23:32:37 +010056struct MilkymistSoftUsbState {
Andreas Färber2a052f62013-07-26 18:37:02 +020057 SysBusDevice parent_obj;
58
Michael Walle4c15ba92011-08-09 23:54:55 +020059 HIDState hid_kbd;
60 HIDState hid_mouse;
Michael Walle87a381e2011-03-07 23:32:37 +010061
Avi Kivity5105ed32011-08-08 21:40:35 +030062 MemoryRegion regs_region;
63 MemoryRegion pmem;
64 MemoryRegion dmem;
Michael Walle87a381e2011-03-07 23:32:37 +010065 qemu_irq irq;
66
Peter Maydellc34e1202013-03-15 14:34:22 +000067 void *pmem_ptr;
68 void *dmem_ptr;
69
Michael Walle87a381e2011-03-07 23:32:37 +010070 /* device properties */
Michael Walle87a381e2011-03-07 23:32:37 +010071 uint32_t pmem_size;
Michael Walle87a381e2011-03-07 23:32:37 +010072 uint32_t dmem_size;
73
74 /* device registers */
75 uint32_t regs[R_MAX];
76
77 /* mouse state */
Michael Walle4c15ba92011-08-09 23:54:55 +020078 uint8_t mouse_hid_buffer[4];
Michael Walle87a381e2011-03-07 23:32:37 +010079
80 /* keyboard state */
Michael Walle4c15ba92011-08-09 23:54:55 +020081 uint8_t kbd_hid_buffer[8];
Michael Walle87a381e2011-03-07 23:32:37 +010082};
83typedef struct MilkymistSoftUsbState MilkymistSoftUsbState;
84
Avi Kivitya8170e52012-10-23 12:30:10 +020085static uint64_t softusb_read(void *opaque, hwaddr addr,
Avi Kivity5105ed32011-08-08 21:40:35 +030086 unsigned size)
Michael Walle87a381e2011-03-07 23:32:37 +010087{
88 MilkymistSoftUsbState *s = opaque;
89 uint32_t r = 0;
90
91 addr >>= 2;
92 switch (addr) {
93 case R_CTRL:
94 r = s->regs[addr];
95 break;
96
97 default:
98 error_report("milkymist_softusb: read access to unknown register 0x"
99 TARGET_FMT_plx, addr << 2);
100 break;
101 }
102
103 trace_milkymist_softusb_memory_read(addr << 2, r);
104
105 return r;
106}
107
108static void
Avi Kivitya8170e52012-10-23 12:30:10 +0200109softusb_write(void *opaque, hwaddr addr, uint64_t value,
Avi Kivity5105ed32011-08-08 21:40:35 +0300110 unsigned size)
Michael Walle87a381e2011-03-07 23:32:37 +0100111{
112 MilkymistSoftUsbState *s = opaque;
113
114 trace_milkymist_softusb_memory_write(addr, value);
115
116 addr >>= 2;
117 switch (addr) {
118 case R_CTRL:
119 s->regs[addr] = value;
120 break;
121
122 default:
123 error_report("milkymist_softusb: write access to unknown register 0x"
124 TARGET_FMT_plx, addr << 2);
125 break;
126 }
127}
128
Avi Kivity5105ed32011-08-08 21:40:35 +0300129static const MemoryRegionOps softusb_mmio_ops = {
130 .read = softusb_read,
131 .write = softusb_write,
132 .endianness = DEVICE_NATIVE_ENDIAN,
133 .valid = {
134 .min_access_size = 4,
135 .max_access_size = 4,
136 },
Michael Walle87a381e2011-03-07 23:32:37 +0100137};
138
139static inline void softusb_read_dmem(MilkymistSoftUsbState *s,
140 uint32_t offset, uint8_t *buf, uint32_t len)
141{
142 if (offset + len >= s->dmem_size) {
143 error_report("milkymist_softusb: read dmem out of bounds "
Markus Armbruster6daf1942011-06-22 14:03:54 +0200144 "at offset 0x%x, len %d", offset, len);
Peter Maydellc31bc982013-03-28 18:43:04 +0000145 memset(buf, 0, len);
Michael Walle87a381e2011-03-07 23:32:37 +0100146 return;
147 }
148
Peter Maydellc34e1202013-03-15 14:34:22 +0000149 memcpy(buf, s->dmem_ptr + offset, len);
Michael Walle87a381e2011-03-07 23:32:37 +0100150}
151
152static inline void softusb_write_dmem(MilkymistSoftUsbState *s,
153 uint32_t offset, uint8_t *buf, uint32_t len)
154{
155 if (offset + len >= s->dmem_size) {
156 error_report("milkymist_softusb: write dmem out of bounds "
Markus Armbruster6daf1942011-06-22 14:03:54 +0200157 "at offset 0x%x, len %d", offset, len);
Michael Walle87a381e2011-03-07 23:32:37 +0100158 return;
159 }
160
Peter Maydellc34e1202013-03-15 14:34:22 +0000161 memcpy(s->dmem_ptr + offset, buf, len);
Michael Walle87a381e2011-03-07 23:32:37 +0100162}
163
Michael Walle87a381e2011-03-07 23:32:37 +0100164static void softusb_mouse_changed(MilkymistSoftUsbState *s)
165{
166 uint8_t m;
Michael Walle87a381e2011-03-07 23:32:37 +0100167
168 softusb_read_dmem(s, COMLOC_MEVT_PRODUCE, &m, 1);
169 trace_milkymist_softusb_mevt(m);
Michael Walle4c15ba92011-08-09 23:54:55 +0200170 softusb_write_dmem(s, COMLOC_MEVT_BASE + 4 * m, s->mouse_hid_buffer, 4);
Michael Walle87a381e2011-03-07 23:32:37 +0100171 m = (m + 1) & 0xf;
172 softusb_write_dmem(s, COMLOC_MEVT_PRODUCE, &m, 1);
173
174 trace_milkymist_softusb_pulse_irq();
175 qemu_irq_pulse(s->irq);
176}
177
178static void softusb_kbd_changed(MilkymistSoftUsbState *s)
179{
180 uint8_t m;
181
182 softusb_read_dmem(s, COMLOC_KEVT_PRODUCE, &m, 1);
183 trace_milkymist_softusb_kevt(m);
Michael Walle4c15ba92011-08-09 23:54:55 +0200184 softusb_write_dmem(s, COMLOC_KEVT_BASE + 8 * m, s->kbd_hid_buffer, 8);
Michael Walle87a381e2011-03-07 23:32:37 +0100185 m = (m + 1) & 0x7;
186 softusb_write_dmem(s, COMLOC_KEVT_PRODUCE, &m, 1);
187
188 trace_milkymist_softusb_pulse_irq();
189 qemu_irq_pulse(s->irq);
190}
191
Michael Walle4c15ba92011-08-09 23:54:55 +0200192static void softusb_kbd_hid_datain(HIDState *hs)
Michael Walle87a381e2011-03-07 23:32:37 +0100193{
Michael Walle4c15ba92011-08-09 23:54:55 +0200194 MilkymistSoftUsbState *s = container_of(hs, MilkymistSoftUsbState, hid_kbd);
195 int len;
Michael Walle87a381e2011-03-07 23:32:37 +0100196
197 /* if device is in reset, do nothing */
198 if (s->regs[R_CTRL] & CTRL_RESET) {
199 return;
200 }
201
Michael Walle857ccca2014-10-04 20:00:07 +0200202 while (hid_has_events(hs)) {
203 len = hid_keyboard_poll(hs, s->kbd_hid_buffer,
204 sizeof(s->kbd_hid_buffer));
Michael Walle87a381e2011-03-07 23:32:37 +0100205
Michael Walle857ccca2014-10-04 20:00:07 +0200206 if (len == 8) {
207 softusb_kbd_changed(s);
208 }
Michael Walle4c15ba92011-08-09 23:54:55 +0200209 }
Michael Walle87a381e2011-03-07 23:32:37 +0100210}
211
Michael Walle4c15ba92011-08-09 23:54:55 +0200212static void softusb_mouse_hid_datain(HIDState *hs)
Michael Walle87a381e2011-03-07 23:32:37 +0100213{
Michael Walle4c15ba92011-08-09 23:54:55 +0200214 MilkymistSoftUsbState *s =
215 container_of(hs, MilkymistSoftUsbState, hid_mouse);
216 int len;
Michael Walle87a381e2011-03-07 23:32:37 +0100217
Michael Walle4c15ba92011-08-09 23:54:55 +0200218 /* if device is in reset, do nothing */
219 if (s->regs[R_CTRL] & CTRL_RESET) {
220 return;
221 }
Michael Walle87a381e2011-03-07 23:32:37 +0100222
Michael Walle857ccca2014-10-04 20:00:07 +0200223 while (hid_has_events(hs)) {
224 len = hid_pointer_poll(hs, s->mouse_hid_buffer,
225 sizeof(s->mouse_hid_buffer));
Michael Walle87a381e2011-03-07 23:32:37 +0100226
Michael Walle857ccca2014-10-04 20:00:07 +0200227 if (len == 4) {
228 softusb_mouse_changed(s);
229 }
Michael Walle4c15ba92011-08-09 23:54:55 +0200230 }
Michael Walle87a381e2011-03-07 23:32:37 +0100231}
232
Michael Walle87a381e2011-03-07 23:32:37 +0100233static void milkymist_softusb_reset(DeviceState *d)
234{
Andreas Färber2a052f62013-07-26 18:37:02 +0200235 MilkymistSoftUsbState *s = MILKYMIST_SOFTUSB(d);
Michael Walle87a381e2011-03-07 23:32:37 +0100236 int i;
237
238 for (i = 0; i < R_MAX; i++) {
239 s->regs[i] = 0;
240 }
Michael Walle4c15ba92011-08-09 23:54:55 +0200241 memset(s->kbd_hid_buffer, 0, sizeof(s->kbd_hid_buffer));
242 memset(s->mouse_hid_buffer, 0, sizeof(s->mouse_hid_buffer));
243
244 hid_reset(&s->hid_kbd);
245 hid_reset(&s->hid_mouse);
Michael Walle87a381e2011-03-07 23:32:37 +0100246
247 /* defaults */
248 s->regs[R_CTRL] = CTRL_RESET;
249}
250
Mao Zhongyif1e321a2018-12-13 13:47:58 +0000251static void milkymist_softusb_realize(DeviceState *dev, Error **errp)
Michael Walle87a381e2011-03-07 23:32:37 +0100252{
Andreas Färber2a052f62013-07-26 18:37:02 +0200253 MilkymistSoftUsbState *s = MILKYMIST_SOFTUSB(dev);
Mao Zhongyif1e321a2018-12-13 13:47:58 +0000254 SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
Michael Walle87a381e2011-03-07 23:32:37 +0100255
Mao Zhongyif1e321a2018-12-13 13:47:58 +0000256 sysbus_init_irq(sbd, &s->irq);
Michael Walle87a381e2011-03-07 23:32:37 +0100257
Paolo Bonzini1437c942013-06-06 21:25:08 -0400258 memory_region_init_io(&s->regs_region, OBJECT(s), &softusb_mmio_ops, s,
Avi Kivity5105ed32011-08-08 21:40:35 +0300259 "milkymist-softusb", R_MAX * 4);
Mao Zhongyif1e321a2018-12-13 13:47:58 +0000260 sysbus_init_mmio(sbd, &s->regs_region);
Michael Walle87a381e2011-03-07 23:32:37 +0100261
262 /* register pmem and dmem */
Peter Maydell1cfe48c2017-07-07 15:42:49 +0100263 memory_region_init_ram_nomigrate(&s->pmem, OBJECT(s), "milkymist-softusb.pmem",
Markus Armbrusterf8ed85a2015-09-11 16:51:43 +0200264 s->pmem_size, &error_fatal);
Avi Kivityc5705a72011-12-20 15:59:12 +0200265 vmstate_register_ram_global(&s->pmem);
Peter Maydellc34e1202013-03-15 14:34:22 +0000266 s->pmem_ptr = memory_region_get_ram_ptr(&s->pmem);
Mao Zhongyif1e321a2018-12-13 13:47:58 +0000267 sysbus_init_mmio(sbd, &s->pmem);
Peter Maydell1cfe48c2017-07-07 15:42:49 +0100268 memory_region_init_ram_nomigrate(&s->dmem, OBJECT(s), "milkymist-softusb.dmem",
Markus Armbrusterf8ed85a2015-09-11 16:51:43 +0200269 s->dmem_size, &error_fatal);
Avi Kivityc5705a72011-12-20 15:59:12 +0200270 vmstate_register_ram_global(&s->dmem);
Peter Maydellc34e1202013-03-15 14:34:22 +0000271 s->dmem_ptr = memory_region_get_ram_ptr(&s->dmem);
Mao Zhongyif1e321a2018-12-13 13:47:58 +0000272 sysbus_init_mmio(sbd, &s->dmem);
Michael Walle87a381e2011-03-07 23:32:37 +0100273
Michael Walle4c15ba92011-08-09 23:54:55 +0200274 hid_init(&s->hid_kbd, HID_KEYBOARD, softusb_kbd_hid_datain);
275 hid_init(&s->hid_mouse, HID_MOUSE, softusb_mouse_hid_datain);
Michael Walle87a381e2011-03-07 23:32:37 +0100276}
277
278static const VMStateDescription vmstate_milkymist_softusb = {
279 .name = "milkymist-softusb",
280 .version_id = 1,
281 .minimum_version_id = 1,
Juan Quintela35d08452014-04-16 16:01:33 +0200282 .fields = (VMStateField[]) {
Michael Walle87a381e2011-03-07 23:32:37 +0100283 VMSTATE_UINT32_ARRAY(regs, MilkymistSoftUsbState, R_MAX),
Michael Walle4c15ba92011-08-09 23:54:55 +0200284 VMSTATE_HID_KEYBOARD_DEVICE(hid_kbd, MilkymistSoftUsbState),
285 VMSTATE_HID_POINTER_DEVICE(hid_mouse, MilkymistSoftUsbState),
286 VMSTATE_BUFFER(kbd_hid_buffer, MilkymistSoftUsbState),
287 VMSTATE_BUFFER(mouse_hid_buffer, MilkymistSoftUsbState),
Michael Walle87a381e2011-03-07 23:32:37 +0100288 VMSTATE_END_OF_LIST()
289 }
290};
291
Anthony Liguori999e12b2012-01-24 13:12:29 -0600292static Property milkymist_softusb_properties[] = {
Anthony Liguori999e12b2012-01-24 13:12:29 -0600293 DEFINE_PROP_UINT32("pmem_size", MilkymistSoftUsbState, pmem_size, 0x00001000),
Anthony Liguori999e12b2012-01-24 13:12:29 -0600294 DEFINE_PROP_UINT32("dmem_size", MilkymistSoftUsbState, dmem_size, 0x00002000),
295 DEFINE_PROP_END_OF_LIST(),
296};
297
298static void milkymist_softusb_class_init(ObjectClass *klass, void *data)
299{
Anthony Liguori39bffca2011-12-07 21:34:16 -0600300 DeviceClass *dc = DEVICE_CLASS(klass);
Anthony Liguori999e12b2012-01-24 13:12:29 -0600301
Mao Zhongyif1e321a2018-12-13 13:47:58 +0000302 dc->realize = milkymist_softusb_realize;
Anthony Liguori39bffca2011-12-07 21:34:16 -0600303 dc->reset = milkymist_softusb_reset;
304 dc->vmsd = &vmstate_milkymist_softusb;
305 dc->props = milkymist_softusb_properties;
Anthony Liguori999e12b2012-01-24 13:12:29 -0600306}
307
Andreas Färber8c43a6f2013-01-10 16:19:07 +0100308static const TypeInfo milkymist_softusb_info = {
Andreas Färber2a052f62013-07-26 18:37:02 +0200309 .name = TYPE_MILKYMIST_SOFTUSB,
Anthony Liguori39bffca2011-12-07 21:34:16 -0600310 .parent = TYPE_SYS_BUS_DEVICE,
311 .instance_size = sizeof(MilkymistSoftUsbState),
312 .class_init = milkymist_softusb_class_init,
Michael Walle87a381e2011-03-07 23:32:37 +0100313};
314
Andreas Färber83f7d432012-02-09 15:20:55 +0100315static void milkymist_softusb_register_types(void)
Michael Walle87a381e2011-03-07 23:32:37 +0100316{
Anthony Liguori39bffca2011-12-07 21:34:16 -0600317 type_register_static(&milkymist_softusb_info);
Michael Walle87a381e2011-03-07 23:32:37 +0100318}
319
Andreas Färber83f7d432012-02-09 15:20:55 +0100320type_init(milkymist_softusb_register_types)