2 * QEMU PowerMac CUDA device support
4 * Copyright (c) 2004-2007 Fabrice Bellard
5 * Copyright (c) 2007 Jocelyn Mayer
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26 #include "qemu/osdep.h"
27 #include "qemu-common.h"
28 #include "hw/ppc/mac.h"
29 #include "hw/qdev-properties.h"
30 #include "migration/vmstate.h"
31 #include "hw/input/adb.h"
32 #include "hw/misc/mos6522.h"
33 #include "hw/misc/macio/cuda.h"
34 #include "qemu/timer.h"
35 #include "sysemu/runstate.h"
36 #include "qemu/cutils.h"
38 #include "qemu/module.h"
41 /* Bits in B data register: all active low */
42 #define TREQ 0x08 /* Transfer request (input) */
43 #define TACK 0x10 /* Transfer acknowledge (output) */
44 #define TIP 0x20 /* Transfer in progress (output) */
46 /* commands (1st byte) */
49 #define ERROR_PACKET 2
50 #define TIMER_PACKET 3
51 #define POWER_PACKET 4
52 #define MACIIC_PACKET 5
55 #define CUDA_TIMER_FREQ (4700000 / 6)
57 /* CUDA returns time_t's offset from Jan 1, 1904, not 1970 */
58 #define RTC_OFFSET 2082844800
60 static void cuda_receive_packet_from_host(CUDAState *s,
61 const uint8_t *data, int len);
63 /* MacOS uses timer 1 for calibration on startup, so we use
64 * the timebase frequency and cuda_get_counter_value() with
65 * cuda_get_load_time() to steer MacOS to calculate calibrate its timers
66 * correctly for both TCG and KVM (see commit b981289c49 "PPC: Cuda: Use cuda
67 * timer to expose tbfreq to guest" for more information) */
69 static uint64_t cuda_get_counter_value(MOS6522State *s, MOS6522Timer *ti)
71 MOS6522CUDAState *mcs = container_of(s, MOS6522CUDAState, parent_obj);
72 CUDAState *cs = container_of(mcs, CUDAState, mos6522_cuda);
74 /* Reverse of the tb calculation algorithm that Mac OS X uses on bootup */
75 uint64_t tb_diff = muldiv64(qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL),
76 cs->tb_frequency, NANOSECONDS_PER_SECOND) -
79 return (tb_diff * 0xBF401675E5DULL) / (cs->tb_frequency << 24);
82 static uint64_t cuda_get_load_time(MOS6522State *s, MOS6522Timer *ti)
84 MOS6522CUDAState *mcs = container_of(s, MOS6522CUDAState, parent_obj);
85 CUDAState *cs = container_of(mcs, CUDAState, mos6522_cuda);
87 uint64_t load_time = muldiv64(qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL),
88 cs->tb_frequency, NANOSECONDS_PER_SECOND);
92 static void cuda_set_sr_int(void *opaque)
94 CUDAState *s = opaque;
95 MOS6522CUDAState *mcs = &s->mos6522_cuda;
96 MOS6522State *ms = MOS6522(mcs);
97 MOS6522DeviceClass *mdc = MOS6522_DEVICE_GET_CLASS(ms);
102 static void cuda_delay_set_sr_int(CUDAState *s)
106 trace_cuda_delay_set_sr_int();
108 expire = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) + s->sr_delay_ns;
109 timer_mod(s->sr_delay_timer, expire);
112 /* NOTE: TIP and TREQ are negated */
113 static void cuda_update(CUDAState *s)
115 MOS6522CUDAState *mcs = &s->mos6522_cuda;
116 MOS6522State *ms = MOS6522(mcs);
117 int packet_received, len;
120 if (!(ms->b & TIP)) {
121 /* transfer requested from host */
123 if (ms->acr & SR_OUT) {
125 if ((ms->b & (TACK | TIP)) != (s->last_b & (TACK | TIP))) {
126 if (s->data_out_index < sizeof(s->data_out)) {
127 trace_cuda_data_send(ms->sr);
128 s->data_out[s->data_out_index++] = ms->sr;
129 cuda_delay_set_sr_int(s);
133 if (s->data_in_index < s->data_in_size) {
135 if ((ms->b & (TACK | TIP)) != (s->last_b & (TACK | TIP))) {
136 ms->sr = s->data_in[s->data_in_index++];
137 trace_cuda_data_recv(ms->sr);
138 /* indicate end of transfer */
139 if (s->data_in_index >= s->data_in_size) {
140 ms->b = (ms->b | TREQ);
142 cuda_delay_set_sr_int(s);
147 /* no transfer requested: handle sync case */
148 if ((s->last_b & TIP) && (ms->b & TACK) != (s->last_b & TACK)) {
149 /* update TREQ state each time TACK change state */
151 ms->b = (ms->b | TREQ);
153 ms->b = (ms->b & ~TREQ);
155 cuda_delay_set_sr_int(s);
157 if (!(s->last_b & TIP)) {
158 /* handle end of host to cuda transfer */
159 packet_received = (s->data_out_index > 0);
160 /* always an IRQ at the end of transfer */
161 cuda_delay_set_sr_int(s);
163 /* signal if there is data to read */
164 if (s->data_in_index < s->data_in_size) {
165 ms->b = (ms->b & ~TREQ);
170 s->last_acr = ms->acr;
173 /* NOTE: cuda_receive_packet_from_host() can call cuda_update()
175 if (packet_received) {
176 len = s->data_out_index;
177 s->data_out_index = 0;
178 cuda_receive_packet_from_host(s, s->data_out, len);
182 static void cuda_send_packet_to_host(CUDAState *s,
183 const uint8_t *data, int len)
187 trace_cuda_packet_send(len);
188 for (i = 0; i < len; i++) {
189 trace_cuda_packet_send_data(i, data[i]);
192 memcpy(s->data_in, data, len);
193 s->data_in_size = len;
194 s->data_in_index = 0;
196 cuda_delay_set_sr_int(s);
199 static void cuda_adb_poll(void *opaque)
201 CUDAState *s = opaque;
202 uint8_t obuf[ADB_MAX_OUT_LEN + 2];
205 olen = adb_poll(&s->adb_bus, obuf + 2, s->adb_poll_mask);
207 obuf[0] = ADB_PACKET;
208 obuf[1] = 0x40; /* polled data */
209 cuda_send_packet_to_host(s, obuf, olen + 2);
211 timer_mod(s->adb_poll_timer, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) +
212 (NANOSECONDS_PER_SECOND / (1000 / s->autopoll_rate_ms)));
215 /* description of commands */
216 typedef struct CudaCommand {
219 bool (*handler)(CUDAState *s,
220 const uint8_t *in_args, int in_len,
221 uint8_t *out_args, int *out_len);
224 static bool cuda_cmd_autopoll(CUDAState *s,
225 const uint8_t *in_data, int in_len,
226 uint8_t *out_data, int *out_len)
234 autopoll = (in_data[0] != 0);
235 if (autopoll != s->autopoll) {
236 s->autopoll = autopoll;
238 timer_mod(s->adb_poll_timer,
239 qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) +
240 (NANOSECONDS_PER_SECOND / (1000 / s->autopoll_rate_ms)));
242 timer_del(s->adb_poll_timer);
248 static bool cuda_cmd_set_autorate(CUDAState *s,
249 const uint8_t *in_data, int in_len,
250 uint8_t *out_data, int *out_len)
256 /* we don't want a period of 0 ms */
257 /* FIXME: check what real hardware does */
258 if (in_data[0] == 0) {
262 s->autopoll_rate_ms = in_data[0];
264 timer_mod(s->adb_poll_timer,
265 qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) +
266 (NANOSECONDS_PER_SECOND / (1000 / s->autopoll_rate_ms)));
271 static bool cuda_cmd_set_device_list(CUDAState *s,
272 const uint8_t *in_data, int in_len,
273 uint8_t *out_data, int *out_len)
279 s->adb_poll_mask = (((uint16_t)in_data[0]) << 8) | in_data[1];
283 static bool cuda_cmd_powerdown(CUDAState *s,
284 const uint8_t *in_data, int in_len,
285 uint8_t *out_data, int *out_len)
291 qemu_system_shutdown_request(SHUTDOWN_CAUSE_GUEST_SHUTDOWN);
295 static bool cuda_cmd_reset_system(CUDAState *s,
296 const uint8_t *in_data, int in_len,
297 uint8_t *out_data, int *out_len)
303 qemu_system_reset_request(SHUTDOWN_CAUSE_GUEST_RESET);
307 static bool cuda_cmd_set_file_server_flag(CUDAState *s,
308 const uint8_t *in_data, int in_len,
309 uint8_t *out_data, int *out_len)
315 qemu_log_mask(LOG_UNIMP,
316 "CUDA: unimplemented command FILE_SERVER_FLAG %d\n",
321 static bool cuda_cmd_set_power_message(CUDAState *s,
322 const uint8_t *in_data, int in_len,
323 uint8_t *out_data, int *out_len)
329 qemu_log_mask(LOG_UNIMP,
330 "CUDA: unimplemented command SET_POWER_MESSAGE %d\n",
335 static bool cuda_cmd_get_time(CUDAState *s,
336 const uint8_t *in_data, int in_len,
337 uint8_t *out_data, int *out_len)
345 ti = s->tick_offset + (qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL)
346 / NANOSECONDS_PER_SECOND);
347 out_data[0] = ti >> 24;
348 out_data[1] = ti >> 16;
349 out_data[2] = ti >> 8;
355 static bool cuda_cmd_set_time(CUDAState *s,
356 const uint8_t *in_data, int in_len,
357 uint8_t *out_data, int *out_len)
365 ti = (((uint32_t)in_data[0]) << 24) + (((uint32_t)in_data[1]) << 16)
366 + (((uint32_t)in_data[2]) << 8) + in_data[3];
367 s->tick_offset = ti - (qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL)
368 / NANOSECONDS_PER_SECOND);
372 static const CudaCommand handlers[] = {
373 { CUDA_AUTOPOLL, "AUTOPOLL", cuda_cmd_autopoll },
374 { CUDA_SET_AUTO_RATE, "SET_AUTO_RATE", cuda_cmd_set_autorate },
375 { CUDA_SET_DEVICE_LIST, "SET_DEVICE_LIST", cuda_cmd_set_device_list },
376 { CUDA_POWERDOWN, "POWERDOWN", cuda_cmd_powerdown },
377 { CUDA_RESET_SYSTEM, "RESET_SYSTEM", cuda_cmd_reset_system },
378 { CUDA_FILE_SERVER_FLAG, "FILE_SERVER_FLAG",
379 cuda_cmd_set_file_server_flag },
380 { CUDA_SET_POWER_MESSAGES, "SET_POWER_MESSAGES",
381 cuda_cmd_set_power_message },
382 { CUDA_GET_TIME, "GET_TIME", cuda_cmd_get_time },
383 { CUDA_SET_TIME, "SET_TIME", cuda_cmd_set_time },
386 static void cuda_receive_packet(CUDAState *s,
387 const uint8_t *data, int len)
389 uint8_t obuf[16] = { CUDA_PACKET, 0, data[0] };
392 for (i = 0; i < ARRAY_SIZE(handlers); i++) {
393 const CudaCommand *desc = &handlers[i];
394 if (desc->command == data[0]) {
395 trace_cuda_receive_packet_cmd(desc->name);
397 if (desc->handler(s, data + 1, len - 1, obuf + 3, &out_len)) {
398 cuda_send_packet_to_host(s, obuf, 3 + out_len);
400 qemu_log_mask(LOG_GUEST_ERROR,
401 "CUDA: %s: wrong parameters %d\n",
403 obuf[0] = ERROR_PACKET;
404 obuf[1] = 0x5; /* bad parameters */
405 obuf[2] = CUDA_PACKET;
407 cuda_send_packet_to_host(s, obuf, 4);
413 qemu_log_mask(LOG_GUEST_ERROR, "CUDA: unknown command 0x%02x\n", data[0]);
414 obuf[0] = ERROR_PACKET;
415 obuf[1] = 0x2; /* unknown command */
416 obuf[2] = CUDA_PACKET;
418 cuda_send_packet_to_host(s, obuf, 4);
421 static void cuda_receive_packet_from_host(CUDAState *s,
422 const uint8_t *data, int len)
426 trace_cuda_packet_receive(len);
427 for (i = 0; i < len; i++) {
428 trace_cuda_packet_receive_data(i, data[i]);
434 uint8_t obuf[ADB_MAX_OUT_LEN + 3];
436 olen = adb_request(&s->adb_bus, obuf + 2, data + 1, len - 1);
438 obuf[0] = ADB_PACKET;
440 cuda_send_packet_to_host(s, obuf, olen + 2);
443 obuf[0] = ADB_PACKET;
447 cuda_send_packet_to_host(s, obuf, olen + 3);
452 cuda_receive_packet(s, data + 1, len - 1);
457 static uint64_t mos6522_cuda_read(void *opaque, hwaddr addr, unsigned size)
459 CUDAState *s = opaque;
460 MOS6522CUDAState *mcs = &s->mos6522_cuda;
461 MOS6522State *ms = MOS6522(mcs);
463 addr = (addr >> 9) & 0xf;
464 return mos6522_read(ms, addr, size);
467 static void mos6522_cuda_write(void *opaque, hwaddr addr, uint64_t val,
470 CUDAState *s = opaque;
471 MOS6522CUDAState *mcs = &s->mos6522_cuda;
472 MOS6522State *ms = MOS6522(mcs);
474 addr = (addr >> 9) & 0xf;
475 mos6522_write(ms, addr, val, size);
478 static const MemoryRegionOps mos6522_cuda_ops = {
479 .read = mos6522_cuda_read,
480 .write = mos6522_cuda_write,
481 .endianness = DEVICE_BIG_ENDIAN,
483 .min_access_size = 1,
484 .max_access_size = 1,
488 static const VMStateDescription vmstate_cuda = {
491 .minimum_version_id = 5,
492 .fields = (VMStateField[]) {
493 VMSTATE_STRUCT(mos6522_cuda.parent_obj, CUDAState, 0, vmstate_mos6522,
495 VMSTATE_UINT8(last_b, CUDAState),
496 VMSTATE_UINT8(last_acr, CUDAState),
497 VMSTATE_INT32(data_in_size, CUDAState),
498 VMSTATE_INT32(data_in_index, CUDAState),
499 VMSTATE_INT32(data_out_index, CUDAState),
500 VMSTATE_UINT8(autopoll, CUDAState),
501 VMSTATE_UINT8(autopoll_rate_ms, CUDAState),
502 VMSTATE_UINT16(adb_poll_mask, CUDAState),
503 VMSTATE_BUFFER(data_in, CUDAState),
504 VMSTATE_BUFFER(data_out, CUDAState),
505 VMSTATE_UINT32(tick_offset, CUDAState),
506 VMSTATE_TIMER_PTR(adb_poll_timer, CUDAState),
507 VMSTATE_TIMER_PTR(sr_delay_timer, CUDAState),
508 VMSTATE_END_OF_LIST()
512 static void cuda_reset(DeviceState *dev)
514 CUDAState *s = CUDA(dev);
517 s->data_in_index = 0;
518 s->data_out_index = 0;
522 static void cuda_realize(DeviceState *dev, Error **errp)
524 CUDAState *s = CUDA(dev);
530 /* Pass IRQ from 6522 */
531 d = DEVICE(&s->mos6522_cuda);
533 sbd = SYS_BUS_DEVICE(s);
534 sysbus_pass_irq(sbd, SYS_BUS_DEVICE(ms));
536 qemu_get_timedate(&tm, 0);
537 s->tick_offset = (uint32_t)mktimegm(&tm) + RTC_OFFSET;
539 s->sr_delay_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, cuda_set_sr_int, s);
540 s->sr_delay_ns = 20 * SCALE_US;
542 s->adb_poll_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, cuda_adb_poll, s);
543 s->adb_poll_mask = 0xffff;
544 s->autopoll_rate_ms = 20;
547 static void cuda_init(Object *obj)
549 CUDAState *s = CUDA(obj);
550 SysBusDevice *sbd = SYS_BUS_DEVICE(obj);
552 sysbus_init_child_obj(obj, "mos6522-cuda", &s->mos6522_cuda,
553 sizeof(s->mos6522_cuda), TYPE_MOS6522_CUDA);
555 memory_region_init_io(&s->mem, obj, &mos6522_cuda_ops, s, "cuda", 0x2000);
556 sysbus_init_mmio(sbd, &s->mem);
558 qbus_create_inplace(&s->adb_bus, sizeof(s->adb_bus), TYPE_ADB_BUS,
559 DEVICE(obj), "adb.0");
562 static Property cuda_properties[] = {
563 DEFINE_PROP_UINT64("timebase-frequency", CUDAState, tb_frequency, 0),
564 DEFINE_PROP_END_OF_LIST()
567 static void cuda_class_init(ObjectClass *oc, void *data)
569 DeviceClass *dc = DEVICE_CLASS(oc);
571 dc->realize = cuda_realize;
572 dc->reset = cuda_reset;
573 dc->vmsd = &vmstate_cuda;
574 dc->props = cuda_properties;
575 set_bit(DEVICE_CATEGORY_BRIDGE, dc->categories);
578 static const TypeInfo cuda_type_info = {
580 .parent = TYPE_SYS_BUS_DEVICE,
581 .instance_size = sizeof(CUDAState),
582 .instance_init = cuda_init,
583 .class_init = cuda_class_init,
586 static void mos6522_cuda_portB_write(MOS6522State *s)
588 MOS6522CUDAState *mcs = container_of(s, MOS6522CUDAState, parent_obj);
589 CUDAState *cs = container_of(mcs, CUDAState, mos6522_cuda);
594 static void mos6522_cuda_reset(DeviceState *dev)
596 MOS6522State *ms = MOS6522(dev);
597 MOS6522DeviceClass *mdc = MOS6522_DEVICE_GET_CLASS(ms);
599 mdc->parent_reset(dev);
601 ms->timers[0].frequency = CUDA_TIMER_FREQ;
602 ms->timers[1].frequency = (SCALE_US * 6000) / 4700;
605 static void mos6522_cuda_class_init(ObjectClass *oc, void *data)
607 DeviceClass *dc = DEVICE_CLASS(oc);
608 MOS6522DeviceClass *mdc = MOS6522_DEVICE_CLASS(oc);
610 dc->reset = mos6522_cuda_reset;
611 mdc->portB_write = mos6522_cuda_portB_write;
612 mdc->get_timer1_counter_value = cuda_get_counter_value;
613 mdc->get_timer2_counter_value = cuda_get_counter_value;
614 mdc->get_timer1_load_time = cuda_get_load_time;
615 mdc->get_timer2_load_time = cuda_get_load_time;
618 static const TypeInfo mos6522_cuda_type_info = {
619 .name = TYPE_MOS6522_CUDA,
620 .parent = TYPE_MOS6522,
621 .instance_size = sizeof(MOS6522CUDAState),
622 .class_init = mos6522_cuda_class_init,
625 static void cuda_register_types(void)
627 type_register_static(&mos6522_cuda_type_info);
628 type_register_static(&cuda_type_info);
631 type_init(cuda_register_types)