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"
27 #include "hw/mips/mips.h"
28 #include "hw/sysbus.h"
29 #include "qemu/timer.h"
30 #include "exec/address-spaces.h"
33 /********************************************************/
34 /* rc4030 emulation */
36 #define MAX_TL_ENTRIES 512
38 typedef struct dma_pagetable_entry {
41 } QEMU_PACKED dma_pagetable_entry;
43 #define DMA_PAGESIZE 4096
44 #define DMA_REG_ENABLE 1
45 #define DMA_REG_COUNT 2
46 #define DMA_REG_ADDRESS 3
48 #define DMA_FLAG_ENABLE 0x0001
49 #define DMA_FLAG_MEM_TO_DEV 0x0002
50 #define DMA_FLAG_TC_INTR 0x0100
51 #define DMA_FLAG_MEM_INTR 0x0200
52 #define DMA_FLAG_ADDR_INTR 0x0400
54 #define TYPE_RC4030 "rc4030"
56 OBJECT_CHECK(rc4030State, (obj), TYPE_RC4030)
58 typedef struct rc4030State
62 uint32_t config; /* 0x0000: RC4030 config register */
63 uint32_t revision; /* 0x0008: RC4030 Revision register */
64 uint32_t invalid_address_register; /* 0x0010: Invalid Address register */
67 uint32_t dma_regs[8][4];
68 uint32_t dma_tl_base; /* 0x0018: DMA transl. table base */
69 uint32_t dma_tl_limit; /* 0x0020: DMA transl. table limit */
72 uint32_t cache_maint; /* 0x0030: Cache Maintenance */
73 uint32_t remote_failed_address; /* 0x0038: Remote Failed Address */
74 uint32_t memory_failed_address; /* 0x0040: Memory Failed Address */
75 uint32_t cache_ptag; /* 0x0048: I/O Cache Physical Tag */
76 uint32_t cache_ltag; /* 0x0050: I/O Cache Logical Tag */
77 uint32_t cache_bmask; /* 0x0058: I/O Cache Byte Mask */
79 uint32_t nmi_interrupt; /* 0x0200: interrupt source */
80 uint32_t memory_refresh_rate; /* 0x0210: memory refresh rate */
81 uint32_t nvram_protect; /* 0x0220: NV ram protect register */
82 uint32_t rem_speed[16];
83 uint32_t imr_jazz; /* Local bus int enable mask */
84 uint32_t isr_jazz; /* Local bus int source */
87 QEMUTimer *periodic_timer;
88 uint32_t itr; /* Interval timer reload */
91 qemu_irq jazz_bus_irq;
93 /* biggest translation table */
95 /* translation table memory region alias, added to system RAM */
96 MemoryRegion dma_tt_alias;
97 /* whole DMA memory region, root of DMA address space */
99 /* translation table entry aliases, added to DMA memory region */
100 MemoryRegion dma_mrs[MAX_TL_ENTRIES];
103 MemoryRegion iomem_chipset;
104 MemoryRegion iomem_jazzio;
107 static void set_next_tick(rc4030State *s)
109 qemu_irq_lower(s->timer_irq);
112 tm_hz = 1000 / (s->itr + 1);
114 timer_mod(s->periodic_timer, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) +
115 NANOSECONDS_PER_SECOND / tm_hz);
118 /* called for accesses to rc4030 */
119 static uint64_t rc4030_read(void *opaque, hwaddr addr, unsigned int size)
121 rc4030State *s = opaque;
125 switch (addr & ~0x3) {
126 /* Global config register */
130 /* Revision register */
134 /* Invalid Address register */
136 val = s->invalid_address_register;
138 /* DMA transl. table base */
140 val = s->dma_tl_base;
142 /* DMA transl. table limit */
144 val = s->dma_tl_limit;
146 /* Remote Failed Address */
148 val = s->remote_failed_address;
150 /* Memory Failed Address */
152 val = s->memory_failed_address;
154 /* I/O Cache Byte Mask */
156 val = s->cache_bmask;
158 if (s->cache_bmask == (uint32_t)-1)
161 /* Remote Speed Registers */
178 val = s->rem_speed[(addr - 0x0070) >> 3];
180 /* DMA channel base address */
214 int entry = (addr - 0x0100) >> 5;
215 int idx = (addr & 0x1f) >> 3;
216 val = s->dma_regs[entry][idx];
219 /* Interrupt source */
221 val = s->nmi_interrupt;
227 /* Memory refresh rate */
229 val = s->memory_refresh_rate;
231 /* NV ram protect register */
233 val = s->nvram_protect;
235 /* Interval timer count */
238 qemu_irq_lower(s->timer_irq);
242 val = 7; /* FIXME: should be read from EISA controller */
245 qemu_log_mask(LOG_GUEST_ERROR,
246 "rc4030: invalid read at 0x%x", (int)addr);
251 if ((addr & ~3) != 0x230) {
252 trace_rc4030_read(addr, val);
258 static void rc4030_dma_as_update_one(rc4030State *s, int index, uint32_t frame)
260 if (index < MAX_TL_ENTRIES) {
261 memory_region_set_enabled(&s->dma_mrs[index], false);
268 if (index >= MAX_TL_ENTRIES) {
269 qemu_log_mask(LOG_UNIMP,
270 "rc4030: trying to use too high "
271 "translation table entry %d (max allowed=%d)",
272 index, MAX_TL_ENTRIES);
275 memory_region_set_alias_offset(&s->dma_mrs[index], frame);
276 memory_region_set_enabled(&s->dma_mrs[index], true);
279 static void rc4030_dma_tt_write(void *opaque, hwaddr addr, uint64_t data,
282 rc4030State *s = opaque;
285 memcpy(memory_region_get_ram_ptr(&s->dma_tt) + addr, &data, size);
287 /* update dma address space (only if frame field has been written) */
288 if (addr % sizeof(dma_pagetable_entry) == 0) {
289 int index = addr / sizeof(dma_pagetable_entry);
290 memory_region_transaction_begin();
291 rc4030_dma_as_update_one(s, index, (uint32_t)data);
292 memory_region_transaction_commit();
296 static const MemoryRegionOps rc4030_dma_tt_ops = {
297 .write = rc4030_dma_tt_write,
298 .impl.min_access_size = 4,
299 .impl.max_access_size = 4,
302 static void rc4030_dma_tt_update(rc4030State *s, uint32_t new_tl_base,
303 uint32_t new_tl_limit)
306 dma_pagetable_entry *dma_tl_contents;
308 if (s->dma_tl_limit) {
309 /* write old dma tl table to physical memory */
310 memory_region_del_subregion(get_system_memory(), &s->dma_tt_alias);
311 cpu_physical_memory_write(s->dma_tl_limit & 0x7fffffff,
312 memory_region_get_ram_ptr(&s->dma_tt),
313 memory_region_size(&s->dma_tt_alias));
315 object_unparent(OBJECT(&s->dma_tt_alias));
317 s->dma_tl_base = new_tl_base;
318 s->dma_tl_limit = new_tl_limit;
319 new_tl_base &= 0x7fffffff;
321 if (s->dma_tl_limit) {
322 uint64_t dma_tt_size;
323 if (s->dma_tl_limit <= memory_region_size(&s->dma_tt)) {
324 dma_tt_size = s->dma_tl_limit;
326 dma_tt_size = memory_region_size(&s->dma_tt);
328 memory_region_init_alias(&s->dma_tt_alias, OBJECT(s),
330 &s->dma_tt, 0, dma_tt_size);
331 dma_tl_contents = memory_region_get_ram_ptr(&s->dma_tt);
332 cpu_physical_memory_read(new_tl_base, dma_tl_contents, dma_tt_size);
334 memory_region_transaction_begin();
335 entries = dma_tt_size / sizeof(dma_pagetable_entry);
336 for (i = 0; i < entries; i++) {
337 rc4030_dma_as_update_one(s, i, dma_tl_contents[i].frame);
339 memory_region_add_subregion(get_system_memory(), new_tl_base,
341 memory_region_transaction_commit();
343 memory_region_init(&s->dma_tt_alias, OBJECT(s),
344 "dma-table-alias", 0);
348 static void rc4030_write(void *opaque, hwaddr addr, uint64_t data,
351 rc4030State *s = opaque;
355 trace_rc4030_write(addr, val);
357 switch (addr & ~0x3) {
358 /* Global config register */
362 /* DMA transl. table base */
364 rc4030_dma_tt_update(s, val, s->dma_tl_limit);
366 /* DMA transl. table limit */
368 rc4030_dma_tt_update(s, s->dma_tl_base, val);
370 /* DMA transl. table invalidated */
373 /* Cache Maintenance */
375 s->cache_maint = val;
377 /* I/O Cache Physical Tag */
381 /* I/O Cache Logical Tag */
385 /* I/O Cache Byte Mask */
387 s->cache_bmask |= val; /* HACK */
389 /* I/O Cache Buffer Window */
392 if (s->cache_ltag == 0x80000001 && s->cache_bmask == 0xf0f0f0f) {
393 hwaddr dest = s->cache_ptag & ~0x1;
394 dest += (s->cache_maint & 0x3) << 3;
395 cpu_physical_memory_write(dest, &val, 4);
398 /* Remote Speed Registers */
415 s->rem_speed[(addr - 0x0070) >> 3] = val;
417 /* DMA channel base address */
451 int entry = (addr - 0x0100) >> 5;
452 int idx = (addr & 0x1f) >> 3;
453 s->dma_regs[entry][idx] = val;
456 /* Memory refresh rate */
458 s->memory_refresh_rate = val;
460 /* Interval timer reload */
463 qemu_irq_lower(s->timer_irq);
470 qemu_log_mask(LOG_GUEST_ERROR,
471 "rc4030: invalid write of 0x%02x at 0x%x",
477 static const MemoryRegionOps rc4030_ops = {
479 .write = rc4030_write,
480 .impl.min_access_size = 4,
481 .impl.max_access_size = 4,
482 .endianness = DEVICE_NATIVE_ENDIAN,
485 static void update_jazz_irq(rc4030State *s)
489 pending = s->isr_jazz & s->imr_jazz;
492 qemu_irq_raise(s->jazz_bus_irq);
494 qemu_irq_lower(s->jazz_bus_irq);
497 static void rc4030_irq_jazz_request(void *opaque, int irq, int level)
499 rc4030State *s = opaque;
502 s->isr_jazz |= 1 << irq;
504 s->isr_jazz &= ~(1 << irq);
510 static void rc4030_periodic_timer(void *opaque)
512 rc4030State *s = opaque;
515 qemu_irq_raise(s->timer_irq);
518 static uint64_t jazzio_read(void *opaque, hwaddr addr, unsigned int size)
520 rc4030State *s = opaque;
526 /* Local bus int source */
528 uint32_t pending = s->isr_jazz & s->imr_jazz;
533 val = (irq + 1) << 2;
541 /* Local bus int enable mask */
546 qemu_log_mask(LOG_GUEST_ERROR,
547 "rc4030/jazzio: invalid read at 0x%x", (int)addr);
552 trace_jazzio_read(addr, val);
557 static void jazzio_write(void *opaque, hwaddr addr, uint64_t data,
560 rc4030State *s = opaque;
564 trace_jazzio_write(addr, val);
567 /* Local bus int enable mask */
573 qemu_log_mask(LOG_GUEST_ERROR,
574 "rc4030/jazzio: invalid write of 0x%02x at 0x%x",
580 static const MemoryRegionOps jazzio_ops = {
582 .write = jazzio_write,
583 .impl.min_access_size = 2,
584 .impl.max_access_size = 2,
585 .endianness = DEVICE_NATIVE_ENDIAN,
588 static void rc4030_reset(DeviceState *dev)
590 rc4030State *s = RC4030(dev);
593 s->config = 0x410; /* some boards seem to accept 0x104 too */
595 s->invalid_address_register = 0;
597 memset(s->dma_regs, 0, sizeof(s->dma_regs));
598 rc4030_dma_tt_update(s, 0, 0);
600 s->remote_failed_address = s->memory_failed_address = 0;
602 s->cache_ptag = s->cache_ltag = 0;
605 s->memory_refresh_rate = 0x18186;
606 s->nvram_protect = 7;
607 for (i = 0; i < 15; i++)
609 s->imr_jazz = 0x10; /* XXX: required by firmware, but why? */
614 qemu_irq_lower(s->timer_irq);
615 qemu_irq_lower(s->jazz_bus_irq);
618 static int rc4030_load(QEMUFile *f, void *opaque, int version_id)
620 rc4030State* s = opaque;
626 s->config = qemu_get_be32(f);
627 s->invalid_address_register = qemu_get_be32(f);
628 for (i = 0; i < 8; i++)
629 for (j = 0; j < 4; j++)
630 s->dma_regs[i][j] = qemu_get_be32(f);
631 s->dma_tl_base = qemu_get_be32(f);
632 s->dma_tl_limit = qemu_get_be32(f);
633 s->cache_maint = qemu_get_be32(f);
634 s->remote_failed_address = qemu_get_be32(f);
635 s->memory_failed_address = qemu_get_be32(f);
636 s->cache_ptag = qemu_get_be32(f);
637 s->cache_ltag = qemu_get_be32(f);
638 s->cache_bmask = qemu_get_be32(f);
639 s->memory_refresh_rate = qemu_get_be32(f);
640 s->nvram_protect = qemu_get_be32(f);
641 for (i = 0; i < 15; i++)
642 s->rem_speed[i] = qemu_get_be32(f);
643 s->imr_jazz = qemu_get_be32(f);
644 s->isr_jazz = qemu_get_be32(f);
645 s->itr = qemu_get_be32(f);
653 static void rc4030_save(QEMUFile *f, void *opaque)
655 rc4030State* s = opaque;
658 qemu_put_be32(f, s->config);
659 qemu_put_be32(f, s->invalid_address_register);
660 for (i = 0; i < 8; i++)
661 for (j = 0; j < 4; j++)
662 qemu_put_be32(f, s->dma_regs[i][j]);
663 qemu_put_be32(f, s->dma_tl_base);
664 qemu_put_be32(f, s->dma_tl_limit);
665 qemu_put_be32(f, s->cache_maint);
666 qemu_put_be32(f, s->remote_failed_address);
667 qemu_put_be32(f, s->memory_failed_address);
668 qemu_put_be32(f, s->cache_ptag);
669 qemu_put_be32(f, s->cache_ltag);
670 qemu_put_be32(f, s->cache_bmask);
671 qemu_put_be32(f, s->memory_refresh_rate);
672 qemu_put_be32(f, s->nvram_protect);
673 for (i = 0; i < 15; i++)
674 qemu_put_be32(f, s->rem_speed[i]);
675 qemu_put_be32(f, s->imr_jazz);
676 qemu_put_be32(f, s->isr_jazz);
677 qemu_put_be32(f, s->itr);
680 static void rc4030_do_dma(void *opaque, int n, uint8_t *buf, int len, int is_write)
682 rc4030State *s = opaque;
686 s->dma_regs[n][DMA_REG_ENABLE] &= ~(DMA_FLAG_TC_INTR | DMA_FLAG_MEM_INTR | DMA_FLAG_ADDR_INTR);
688 /* Check DMA channel consistency */
689 dev_to_mem = (s->dma_regs[n][DMA_REG_ENABLE] & DMA_FLAG_MEM_TO_DEV) ? 0 : 1;
690 if (!(s->dma_regs[n][DMA_REG_ENABLE] & DMA_FLAG_ENABLE) ||
691 (is_write != dev_to_mem)) {
692 s->dma_regs[n][DMA_REG_ENABLE] |= DMA_FLAG_MEM_INTR;
693 s->nmi_interrupt |= 1 << n;
697 /* Get start address and len */
698 if (len > s->dma_regs[n][DMA_REG_COUNT])
699 len = s->dma_regs[n][DMA_REG_COUNT];
700 dma_addr = s->dma_regs[n][DMA_REG_ADDRESS];
702 /* Read/write data at right place */
703 address_space_rw(&s->dma_as, dma_addr, MEMTXATTRS_UNSPECIFIED,
706 s->dma_regs[n][DMA_REG_ENABLE] |= DMA_FLAG_TC_INTR;
707 s->dma_regs[n][DMA_REG_COUNT] -= len;
710 struct rc4030DMAState {
715 void rc4030_dma_read(void *dma, uint8_t *buf, int len)
718 rc4030_do_dma(s->opaque, s->n, buf, len, 0);
721 void rc4030_dma_write(void *dma, uint8_t *buf, int len)
724 rc4030_do_dma(s->opaque, s->n, buf, len, 1);
727 static rc4030_dma *rc4030_allocate_dmas(void *opaque, int n)
730 struct rc4030DMAState *p;
733 s = (rc4030_dma *)g_malloc0(sizeof(rc4030_dma) * n);
734 p = (struct rc4030DMAState *)g_malloc0(sizeof(struct rc4030DMAState) * n);
735 for (i = 0; i < n; i++) {
744 static void rc4030_initfn(Object *obj)
746 DeviceState *dev = DEVICE(obj);
747 rc4030State *s = RC4030(obj);
748 SysBusDevice *sysbus = SYS_BUS_DEVICE(obj);
750 qdev_init_gpio_in(dev, rc4030_irq_jazz_request, 16);
752 sysbus_init_irq(sysbus, &s->timer_irq);
753 sysbus_init_irq(sysbus, &s->jazz_bus_irq);
755 register_savevm(NULL, "rc4030", 0, 2, rc4030_save, rc4030_load, s);
757 sysbus_init_mmio(sysbus, &s->iomem_chipset);
758 sysbus_init_mmio(sysbus, &s->iomem_jazzio);
761 static void rc4030_realize(DeviceState *dev, Error **errp)
763 rc4030State *s = RC4030(dev);
764 Object *o = OBJECT(dev);
767 s->periodic_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL,
768 rc4030_periodic_timer, s);
770 memory_region_init_io(&s->iomem_chipset, NULL, &rc4030_ops, s,
771 "rc4030.chipset", 0x300);
772 memory_region_init_io(&s->iomem_jazzio, NULL, &jazzio_ops, s,
773 "rc4030.jazzio", 0x00001000);
775 memory_region_init_rom_device(&s->dma_tt, o,
776 &rc4030_dma_tt_ops, s, "dma-table",
777 MAX_TL_ENTRIES * sizeof(dma_pagetable_entry),
779 memory_region_init(&s->dma_tt_alias, o, "dma-table-alias", 0);
780 memory_region_init(&s->dma_mr, o, "dma", INT32_MAX);
781 for (i = 0; i < MAX_TL_ENTRIES; ++i) {
782 memory_region_init_alias(&s->dma_mrs[i], o, "dma-alias",
783 get_system_memory(), 0, DMA_PAGESIZE);
784 memory_region_set_enabled(&s->dma_mrs[i], false);
785 memory_region_add_subregion(&s->dma_mr, i * DMA_PAGESIZE,
788 address_space_init(&s->dma_as, &s->dma_mr, "rc4030-dma");
791 static void rc4030_unrealize(DeviceState *dev, Error **errp)
793 rc4030State *s = RC4030(dev);
796 timer_free(s->periodic_timer);
798 address_space_destroy(&s->dma_as);
799 object_unparent(OBJECT(&s->dma_tt));
800 object_unparent(OBJECT(&s->dma_tt_alias));
801 object_unparent(OBJECT(&s->dma_mr));
802 for (i = 0; i < MAX_TL_ENTRIES; ++i) {
803 memory_region_del_subregion(&s->dma_mr, &s->dma_mrs[i]);
804 object_unparent(OBJECT(&s->dma_mrs[i]));
808 static void rc4030_class_init(ObjectClass *klass, void *class_data)
810 DeviceClass *dc = DEVICE_CLASS(klass);
812 dc->realize = rc4030_realize;
813 dc->unrealize = rc4030_unrealize;
814 dc->reset = rc4030_reset;
817 static const TypeInfo rc4030_info = {
819 .parent = TYPE_SYS_BUS_DEVICE,
820 .instance_size = sizeof(rc4030State),
821 .instance_init = rc4030_initfn,
822 .class_init = rc4030_class_init,
825 static void rc4030_register_types(void)
827 type_register_static(&rc4030_info);
830 type_init(rc4030_register_types)
832 DeviceState *rc4030_init(rc4030_dma **dmas, MemoryRegion **dma_mr)
836 dev = qdev_create(NULL, TYPE_RC4030);
837 qdev_init_nofail(dev);
839 *dmas = rc4030_allocate_dmas(dev, 4);
840 *dma_mr = &RC4030(dev)->dma_mr;