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
)
248 to_device
= (s
->ti_size
< 0);
251 trace_esp_do_dma(s
->cmdlen
, len
);
252 s
->dma_memory_read(s
->dma_opaque
, &s
->cmdbuf
[s
->cmdlen
], len
);
256 do_cmd(s
, s
->cmdbuf
);
259 if (s
->async_len
== 0) {
260 /* Defer until data is available. */
263 if (len
> s
->async_len
) {
267 s
->dma_memory_read(s
->dma_opaque
, s
->async_buf
, len
);
269 s
->dma_memory_write(s
->dma_opaque
, s
->async_buf
, len
);
278 if (s
->async_len
== 0) {
279 scsi_req_continue(s
->current_req
);
280 /* If there is still data to be read from the device then
281 complete the DMA operation immediately. Otherwise defer
282 until the scsi layer has completed. */
283 if (to_device
|| s
->dma_left
!= 0 || s
->ti_size
== 0) {
288 /* Partially filled a scsi buffer. Complete immediately. */
292 void esp_command_complete(SCSIRequest
*req
, uint32_t status
,
295 ESPState
*s
= req
->hba_private
;
297 trace_esp_command_complete();
298 if (s
->ti_size
!= 0) {
299 trace_esp_command_complete_unexpected();
305 trace_esp_command_complete_fail();
308 s
->rregs
[ESP_RSTAT
] = STAT_ST
;
310 if (s
->current_req
) {
311 scsi_req_unref(s
->current_req
);
312 s
->current_req
= NULL
;
313 s
->current_dev
= NULL
;
317 void esp_transfer_data(SCSIRequest
*req
, uint32_t len
)
319 ESPState
*s
= req
->hba_private
;
321 trace_esp_transfer_data(s
->dma_left
, s
->ti_size
);
323 s
->async_buf
= scsi_req_get_buf(req
);
326 } else if (s
->dma_counter
!= 0 && s
->ti_size
<= 0) {
327 /* If this was the last part of a DMA transfer then the
328 completion interrupt is deferred to here. */
333 static void handle_ti(ESPState
*s
)
335 uint32_t dmalen
, minlen
;
337 if (s
->dma
&& !s
->dma_enabled
) {
338 s
->dma_cb
= handle_ti
;
342 dmalen
= s
->rregs
[ESP_TCLO
];
343 dmalen
|= s
->rregs
[ESP_TCMID
] << 8;
344 dmalen
|= s
->rregs
[ESP_TCHI
] << 16;
348 s
->dma_counter
= dmalen
;
351 minlen
= (dmalen
< 32) ? dmalen
: 32;
352 else if (s
->ti_size
< 0)
353 minlen
= (dmalen
< -s
->ti_size
) ? dmalen
: -s
->ti_size
;
355 minlen
= (dmalen
< s
->ti_size
) ? dmalen
: s
->ti_size
;
356 trace_esp_handle_ti(minlen
);
358 s
->dma_left
= minlen
;
359 s
->rregs
[ESP_RSTAT
] &= ~STAT_TC
;
361 } else if (s
->do_cmd
) {
362 trace_esp_handle_ti_cmd(s
->cmdlen
);
366 do_cmd(s
, s
->cmdbuf
);
371 void esp_hard_reset(ESPState
*s
)
373 memset(s
->rregs
, 0, ESP_REGS
);
374 memset(s
->wregs
, 0, ESP_REGS
);
383 s
->rregs
[ESP_CFG1
] = 7;
386 static void esp_soft_reset(ESPState
*s
)
388 qemu_irq_lower(s
->irq
);
392 static void parent_esp_reset(ESPState
*s
, int irq
, int level
)
399 uint64_t esp_reg_read(ESPState
*s
, uint32_t saddr
)
403 trace_esp_mem_readb(saddr
, s
->rregs
[saddr
]);
406 if ((s
->rregs
[ESP_RSTAT
] & STAT_PIO_MASK
) == 0) {
408 qemu_log_mask(LOG_UNIMP
, "esp: PIO data read not implemented\n");
409 s
->rregs
[ESP_FIFO
] = 0;
411 } else if (s
->ti_rptr
< s
->ti_wptr
) {
413 s
->rregs
[ESP_FIFO
] = s
->ti_buf
[s
->ti_rptr
++];
416 if (s
->ti_rptr
== s
->ti_wptr
) {
422 /* Clear sequence step, interrupt register and all status bits
424 old_val
= s
->rregs
[ESP_RINTR
];
425 s
->rregs
[ESP_RINTR
] = 0;
426 s
->rregs
[ESP_RSTAT
] &= ~STAT_TC
;
427 s
->rregs
[ESP_RSEQ
] = SEQ_CD
;
432 /* Return the unique id if the value has never been written */
433 if (!s
->tchi_written
) {
439 return s
->rregs
[saddr
];
442 void esp_reg_write(ESPState
*s
, uint32_t saddr
, uint64_t val
)
444 trace_esp_mem_writeb(saddr
, s
->wregs
[saddr
], val
);
447 s
->tchi_written
= true;
451 s
->rregs
[ESP_RSTAT
] &= ~STAT_TC
;
455 if (s
->cmdlen
< TI_BUFSZ
) {
456 s
->cmdbuf
[s
->cmdlen
++] = val
& 0xff;
458 trace_esp_error_fifo_overrun();
460 } else if (s
->ti_wptr
== TI_BUFSZ
- 1) {
461 trace_esp_error_fifo_overrun();
464 s
->ti_buf
[s
->ti_wptr
++] = val
& 0xff;
468 s
->rregs
[saddr
] = val
;
471 /* Reload DMA counter. */
472 s
->rregs
[ESP_TCLO
] = s
->wregs
[ESP_TCLO
];
473 s
->rregs
[ESP_TCMID
] = s
->wregs
[ESP_TCMID
];
474 s
->rregs
[ESP_TCHI
] = s
->wregs
[ESP_TCHI
];
478 switch(val
& CMD_CMD
) {
480 trace_esp_mem_writeb_cmd_nop(val
);
483 trace_esp_mem_writeb_cmd_flush(val
);
485 s
->rregs
[ESP_RINTR
] = INTR_FC
;
486 s
->rregs
[ESP_RSEQ
] = 0;
487 s
->rregs
[ESP_RFLAGS
] = 0;
490 trace_esp_mem_writeb_cmd_reset(val
);
494 trace_esp_mem_writeb_cmd_bus_reset(val
);
495 s
->rregs
[ESP_RINTR
] = INTR_RST
;
496 if (!(s
->wregs
[ESP_CFG1
] & CFG1_RESREPT
)) {
504 trace_esp_mem_writeb_cmd_iccs(val
);
506 s
->rregs
[ESP_RINTR
] = INTR_FC
;
507 s
->rregs
[ESP_RSTAT
] |= STAT_MI
;
510 trace_esp_mem_writeb_cmd_msgacc(val
);
511 s
->rregs
[ESP_RINTR
] = INTR_DC
;
512 s
->rregs
[ESP_RSEQ
] = 0;
513 s
->rregs
[ESP_RFLAGS
] = 0;
517 trace_esp_mem_writeb_cmd_pad(val
);
518 s
->rregs
[ESP_RSTAT
] = STAT_TC
;
519 s
->rregs
[ESP_RINTR
] = INTR_FC
;
520 s
->rregs
[ESP_RSEQ
] = 0;
523 trace_esp_mem_writeb_cmd_satn(val
);
526 trace_esp_mem_writeb_cmd_rstatn(val
);
529 trace_esp_mem_writeb_cmd_sel(val
);
530 handle_s_without_atn(s
);
533 trace_esp_mem_writeb_cmd_selatn(val
);
537 trace_esp_mem_writeb_cmd_selatns(val
);
541 trace_esp_mem_writeb_cmd_ensel(val
);
542 s
->rregs
[ESP_RINTR
] = 0;
545 trace_esp_mem_writeb_cmd_dissel(val
);
546 s
->rregs
[ESP_RINTR
] = 0;
550 trace_esp_error_unhandled_command(val
);
554 case ESP_WBUSID
... ESP_WSYNO
:
557 case ESP_CFG2
: case ESP_CFG3
:
558 case ESP_RES3
: case ESP_RES4
:
559 s
->rregs
[saddr
] = val
;
561 case ESP_WCCF
... ESP_WTEST
:
564 trace_esp_error_invalid_write(val
, saddr
);
567 s
->wregs
[saddr
] = val
;
570 static bool esp_mem_accepts(void *opaque
, hwaddr addr
,
571 unsigned size
, bool is_write
)
573 return (size
== 1) || (is_write
&& size
== 4);
576 const VMStateDescription vmstate_esp
= {
579 .minimum_version_id
= 3,
580 .fields
= (VMStateField
[]) {
581 VMSTATE_BUFFER(rregs
, ESPState
),
582 VMSTATE_BUFFER(wregs
, ESPState
),
583 VMSTATE_INT32(ti_size
, ESPState
),
584 VMSTATE_UINT32(ti_rptr
, ESPState
),
585 VMSTATE_UINT32(ti_wptr
, ESPState
),
586 VMSTATE_BUFFER(ti_buf
, ESPState
),
587 VMSTATE_UINT32(status
, ESPState
),
588 VMSTATE_UINT32(dma
, ESPState
),
589 VMSTATE_BUFFER(cmdbuf
, ESPState
),
590 VMSTATE_UINT32(cmdlen
, ESPState
),
591 VMSTATE_UINT32(do_cmd
, ESPState
),
592 VMSTATE_UINT32(dma_left
, ESPState
),
593 VMSTATE_END_OF_LIST()
597 #define TYPE_ESP "esp"
598 #define ESP(obj) OBJECT_CHECK(SysBusESPState, (obj), TYPE_ESP)
602 SysBusDevice parent_obj
;
610 static void sysbus_esp_mem_write(void *opaque
, hwaddr addr
,
611 uint64_t val
, unsigned int size
)
613 SysBusESPState
*sysbus
= opaque
;
616 saddr
= addr
>> sysbus
->it_shift
;
617 esp_reg_write(&sysbus
->esp
, saddr
, val
);
620 static uint64_t sysbus_esp_mem_read(void *opaque
, hwaddr addr
,
623 SysBusESPState
*sysbus
= opaque
;
626 saddr
= addr
>> sysbus
->it_shift
;
627 return esp_reg_read(&sysbus
->esp
, saddr
);
630 static const MemoryRegionOps sysbus_esp_mem_ops
= {
631 .read
= sysbus_esp_mem_read
,
632 .write
= sysbus_esp_mem_write
,
633 .endianness
= DEVICE_NATIVE_ENDIAN
,
634 .valid
.accepts
= esp_mem_accepts
,
637 void esp_init(hwaddr espaddr
, int it_shift
,
638 ESPDMAMemoryReadWriteFunc dma_memory_read
,
639 ESPDMAMemoryReadWriteFunc dma_memory_write
,
640 void *dma_opaque
, qemu_irq irq
, qemu_irq
*reset
,
641 qemu_irq
*dma_enable
)
645 SysBusESPState
*sysbus
;
648 dev
= qdev_create(NULL
, TYPE_ESP
);
651 esp
->dma_memory_read
= dma_memory_read
;
652 esp
->dma_memory_write
= dma_memory_write
;
653 esp
->dma_opaque
= dma_opaque
;
654 sysbus
->it_shift
= it_shift
;
655 /* XXX for now until rc4030 has been changed to use DMA enable signal */
656 esp
->dma_enabled
= 1;
657 qdev_init_nofail(dev
);
658 s
= SYS_BUS_DEVICE(dev
);
659 sysbus_connect_irq(s
, 0, irq
);
660 sysbus_mmio_map(s
, 0, espaddr
);
661 *reset
= qdev_get_gpio_in(dev
, 0);
662 *dma_enable
= qdev_get_gpio_in(dev
, 1);
665 static const struct SCSIBusInfo esp_scsi_info
= {
667 .max_target
= ESP_MAX_DEVS
,
670 .transfer_data
= esp_transfer_data
,
671 .complete
= esp_command_complete
,
672 .cancel
= esp_request_cancelled
675 static void sysbus_esp_gpio_demux(void *opaque
, int irq
, int level
)
677 SysBusESPState
*sysbus
= ESP(opaque
);
678 ESPState
*s
= &sysbus
->esp
;
682 parent_esp_reset(s
, irq
, level
);
685 esp_dma_enable(opaque
, irq
, level
);
690 static void sysbus_esp_realize(DeviceState
*dev
, Error
**errp
)
692 SysBusDevice
*sbd
= SYS_BUS_DEVICE(dev
);
693 SysBusESPState
*sysbus
= ESP(dev
);
694 ESPState
*s
= &sysbus
->esp
;
697 sysbus_init_irq(sbd
, &s
->irq
);
698 assert(sysbus
->it_shift
!= -1);
700 s
->chip_id
= TCHI_FAS100A
;
701 memory_region_init_io(&sysbus
->iomem
, OBJECT(sysbus
), &sysbus_esp_mem_ops
,
702 sysbus
, "esp", ESP_REGS
<< sysbus
->it_shift
);
703 sysbus_init_mmio(sbd
, &sysbus
->iomem
);
705 qdev_init_gpio_in(dev
, sysbus_esp_gpio_demux
, 2);
707 scsi_bus_new(&s
->bus
, sizeof(s
->bus
), dev
, &esp_scsi_info
, NULL
);
708 scsi_bus_legacy_handle_cmdline(&s
->bus
, &err
);
710 error_propagate(errp
, err
);
715 static void sysbus_esp_hard_reset(DeviceState
*dev
)
717 SysBusESPState
*sysbus
= ESP(dev
);
718 esp_hard_reset(&sysbus
->esp
);
721 static const VMStateDescription vmstate_sysbus_esp_scsi
= {
722 .name
= "sysbusespscsi",
724 .minimum_version_id
= 0,
725 .fields
= (VMStateField
[]) {
726 VMSTATE_STRUCT(esp
, SysBusESPState
, 0, vmstate_esp
, ESPState
),
727 VMSTATE_END_OF_LIST()
731 static void sysbus_esp_class_init(ObjectClass
*klass
, void *data
)
733 DeviceClass
*dc
= DEVICE_CLASS(klass
);
735 dc
->realize
= sysbus_esp_realize
;
736 dc
->reset
= sysbus_esp_hard_reset
;
737 dc
->vmsd
= &vmstate_sysbus_esp_scsi
;
738 set_bit(DEVICE_CATEGORY_STORAGE
, dc
->categories
);
741 static const TypeInfo sysbus_esp_info
= {
743 .parent
= TYPE_SYS_BUS_DEVICE
,
744 .instance_size
= sizeof(SysBusESPState
),
745 .class_init
= sysbus_esp_class_init
,
748 static void esp_register_types(void)
750 type_register_static(&sysbus_esp_info
);
753 type_init(esp_register_types
)