2 * PowerMac descriptor-based DMA emulation
4 * Copyright (c) 2005-2007 Fabrice Bellard
5 * Copyright (c) 2007 Jocelyn Mayer
6 * Copyright (c) 2009 Laurent Vivier
8 * some parts from linux-2.6.28, arch/powerpc/include/asm/dbdma.h
10 * Definitions for using the Apple Descriptor-Based DMA controller
11 * in Power Macintosh computers.
13 * Copyright (C) 1996 Paul Mackerras.
15 * some parts from mol 0.9.71
17 * Descriptor based DMA emulation
21 * Permission is hereby granted, free of charge, to any person obtaining a copy
22 * of this software and associated documentation files (the "Software"), to deal
23 * in the Software without restriction, including without limitation the rights
24 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
25 * copies of the Software, and to permit persons to whom the Software is
26 * furnished to do so, subject to the following conditions:
28 * The above copyright notice and this permission notice shall be included in
29 * all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
32 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
33 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
34 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
35 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
36 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
41 #include "mac_dbdma.h"
47 #define DBDMA_DPRINTF(fmt, ...) \
48 do { printf("DBDMA: " fmt , ## __VA_ARGS__); } while (0)
50 #define DBDMA_DPRINTF(fmt, ...)
57 * DBDMA control/status registers. All little-endian.
60 #define DBDMA_CONTROL 0x00
61 #define DBDMA_STATUS 0x01
62 #define DBDMA_CMDPTR_HI 0x02
63 #define DBDMA_CMDPTR_LO 0x03
64 #define DBDMA_INTR_SEL 0x04
65 #define DBDMA_BRANCH_SEL 0x05
66 #define DBDMA_WAIT_SEL 0x06
67 #define DBDMA_XFER_MODE 0x07
68 #define DBDMA_DATA2PTR_HI 0x08
69 #define DBDMA_DATA2PTR_LO 0x09
70 #define DBDMA_RES1 0x0A
71 #define DBDMA_ADDRESS_HI 0x0B
72 #define DBDMA_BRANCH_ADDR_HI 0x0C
73 #define DBDMA_RES2 0x0D
74 #define DBDMA_RES3 0x0E
75 #define DBDMA_RES4 0x0F
78 #define DBDMA_SIZE (DBDMA_REGS * sizeof(uint32_t))
80 #define DBDMA_CHANNEL_SHIFT 7
81 #define DBDMA_CHANNEL_SIZE (1 << DBDMA_CHANNEL_SHIFT)
83 #define DBDMA_CHANNELS (0x1000 >> DBDMA_CHANNEL_SHIFT)
85 /* Bits in control and status registers */
94 #define DEVSTAT 0x00ff
97 * DBDMA command structure. These fields are all little-endian!
100 typedef struct dbdma_cmd {
101 uint16_t req_count; /* requested byte transfer count */
102 uint16_t command; /* command word (has bit-fields) */
103 uint32_t phy_addr; /* physical data address */
104 uint32_t cmd_dep; /* command-dependent field */
105 uint16_t res_count; /* residual count after completion */
106 uint16_t xfer_status; /* transfer status */
109 /* DBDMA command values in command field */
111 #define COMMAND_MASK 0xf000
112 #define OUTPUT_MORE 0x0000 /* transfer memory data to stream */
113 #define OUTPUT_LAST 0x1000 /* ditto followed by end marker */
114 #define INPUT_MORE 0x2000 /* transfer stream data to memory */
115 #define INPUT_LAST 0x3000 /* ditto, expect end marker */
116 #define STORE_WORD 0x4000 /* write word (4 bytes) to device reg */
117 #define LOAD_WORD 0x5000 /* read word (4 bytes) from device reg */
118 #define DBDMA_NOP 0x6000 /* do nothing */
119 #define DBDMA_STOP 0x7000 /* suspend processing */
121 /* Key values in command field */
123 #define KEY_MASK 0x0700
124 #define KEY_STREAM0 0x0000 /* usual data stream */
125 #define KEY_STREAM1 0x0100 /* control/status stream */
126 #define KEY_STREAM2 0x0200 /* device-dependent stream */
127 #define KEY_STREAM3 0x0300 /* device-dependent stream */
128 #define KEY_STREAM4 0x0400 /* reserved */
129 #define KEY_REGS 0x0500 /* device register space */
130 #define KEY_SYSTEM 0x0600 /* system memory-mapped space */
131 #define KEY_DEVICE 0x0700 /* device memory-mapped space */
133 /* Interrupt control values in command field */
135 #define INTR_MASK 0x0030
136 #define INTR_NEVER 0x0000 /* don't interrupt */
137 #define INTR_IFSET 0x0010 /* intr if condition bit is 1 */
138 #define INTR_IFCLR 0x0020 /* intr if condition bit is 0 */
139 #define INTR_ALWAYS 0x0030 /* always interrupt */
141 /* Branch control values in command field */
143 #define BR_MASK 0x000c
144 #define BR_NEVER 0x0000 /* don't branch */
145 #define BR_IFSET 0x0004 /* branch if condition bit is 1 */
146 #define BR_IFCLR 0x0008 /* branch if condition bit is 0 */
147 #define BR_ALWAYS 0x000c /* always branch */
149 /* Wait control values in command field */
151 #define WAIT_MASK 0x0003
152 #define WAIT_NEVER 0x0000 /* don't wait */
153 #define WAIT_IFSET 0x0001 /* wait if condition bit is 1 */
154 #define WAIT_IFCLR 0x0002 /* wait if condition bit is 0 */
155 #define WAIT_ALWAYS 0x0003 /* always wait */
157 typedef struct DBDMA_channel {
159 uint32_t regs[DBDMA_REGS];
169 static void dump_dbdma_cmd(dbdma_cmd *cmd)
171 printf("dbdma_cmd %p\n", cmd);
172 printf(" req_count 0x%04x\n", le16_to_cpu(cmd->req_count));
173 printf(" command 0x%04x\n", le16_to_cpu(cmd->command));
174 printf(" phy_addr 0x%08x\n", le32_to_cpu(cmd->phy_addr));
175 printf(" cmd_dep 0x%08x\n", le32_to_cpu(cmd->cmd_dep));
176 printf(" res_count 0x%04x\n", le16_to_cpu(cmd->res_count));
177 printf(" xfer_status 0x%04x\n", le16_to_cpu(cmd->xfer_status));
180 static void dump_dbdma_cmd(dbdma_cmd *cmd)
184 static void dbdma_cmdptr_load(DBDMA_channel *ch)
186 DBDMA_DPRINTF("dbdma_cmdptr_load 0x%08x\n",
187 be32_to_cpu(ch->regs[DBDMA_CMDPTR_LO]));
188 cpu_physical_memory_read(be32_to_cpu(ch->regs[DBDMA_CMDPTR_LO]),
189 (uint8_t*)&ch->current, sizeof(dbdma_cmd));
192 static void dbdma_cmdptr_save(DBDMA_channel *ch)
194 DBDMA_DPRINTF("dbdma_cmdptr_save 0x%08x\n",
195 be32_to_cpu(ch->regs[DBDMA_CMDPTR_LO]));
196 DBDMA_DPRINTF("xfer_status 0x%08x res_count 0x%04x\n",
197 le16_to_cpu(ch->current.xfer_status),
198 le16_to_cpu(ch->current.res_count));
199 cpu_physical_memory_write(be32_to_cpu(ch->regs[DBDMA_CMDPTR_LO]),
200 (uint8_t*)&ch->current, sizeof(dbdma_cmd));
203 static void kill_channel(DBDMA_channel *ch)
205 DBDMA_DPRINTF("kill_channel\n");
207 ch->regs[DBDMA_STATUS] |= cpu_to_be32(DEAD);
208 ch->regs[DBDMA_STATUS] &= cpu_to_be32(~ACTIVE);
210 qemu_irq_raise(ch->irq);
213 static void conditional_interrupt(DBDMA_channel *ch)
215 dbdma_cmd *current = &ch->current;
217 uint16_t sel_mask, sel_value;
221 DBDMA_DPRINTF("conditional_interrupt\n");
223 intr = le16_to_cpu(current->command) & INTR_MASK;
226 case INTR_NEVER: /* don't interrupt */
228 case INTR_ALWAYS: /* always interrupt */
229 qemu_irq_raise(ch->irq);
233 status = be32_to_cpu(ch->regs[DBDMA_STATUS]) & DEVSTAT;
235 sel_mask = (be32_to_cpu(ch->regs[DBDMA_INTR_SEL]) >> 16) & 0x0f;
236 sel_value = be32_to_cpu(ch->regs[DBDMA_INTR_SEL]) & 0x0f;
238 cond = (status & sel_mask) == (sel_value & sel_mask);
241 case INTR_IFSET: /* intr if condition bit is 1 */
243 qemu_irq_raise(ch->irq);
245 case INTR_IFCLR: /* intr if condition bit is 0 */
247 qemu_irq_raise(ch->irq);
252 static int conditional_wait(DBDMA_channel *ch)
254 dbdma_cmd *current = &ch->current;
256 uint16_t sel_mask, sel_value;
260 DBDMA_DPRINTF("conditional_wait\n");
262 wait = le16_to_cpu(current->command) & WAIT_MASK;
265 case WAIT_NEVER: /* don't wait */
267 case WAIT_ALWAYS: /* always wait */
271 status = be32_to_cpu(ch->regs[DBDMA_STATUS]) & DEVSTAT;
273 sel_mask = (be32_to_cpu(ch->regs[DBDMA_WAIT_SEL]) >> 16) & 0x0f;
274 sel_value = be32_to_cpu(ch->regs[DBDMA_WAIT_SEL]) & 0x0f;
276 cond = (status & sel_mask) == (sel_value & sel_mask);
279 case WAIT_IFSET: /* wait if condition bit is 1 */
283 case WAIT_IFCLR: /* wait if condition bit is 0 */
291 static void next(DBDMA_channel *ch)
295 ch->regs[DBDMA_STATUS] &= cpu_to_be32(~BT);
297 cp = be32_to_cpu(ch->regs[DBDMA_CMDPTR_LO]);
298 ch->regs[DBDMA_CMDPTR_LO] = cpu_to_be32(cp + sizeof(dbdma_cmd));
299 dbdma_cmdptr_load(ch);
302 static void branch(DBDMA_channel *ch)
304 dbdma_cmd *current = &ch->current;
306 ch->regs[DBDMA_CMDPTR_LO] = current->cmd_dep;
307 ch->regs[DBDMA_STATUS] |= cpu_to_be32(BT);
308 dbdma_cmdptr_load(ch);
311 static void conditional_branch(DBDMA_channel *ch)
313 dbdma_cmd *current = &ch->current;
315 uint16_t sel_mask, sel_value;
319 DBDMA_DPRINTF("conditional_branch\n");
321 /* check if we must branch */
323 br = le16_to_cpu(current->command) & BR_MASK;
326 case BR_NEVER: /* don't branch */
329 case BR_ALWAYS: /* always branch */
334 status = be32_to_cpu(ch->regs[DBDMA_STATUS]) & DEVSTAT;
336 sel_mask = (be32_to_cpu(ch->regs[DBDMA_BRANCH_SEL]) >> 16) & 0x0f;
337 sel_value = be32_to_cpu(ch->regs[DBDMA_BRANCH_SEL]) & 0x0f;
339 cond = (status & sel_mask) == (sel_value & sel_mask);
342 case BR_IFSET: /* branch if condition bit is 1 */
348 case BR_IFCLR: /* branch if condition bit is 0 */
357 static QEMUBH *dbdma_bh;
358 static void channel_run(DBDMA_channel *ch);
360 static void dbdma_end(DBDMA_io *io)
362 DBDMA_channel *ch = io->channel;
363 dbdma_cmd *current = &ch->current;
365 if (conditional_wait(ch))
368 current->xfer_status = cpu_to_le16(be32_to_cpu(ch->regs[DBDMA_STATUS]));
369 current->res_count = cpu_to_le16(be32_to_cpu(io->len));
370 dbdma_cmdptr_save(ch);
372 ch->regs[DBDMA_STATUS] &= cpu_to_be32(~FLUSH);
374 conditional_interrupt(ch);
375 conditional_branch(ch);
379 if ((ch->regs[DBDMA_STATUS] & cpu_to_be32(RUN)) &&
380 (ch->regs[DBDMA_STATUS] & cpu_to_be32(ACTIVE)))
384 static void start_output(DBDMA_channel *ch, int key, uint32_t addr,
385 uint16_t req_count, int is_last)
387 DBDMA_DPRINTF("start_output\n");
389 /* KEY_REGS, KEY_DEVICE and KEY_STREAM
390 * are not implemented in the mac-io chip
393 DBDMA_DPRINTF("addr 0x%x key 0x%x\n", addr, key);
394 if (!addr || key > KEY_STREAM3) {
400 ch->io.len = req_count;
401 ch->io.is_last = is_last;
402 ch->io.dma_end = dbdma_end;
403 ch->io.is_dma_out = 1;
408 static void start_input(DBDMA_channel *ch, int key, uint32_t addr,
409 uint16_t req_count, int is_last)
411 DBDMA_DPRINTF("start_input\n");
413 /* KEY_REGS, KEY_DEVICE and KEY_STREAM
414 * are not implemented in the mac-io chip
417 if (!addr || key > KEY_STREAM3) {
423 ch->io.len = req_count;
424 ch->io.is_last = is_last;
425 ch->io.dma_end = dbdma_end;
426 ch->io.is_dma_out = 0;
431 static void load_word(DBDMA_channel *ch, int key, uint32_t addr,
434 dbdma_cmd *current = &ch->current;
437 DBDMA_DPRINTF("load_word\n");
439 /* only implements KEY_SYSTEM */
441 if (key != KEY_SYSTEM) {
442 printf("DBDMA: LOAD_WORD, unimplemented key %x\n", key);
447 cpu_physical_memory_read(addr, (uint8_t*)&val, len);
450 val = (val << 16) | (current->cmd_dep & 0x0000ffff);
452 val = (val << 24) | (current->cmd_dep & 0x00ffffff);
454 current->cmd_dep = val;
456 if (conditional_wait(ch))
459 current->xfer_status = cpu_to_le16(be32_to_cpu(ch->regs[DBDMA_STATUS]));
460 dbdma_cmdptr_save(ch);
461 ch->regs[DBDMA_STATUS] &= cpu_to_be32(~FLUSH);
463 conditional_interrupt(ch);
467 qemu_bh_schedule(dbdma_bh);
470 static void store_word(DBDMA_channel *ch, int key, uint32_t addr,
473 dbdma_cmd *current = &ch->current;
476 DBDMA_DPRINTF("store_word\n");
478 /* only implements KEY_SYSTEM */
480 if (key != KEY_SYSTEM) {
481 printf("DBDMA: STORE_WORD, unimplemented key %x\n", key);
486 val = current->cmd_dep;
492 cpu_physical_memory_write(addr, (uint8_t*)&val, len);
494 if (conditional_wait(ch))
497 current->xfer_status = cpu_to_le16(be32_to_cpu(ch->regs[DBDMA_STATUS]));
498 dbdma_cmdptr_save(ch);
499 ch->regs[DBDMA_STATUS] &= cpu_to_be32(~FLUSH);
501 conditional_interrupt(ch);
505 qemu_bh_schedule(dbdma_bh);
508 static void nop(DBDMA_channel *ch)
510 dbdma_cmd *current = &ch->current;
512 if (conditional_wait(ch))
515 current->xfer_status = cpu_to_le16(be32_to_cpu(ch->regs[DBDMA_STATUS]));
516 dbdma_cmdptr_save(ch);
518 conditional_interrupt(ch);
519 conditional_branch(ch);
522 qemu_bh_schedule(dbdma_bh);
525 static void stop(DBDMA_channel *ch)
527 ch->regs[DBDMA_STATUS] &= cpu_to_be32(~(ACTIVE|DEAD|FLUSH));
529 /* the stop command does not increment command pointer */
532 static void channel_run(DBDMA_channel *ch)
534 dbdma_cmd *current = &ch->current;
539 DBDMA_DPRINTF("channel_run\n");
540 dump_dbdma_cmd(current);
542 /* clear WAKE flag at command fetch */
544 ch->regs[DBDMA_STATUS] &= cpu_to_be32(~WAKE);
546 cmd = le16_to_cpu(current->command) & COMMAND_MASK;
558 key = le16_to_cpu(current->command) & 0x0700;
559 req_count = le16_to_cpu(current->req_count);
560 phy_addr = le32_to_cpu(current->phy_addr);
562 if (key == KEY_STREAM4) {
563 printf("command %x, invalid key 4\n", cmd);
570 start_output(ch, key, phy_addr, req_count, 0);
574 start_output(ch, key, phy_addr, req_count, 1);
578 start_input(ch, key, phy_addr, req_count, 0);
582 start_input(ch, key, phy_addr, req_count, 1);
586 if (key < KEY_REGS) {
587 printf("command %x, invalid key %x\n", cmd, key);
591 /* for LOAD_WORD and STORE_WORD, req_count is on 3 bits
592 * and BRANCH is invalid
595 req_count = req_count & 0x0007;
596 if (req_count & 0x4) {
599 } else if (req_count & 0x2) {
607 load_word(ch, key, phy_addr, req_count);
611 store_word(ch, key, phy_addr, req_count);
616 static void DBDMA_run (DBDMA_channel *ch)
620 for (channel = 0; channel < DBDMA_CHANNELS; channel++, ch++) {
621 uint32_t status = be32_to_cpu(ch->regs[DBDMA_STATUS]);
622 if (!ch->processing && (status & RUN) && (status & ACTIVE))
627 static void DBDMA_run_bh(void *opaque)
629 DBDMA_channel *ch = opaque;
631 DBDMA_DPRINTF("DBDMA_run_bh\n");
636 void DBDMA_register_channel(void *dbdma, int nchan, qemu_irq irq,
637 DBDMA_rw rw, DBDMA_flush flush,
640 DBDMA_channel *ch = ( DBDMA_channel *)dbdma + nchan;
642 DBDMA_DPRINTF("DBDMA_register_channel 0x%x\n", nchan);
648 ch->io.opaque = opaque;
652 void DBDMA_schedule(void)
658 dbdma_control_write(DBDMA_channel *ch)
660 uint16_t mask, value;
663 mask = (be32_to_cpu(ch->regs[DBDMA_CONTROL]) >> 16) & 0xffff;
664 value = be32_to_cpu(ch->regs[DBDMA_CONTROL]) & 0xffff;
666 value &= (RUN | PAUSE | FLUSH | WAKE | DEVSTAT);
668 status = be32_to_cpu(ch->regs[DBDMA_STATUS]);
670 status = (value & mask) | (status & ~mask);
680 if ((be32_to_cpu(ch->regs[DBDMA_STATUS]) & RUN) && !(status & RUN)) {
682 status &= ~(ACTIVE|DEAD);
685 DBDMA_DPRINTF(" status 0x%08x\n", status);
687 ch->regs[DBDMA_STATUS] = cpu_to_be32(status);
690 qemu_bh_schedule(dbdma_bh);
695 static void dbdma_writel (void *opaque,
696 target_phys_addr_t addr, uint32_t value)
698 int channel = addr >> DBDMA_CHANNEL_SHIFT;
699 DBDMA_channel *ch = (DBDMA_channel *)opaque + channel;
700 int reg = (addr - (channel << DBDMA_CHANNEL_SHIFT)) >> 2;
702 DBDMA_DPRINTF("writel 0x" TARGET_FMT_plx " <= 0x%08x\n", addr, value);
703 DBDMA_DPRINTF("channel 0x%x reg 0x%x\n",
704 (uint32_t)addr >> DBDMA_CHANNEL_SHIFT, reg);
706 /* cmdptr cannot be modified if channel is RUN or ACTIVE */
708 if (reg == DBDMA_CMDPTR_LO &&
709 (ch->regs[DBDMA_STATUS] & cpu_to_be32(RUN | ACTIVE)))
712 ch->regs[reg] = value;
716 dbdma_control_write(ch);
718 case DBDMA_CMDPTR_LO:
719 /* 16-byte aligned */
720 ch->regs[DBDMA_CMDPTR_LO] &= cpu_to_be32(~0xf);
721 dbdma_cmdptr_load(ch);
725 case DBDMA_BRANCH_SEL:
729 case DBDMA_XFER_MODE:
730 case DBDMA_CMDPTR_HI:
731 case DBDMA_DATA2PTR_HI:
732 case DBDMA_DATA2PTR_LO:
733 case DBDMA_ADDRESS_HI:
734 case DBDMA_BRANCH_ADDR_HI:
744 static uint32_t dbdma_readl (void *opaque, target_phys_addr_t addr)
747 int channel = addr >> DBDMA_CHANNEL_SHIFT;
748 DBDMA_channel *ch = (DBDMA_channel *)opaque + channel;
749 int reg = (addr - (channel << DBDMA_CHANNEL_SHIFT)) >> 2;
751 value = ch->regs[reg];
753 DBDMA_DPRINTF("readl 0x" TARGET_FMT_plx " => 0x%08x\n", addr, value);
754 DBDMA_DPRINTF("channel 0x%x reg 0x%x\n",
755 (uint32_t)addr >> DBDMA_CHANNEL_SHIFT, reg);
762 case DBDMA_CMDPTR_LO:
764 case DBDMA_BRANCH_SEL:
768 case DBDMA_XFER_MODE:
769 case DBDMA_CMDPTR_HI:
770 case DBDMA_DATA2PTR_HI:
771 case DBDMA_DATA2PTR_LO:
772 case DBDMA_ADDRESS_HI:
773 case DBDMA_BRANCH_ADDR_HI:
788 static CPUWriteMemoryFunc * const dbdma_write[] = {
794 static CPUReadMemoryFunc * const dbdma_read[] = {
800 static void dbdma_save(QEMUFile *f, void *opaque)
802 DBDMA_channel *s = opaque;
805 for (i = 0; i < DBDMA_CHANNELS; i++)
806 for (j = 0; j < DBDMA_REGS; j++)
807 qemu_put_be32s(f, &s[i].regs[j]);
810 static int dbdma_load(QEMUFile *f, void *opaque, int version_id)
812 DBDMA_channel *s = opaque;
818 for (i = 0; i < DBDMA_CHANNELS; i++)
819 for (j = 0; j < DBDMA_REGS; j++)
820 qemu_get_be32s(f, &s[i].regs[j]);
825 static void dbdma_reset(void *opaque)
827 DBDMA_channel *s = opaque;
830 for (i = 0; i < DBDMA_CHANNELS; i++)
831 memset(s[i].regs, 0, DBDMA_SIZE);
834 void* DBDMA_init (int *dbdma_mem_index)
838 s = qemu_mallocz(sizeof(DBDMA_channel) * DBDMA_CHANNELS);
840 *dbdma_mem_index = cpu_register_io_memory(dbdma_read, dbdma_write, s);
841 register_savevm("dbdma", -1, 1, dbdma_save, dbdma_load, s);
842 qemu_register_reset(dbdma_reset, s);
845 dbdma_bh = qemu_bh_new(DBDMA_run_bh, s);