2 * QEMU ESP/NCR53C9x emulation
4 * Copyright (c) 2005-2006 Fabrice Bellard
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
33 * On Sparc32, this is the ESP (NCR53C90) part of chip STP2000 (Master I/O),
34 * also produced as NCR89C100. See
35 * http://www.ibiblio.org/pub/historic-linux/early-ports/Sparc/NCR/NCR89C100.txt
37 * http://www.ibiblio.org/pub/historic-linux/early-ports/Sparc/NCR/NCR53C9X.txt
41 #define DPRINTF(fmt, ...) \
42 do { printf("ESP: " fmt , ## __VA_ARGS__); } while (0)
44 #define DPRINTF(fmt, ...) do {} while (0)
47 #define ESP_ERROR(fmt, ...) \
48 do { printf("ESP ERROR: %s: " fmt, __func__ , ## __VA_ARGS__); } while (0)
53 typedef struct ESPState ESPState
;
57 uint8_t rregs
[ESP_REGS
];
58 uint8_t wregs
[ESP_REGS
];
62 uint32_t ti_rptr
, ti_wptr
;
65 uint8_t ti_buf
[TI_BUFSZ
];
67 SCSIDevice
*current_dev
;
68 SCSIRequest
*current_req
;
69 uint8_t cmdbuf
[TI_BUFSZ
];
73 /* The amount of data left in the current DMA transfer. */
75 /* The size of the current DMA transfer. Zero if no transfer is in
83 ESPDMAMemoryReadWriteFunc dma_memory_read
;
84 ESPDMAMemoryReadWriteFunc dma_memory_write
;
86 void (*dma_cb
)(ESPState
*s
);
94 #define ESP_WBUSID 0x4
98 #define ESP_WSYNTP 0x6
99 #define ESP_RFLAGS 0x7
100 #define ESP_WSYNO 0x7
102 #define ESP_RRES1 0x9
104 #define ESP_RRES2 0xa
105 #define ESP_WTEST 0xa
116 #define CMD_FLUSH 0x01
117 #define CMD_RESET 0x02
118 #define CMD_BUSRESET 0x03
120 #define CMD_ICCS 0x11
121 #define CMD_MSGACC 0x12
123 #define CMD_SATN 0x1a
125 #define CMD_SELATN 0x42
126 #define CMD_SELATNS 0x43
127 #define CMD_ENSEL 0x44
135 #define STAT_PIO_MASK 0x06
140 #define STAT_INT 0x80
142 #define BUSID_DID 0x07
147 #define INTR_RST 0x80
152 #define CFG1_RESREPT 0x40
154 #define TCHI_FAS100A 0x4
156 static void esp_raise_irq(ESPState
*s
)
158 if (!(s
->rregs
[ESP_RSTAT
] & STAT_INT
)) {
159 s
->rregs
[ESP_RSTAT
] |= STAT_INT
;
160 qemu_irq_raise(s
->irq
);
161 DPRINTF("Raise IRQ\n");
165 static void esp_lower_irq(ESPState
*s
)
167 if (s
->rregs
[ESP_RSTAT
] & STAT_INT
) {
168 s
->rregs
[ESP_RSTAT
] &= ~STAT_INT
;
169 qemu_irq_lower(s
->irq
);
170 DPRINTF("Lower IRQ\n");
174 static void esp_dma_enable(void *opaque
, int irq
, int level
)
176 DeviceState
*d
= opaque
;
177 ESPState
*s
= container_of(d
, ESPState
, busdev
.qdev
);
181 DPRINTF("Raise enable\n");
187 DPRINTF("Lower enable\n");
192 static void esp_request_cancelled(SCSIRequest
*req
)
194 ESPState
*s
= DO_UPCAST(ESPState
, busdev
.qdev
, req
->bus
->qbus
.parent
);
196 if (req
== s
->current_req
) {
197 scsi_req_unref(s
->current_req
);
198 s
->current_req
= NULL
;
199 s
->current_dev
= NULL
;
203 static uint32_t get_cmd(ESPState
*s
, uint8_t *buf
)
208 target
= s
->wregs
[ESP_WBUSID
] & BUSID_DID
;
210 dmalen
= s
->rregs
[ESP_TCLO
] | (s
->rregs
[ESP_TCMID
] << 8);
211 s
->dma_memory_read(s
->dma_opaque
, buf
, dmalen
);
214 memcpy(buf
, s
->ti_buf
, dmalen
);
215 buf
[0] = buf
[2] >> 5;
217 DPRINTF("get_cmd: len %d target %d\n", dmalen
, target
);
223 if (s
->current_req
) {
224 /* Started a new command before the old one finished. Cancel it. */
225 scsi_req_cancel(s
->current_req
);
229 if (target
>= ESP_MAX_DEVS
|| !s
->bus
.devs
[target
]) {
231 s
->rregs
[ESP_RSTAT
] = 0;
232 s
->rregs
[ESP_RINTR
] = INTR_DC
;
233 s
->rregs
[ESP_RSEQ
] = SEQ_0
;
237 s
->current_dev
= s
->bus
.devs
[target
];
241 static void do_busid_cmd(ESPState
*s
, uint8_t *buf
, uint8_t busid
)
246 DPRINTF("do_busid_cmd: busid 0x%x\n", busid
);
248 s
->current_req
= scsi_req_new(s
->current_dev
, 0, lun
, buf
, NULL
);
249 datalen
= scsi_req_enqueue(s
->current_req
);
250 s
->ti_size
= datalen
;
252 s
->rregs
[ESP_RSTAT
] = STAT_TC
;
256 s
->rregs
[ESP_RSTAT
] |= STAT_DI
;
258 s
->rregs
[ESP_RSTAT
] |= STAT_DO
;
260 scsi_req_continue(s
->current_req
);
262 s
->rregs
[ESP_RINTR
] = INTR_BS
| INTR_FC
;
263 s
->rregs
[ESP_RSEQ
] = SEQ_CD
;
267 static void do_cmd(ESPState
*s
, uint8_t *buf
)
269 uint8_t busid
= buf
[0];
271 do_busid_cmd(s
, &buf
[1], busid
);
274 static void handle_satn(ESPState
*s
)
279 if (!s
->dma_enabled
) {
280 s
->dma_cb
= handle_satn
;
283 len
= get_cmd(s
, buf
);
288 static void handle_s_without_atn(ESPState
*s
)
293 if (!s
->dma_enabled
) {
294 s
->dma_cb
= handle_s_without_atn
;
297 len
= get_cmd(s
, buf
);
299 do_busid_cmd(s
, buf
, 0);
303 static void handle_satn_stop(ESPState
*s
)
305 if (!s
->dma_enabled
) {
306 s
->dma_cb
= handle_satn_stop
;
309 s
->cmdlen
= get_cmd(s
, s
->cmdbuf
);
311 DPRINTF("Set ATN & Stop: cmdlen %d\n", s
->cmdlen
);
313 s
->rregs
[ESP_RSTAT
] = STAT_TC
| STAT_CD
;
314 s
->rregs
[ESP_RINTR
] = INTR_BS
| INTR_FC
;
315 s
->rregs
[ESP_RSEQ
] = SEQ_CD
;
320 static void write_response(ESPState
*s
)
322 DPRINTF("Transfer status (status=%d)\n", s
->status
);
323 s
->ti_buf
[0] = s
->status
;
326 s
->dma_memory_write(s
->dma_opaque
, s
->ti_buf
, 2);
327 s
->rregs
[ESP_RSTAT
] = STAT_TC
| STAT_ST
;
328 s
->rregs
[ESP_RINTR
] = INTR_BS
| INTR_FC
;
329 s
->rregs
[ESP_RSEQ
] = SEQ_CD
;
334 s
->rregs
[ESP_RFLAGS
] = 2;
339 static void esp_dma_done(ESPState
*s
)
341 s
->rregs
[ESP_RSTAT
] |= STAT_TC
;
342 s
->rregs
[ESP_RINTR
] = INTR_BS
;
343 s
->rregs
[ESP_RSEQ
] = 0;
344 s
->rregs
[ESP_RFLAGS
] = 0;
345 s
->rregs
[ESP_TCLO
] = 0;
346 s
->rregs
[ESP_TCMID
] = 0;
350 static void esp_do_dma(ESPState
*s
)
355 to_device
= (s
->ti_size
< 0);
358 DPRINTF("command len %d + %d\n", s
->cmdlen
, len
);
359 s
->dma_memory_read(s
->dma_opaque
, &s
->cmdbuf
[s
->cmdlen
], len
);
363 do_cmd(s
, s
->cmdbuf
);
366 if (s
->async_len
== 0) {
367 /* Defer until data is available. */
370 if (len
> s
->async_len
) {
374 s
->dma_memory_read(s
->dma_opaque
, s
->async_buf
, len
);
376 s
->dma_memory_write(s
->dma_opaque
, s
->async_buf
, len
);
385 if (s
->async_len
== 0) {
386 scsi_req_continue(s
->current_req
);
387 /* If there is still data to be read from the device then
388 complete the DMA operation immediately. Otherwise defer
389 until the scsi layer has completed. */
390 if (to_device
|| s
->dma_left
!= 0 || s
->ti_size
== 0) {
395 /* Partially filled a scsi buffer. Complete immediately. */
399 static void esp_command_complete(SCSIRequest
*req
, uint32_t status
)
401 ESPState
*s
= DO_UPCAST(ESPState
, busdev
.qdev
, req
->bus
->qbus
.parent
);
403 DPRINTF("SCSI Command complete\n");
404 if (s
->ti_size
!= 0) {
405 DPRINTF("SCSI command completed unexpectedly\n");
411 DPRINTF("Command failed\n");
414 s
->rregs
[ESP_RSTAT
] = STAT_ST
;
416 if (s
->current_req
) {
417 scsi_req_unref(s
->current_req
);
418 s
->current_req
= NULL
;
419 s
->current_dev
= NULL
;
423 static void esp_transfer_data(SCSIRequest
*req
, uint32_t len
)
425 ESPState
*s
= DO_UPCAST(ESPState
, busdev
.qdev
, req
->bus
->qbus
.parent
);
427 DPRINTF("transfer %d/%d\n", s
->dma_left
, s
->ti_size
);
429 s
->async_buf
= scsi_req_get_buf(req
);
432 } else if (s
->dma_counter
!= 0 && s
->ti_size
<= 0) {
433 /* If this was the last part of a DMA transfer then the
434 completion interrupt is deferred to here. */
439 static void handle_ti(ESPState
*s
)
441 uint32_t dmalen
, minlen
;
443 dmalen
= s
->rregs
[ESP_TCLO
] | (s
->rregs
[ESP_TCMID
] << 8);
447 s
->dma_counter
= dmalen
;
450 minlen
= (dmalen
< 32) ? dmalen
: 32;
451 else if (s
->ti_size
< 0)
452 minlen
= (dmalen
< -s
->ti_size
) ? dmalen
: -s
->ti_size
;
454 minlen
= (dmalen
< s
->ti_size
) ? dmalen
: s
->ti_size
;
455 DPRINTF("Transfer Information len %d\n", minlen
);
457 s
->dma_left
= minlen
;
458 s
->rregs
[ESP_RSTAT
] &= ~STAT_TC
;
460 } else if (s
->do_cmd
) {
461 DPRINTF("command len %d\n", s
->cmdlen
);
465 do_cmd(s
, s
->cmdbuf
);
470 static void esp_hard_reset(DeviceState
*d
)
472 ESPState
*s
= container_of(d
, ESPState
, busdev
.qdev
);
474 memset(s
->rregs
, 0, ESP_REGS
);
475 memset(s
->wregs
, 0, ESP_REGS
);
476 s
->rregs
[ESP_TCHI
] = TCHI_FAS100A
; // Indicate fas100a
484 s
->rregs
[ESP_CFG1
] = 7;
487 static void esp_soft_reset(DeviceState
*d
)
489 ESPState
*s
= container_of(d
, ESPState
, busdev
.qdev
);
491 qemu_irq_lower(s
->irq
);
495 static void parent_esp_reset(void *opaque
, int irq
, int level
)
498 esp_soft_reset(opaque
);
502 static void esp_gpio_demux(void *opaque
, int irq
, int level
)
506 parent_esp_reset(opaque
, irq
, level
);
509 esp_dma_enable(opaque
, irq
, level
);
514 static uint32_t esp_mem_readb(void *opaque
, target_phys_addr_t addr
)
516 ESPState
*s
= opaque
;
517 uint32_t saddr
, old_val
;
519 saddr
= addr
>> s
->it_shift
;
520 DPRINTF("read reg[%d]: 0x%2.2x\n", saddr
, s
->rregs
[saddr
]);
523 if (s
->ti_size
> 0) {
525 if ((s
->rregs
[ESP_RSTAT
] & STAT_PIO_MASK
) == 0) {
527 ESP_ERROR("PIO data read not implemented\n");
528 s
->rregs
[ESP_FIFO
] = 0;
530 s
->rregs
[ESP_FIFO
] = s
->ti_buf
[s
->ti_rptr
++];
534 if (s
->ti_size
== 0) {
540 /* Clear sequence step, interrupt register and all status bits
542 old_val
= s
->rregs
[ESP_RINTR
];
543 s
->rregs
[ESP_RINTR
] = 0;
544 s
->rregs
[ESP_RSTAT
] &= ~STAT_TC
;
545 s
->rregs
[ESP_RSEQ
] = SEQ_CD
;
552 return s
->rregs
[saddr
];
555 static void esp_mem_writeb(void *opaque
, target_phys_addr_t addr
, uint32_t val
)
557 ESPState
*s
= opaque
;
560 saddr
= addr
>> s
->it_shift
;
561 DPRINTF("write reg[%d]: 0x%2.2x -> 0x%2.2x\n", saddr
, s
->wregs
[saddr
],
566 s
->rregs
[ESP_RSTAT
] &= ~STAT_TC
;
570 s
->cmdbuf
[s
->cmdlen
++] = val
& 0xff;
571 } else if (s
->ti_size
== TI_BUFSZ
- 1) {
572 ESP_ERROR("fifo overrun\n");
575 s
->ti_buf
[s
->ti_wptr
++] = val
& 0xff;
579 s
->rregs
[saddr
] = val
;
582 /* Reload DMA counter. */
583 s
->rregs
[ESP_TCLO
] = s
->wregs
[ESP_TCLO
];
584 s
->rregs
[ESP_TCMID
] = s
->wregs
[ESP_TCMID
];
588 switch(val
& CMD_CMD
) {
590 DPRINTF("NOP (%2.2x)\n", val
);
593 DPRINTF("Flush FIFO (%2.2x)\n", val
);
595 s
->rregs
[ESP_RINTR
] = INTR_FC
;
596 s
->rregs
[ESP_RSEQ
] = 0;
597 s
->rregs
[ESP_RFLAGS
] = 0;
600 DPRINTF("Chip reset (%2.2x)\n", val
);
601 esp_soft_reset(&s
->busdev
.qdev
);
604 DPRINTF("Bus reset (%2.2x)\n", val
);
605 s
->rregs
[ESP_RINTR
] = INTR_RST
;
606 if (!(s
->wregs
[ESP_CFG1
] & CFG1_RESREPT
)) {
614 DPRINTF("Initiator Command Complete Sequence (%2.2x)\n", val
);
616 s
->rregs
[ESP_RINTR
] = INTR_FC
;
617 s
->rregs
[ESP_RSTAT
] |= STAT_MI
;
620 DPRINTF("Message Accepted (%2.2x)\n", val
);
621 s
->rregs
[ESP_RINTR
] = INTR_DC
;
622 s
->rregs
[ESP_RSEQ
] = 0;
623 s
->rregs
[ESP_RFLAGS
] = 0;
627 DPRINTF("Transfer padding (%2.2x)\n", val
);
628 s
->rregs
[ESP_RSTAT
] = STAT_TC
;
629 s
->rregs
[ESP_RINTR
] = INTR_FC
;
630 s
->rregs
[ESP_RSEQ
] = 0;
633 DPRINTF("Set ATN (%2.2x)\n", val
);
636 DPRINTF("Select without ATN (%2.2x)\n", val
);
637 handle_s_without_atn(s
);
640 DPRINTF("Select with ATN (%2.2x)\n", val
);
644 DPRINTF("Select with ATN & stop (%2.2x)\n", val
);
648 DPRINTF("Enable selection (%2.2x)\n", val
);
649 s
->rregs
[ESP_RINTR
] = 0;
652 ESP_ERROR("Unhandled ESP command (%2.2x)\n", val
);
656 case ESP_WBUSID
... ESP_WSYNO
:
659 s
->rregs
[saddr
] = val
;
661 case ESP_WCCF
... ESP_WTEST
:
663 case ESP_CFG2
... ESP_RES4
:
664 s
->rregs
[saddr
] = val
;
667 ESP_ERROR("invalid write of 0x%02x at [0x%x]\n", val
, saddr
);
670 s
->wregs
[saddr
] = val
;
673 static CPUReadMemoryFunc
* const esp_mem_read
[3] = {
679 static CPUWriteMemoryFunc
* const esp_mem_write
[3] = {
685 static const VMStateDescription vmstate_esp
= {
688 .minimum_version_id
= 3,
689 .minimum_version_id_old
= 3,
690 .fields
= (VMStateField
[]) {
691 VMSTATE_BUFFER(rregs
, ESPState
),
692 VMSTATE_BUFFER(wregs
, ESPState
),
693 VMSTATE_INT32(ti_size
, ESPState
),
694 VMSTATE_UINT32(ti_rptr
, ESPState
),
695 VMSTATE_UINT32(ti_wptr
, ESPState
),
696 VMSTATE_BUFFER(ti_buf
, ESPState
),
697 VMSTATE_UINT32(status
, ESPState
),
698 VMSTATE_UINT32(dma
, ESPState
),
699 VMSTATE_BUFFER(cmdbuf
, ESPState
),
700 VMSTATE_UINT32(cmdlen
, ESPState
),
701 VMSTATE_UINT32(do_cmd
, ESPState
),
702 VMSTATE_UINT32(dma_left
, ESPState
),
703 VMSTATE_END_OF_LIST()
707 void esp_init(target_phys_addr_t espaddr
, int it_shift
,
708 ESPDMAMemoryReadWriteFunc dma_memory_read
,
709 ESPDMAMemoryReadWriteFunc dma_memory_write
,
710 void *dma_opaque
, qemu_irq irq
, qemu_irq
*reset
,
711 qemu_irq
*dma_enable
)
717 dev
= qdev_create(NULL
, "esp");
718 esp
= DO_UPCAST(ESPState
, busdev
.qdev
, dev
);
719 esp
->dma_memory_read
= dma_memory_read
;
720 esp
->dma_memory_write
= dma_memory_write
;
721 esp
->dma_opaque
= dma_opaque
;
722 esp
->it_shift
= it_shift
;
723 /* XXX for now until rc4030 has been changed to use DMA enable signal */
724 esp
->dma_enabled
= 1;
725 qdev_init_nofail(dev
);
726 s
= sysbus_from_qdev(dev
);
727 sysbus_connect_irq(s
, 0, irq
);
728 sysbus_mmio_map(s
, 0, espaddr
);
729 *reset
= qdev_get_gpio_in(dev
, 0);
730 *dma_enable
= qdev_get_gpio_in(dev
, 1);
733 static const struct SCSIBusOps esp_scsi_ops
= {
734 .transfer_data
= esp_transfer_data
,
735 .complete
= esp_command_complete
,
736 .cancel
= esp_request_cancelled
739 static int esp_init1(SysBusDevice
*dev
)
741 ESPState
*s
= FROM_SYSBUS(ESPState
, dev
);
744 sysbus_init_irq(dev
, &s
->irq
);
745 assert(s
->it_shift
!= -1);
747 esp_io_memory
= cpu_register_io_memory(esp_mem_read
, esp_mem_write
, s
,
748 DEVICE_NATIVE_ENDIAN
);
749 sysbus_init_mmio(dev
, ESP_REGS
<< s
->it_shift
, esp_io_memory
);
751 qdev_init_gpio_in(&dev
->qdev
, esp_gpio_demux
, 2);
753 scsi_bus_new(&s
->bus
, &dev
->qdev
, 0, ESP_MAX_DEVS
, &esp_scsi_ops
);
754 return scsi_bus_legacy_handle_cmdline(&s
->bus
);
757 static SysBusDeviceInfo esp_info
= {
760 .qdev
.size
= sizeof(ESPState
),
761 .qdev
.vmsd
= &vmstate_esp
,
762 .qdev
.reset
= esp_hard_reset
,
763 .qdev
.props
= (Property
[]) {
768 static void esp_register_devices(void)
770 sysbus_register_withprop(&esp_info
);
773 device_init(esp_register_devices
)