2 * QEMU JAZZ RC4030 chipset
4 * Copyright (c) 2007-2013 Hervé Poussineau
6 * 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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
25 #include "qemu/osdep.h"
26 #include "qemu/units.h"
28 #include "hw/mips/mips.h"
29 #include "hw/sysbus.h"
30 #include "migration/vmstate.h"
31 #include "qemu/timer.h"
33 #include "qemu/module.h"
34 #include "exec/address-spaces.h"
37 /********************************************************/
38 /* rc4030 emulation */
40 typedef struct dma_pagetable_entry {
43 } QEMU_PACKED dma_pagetable_entry;
45 #define DMA_PAGESIZE 4096
46 #define DMA_REG_ENABLE 1
47 #define DMA_REG_COUNT 2
48 #define DMA_REG_ADDRESS 3
50 #define DMA_FLAG_ENABLE 0x0001
51 #define DMA_FLAG_MEM_TO_DEV 0x0002
52 #define DMA_FLAG_TC_INTR 0x0100
53 #define DMA_FLAG_MEM_INTR 0x0200
54 #define DMA_FLAG_ADDR_INTR 0x0400
56 #define TYPE_RC4030 "rc4030"
58 OBJECT_CHECK(rc4030State, (obj), TYPE_RC4030)
60 #define TYPE_RC4030_IOMMU_MEMORY_REGION "rc4030-iommu-memory-region"
62 typedef struct rc4030State {
66 uint32_t config; /* 0x0000: RC4030 config register */
67 uint32_t revision; /* 0x0008: RC4030 Revision register */
68 uint32_t invalid_address_register; /* 0x0010: Invalid Address register */
71 uint32_t dma_regs[8][4];
72 uint32_t dma_tl_base; /* 0x0018: DMA transl. table base */
73 uint32_t dma_tl_limit; /* 0x0020: DMA transl. table limit */
76 uint32_t cache_maint; /* 0x0030: Cache Maintenance */
77 uint32_t remote_failed_address; /* 0x0038: Remote Failed Address */
78 uint32_t memory_failed_address; /* 0x0040: Memory Failed Address */
79 uint32_t cache_ptag; /* 0x0048: I/O Cache Physical Tag */
80 uint32_t cache_ltag; /* 0x0050: I/O Cache Logical Tag */
81 uint32_t cache_bmask; /* 0x0058: I/O Cache Byte Mask */
83 uint32_t nmi_interrupt; /* 0x0200: interrupt source */
84 uint32_t memory_refresh_rate; /* 0x0210: memory refresh rate */
85 uint32_t nvram_protect; /* 0x0220: NV ram protect register */
86 uint32_t rem_speed[16];
87 uint32_t imr_jazz; /* Local bus int enable mask */
88 uint32_t isr_jazz; /* Local bus int source */
91 QEMUTimer *periodic_timer;
92 uint32_t itr; /* Interval timer reload */
95 qemu_irq jazz_bus_irq;
97 /* whole DMA memory region, root of DMA address space */
98 IOMMUMemoryRegion dma_mr;
101 MemoryRegion iomem_chipset;
102 MemoryRegion iomem_jazzio;
105 static void set_next_tick(rc4030State *s)
108 qemu_irq_lower(s->timer_irq);
110 tm_hz = 1000 / (s->itr + 1);
112 timer_mod(s->periodic_timer, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) +
113 NANOSECONDS_PER_SECOND / tm_hz);
116 /* called for accesses to rc4030 */
117 static uint64_t rc4030_read(void *opaque, hwaddr addr, unsigned int size)
119 rc4030State *s = opaque;
123 switch (addr & ~0x3) {
124 /* Global config register */
128 /* Revision register */
132 /* Invalid Address register */
134 val = s->invalid_address_register;
136 /* DMA transl. table base */
138 val = s->dma_tl_base;
140 /* DMA transl. table limit */
142 val = s->dma_tl_limit;
144 /* Remote Failed Address */
146 val = s->remote_failed_address;
148 /* Memory Failed Address */
150 val = s->memory_failed_address;
152 /* I/O Cache Byte Mask */
154 val = s->cache_bmask;
156 if (s->cache_bmask == (uint32_t)-1) {
160 /* Remote Speed Registers */
177 val = s->rem_speed[(addr - 0x0070) >> 3];
179 /* DMA channel base address */
213 int entry = (addr - 0x0100) >> 5;
214 int idx = (addr & 0x1f) >> 3;
215 val = s->dma_regs[entry][idx];
218 /* Interrupt source */
220 val = s->nmi_interrupt;
226 /* Memory refresh rate */
228 val = s->memory_refresh_rate;
230 /* NV ram protect register */
232 val = s->nvram_protect;
234 /* Interval timer count */
237 qemu_irq_lower(s->timer_irq);
241 val = 7; /* FIXME: should be read from EISA controller */
244 qemu_log_mask(LOG_GUEST_ERROR,
245 "rc4030: invalid read at 0x%x", (int)addr);
250 if ((addr & ~3) != 0x230) {
251 trace_rc4030_read(addr, val);
257 static void rc4030_write(void *opaque, hwaddr addr, uint64_t data,
260 rc4030State *s = opaque;
264 trace_rc4030_write(addr, val);
266 switch (addr & ~0x3) {
267 /* Global config register */
271 /* DMA transl. table base */
273 s->dma_tl_base = val;
275 /* DMA transl. table limit */
277 s->dma_tl_limit = val;
279 /* DMA transl. table invalidated */
282 /* Cache Maintenance */
284 s->cache_maint = val;
286 /* I/O Cache Physical Tag */
290 /* I/O Cache Logical Tag */
294 /* I/O Cache Byte Mask */
296 s->cache_bmask |= val; /* HACK */
298 /* I/O Cache Buffer Window */
301 if (s->cache_ltag == 0x80000001 && s->cache_bmask == 0xf0f0f0f) {
302 hwaddr dest = s->cache_ptag & ~0x1;
303 dest += (s->cache_maint & 0x3) << 3;
304 cpu_physical_memory_write(dest, &val, 4);
307 /* Remote Speed Registers */
324 s->rem_speed[(addr - 0x0070) >> 3] = val;
326 /* DMA channel base address */
360 int entry = (addr - 0x0100) >> 5;
361 int idx = (addr & 0x1f) >> 3;
362 s->dma_regs[entry][idx] = val;
365 /* Memory refresh rate */
367 s->memory_refresh_rate = val;
369 /* Interval timer reload */
371 s->itr = val & 0x01FF;
372 qemu_irq_lower(s->timer_irq);
379 qemu_log_mask(LOG_GUEST_ERROR,
380 "rc4030: invalid write of 0x%02x at 0x%x",
386 static const MemoryRegionOps rc4030_ops = {
388 .write = rc4030_write,
389 .impl.min_access_size = 4,
390 .impl.max_access_size = 4,
391 .endianness = DEVICE_NATIVE_ENDIAN,
394 static void update_jazz_irq(rc4030State *s)
398 pending = s->isr_jazz & s->imr_jazz;
401 qemu_irq_raise(s->jazz_bus_irq);
403 qemu_irq_lower(s->jazz_bus_irq);
406 static void rc4030_irq_jazz_request(void *opaque, int irq, int level)
408 rc4030State *s = opaque;
411 s->isr_jazz |= 1 << irq;
413 s->isr_jazz &= ~(1 << irq);
419 static void rc4030_periodic_timer(void *opaque)
421 rc4030State *s = opaque;
424 qemu_irq_raise(s->timer_irq);
427 static uint64_t jazzio_read(void *opaque, hwaddr addr, unsigned int size)
429 rc4030State *s = opaque;
435 /* Local bus int source */
437 uint32_t pending = s->isr_jazz & s->imr_jazz;
442 val = (irq + 1) << 2;
450 /* Local bus int enable mask */
455 qemu_log_mask(LOG_GUEST_ERROR,
456 "rc4030/jazzio: invalid read at 0x%x", (int)addr);
461 trace_jazzio_read(addr, val);
466 static void jazzio_write(void *opaque, hwaddr addr, uint64_t data,
469 rc4030State *s = opaque;
473 trace_jazzio_write(addr, val);
476 /* Local bus int enable mask */
482 qemu_log_mask(LOG_GUEST_ERROR,
483 "rc4030/jazzio: invalid write of 0x%02x at 0x%x",
489 static const MemoryRegionOps jazzio_ops = {
491 .write = jazzio_write,
492 .impl.min_access_size = 2,
493 .impl.max_access_size = 2,
494 .endianness = DEVICE_NATIVE_ENDIAN,
497 static IOMMUTLBEntry rc4030_dma_translate(IOMMUMemoryRegion *iommu, hwaddr addr,
498 IOMMUAccessFlags flag, int iommu_idx)
500 rc4030State *s = container_of(iommu, rc4030State, dma_mr);
501 IOMMUTLBEntry ret = {
502 .target_as = &address_space_memory,
503 .iova = addr & ~(DMA_PAGESIZE - 1),
504 .translated_addr = 0,
505 .addr_mask = DMA_PAGESIZE - 1,
508 uint64_t i, entry_address;
509 dma_pagetable_entry entry;
511 i = addr / DMA_PAGESIZE;
512 if (i < s->dma_tl_limit / sizeof(entry)) {
513 entry_address = (s->dma_tl_base & 0x7fffffff) + i * sizeof(entry);
514 if (address_space_read(ret.target_as, entry_address,
515 MEMTXATTRS_UNSPECIFIED, (unsigned char *)&entry,
516 sizeof(entry)) == MEMTX_OK) {
517 ret.translated_addr = entry.frame & ~(DMA_PAGESIZE - 1);
525 static void rc4030_reset(DeviceState *dev)
527 rc4030State *s = RC4030(dev);
530 s->config = 0x410; /* some boards seem to accept 0x104 too */
532 s->invalid_address_register = 0;
534 memset(s->dma_regs, 0, sizeof(s->dma_regs));
536 s->remote_failed_address = s->memory_failed_address = 0;
538 s->cache_ptag = s->cache_ltag = 0;
541 s->memory_refresh_rate = 0x18186;
542 s->nvram_protect = 7;
543 for (i = 0; i < 15; i++) {
546 s->imr_jazz = 0x10; /* XXX: required by firmware, but why? */
551 qemu_irq_lower(s->timer_irq);
552 qemu_irq_lower(s->jazz_bus_irq);
555 static int rc4030_post_load(void *opaque, int version_id)
557 rc4030State *s = opaque;
565 static const VMStateDescription vmstate_rc4030 = {
568 .post_load = rc4030_post_load,
569 .fields = (VMStateField []) {
570 VMSTATE_UINT32(config, rc4030State),
571 VMSTATE_UINT32(invalid_address_register, rc4030State),
572 VMSTATE_UINT32_2DARRAY(dma_regs, rc4030State, 8, 4),
573 VMSTATE_UINT32(dma_tl_base, rc4030State),
574 VMSTATE_UINT32(dma_tl_limit, rc4030State),
575 VMSTATE_UINT32(cache_maint, rc4030State),
576 VMSTATE_UINT32(remote_failed_address, rc4030State),
577 VMSTATE_UINT32(memory_failed_address, rc4030State),
578 VMSTATE_UINT32(cache_ptag, rc4030State),
579 VMSTATE_UINT32(cache_ltag, rc4030State),
580 VMSTATE_UINT32(cache_bmask, rc4030State),
581 VMSTATE_UINT32(memory_refresh_rate, rc4030State),
582 VMSTATE_UINT32(nvram_protect, rc4030State),
583 VMSTATE_UINT32_ARRAY(rem_speed, rc4030State, 16),
584 VMSTATE_UINT32(imr_jazz, rc4030State),
585 VMSTATE_UINT32(isr_jazz, rc4030State),
586 VMSTATE_UINT32(itr, rc4030State),
587 VMSTATE_END_OF_LIST()
591 static void rc4030_do_dma(void *opaque, int n, uint8_t *buf, int len, int is_write)
593 rc4030State *s = opaque;
597 s->dma_regs[n][DMA_REG_ENABLE] &=
598 ~(DMA_FLAG_TC_INTR | DMA_FLAG_MEM_INTR | DMA_FLAG_ADDR_INTR);
600 /* Check DMA channel consistency */
601 dev_to_mem = (s->dma_regs[n][DMA_REG_ENABLE] & DMA_FLAG_MEM_TO_DEV) ? 0 : 1;
602 if (!(s->dma_regs[n][DMA_REG_ENABLE] & DMA_FLAG_ENABLE) ||
603 (is_write != dev_to_mem)) {
604 s->dma_regs[n][DMA_REG_ENABLE] |= DMA_FLAG_MEM_INTR;
605 s->nmi_interrupt |= 1 << n;
609 /* Get start address and len */
610 if (len > s->dma_regs[n][DMA_REG_COUNT]) {
611 len = s->dma_regs[n][DMA_REG_COUNT];
613 dma_addr = s->dma_regs[n][DMA_REG_ADDRESS];
615 /* Read/write data at right place */
616 address_space_rw(&s->dma_as, dma_addr, MEMTXATTRS_UNSPECIFIED,
619 s->dma_regs[n][DMA_REG_ENABLE] |= DMA_FLAG_TC_INTR;
620 s->dma_regs[n][DMA_REG_COUNT] -= len;
623 struct rc4030DMAState {
628 void rc4030_dma_read(void *dma, uint8_t *buf, int len)
631 rc4030_do_dma(s->opaque, s->n, buf, len, 0);
634 void rc4030_dma_write(void *dma, uint8_t *buf, int len)
637 rc4030_do_dma(s->opaque, s->n, buf, len, 1);
640 static rc4030_dma *rc4030_allocate_dmas(void *opaque, int n)
643 struct rc4030DMAState *p;
646 s = (rc4030_dma *)g_malloc0(sizeof(rc4030_dma) * n);
647 p = (struct rc4030DMAState *)g_malloc0(sizeof(struct rc4030DMAState) * n);
648 for (i = 0; i < n; i++) {
657 static void rc4030_initfn(Object *obj)
659 DeviceState *dev = DEVICE(obj);
660 rc4030State *s = RC4030(obj);
661 SysBusDevice *sysbus = SYS_BUS_DEVICE(obj);
663 qdev_init_gpio_in(dev, rc4030_irq_jazz_request, 16);
665 sysbus_init_irq(sysbus, &s->timer_irq);
666 sysbus_init_irq(sysbus, &s->jazz_bus_irq);
668 sysbus_init_mmio(sysbus, &s->iomem_chipset);
669 sysbus_init_mmio(sysbus, &s->iomem_jazzio);
672 static void rc4030_realize(DeviceState *dev, Error **errp)
674 rc4030State *s = RC4030(dev);
675 Object *o = OBJECT(dev);
677 s->periodic_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL,
678 rc4030_periodic_timer, s);
680 memory_region_init_io(&s->iomem_chipset, NULL, &rc4030_ops, s,
681 "rc4030.chipset", 0x300);
682 memory_region_init_io(&s->iomem_jazzio, NULL, &jazzio_ops, s,
683 "rc4030.jazzio", 0x00001000);
685 memory_region_init_iommu(&s->dma_mr, sizeof(s->dma_mr),
686 TYPE_RC4030_IOMMU_MEMORY_REGION,
687 o, "rc4030.dma", 4 * GiB);
688 address_space_init(&s->dma_as, MEMORY_REGION(&s->dma_mr), "rc4030-dma");
691 static void rc4030_unrealize(DeviceState *dev, Error **errp)
693 rc4030State *s = RC4030(dev);
695 timer_free(s->periodic_timer);
697 address_space_destroy(&s->dma_as);
698 object_unparent(OBJECT(&s->dma_mr));
701 static void rc4030_class_init(ObjectClass *klass, void *class_data)
703 DeviceClass *dc = DEVICE_CLASS(klass);
705 dc->realize = rc4030_realize;
706 dc->unrealize = rc4030_unrealize;
707 dc->reset = rc4030_reset;
708 dc->vmsd = &vmstate_rc4030;
711 static const TypeInfo rc4030_info = {
713 .parent = TYPE_SYS_BUS_DEVICE,
714 .instance_size = sizeof(rc4030State),
715 .instance_init = rc4030_initfn,
716 .class_init = rc4030_class_init,
719 static void rc4030_iommu_memory_region_class_init(ObjectClass *klass,
722 IOMMUMemoryRegionClass *imrc = IOMMU_MEMORY_REGION_CLASS(klass);
724 imrc->translate = rc4030_dma_translate;
727 static const TypeInfo rc4030_iommu_memory_region_info = {
728 .parent = TYPE_IOMMU_MEMORY_REGION,
729 .name = TYPE_RC4030_IOMMU_MEMORY_REGION,
730 .class_init = rc4030_iommu_memory_region_class_init,
733 static void rc4030_register_types(void)
735 type_register_static(&rc4030_info);
736 type_register_static(&rc4030_iommu_memory_region_info);
739 type_init(rc4030_register_types)
741 DeviceState *rc4030_init(rc4030_dma **dmas, IOMMUMemoryRegion **dma_mr)
745 dev = qdev_create(NULL, TYPE_RC4030);
746 qdev_init_nofail(dev);
748 *dmas = rc4030_allocate_dmas(dev, 4);
749 *dma_mr = &RC4030(dev)->dma_mr;