2 * QEMU ESP/NCR53C9x emulation
4 * Copyright (c) 2005-2006 Fabrice Bellard
5 * Copyright (c) 2012 Herve Poussineau
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 "hw/sysbus.h"
28 #include "hw/scsi/esp.h"
30 #include "qapi/error.h"
34 * On Sparc32, this is the ESP (NCR53C90) part of chip STP2000 (Master I/O),
35 * also produced as NCR89C100. See
36 * http://www.ibiblio.org/pub/historic-linux/early-ports/Sparc/NCR/NCR89C100.txt
38 * http://www.ibiblio.org/pub/historic-linux/early-ports/Sparc/NCR/NCR53C9X.txt
41 static void esp_raise_irq(ESPState *s)
43 if (!(s->rregs[ESP_RSTAT] & STAT_INT)) {
44 s->rregs[ESP_RSTAT] |= STAT_INT;
45 qemu_irq_raise(s->irq);
46 trace_esp_raise_irq();
50 static void esp_lower_irq(ESPState *s)
52 if (s->rregs[ESP_RSTAT] & STAT_INT) {
53 s->rregs[ESP_RSTAT] &= ~STAT_INT;
54 qemu_irq_lower(s->irq);
55 trace_esp_lower_irq();
59 void esp_dma_enable(ESPState *s, int irq, int level)
63 trace_esp_dma_enable();
69 trace_esp_dma_disable();
74 void esp_request_cancelled(SCSIRequest *req)
76 ESPState *s = req->hba_private;
78 if (req == s->current_req) {
79 scsi_req_unref(s->current_req);
80 s->current_req = NULL;
81 s->current_dev = NULL;
85 static uint32_t get_cmd(ESPState *s, uint8_t *buf, uint8_t buflen)
90 target = s->wregs[ESP_WBUSID] & BUSID_DID;
92 dmalen = s->rregs[ESP_TCLO];
93 dmalen |= s->rregs[ESP_TCMID] << 8;
94 dmalen |= s->rregs[ESP_TCHI] << 16;
95 if (dmalen > buflen) {
98 s->dma_memory_read(s->dma_opaque, buf, dmalen);
101 if (dmalen > TI_BUFSZ) {
104 memcpy(buf, s->ti_buf, dmalen);
105 buf[0] = buf[2] >> 5;
107 trace_esp_get_cmd(dmalen, target);
113 if (s->current_req) {
114 /* Started a new command before the old one finished. Cancel it. */
115 scsi_req_cancel(s->current_req);
119 s->current_dev = scsi_device_find(&s->bus, 0, target, 0);
120 if (!s->current_dev) {
122 s->rregs[ESP_RSTAT] = 0;
123 s->rregs[ESP_RINTR] = INTR_DC;
124 s->rregs[ESP_RSEQ] = SEQ_0;
131 static void do_busid_cmd(ESPState *s, uint8_t *buf, uint8_t busid)
135 SCSIDevice *current_lun;
137 trace_esp_do_busid_cmd(busid);
139 current_lun = scsi_device_find(&s->bus, 0, s->current_dev->id, lun);
140 s->current_req = scsi_req_new(current_lun, 0, lun, buf, s);
141 datalen = scsi_req_enqueue(s->current_req);
142 s->ti_size = datalen;
144 s->rregs[ESP_RSTAT] = STAT_TC;
148 s->rregs[ESP_RSTAT] |= STAT_DI;
150 s->rregs[ESP_RSTAT] |= STAT_DO;
152 scsi_req_continue(s->current_req);
154 s->rregs[ESP_RINTR] = INTR_BS | INTR_FC;
155 s->rregs[ESP_RSEQ] = SEQ_CD;
159 static void do_cmd(ESPState *s, uint8_t *buf)
161 uint8_t busid = buf[0];
163 do_busid_cmd(s, &buf[1], busid);
166 static void handle_satn(ESPState *s)
171 if (s->dma && !s->dma_enabled) {
172 s->dma_cb = handle_satn;
175 len = get_cmd(s, buf, sizeof(buf));
180 static void handle_s_without_atn(ESPState *s)
185 if (s->dma && !s->dma_enabled) {
186 s->dma_cb = handle_s_without_atn;
189 len = get_cmd(s, buf, sizeof(buf));
191 do_busid_cmd(s, buf, 0);
195 static void handle_satn_stop(ESPState *s)
197 if (s->dma && !s->dma_enabled) {
198 s->dma_cb = handle_satn_stop;
201 s->cmdlen = get_cmd(s, s->cmdbuf, sizeof(s->cmdbuf));
203 trace_esp_handle_satn_stop(s->cmdlen);
205 s->rregs[ESP_RSTAT] = STAT_TC | STAT_CD;
206 s->rregs[ESP_RINTR] = INTR_BS | INTR_FC;
207 s->rregs[ESP_RSEQ] = SEQ_CD;
212 static void write_response(ESPState *s)
214 trace_esp_write_response(s->status);
215 s->ti_buf[0] = s->status;
218 s->dma_memory_write(s->dma_opaque, s->ti_buf, 2);
219 s->rregs[ESP_RSTAT] = STAT_TC | STAT_ST;
220 s->rregs[ESP_RINTR] = INTR_BS | INTR_FC;
221 s->rregs[ESP_RSEQ] = SEQ_CD;
226 s->rregs[ESP_RFLAGS] = 2;
231 static void esp_dma_done(ESPState *s)
233 s->rregs[ESP_RSTAT] |= STAT_TC;
234 s->rregs[ESP_RINTR] = INTR_BS;
235 s->rregs[ESP_RSEQ] = 0;
236 s->rregs[ESP_RFLAGS] = 0;
237 s->rregs[ESP_TCLO] = 0;
238 s->rregs[ESP_TCMID] = 0;
239 s->rregs[ESP_TCHI] = 0;
243 static void esp_do_dma(ESPState *s)
250 trace_esp_do_dma(s->cmdlen, len);
251 assert (s->cmdlen <= sizeof(s->cmdbuf) &&
252 len <= sizeof(s->cmdbuf) - s->cmdlen);
253 s->dma_memory_read(s->dma_opaque, &s->cmdbuf[s->cmdlen], len);
256 if (s->async_len == 0) {
257 /* Defer until data is available. */
260 if (len > s->async_len) {
263 to_device = (s->ti_size < 0);
265 s->dma_memory_read(s->dma_opaque, s->async_buf, len);
267 s->dma_memory_write(s->dma_opaque, s->async_buf, len);
276 if (s->async_len == 0) {
277 scsi_req_continue(s->current_req);
278 /* If there is still data to be read from the device then
279 complete the DMA operation immediately. Otherwise defer
280 until the scsi layer has completed. */
281 if (to_device || s->dma_left != 0 || s->ti_size == 0) {
286 /* Partially filled a scsi buffer. Complete immediately. */
290 void esp_command_complete(SCSIRequest *req, uint32_t status,
293 ESPState *s = req->hba_private;
295 trace_esp_command_complete();
296 if (s->ti_size != 0) {
297 trace_esp_command_complete_unexpected();
303 trace_esp_command_complete_fail();
306 s->rregs[ESP_RSTAT] = STAT_ST;
308 if (s->current_req) {
309 scsi_req_unref(s->current_req);
310 s->current_req = NULL;
311 s->current_dev = NULL;
315 void esp_transfer_data(SCSIRequest *req, uint32_t len)
317 ESPState *s = req->hba_private;
320 trace_esp_transfer_data(s->dma_left, s->ti_size);
322 s->async_buf = scsi_req_get_buf(req);
325 } else if (s->dma_counter != 0 && s->ti_size <= 0) {
326 /* If this was the last part of a DMA transfer then the
327 completion interrupt is deferred to here. */
332 static void handle_ti(ESPState *s)
334 uint32_t dmalen, minlen;
336 if (s->dma && !s->dma_enabled) {
337 s->dma_cb = handle_ti;
341 dmalen = s->rregs[ESP_TCLO];
342 dmalen |= s->rregs[ESP_TCMID] << 8;
343 dmalen |= s->rregs[ESP_TCHI] << 16;
347 s->dma_counter = dmalen;
350 minlen = (dmalen < ESP_CMDBUF_SZ) ? dmalen : ESP_CMDBUF_SZ;
351 else if (s->ti_size < 0)
352 minlen = (dmalen < -s->ti_size) ? dmalen : -s->ti_size;
354 minlen = (dmalen < s->ti_size) ? dmalen : s->ti_size;
355 trace_esp_handle_ti(minlen);
357 s->dma_left = minlen;
358 s->rregs[ESP_RSTAT] &= ~STAT_TC;
362 trace_esp_handle_ti_cmd(s->cmdlen);
366 do_cmd(s, s->cmdbuf);
370 void esp_hard_reset(ESPState *s)
372 memset(s->rregs, 0, ESP_REGS);
373 memset(s->wregs, 0, ESP_REGS);
382 s->rregs[ESP_CFG1] = 7;
385 static void esp_soft_reset(ESPState *s)
387 qemu_irq_lower(s->irq);
391 static void parent_esp_reset(ESPState *s, int irq, int level)
398 uint64_t esp_reg_read(ESPState *s, uint32_t saddr)
402 trace_esp_mem_readb(saddr, s->rregs[saddr]);
405 if ((s->rregs[ESP_RSTAT] & STAT_PIO_MASK) == 0) {
407 qemu_log_mask(LOG_UNIMP, "esp: PIO data read not implemented\n");
408 s->rregs[ESP_FIFO] = 0;
409 } else if (s->ti_rptr < s->ti_wptr) {
411 s->rregs[ESP_FIFO] = s->ti_buf[s->ti_rptr++];
413 if (s->ti_rptr == s->ti_wptr) {
419 /* Clear sequence step, interrupt register and all status bits
421 old_val = s->rregs[ESP_RINTR];
422 s->rregs[ESP_RINTR] = 0;
423 s->rregs[ESP_RSTAT] &= ~STAT_TC;
424 s->rregs[ESP_RSEQ] = SEQ_CD;
429 /* Return the unique id if the value has never been written */
430 if (!s->tchi_written) {
436 return s->rregs[saddr];
439 void esp_reg_write(ESPState *s, uint32_t saddr, uint64_t val)
441 trace_esp_mem_writeb(saddr, s->wregs[saddr], val);
444 s->tchi_written = true;
448 s->rregs[ESP_RSTAT] &= ~STAT_TC;
452 if (s->cmdlen < ESP_CMDBUF_SZ) {
453 s->cmdbuf[s->cmdlen++] = val & 0xff;
455 trace_esp_error_fifo_overrun();
457 } else if (s->ti_wptr == TI_BUFSZ - 1) {
458 trace_esp_error_fifo_overrun();
461 s->ti_buf[s->ti_wptr++] = val & 0xff;
465 s->rregs[saddr] = val;
468 /* Reload DMA counter. */
469 s->rregs[ESP_TCLO] = s->wregs[ESP_TCLO];
470 s->rregs[ESP_TCMID] = s->wregs[ESP_TCMID];
471 s->rregs[ESP_TCHI] = s->wregs[ESP_TCHI];
475 switch(val & CMD_CMD) {
477 trace_esp_mem_writeb_cmd_nop(val);
480 trace_esp_mem_writeb_cmd_flush(val);
482 s->rregs[ESP_RINTR] = INTR_FC;
483 s->rregs[ESP_RSEQ] = 0;
484 s->rregs[ESP_RFLAGS] = 0;
487 trace_esp_mem_writeb_cmd_reset(val);
491 trace_esp_mem_writeb_cmd_bus_reset(val);
492 s->rregs[ESP_RINTR] = INTR_RST;
493 if (!(s->wregs[ESP_CFG1] & CFG1_RESREPT)) {
501 trace_esp_mem_writeb_cmd_iccs(val);
503 s->rregs[ESP_RINTR] = INTR_FC;
504 s->rregs[ESP_RSTAT] |= STAT_MI;
507 trace_esp_mem_writeb_cmd_msgacc(val);
508 s->rregs[ESP_RINTR] = INTR_DC;
509 s->rregs[ESP_RSEQ] = 0;
510 s->rregs[ESP_RFLAGS] = 0;
514 trace_esp_mem_writeb_cmd_pad(val);
515 s->rregs[ESP_RSTAT] = STAT_TC;
516 s->rregs[ESP_RINTR] = INTR_FC;
517 s->rregs[ESP_RSEQ] = 0;
520 trace_esp_mem_writeb_cmd_satn(val);
523 trace_esp_mem_writeb_cmd_rstatn(val);
526 trace_esp_mem_writeb_cmd_sel(val);
527 handle_s_without_atn(s);
530 trace_esp_mem_writeb_cmd_selatn(val);
534 trace_esp_mem_writeb_cmd_selatns(val);
538 trace_esp_mem_writeb_cmd_ensel(val);
539 s->rregs[ESP_RINTR] = 0;
542 trace_esp_mem_writeb_cmd_dissel(val);
543 s->rregs[ESP_RINTR] = 0;
547 trace_esp_error_unhandled_command(val);
551 case ESP_WBUSID ... ESP_WSYNO:
554 case ESP_CFG2: case ESP_CFG3:
555 case ESP_RES3: case ESP_RES4:
556 s->rregs[saddr] = val;
558 case ESP_WCCF ... ESP_WTEST:
561 trace_esp_error_invalid_write(val, saddr);
564 s->wregs[saddr] = val;
567 static bool esp_mem_accepts(void *opaque, hwaddr addr,
568 unsigned size, bool is_write)
570 return (size == 1) || (is_write && size == 4);
573 const VMStateDescription vmstate_esp = {
576 .minimum_version_id = 3,
577 .fields = (VMStateField[]) {
578 VMSTATE_BUFFER(rregs, ESPState),
579 VMSTATE_BUFFER(wregs, ESPState),
580 VMSTATE_INT32(ti_size, ESPState),
581 VMSTATE_UINT32(ti_rptr, ESPState),
582 VMSTATE_UINT32(ti_wptr, ESPState),
583 VMSTATE_BUFFER(ti_buf, ESPState),
584 VMSTATE_UINT32(status, ESPState),
585 VMSTATE_UINT32(dma, ESPState),
586 VMSTATE_PARTIAL_BUFFER(cmdbuf, ESPState, 16),
587 VMSTATE_BUFFER_START_MIDDLE_V(cmdbuf, ESPState, 16, 4),
588 VMSTATE_UINT32(cmdlen, ESPState),
589 VMSTATE_UINT32(do_cmd, ESPState),
590 VMSTATE_UINT32(dma_left, ESPState),
591 VMSTATE_END_OF_LIST()
595 #define TYPE_ESP "esp"
596 #define ESP(obj) OBJECT_CHECK(SysBusESPState, (obj), TYPE_ESP)
600 SysBusDevice parent_obj;
608 static void sysbus_esp_mem_write(void *opaque, hwaddr addr,
609 uint64_t val, unsigned int size)
611 SysBusESPState *sysbus = opaque;
614 saddr = addr >> sysbus->it_shift;
615 esp_reg_write(&sysbus->esp, saddr, val);
618 static uint64_t sysbus_esp_mem_read(void *opaque, hwaddr addr,
621 SysBusESPState *sysbus = opaque;
624 saddr = addr >> sysbus->it_shift;
625 return esp_reg_read(&sysbus->esp, saddr);
628 static const MemoryRegionOps sysbus_esp_mem_ops = {
629 .read = sysbus_esp_mem_read,
630 .write = sysbus_esp_mem_write,
631 .endianness = DEVICE_NATIVE_ENDIAN,
632 .valid.accepts = esp_mem_accepts,
635 void esp_init(hwaddr espaddr, int it_shift,
636 ESPDMAMemoryReadWriteFunc dma_memory_read,
637 ESPDMAMemoryReadWriteFunc dma_memory_write,
638 void *dma_opaque, qemu_irq irq, qemu_irq *reset,
639 qemu_irq *dma_enable)
643 SysBusESPState *sysbus;
646 dev = qdev_create(NULL, TYPE_ESP);
649 esp->dma_memory_read = dma_memory_read;
650 esp->dma_memory_write = dma_memory_write;
651 esp->dma_opaque = dma_opaque;
652 sysbus->it_shift = it_shift;
653 /* XXX for now until rc4030 has been changed to use DMA enable signal */
654 esp->dma_enabled = 1;
655 qdev_init_nofail(dev);
656 s = SYS_BUS_DEVICE(dev);
657 sysbus_connect_irq(s, 0, irq);
658 sysbus_mmio_map(s, 0, espaddr);
659 *reset = qdev_get_gpio_in(dev, 0);
660 *dma_enable = qdev_get_gpio_in(dev, 1);
663 static const struct SCSIBusInfo esp_scsi_info = {
665 .max_target = ESP_MAX_DEVS,
668 .transfer_data = esp_transfer_data,
669 .complete = esp_command_complete,
670 .cancel = esp_request_cancelled
673 static void sysbus_esp_gpio_demux(void *opaque, int irq, int level)
675 SysBusESPState *sysbus = ESP(opaque);
676 ESPState *s = &sysbus->esp;
680 parent_esp_reset(s, irq, level);
683 esp_dma_enable(opaque, irq, level);
688 static void sysbus_esp_realize(DeviceState *dev, Error **errp)
690 SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
691 SysBusESPState *sysbus = ESP(dev);
692 ESPState *s = &sysbus->esp;
695 sysbus_init_irq(sbd, &s->irq);
696 assert(sysbus->it_shift != -1);
698 s->chip_id = TCHI_FAS100A;
699 memory_region_init_io(&sysbus->iomem, OBJECT(sysbus), &sysbus_esp_mem_ops,
700 sysbus, "esp", ESP_REGS << sysbus->it_shift);
701 sysbus_init_mmio(sbd, &sysbus->iomem);
703 qdev_init_gpio_in(dev, sysbus_esp_gpio_demux, 2);
705 scsi_bus_new(&s->bus, sizeof(s->bus), dev, &esp_scsi_info, NULL);
706 scsi_bus_legacy_handle_cmdline(&s->bus, &err);
708 error_propagate(errp, err);
713 static void sysbus_esp_hard_reset(DeviceState *dev)
715 SysBusESPState *sysbus = ESP(dev);
716 esp_hard_reset(&sysbus->esp);
719 static const VMStateDescription vmstate_sysbus_esp_scsi = {
720 .name = "sysbusespscsi",
722 .minimum_version_id = 0,
723 .fields = (VMStateField[]) {
724 VMSTATE_STRUCT(esp, SysBusESPState, 0, vmstate_esp, ESPState),
725 VMSTATE_END_OF_LIST()
729 static void sysbus_esp_class_init(ObjectClass *klass, void *data)
731 DeviceClass *dc = DEVICE_CLASS(klass);
733 dc->realize = sysbus_esp_realize;
734 dc->reset = sysbus_esp_hard_reset;
735 dc->vmsd = &vmstate_sysbus_esp_scsi;
736 set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
739 static const TypeInfo sysbus_esp_info = {
741 .parent = TYPE_SYS_BUS_DEVICE,
742 .instance_size = sizeof(SysBusESPState),
743 .class_init = sysbus_esp_class_init,
746 static void esp_register_types(void)
748 type_register_static(&sysbus_esp_info);
751 type_init(esp_register_types)