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"
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
40 static void esp_raise_irq(ESPState *s)
42 if (!(s->rregs[ESP_RSTAT] & STAT_INT)) {
43 s->rregs[ESP_RSTAT] |= STAT_INT;
44 qemu_irq_raise(s->irq);
45 trace_esp_raise_irq();
49 static void esp_lower_irq(ESPState *s)
51 if (s->rregs[ESP_RSTAT] & STAT_INT) {
52 s->rregs[ESP_RSTAT] &= ~STAT_INT;
53 qemu_irq_lower(s->irq);
54 trace_esp_lower_irq();
58 void esp_dma_enable(ESPState *s, int irq, int level)
62 trace_esp_dma_enable();
68 trace_esp_dma_disable();
73 void esp_request_cancelled(SCSIRequest *req)
75 ESPState *s = req->hba_private;
77 if (req == s->current_req) {
78 scsi_req_unref(s->current_req);
79 s->current_req = NULL;
80 s->current_dev = NULL;
84 static uint32_t get_cmd(ESPState *s, uint8_t *buf, uint8_t buflen)
89 target = s->wregs[ESP_WBUSID] & BUSID_DID;
91 dmalen = s->rregs[ESP_TCLO];
92 dmalen |= s->rregs[ESP_TCMID] << 8;
93 dmalen |= s->rregs[ESP_TCHI] << 16;
94 if (dmalen > buflen) {
97 s->dma_memory_read(s->dma_opaque, buf, dmalen);
100 if (dmalen > TI_BUFSZ) {
103 memcpy(buf, s->ti_buf, dmalen);
104 buf[0] = buf[2] >> 5;
106 trace_esp_get_cmd(dmalen, target);
112 if (s->current_req) {
113 /* Started a new command before the old one finished. Cancel it. */
114 scsi_req_cancel(s->current_req);
118 s->current_dev = scsi_device_find(&s->bus, 0, target, 0);
119 if (!s->current_dev) {
121 s->rregs[ESP_RSTAT] = 0;
122 s->rregs[ESP_RINTR] = INTR_DC;
123 s->rregs[ESP_RSEQ] = SEQ_0;
130 static void do_busid_cmd(ESPState *s, uint8_t *buf, uint8_t busid)
134 SCSIDevice *current_lun;
136 trace_esp_do_busid_cmd(busid);
138 current_lun = scsi_device_find(&s->bus, 0, s->current_dev->id, lun);
139 s->current_req = scsi_req_new(current_lun, 0, lun, buf, s);
140 datalen = scsi_req_enqueue(s->current_req);
141 s->ti_size = datalen;
143 s->rregs[ESP_RSTAT] = STAT_TC;
147 s->rregs[ESP_RSTAT] |= STAT_DI;
149 s->rregs[ESP_RSTAT] |= STAT_DO;
151 scsi_req_continue(s->current_req);
153 s->rregs[ESP_RINTR] = INTR_BS | INTR_FC;
154 s->rregs[ESP_RSEQ] = SEQ_CD;
158 static void do_cmd(ESPState *s, uint8_t *buf)
160 uint8_t busid = buf[0];
162 do_busid_cmd(s, &buf[1], busid);
165 static void handle_satn(ESPState *s)
170 if (s->dma && !s->dma_enabled) {
171 s->dma_cb = handle_satn;
174 len = get_cmd(s, buf, sizeof(buf));
179 static void handle_s_without_atn(ESPState *s)
184 if (s->dma && !s->dma_enabled) {
185 s->dma_cb = handle_s_without_atn;
188 len = get_cmd(s, buf, sizeof(buf));
190 do_busid_cmd(s, buf, 0);
194 static void handle_satn_stop(ESPState *s)
196 if (s->dma && !s->dma_enabled) {
197 s->dma_cb = handle_satn_stop;
200 s->cmdlen = get_cmd(s, s->cmdbuf, sizeof(s->cmdbuf));
202 trace_esp_handle_satn_stop(s->cmdlen);
204 s->rregs[ESP_RSTAT] = STAT_TC | STAT_CD;
205 s->rregs[ESP_RINTR] = INTR_BS | INTR_FC;
206 s->rregs[ESP_RSEQ] = SEQ_CD;
211 static void write_response(ESPState *s)
213 trace_esp_write_response(s->status);
214 s->ti_buf[0] = s->status;
217 s->dma_memory_write(s->dma_opaque, s->ti_buf, 2);
218 s->rregs[ESP_RSTAT] = STAT_TC | STAT_ST;
219 s->rregs[ESP_RINTR] = INTR_BS | INTR_FC;
220 s->rregs[ESP_RSEQ] = SEQ_CD;
225 s->rregs[ESP_RFLAGS] = 2;
230 static void esp_dma_done(ESPState *s)
232 s->rregs[ESP_RSTAT] |= STAT_TC;
233 s->rregs[ESP_RINTR] = INTR_BS;
234 s->rregs[ESP_RSEQ] = 0;
235 s->rregs[ESP_RFLAGS] = 0;
236 s->rregs[ESP_TCLO] = 0;
237 s->rregs[ESP_TCMID] = 0;
238 s->rregs[ESP_TCHI] = 0;
242 static void esp_do_dma(ESPState *s)
249 trace_esp_do_dma(s->cmdlen, len);
250 assert (s->cmdlen <= sizeof(s->cmdbuf) &&
251 len <= sizeof(s->cmdbuf) - s->cmdlen);
252 s->dma_memory_read(s->dma_opaque, &s->cmdbuf[s->cmdlen], len);
255 if (s->async_len == 0) {
256 /* Defer until data is available. */
259 if (len > s->async_len) {
262 to_device = (s->ti_size < 0);
264 s->dma_memory_read(s->dma_opaque, s->async_buf, len);
266 s->dma_memory_write(s->dma_opaque, s->async_buf, len);
275 if (s->async_len == 0) {
276 scsi_req_continue(s->current_req);
277 /* If there is still data to be read from the device then
278 complete the DMA operation immediately. Otherwise defer
279 until the scsi layer has completed. */
280 if (to_device || s->dma_left != 0 || s->ti_size == 0) {
285 /* Partially filled a scsi buffer. Complete immediately. */
289 void esp_command_complete(SCSIRequest *req, uint32_t status,
292 ESPState *s = req->hba_private;
294 trace_esp_command_complete();
295 if (s->ti_size != 0) {
296 trace_esp_command_complete_unexpected();
302 trace_esp_command_complete_fail();
305 s->rregs[ESP_RSTAT] = STAT_ST;
307 if (s->current_req) {
308 scsi_req_unref(s->current_req);
309 s->current_req = NULL;
310 s->current_dev = NULL;
314 void esp_transfer_data(SCSIRequest *req, uint32_t len)
316 ESPState *s = req->hba_private;
319 trace_esp_transfer_data(s->dma_left, s->ti_size);
321 s->async_buf = scsi_req_get_buf(req);
324 } else if (s->dma_counter != 0 && s->ti_size <= 0) {
325 /* If this was the last part of a DMA transfer then the
326 completion interrupt is deferred to here. */
331 static void handle_ti(ESPState *s)
333 uint32_t dmalen, minlen;
335 if (s->dma && !s->dma_enabled) {
336 s->dma_cb = handle_ti;
340 dmalen = s->rregs[ESP_TCLO];
341 dmalen |= s->rregs[ESP_TCMID] << 8;
342 dmalen |= s->rregs[ESP_TCHI] << 16;
346 s->dma_counter = dmalen;
349 minlen = (dmalen < ESP_CMDBUF_SZ) ? dmalen : ESP_CMDBUF_SZ;
350 else if (s->ti_size < 0)
351 minlen = (dmalen < -s->ti_size) ? dmalen : -s->ti_size;
353 minlen = (dmalen < s->ti_size) ? dmalen : s->ti_size;
354 trace_esp_handle_ti(minlen);
356 s->dma_left = minlen;
357 s->rregs[ESP_RSTAT] &= ~STAT_TC;
361 trace_esp_handle_ti_cmd(s->cmdlen);
365 do_cmd(s, s->cmdbuf);
369 void esp_hard_reset(ESPState *s)
371 memset(s->rregs, 0, ESP_REGS);
372 memset(s->wregs, 0, ESP_REGS);
381 s->rregs[ESP_CFG1] = 7;
384 static void esp_soft_reset(ESPState *s)
386 qemu_irq_lower(s->irq);
390 static void parent_esp_reset(ESPState *s, int irq, int level)
397 uint64_t esp_reg_read(ESPState *s, uint32_t saddr)
401 trace_esp_mem_readb(saddr, s->rregs[saddr]);
404 if ((s->rregs[ESP_RSTAT] & STAT_PIO_MASK) == 0) {
406 qemu_log_mask(LOG_UNIMP, "esp: PIO data read not implemented\n");
407 s->rregs[ESP_FIFO] = 0;
408 } else if (s->ti_rptr < s->ti_wptr) {
410 s->rregs[ESP_FIFO] = s->ti_buf[s->ti_rptr++];
412 if (s->ti_rptr == s->ti_wptr) {
418 /* Clear sequence step, interrupt register and all status bits
420 old_val = s->rregs[ESP_RINTR];
421 s->rregs[ESP_RINTR] = 0;
422 s->rregs[ESP_RSTAT] &= ~STAT_TC;
423 s->rregs[ESP_RSEQ] = SEQ_CD;
428 /* Return the unique id if the value has never been written */
429 if (!s->tchi_written) {
435 return s->rregs[saddr];
438 void esp_reg_write(ESPState *s, uint32_t saddr, uint64_t val)
440 trace_esp_mem_writeb(saddr, s->wregs[saddr], val);
443 s->tchi_written = true;
447 s->rregs[ESP_RSTAT] &= ~STAT_TC;
451 if (s->cmdlen < ESP_CMDBUF_SZ) {
452 s->cmdbuf[s->cmdlen++] = val & 0xff;
454 trace_esp_error_fifo_overrun();
456 } else if (s->ti_wptr == TI_BUFSZ - 1) {
457 trace_esp_error_fifo_overrun();
460 s->ti_buf[s->ti_wptr++] = val & 0xff;
464 s->rregs[saddr] = val;
467 /* Reload DMA counter. */
468 s->rregs[ESP_TCLO] = s->wregs[ESP_TCLO];
469 s->rregs[ESP_TCMID] = s->wregs[ESP_TCMID];
470 s->rregs[ESP_TCHI] = s->wregs[ESP_TCHI];
474 switch(val & CMD_CMD) {
476 trace_esp_mem_writeb_cmd_nop(val);
479 trace_esp_mem_writeb_cmd_flush(val);
481 s->rregs[ESP_RINTR] = INTR_FC;
482 s->rregs[ESP_RSEQ] = 0;
483 s->rregs[ESP_RFLAGS] = 0;
486 trace_esp_mem_writeb_cmd_reset(val);
490 trace_esp_mem_writeb_cmd_bus_reset(val);
491 s->rregs[ESP_RINTR] = INTR_RST;
492 if (!(s->wregs[ESP_CFG1] & CFG1_RESREPT)) {
500 trace_esp_mem_writeb_cmd_iccs(val);
502 s->rregs[ESP_RINTR] = INTR_FC;
503 s->rregs[ESP_RSTAT] |= STAT_MI;
506 trace_esp_mem_writeb_cmd_msgacc(val);
507 s->rregs[ESP_RINTR] = INTR_DC;
508 s->rregs[ESP_RSEQ] = 0;
509 s->rregs[ESP_RFLAGS] = 0;
513 trace_esp_mem_writeb_cmd_pad(val);
514 s->rregs[ESP_RSTAT] = STAT_TC;
515 s->rregs[ESP_RINTR] = INTR_FC;
516 s->rregs[ESP_RSEQ] = 0;
519 trace_esp_mem_writeb_cmd_satn(val);
522 trace_esp_mem_writeb_cmd_rstatn(val);
525 trace_esp_mem_writeb_cmd_sel(val);
526 handle_s_without_atn(s);
529 trace_esp_mem_writeb_cmd_selatn(val);
533 trace_esp_mem_writeb_cmd_selatns(val);
537 trace_esp_mem_writeb_cmd_ensel(val);
538 s->rregs[ESP_RINTR] = 0;
541 trace_esp_mem_writeb_cmd_dissel(val);
542 s->rregs[ESP_RINTR] = 0;
546 trace_esp_error_unhandled_command(val);
550 case ESP_WBUSID ... ESP_WSYNO:
553 case ESP_CFG2: case ESP_CFG3:
554 case ESP_RES3: case ESP_RES4:
555 s->rregs[saddr] = val;
557 case ESP_WCCF ... ESP_WTEST:
560 trace_esp_error_invalid_write(val, saddr);
563 s->wregs[saddr] = val;
566 static bool esp_mem_accepts(void *opaque, hwaddr addr,
567 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 static void sysbus_esp_mem_write(void *opaque, hwaddr addr,
596 uint64_t val, unsigned int size)
598 SysBusESPState *sysbus = opaque;
601 saddr = addr >> sysbus->it_shift;
602 esp_reg_write(&sysbus->esp, saddr, val);
605 static uint64_t sysbus_esp_mem_read(void *opaque, hwaddr addr,
608 SysBusESPState *sysbus = opaque;
611 saddr = addr >> sysbus->it_shift;
612 return esp_reg_read(&sysbus->esp, saddr);
615 static const MemoryRegionOps sysbus_esp_mem_ops = {
616 .read = sysbus_esp_mem_read,
617 .write = sysbus_esp_mem_write,
618 .endianness = DEVICE_NATIVE_ENDIAN,
619 .valid.accepts = esp_mem_accepts,
622 static const struct SCSIBusInfo esp_scsi_info = {
624 .max_target = ESP_MAX_DEVS,
627 .transfer_data = esp_transfer_data,
628 .complete = esp_command_complete,
629 .cancel = esp_request_cancelled
632 static void sysbus_esp_gpio_demux(void *opaque, int irq, int level)
634 SysBusESPState *sysbus = ESP_STATE(opaque);
635 ESPState *s = &sysbus->esp;
639 parent_esp_reset(s, irq, level);
642 esp_dma_enable(opaque, irq, level);
647 static void sysbus_esp_realize(DeviceState *dev, Error **errp)
649 SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
650 SysBusESPState *sysbus = ESP_STATE(dev);
651 ESPState *s = &sysbus->esp;
653 sysbus_init_irq(sbd, &s->irq);
654 assert(sysbus->it_shift != -1);
656 s->chip_id = TCHI_FAS100A;
657 memory_region_init_io(&sysbus->iomem, OBJECT(sysbus), &sysbus_esp_mem_ops,
658 sysbus, "esp", ESP_REGS << sysbus->it_shift);
659 sysbus_init_mmio(sbd, &sysbus->iomem);
661 qdev_init_gpio_in(dev, sysbus_esp_gpio_demux, 2);
663 scsi_bus_new(&s->bus, sizeof(s->bus), dev, &esp_scsi_info, NULL);
666 static void sysbus_esp_hard_reset(DeviceState *dev)
668 SysBusESPState *sysbus = ESP_STATE(dev);
669 esp_hard_reset(&sysbus->esp);
672 static const VMStateDescription vmstate_sysbus_esp_scsi = {
673 .name = "sysbusespscsi",
675 .minimum_version_id = 0,
676 .fields = (VMStateField[]) {
677 VMSTATE_STRUCT(esp, SysBusESPState, 0, vmstate_esp, ESPState),
678 VMSTATE_END_OF_LIST()
682 static void sysbus_esp_class_init(ObjectClass *klass, void *data)
684 DeviceClass *dc = DEVICE_CLASS(klass);
686 dc->realize = sysbus_esp_realize;
687 dc->reset = sysbus_esp_hard_reset;
688 dc->vmsd = &vmstate_sysbus_esp_scsi;
689 set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
692 static const TypeInfo sysbus_esp_info = {
694 .parent = TYPE_SYS_BUS_DEVICE,
695 .instance_size = sizeof(SysBusESPState),
696 .class_init = sysbus_esp_class_init,
699 static void esp_register_types(void)
701 type_register_static(&sysbus_esp_info);
704 type_init(esp_register_types)