Re: [PATCH v14 1/9] esp: add pseudo-DMA as used by Macintosh

[Laurent Vivier]

Le 22/10/2019 à 14:21, Philippe Mathieu-Daudé a écrit :
> Hi Laurent,
> 
> On 10/22/19 1:17 PM, Laurent Vivier wrote:
>> There is no DMA in Quadra 800, so the CPU reads/writes the data from the
>> PDMA register (offset 0x100, ESP_PDMA in hw/m68k/q800.c) and copies them
>> to/from the memory.
>>
>> There is a nice assembly loop in the kernel to do that, see
>> linux/drivers/scsi/mac_esp.c:MAC_ESP_PDMA_LOOP().
>>
>> The start of the transfer is triggered by the DREQ interrupt (see linux
>> mac_esp_send_pdma_cmd()), the CPU polls on the IRQ flag to start the
>> transfer after a SCSI command has been sent (in Quadra 800 it goes
>> through the VIA2, the via2-irq line and the vIFR register)
>>
>> The Macintosh hardware includes hardware handshaking to prevent the CPU
>> from reading invalid data or writing data faster than the peripheral
>> device can accept it.
>>
>> This is the "blind mode", and from the doc:
>> "Approximate maximum SCSI transfer rates within a blocks are 1.4 MB per
>> second for blind transfers in the Macintosh II"
>>
>> Some references can be found in:
>>    Apple Macintosh Family Hardware Reference, ISBN 0-201-19255-1
>>    Guide to the Macintosh Family Hardware, ISBN-0-201-52405-8
>>
>> Acked-by: Dr. David Alan Gilbert <address@hidden>
>> Co-developed-by: Mark Cave-Ayland <address@hidden>
>> Signed-off-by: Mark Cave-Ayland <address@hidden>
>> Signed-off-by: Laurent Vivier <address@hidden>
>> ---
>>   include/hw/scsi/esp.h |  15 ++
>>   hw/scsi/esp.c         | 338 ++++++++++++++++++++++++++++++++++++++----
>>   2 files changed, 324 insertions(+), 29 deletions(-)
>>
>> diff --git a/include/hw/scsi/esp.h b/include/hw/scsi/esp.h
>> index adab63d1c9..6ba47dac41 100644
>> --- a/include/hw/scsi/esp.h
>> +++ b/include/hw/scsi/esp.h
>> @@ -14,10 +14,18 @@ typedef void (*ESPDMAMemoryReadWriteFunc)(void
>> *opaque, uint8_t *buf, int len);
>>     typedef struct ESPState ESPState;
>>   +enum pdma_origin_id {
>> +    PDMA,
>> +    TI,
>> +    CMD,
>> +    ASYNC,
>> +};
>> +
>>   struct ESPState {
>>       uint8_t rregs[ESP_REGS];
>>       uint8_t wregs[ESP_REGS];
>>       qemu_irq irq;
>> +    qemu_irq irq_data;
>>       uint8_t chip_id;
>>       bool tchi_written;
>>       int32_t ti_size;
>> @@ -48,6 +56,12 @@ struct ESPState {
>>       ESPDMAMemoryReadWriteFunc dma_memory_write;
>>       void *dma_opaque;
>>       void (*dma_cb)(ESPState *s);
>> +    uint8_t pdma_buf[32];
>> +    int pdma_origin;
>> +    uint32_t pdma_len;
>> +    uint32_t pdma_start;
>> +    uint32_t pdma_cur;
>> +    void (*pdma_cb)(ESPState *s);
>>   };
>>     #define TYPE_ESP "esp"
>> @@ -59,6 +73,7 @@ typedef struct {
>>       /*< public >*/
>>         MemoryRegion iomem;
>> +    MemoryRegion pdma;
>>       uint32_t it_shift;
>>       ESPState esp;
>>   } SysBusESPState;
>> diff --git a/hw/scsi/esp.c b/hw/scsi/esp.c
>> index 841d79b60e..90b40c4cb5 100644
>> --- a/hw/scsi/esp.c
>> +++ b/hw/scsi/esp.c
>> @@ -38,6 +38,8 @@
>>    *
>> http://www.ibiblio.org/pub/historic-linux/early-ports/Sparc/NCR/NCR89C100.txt
>>
>>    * and
>>    *
>> http://www.ibiblio.org/pub/historic-linux/early-ports/Sparc/NCR/NCR53C9X.txt
>>
>> + *
>> + * On Macintosh Quadra it is a NCR53C96.
>>    */
>>     static void esp_raise_irq(ESPState *s)
>> @@ -58,6 +60,16 @@ static void esp_lower_irq(ESPState *s)
>>       }
>>   }
>>   +static void esp_raise_drq(ESPState *s)
>> +{
>> +    qemu_irq_raise(s->irq_data);
>> +}
>> +
>> +static void esp_lower_drq(ESPState *s)
>> +{
>> +    qemu_irq_lower(s->irq_data);
>> +}
>> +
>>   void esp_dma_enable(ESPState *s, int irq, int level)
>>   {
>>       if (level) {
>> @@ -84,29 +96,35 @@ void esp_request_cancelled(SCSIRequest *req)
>>       }
>>   }
>>   -static uint32_t get_cmd(ESPState *s, uint8_t *buf, uint8_t buflen)
>> +static void set_pdma(ESPState *s, enum pdma_origin_id origin,
>> +                     uint32_t index, uint32_t len)
>> +{
>> +    s->pdma_origin = origin;
>> +    s->pdma_start = index;
>> +    s->pdma_cur = index;
>> +    s->pdma_len = len;
> 
> Can you pass the pdma_cb to this function, and:
> 
>        s->pdma_cb = pdma_cb;
> 
>> +}
>> +
>> +static uint8_t *get_pdma_buf(ESPState *s)
>> +{
>> +    switch (s->pdma_origin) {
>> +    case PDMA:
>> +        return s->pdma_buf;
>> +    case TI:
>> +        return s->ti_buf;
>> +    case CMD:
>> +        return s->cmdbuf;
>> +    case ASYNC:
>> +        return s->async_buf;
>> +    }
>> +    return NULL;
>> +}
>> +
>> +static int get_cmd_cb(ESPState *s)
>>   {
>> -    uint32_t dmalen;
>>       int target;
>>         target = s->wregs[ESP_WBUSID] & BUSID_DID;
>> -    if (s->dma) {
>> -        dmalen = s->rregs[ESP_TCLO];
>> -        dmalen |= s->rregs[ESP_TCMID] << 8;
>> -        dmalen |= s->rregs[ESP_TCHI] << 16;
>> -        if (dmalen > buflen) {
>> -            return 0;
>> -        }
>> -        s->dma_memory_read(s->dma_opaque, buf, dmalen);
>> -    } else {
>> -        dmalen = s->ti_size;
>> -        if (dmalen > TI_BUFSZ) {
>> -            return 0;
>> -        }
>> -        memcpy(buf, s->ti_buf, dmalen);
>> -        buf[0] = buf[2] >> 5;
>> -    }
>> -    trace_esp_get_cmd(dmalen, target);
>>         s->ti_size = 0;
>>       s->ti_rptr = 0;
>> @@ -125,8 +143,46 @@ static uint32_t get_cmd(ESPState *s, uint8_t
>> *buf, uint8_t buflen)
>>           s->rregs[ESP_RINTR] = INTR_DC;
>>           s->rregs[ESP_RSEQ] = SEQ_0;
>>           esp_raise_irq(s);
>> +        return -1;
>> +    }
>> +    return 0;
>> +}
>> +
>> +static uint32_t get_cmd(ESPState *s, uint8_t *buf, uint8_t buflen)
>> +{
>> +    int target;
>> +    uint32_t dmalen;
>> +
>> +    target = s->wregs[ESP_WBUSID] & BUSID_DID;
>> +    if (s->dma) {
>> +        dmalen = s->rregs[ESP_TCLO];
>> +        dmalen |= s->rregs[ESP_TCMID] << 8;
>> +        dmalen |= s->rregs[ESP_TCHI] << 16;
>> +        if (dmalen > buflen) {
>> +            return 0;
>> +        }
>> +        if (s->dma_memory_read) {
>> +            s->dma_memory_read(s->dma_opaque, buf, dmalen);
>> +        } else {
>> +            memcpy(s->pdma_buf, buf, dmalen);
>> +            set_pdma(s, PDMA, 0, dmalen);
>> +            esp_raise_drq(s);
>> +            return 0;
>> +        }
>> +    } else {
>> +        dmalen = s->ti_size;
>> +        if (dmalen > TI_BUFSZ) {
>> +            return 0;
>> +        }
>> +        memcpy(buf, s->ti_buf, dmalen);
>> +        buf[0] = buf[2] >> 5;
>> +    }
>> +    trace_esp_get_cmd(dmalen, target);
>> +
>> +    if (get_cmd_cb(s) < 0) {
>>           return 0;
>>       }
>> +
>>       return dmalen;
>>   }
>>   @@ -165,6 +221,16 @@ static void do_cmd(ESPState *s, uint8_t *buf)
>>       do_busid_cmd(s, &buf[1], busid);
>>   }
>>   +static void satn_pdma_cb(ESPState *s)
>> +{
>> +    if (get_cmd_cb(s) < 0) {
>> +        return;
>> +    }
>> +    if (s->pdma_cur != s->pdma_start) {
>> +        do_cmd(s, get_pdma_buf(s) + s->pdma_start);
>> +    }
>> +}
>> +
>>   static void handle_satn(ESPState *s)
>>   {
>>       uint8_t buf[32];
>> @@ -174,11 +240,22 @@ static void handle_satn(ESPState *s)
>>           s->dma_cb = handle_satn;
>>           return;
>>       }
>> +    s->pdma_cb = satn_pdma_cb;
>>       len = get_cmd(s, buf, sizeof(buf));
>>       if (len)
>>           do_cmd(s, buf);
>>   }
>>   +static void s_without_satn_pdma_cb(ESPState *s)
>> +{
>> +    if (get_cmd_cb(s) < 0) {
>> +        return;
>> +    }
>> +    if (s->pdma_cur != s->pdma_start) {
>> +        do_busid_cmd(s, get_pdma_buf(s) + s->pdma_start, 0);
>> +    }
>> +}
>> +
>>   static void handle_s_without_atn(ESPState *s)
>>   {
>>       uint8_t buf[32];
>> @@ -188,18 +265,36 @@ static void handle_s_without_atn(ESPState *s)
>>           s->dma_cb = handle_s_without_atn;
>>           return;
>>       }
>> +    s->pdma_cb = s_without_satn_pdma_cb;
>>       len = get_cmd(s, buf, sizeof(buf));
>>       if (len) {
>>           do_busid_cmd(s, buf, 0);
>>       }
>>   }
>>   +static void satn_stop_pdma_cb(ESPState *s)
>> +{
>> +    if (get_cmd_cb(s) < 0) {
>> +        return;
>> +    }
>> +    s->cmdlen = s->pdma_cur - s->pdma_start;
>> +    if (s->cmdlen) {
>> +        trace_esp_handle_satn_stop(s->cmdlen);
>> +        s->do_cmd = 1;
>> +        s->rregs[ESP_RSTAT] = STAT_TC | STAT_CD;
>> +        s->rregs[ESP_RINTR] = INTR_BS | INTR_FC;
>> +        s->rregs[ESP_RSEQ] = SEQ_CD;
>> +        esp_raise_irq(s);
>> +    }
>> +}
>> +
>>   static void handle_satn_stop(ESPState *s)
>>   {
>>       if (s->dma && !s->dma_enabled) {
>>           s->dma_cb = handle_satn_stop;
>>           return;
>>       }
>> +    s->pdma_cb = satn_stop_pdma_cb;;
>>       s->cmdlen = get_cmd(s, s->cmdbuf, sizeof(s->cmdbuf));
>>       if (s->cmdlen) {
>>           trace_esp_handle_satn_stop(s->cmdlen);
>> @@ -211,16 +306,31 @@ static void handle_satn_stop(ESPState *s)
>>       }
>>   }
>>   +static void write_response_pdma_cb(ESPState *s)
>> +{
>> +    s->rregs[ESP_RSTAT] = STAT_TC | STAT_ST;
>> +    s->rregs[ESP_RINTR] = INTR_BS | INTR_FC;
>> +    s->rregs[ESP_RSEQ] = SEQ_CD;
>> +    esp_raise_irq(s);
>> +}
>> +
>>   static void write_response(ESPState *s)
>>   {
>>       trace_esp_write_response(s->status);
>>       s->ti_buf[0] = s->status;
>>       s->ti_buf[1] = 0;
>>       if (s->dma) {
>> -        s->dma_memory_write(s->dma_opaque, s->ti_buf, 2);
>> -        s->rregs[ESP_RSTAT] = STAT_TC | STAT_ST;
>> -        s->rregs[ESP_RINTR] = INTR_BS | INTR_FC;
>> -        s->rregs[ESP_RSEQ] = SEQ_CD;
>> +        if (s->dma_memory_write) {
>> +            s->dma_memory_write(s->dma_opaque, s->ti_buf, 2);
>> +            s->rregs[ESP_RSTAT] = STAT_TC | STAT_ST;
>> +            s->rregs[ESP_RINTR] = INTR_BS | INTR_FC;
>> +            s->rregs[ESP_RSEQ] = SEQ_CD;
>> +        } else {
>> +            set_pdma(s, TI, 0, 2);
>> +            s->pdma_cb = write_response_pdma_cb;
>> +            esp_raise_drq(s);
>> +            return;
>> +        }
>>       } else {
>>           s->ti_size = 2;
>>           s->ti_rptr = 0;
>> @@ -242,6 +352,41 @@ static void esp_dma_done(ESPState *s)
>>       esp_raise_irq(s);
>>   }
>>   +static void do_dma_pdma_cb(ESPState *s)
>> +{
>> +    int to_device = (s->ti_size < 0);
>> +    int len = s->pdma_cur - s->pdma_start;
>> +    if (s->do_cmd) {
>> +        s->ti_size = 0;
>> +        s->cmdlen = 0;
>> +        s->do_cmd = 0;
>> +        do_cmd(s, s->cmdbuf);
>> +        return;
>> +    }
>> +    s->dma_left -= len;
>> +    s->async_buf += len;
>> +    s->async_len -= len;
>> +    if (to_device) {
>> +        s->ti_size += len;
>> +    } else {
>> +        s->ti_size -= len;
>> +    }
>> +    if (s->async_len == 0) {
>> +        scsi_req_continue(s->current_req);
>> +        /*
>> +         * If there is still data to be read from the device then
>> +         * complete the DMA operation immediately.  Otherwise defer
>> +         * until the scsi layer has completed.
>> +         */
>> +        if (to_device || s->dma_left != 0 || s->ti_size == 0) {
>> +            return;
>> +        }
>> +    }
>> +
>> +    /* Partially filled a scsi buffer. Complete immediately.  */
>> +    esp_dma_done(s);
>> +}
>> +
>>   static void esp_do_dma(ESPState *s)
>>   {
>>       uint32_t len;
>> @@ -252,10 +397,25 @@ static void esp_do_dma(ESPState *s)
>>           trace_esp_do_dma(s->cmdlen, len);
>>           assert (s->cmdlen <= sizeof(s->cmdbuf) &&
>>                   len <= sizeof(s->cmdbuf) - s->cmdlen);
>> -        s->dma_memory_read(s->dma_opaque, &s->cmdbuf[s->cmdlen], len);
>> +        if (s->dma_memory_read) {
>> +            s->dma_memory_read(s->dma_opaque, &s->cmdbuf[s->cmdlen],
>> len);
>> +        } else {
>> +            set_pdma(s, CMD, s->cmdlen, len);
>> +            s->pdma_cb = do_dma_pdma_cb;
>> +            esp_raise_drq(s);
>> +            return;
>> +        }
>> +        trace_esp_handle_ti_cmd(s->cmdlen);
>> +        s->ti_size = 0;
>> +        s->cmdlen = 0;
>> +        s->do_cmd = 0;
>> +        do_cmd(s, s->cmdbuf);
>>           return;
>>       }
>>       if (s->async_len == 0) {
>> +        if (s->dma_left == 0) {
>> +            esp_dma_done(s);
>> +        }
> 
> This change seems unrelated to PDMA, is this a fix?

In fact, dma_left cannot be equal to 0 here, esp_do_dma() is called from:
1- esp_transfer_data() only if s->dma_left != 0
2- handle_ti() and s->dma_left >= 0x1000

So I will remove this change.

Thanks,
Laurent