xref: /openbmc/qemu/include/hw/scsi/esp.h (revision e70aa5dc299c49c59bd91c80e771db56996c2188)
1 #ifndef QEMU_HW_ESP_H
2 #define QEMU_HW_ESP_H
3 
4 #include "hw/scsi/scsi.h"
5 #include "hw/sysbus.h"
6 #include "qemu/fifo8.h"
7 #include "qom/object.h"
8 
9 /* esp.c */
10 #define ESP_MAX_DEVS 7
11 typedef void (*ESPDMAMemoryReadWriteFunc)(void *opaque, uint8_t *buf, int len);
12 
13 #define ESP_REGS 16
14 #define ESP_FIFO_SZ 16
15 #define ESP_CMDFIFO_SZ 32
16 
17 #define TYPE_ESP "esp"
18 OBJECT_DECLARE_SIMPLE_TYPE(ESPState, ESP)
19 
20 struct ESPState {
21     DeviceState parent_obj;
22 
23     uint8_t rregs[ESP_REGS];
24     uint8_t wregs[ESP_REGS];
25     qemu_irq irq;
26     qemu_irq drq_irq;
27     bool drq_state;
28     uint8_t chip_id;
29     bool tchi_written;
30     int32_t ti_size;
31     uint32_t status;
32     uint32_t dma;
33     Fifo8 fifo;
34     SCSIBus bus;
35     SCSIDevice *current_dev;
36     SCSIRequest *current_req;
37     Fifo8 cmdfifo;
38     uint8_t cmdfifo_cdb_offset;
39     uint8_t lun;
40     uint32_t do_cmd;
41 
42     bool data_ready;
43     int dma_enabled;
44 
45     uint32_t async_len;
46     uint8_t *async_buf;
47 
48     ESPDMAMemoryReadWriteFunc dma_memory_read;
49     ESPDMAMemoryReadWriteFunc dma_memory_write;
50     void *dma_opaque;
51     void (*dma_cb)(ESPState *s);
52 
53     uint8_t mig_version_id;
54 
55     /* Legacy fields for vmstate_esp version < 5 */
56     uint32_t mig_dma_left;
57     uint32_t mig_deferred_status;
58     bool mig_deferred_complete;
59     uint32_t mig_ti_rptr, mig_ti_wptr;
60     uint8_t mig_ti_buf[ESP_FIFO_SZ];
61     uint8_t mig_cmdbuf[ESP_CMDFIFO_SZ];
62     uint32_t mig_cmdlen;
63 
64     uint8_t mig_ti_cmd;
65 };
66 
67 #define TYPE_SYSBUS_ESP "sysbus-esp"
68 OBJECT_DECLARE_SIMPLE_TYPE(SysBusESPState, SYSBUS_ESP)
69 
70 struct SysBusESPState {
71     /*< private >*/
72     SysBusDevice parent_obj;
73     /*< public >*/
74 
75     MemoryRegion iomem;
76     MemoryRegion pdma;
77     uint32_t it_shift;
78     ESPState esp;
79 };
80 
81 #define ESP_TCLO   0x0
82 #define ESP_TCMID  0x1
83 #define ESP_FIFO   0x2
84 #define ESP_CMD    0x3
85 #define ESP_RSTAT  0x4
86 #define ESP_WBUSID 0x4
87 #define ESP_RINTR  0x5
88 #define ESP_WSEL   0x5
89 #define ESP_RSEQ   0x6
90 #define ESP_WSYNTP 0x6
91 #define ESP_RFLAGS 0x7
92 #define ESP_WSYNO  0x7
93 #define ESP_CFG1   0x8
94 #define ESP_RRES1  0x9
95 #define ESP_WCCF   0x9
96 #define ESP_RRES2  0xa
97 #define ESP_WTEST  0xa
98 #define ESP_CFG2   0xb
99 #define ESP_CFG3   0xc
100 #define ESP_RES3   0xd
101 #define ESP_TCHI   0xe
102 #define ESP_RES4   0xf
103 
104 #define CMD_DMA 0x80
105 #define CMD_CMD 0x7f
106 
107 #define CMD_NOP      0x00
108 #define CMD_FLUSH    0x01
109 #define CMD_RESET    0x02
110 #define CMD_BUSRESET 0x03
111 #define CMD_TI       0x10
112 #define CMD_ICCS     0x11
113 #define CMD_MSGACC   0x12
114 #define CMD_PAD      0x18
115 #define CMD_SATN     0x1a
116 #define CMD_RSTATN   0x1b
117 #define CMD_SEL      0x41
118 #define CMD_SELATN   0x42
119 #define CMD_SELATNS  0x43
120 #define CMD_ENSEL    0x44
121 #define CMD_DISSEL   0x45
122 
123 #define STAT_DO 0x00
124 #define STAT_DI 0x01
125 #define STAT_CD 0x02
126 #define STAT_ST 0x03
127 #define STAT_MO 0x06
128 #define STAT_MI 0x07
129 #define STAT_PIO_MASK 0x06
130 
131 #define STAT_TC 0x10
132 #define STAT_PE 0x20
133 #define STAT_GE 0x40
134 #define STAT_INT 0x80
135 
136 #define BUSID_DID 0x07
137 
138 #define INTR_FC 0x08
139 #define INTR_BS 0x10
140 #define INTR_DC 0x20
141 #define INTR_RST 0x80
142 
143 #define SEQ_0 0x0
144 #define SEQ_MO 0x1
145 #define SEQ_CD 0x4
146 
147 #define CFG1_RESREPT 0x40
148 
149 #define TCHI_FAS100A 0x4
150 #define TCHI_AM53C974 0x12
151 
152 void esp_dma_enable(ESPState *s, int irq, int level);
153 void esp_request_cancelled(SCSIRequest *req);
154 void esp_command_complete(SCSIRequest *req, size_t resid);
155 void esp_transfer_data(SCSIRequest *req, uint32_t len);
156 void esp_hard_reset(ESPState *s);
157 uint64_t esp_reg_read(ESPState *s, uint32_t saddr);
158 void esp_reg_write(ESPState *s, uint32_t saddr, uint64_t val);
159 extern const VMStateDescription vmstate_esp;
160 int esp_pre_save(void *opaque);
161 
162 #endif
163