Skip to contentSkip to conversation

hw/dma: Add error handling for loading descriptions failing

PATCH Superseded Fea.Wang 3 participants 7 messages Jun 4, 2024 – Jun 13, 2024 Arm/Zynq architecture

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Fea.Wang

author
#0 lore raw

v2 cover hw/dma: Add error handling for loading descriptions failing

The original code assumes that memory transmission is always successful, but in some cases, it gets bus-error.

Add error handling for DMA reading description failures. Do some reasonable settings, and return the corrected transmission size. Finally, return the error status.

* Add DMASR_DECERR case
* Squash the two commits to one

base-commit: 915758c537b5fe09575291f4acd87e2d377a93de

[v1]
base-commit: 1806da76cb81088ea026ca3441551782b850e393

Fea.Wang (3):
hw/dma: Enhance error handling in loading description hw/dma: Add a trace log for a description loading failure hw/net: Fix the transmission return size

 hw/dma/trace-events     |  3 +++
 hw/dma/xilinx_axidma.c  | 33 +++++++++++++++++++++++++++++----
 hw/net/xilinx_axienet.c |  2 +-
 3 files changed, 33 insertions(+), 5 deletions(-)
Signature · 1 line
2.34.1
author
#1 lore raw

PATCH v2 1/3 hw/dma: Enhance error handling in loading description

Loading a description from memory may cause a bus-error. In this case, the DMA should stop working, set the error flag, and return the failure value.

When calling the loading a description function, it should be noticed that the function may return a failure value. Breaking the loop in this case is one of the possible ways to handle it.

---
 hw/dma/xilinx_axidma.c | 30 ++++++++++++++++++++++++++----
 1 file changed, 26 insertions(+), 4 deletions(-)
hw/dma/xilinx_axidma.c +26 -4
index 0ae056ed06..ad307994c2 100644
@@ -71,8 +71,11 @@ enum {
 enum {
     DMASR_HALTED = 1,
     DMASR_IDLE  = 2,
+    DMASR_SLVERR = 1 << 5,
+    DMASR_DECERR = 1 << 6,
     DMASR_IOC_IRQ  = 1 << 12,
     DMASR_DLY_IRQ  = 1 << 13,
+    DMASR_ERR_IRQ  = 1 << 14,
 
     DMASR_IRQ_MASK = 7 << 12
 };
@@ -190,17 +193,32 @@ static inline int streamid_from_addr(hwaddr addr)
     return sid;
 }
 
-static void stream_desc_load(struct Stream *s, hwaddr addr)
+static MemTxResult stream_desc_load(struct Stream *s, hwaddr addr)
 {
     struct SDesc *d = &s->desc;
 
-    address_space_read(&s->dma->as, addr, MEMTXATTRS_UNSPECIFIED, d, sizeof *d);
+    MemTxResult result = address_space_read(&s->dma->as,
+                                            addr, MEMTXATTRS_UNSPECIFIED,
+                                            d, sizeof *d);
+    if (result != MEMTX_OK) {
+        if (result == MEMTX_DECODE_ERROR) {
+            s->regs[R_DMASR] |= DMASR_DECERR;
+        } else {
+            s->regs[R_DMASR] |= DMASR_SLVERR;
+        }
+
+        s->regs[R_DMACR] &= ~DMACR_RUNSTOP;
+        s->regs[R_DMASR] |= DMASR_HALTED;
+        s->regs[R_DMASR] |= DMASR_ERR_IRQ;
+        return result;
+    }
 
     /* Convert from LE into host endianness.  */
     d->buffer_address = le64_to_cpu(d->buffer_address);
     d->nxtdesc = le64_to_cpu(d->nxtdesc);
     d->control = le32_to_cpu(d->control);
     d->status = le32_to_cpu(d->status);
+    return result;
 }
 
 static void stream_desc_store(struct Stream *s, hwaddr addr)
@@ -279,7 +297,9 @@ static void stream_process_mem2s(struct Stream *s, StreamSink *tx_data_dev,
     }
 
     while (1) {
-        stream_desc_load(s, s->regs[R_CURDESC]);
+        if (MEMTX_OK != stream_desc_load(s, s->regs[R_CURDESC])) {
+            break;
+        }
 
         if (s->desc.status & SDESC_STATUS_COMPLETE) {
             s->regs[R_DMASR] |= DMASR_HALTED;
@@ -336,7 +356,9 @@ static size_t stream_process_s2mem(struct Stream *s, unsigned char *buf,
     }
 
     while (len) {
-        stream_desc_load(s, s->regs[R_CURDESC]);
+        if (MEMTX_OK != stream_desc_load(s, s->regs[R_CURDESC])) {
+            break;
+        }
 
         if (s->desc.status & SDESC_STATUS_COMPLETE) {
             s->regs[R_DMASR] |= DMASR_HALTED;
Signature · 1 line
2.34.1
Reviewed-by on v2 1/3
#2 lore raw

Re: [PATCH v2 1/3] hw/dma: Enhance error handling in loading description

Quoted 11 lines · Fea.Wang

Loading a description from memory may cause a bus-error. In this case, the DMA should stop working, set the error flag, and return the failure value.

When calling the loading a description function, it should be noticed that the function may return a failure value. Breaking the loop in this case is one of the possible ways to handle it.

Thanks!

---

Quoted 83 lines
 hw/dma/xilinx_axidma.c | 30 ++++++++++++++++++++++++++----
 1 file changed, 26 insertions(+), 4 deletions(-)
hw/dma/xilinx_axidma.c +20 -2
index 0ae056ed06..ad307994c2 100644
@@ -71,8 +71,11 @@ enum {
 enum {
     DMASR_HALTED = 1,
     DMASR_IDLE  = 2,
+    DMASR_SLVERR = 1 << 5,
+    DMASR_DECERR = 1 << 6,
     DMASR_IOC_IRQ  = 1 << 12,
     DMASR_DLY_IRQ  = 1 << 13,
+    DMASR_ERR_IRQ  = 1 << 14,
 
     DMASR_IRQ_MASK = 7 << 12
 };
@@ -190,17 +193,32 @@ static inline int streamid_from_addr(hwaddr addr)
     return sid;
 }
 
-static void stream_desc_load(struct Stream *s, hwaddr addr)
+static MemTxResult stream_desc_load(struct Stream *s, hwaddr addr)
 {
     struct SDesc *d = &s->desc;
 
-    address_space_read(&s->dma->as, addr, MEMTXATTRS_UNSPECIFIED, d,
 sizeof *d);
+    MemTxResult result = address_space_read(&s->dma->as,
+                                            addr, MEMTXATTRS_UNSPECIFIED,
+                                            d, sizeof *d);
+    if (result != MEMTX_OK) {
+        if (result == MEMTX_DECODE_ERROR) {
+            s->regs[R_DMASR] |= DMASR_DECERR;
+        } else {
+            s->regs[R_DMASR] |= DMASR_SLVERR;
+        }
+
+        s->regs[R_DMACR] &= ~DMACR_RUNSTOP;
+        s->regs[R_DMASR] |= DMASR_HALTED;
+        s->regs[R_DMASR] |= DMASR_ERR_IRQ;
+        return result;
+    }
 
     /* Convert from LE into host endianness.  */
     d->buffer_address = le64_to_cpu(d->buffer_address);
     d->nxtdesc = le64_to_cpu(d->nxtdesc);
     d->control = le32_to_cpu(d->control);
     d->status = le32_to_cpu(d->status);
+    return result;
 }
 

static void stream_desc_store(struct Stream *s, hwaddr addr)

hw/dma/xilinx_axidma.c +3 -1
@@ -279,7 +297,9 @@ static void stream_process_mem2s(struct Stream *s,
 StreamSink *tx_data_dev,
     }
 
     while (1) {
-        stream_desc_load(s, s->regs[R_CURDESC]);
+        if (MEMTX_OK != stream_desc_load(s, s->regs[R_CURDESC])) {
+            break;
+        }
 
         if (s->desc.status & SDESC_STATUS_COMPLETE) {
             s->regs[R_DMASR] |= DMASR_HALTED;
hw/dma/xilinx_axidma.c +3 -1
@@ -336,7 +356,9 @@ static size_t stream_process_s2mem(struct Stream *s,
 unsigned char *buf,
     }
 
     while (len) {
-        stream_desc_load(s, s->regs[R_CURDESC]);
+        if (MEMTX_OK != stream_desc_load(s, s->regs[R_CURDESC])) {
+            break;
+        }
 
         if (s->desc.status & SDESC_STATUS_COMPLETE) {
             s->regs[R_DMASR] |= DMASR_HALTED;

--
2.34.1

author
#3 lore raw

PATCH v2 2/3 hw/dma: Add a trace log for a description loading failure

In reply to Fea.Wang

Due to a description loading failure, adding a trace log makes observing the DMA behavior easy.

---
 hw/dma/trace-events    | 3 +++
 hw/dma/xilinx_axidma.c | 3 +++
 2 files changed, 6 insertions(+)
hw/dma/trace-events +3 -0
index 3c47df54e4..95db083be4 100644
@@ -44,3 +44,6 @@ pl330_debug_exec_stall(void) "stall of debug instruction not implemented"
 pl330_iomem_write(uint32_t offset, uint32_t value) "addr: 0x%08"PRIx32" data: 0x%08"PRIx32
 pl330_iomem_write_clr(int i) "event interrupt lowered %d"
 pl330_iomem_read(uint32_t addr, uint32_t data) "addr: 0x%08"PRIx32" data: 0x%08"PRIx32
+
+# xilinx_axidma.c
+xilinx_axidma_loading_desc_fail(uint32_t res) "error:%d"
hw/dma/xilinx_axidma.c +3 -0
index ad307994c2..c9cfc3169b 100644
@@ -36,6 +36,7 @@
 #include "sysemu/dma.h"
 #include "hw/stream.h"
 #include "qom/object.h"
+#include "trace.h"
 
 #define D(x)
 
@@ -201,6 +202,8 @@ static MemTxResult stream_desc_load(struct Stream *s, hwaddr addr)
                                             addr, MEMTXATTRS_UNSPECIFIED,
                                             d, sizeof *d);
     if (result != MEMTX_OK) {
+        trace_xilinx_axidma_loading_desc_fail(result);
+
         if (result == MEMTX_DECODE_ERROR) {
             s->regs[R_DMASR] |= DMASR_DECERR;
         } else {
Signature · 1 line
2.34.1
#4 lore raw

Re: [PATCH v2 2/3] hw/dma: Add a trace log for a description loading failure

Hi Fea,

Quoted 12 lines · Fea.Wang

Due to a description loading failure, adding a trace log makes observing the DMA behavior easy.

---
  hw/dma/trace-events    | 3 +++
  hw/dma/xilinx_axidma.c | 3 +++
  2 files changed, 6 insertions(+)

hw/dma/trace-events pl330_debug_exec_stall(void) "stall of debug instruction not implemented" · line 49

Quoted 2 lines
hw/dma/trace-events +2 -0
+# xilinx_axidma.c
+xilinx_axidma_loading_desc_fail(uint32_t res) "error:%d"

Unsigned format is "%u".

Regards,

Phil.

author
#5 lore raw

Re: [PATCH v2 2/3] hw/dma: Add a trace log for a description loading failure

Sure, I will fix it in the next patch series.
Thank you

Sincerely,
Fea

Quoted 24 lines · Philippe Mathieu-Daudé

Hi Fea,

Quoted 12 lines · Fea.Wang

Due to a description loading failure, adding a trace log makes observing the DMA behavior easy.

---
  hw/dma/trace-events    | 3 +++
  hw/dma/xilinx_axidma.c | 3 +++
  2 files changed, 6 insertions(+)

hw/dma/trace-events pl330_debug_exec_stall(void) "stall of debug instruction not implemented" · line 49

Quoted 2 lines
hw/dma/trace-events +2 -0
+# xilinx_axidma.c
+xilinx_axidma_loading_desc_fail(uint32_t res) "error:%d"

Unsigned format is "%u".

Regards,

Phil.

author
#6 lore raw

PATCH v2 3/3 hw/net: Fix the transmission return size

In reply to Fea.Wang

Fix the transmission return size because not all bytes could be transmitted successfully. So, return a successful length instead of a constant value.

---
 hw/net/xilinx_axienet.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
hw/net/xilinx_axienet.c +1 -1
index 7d1fd37b4a..05d41bd548 100644
@@ -847,7 +847,7 @@ static ssize_t eth_rx(NetClientState *nc, const uint8_t *buf, size_t size)
     axienet_eth_rx_notify(s);
 
     enet_update_irq(s);
-    return size;
+    return s->rxpos;
 }
 
 static size_t
Signature · 1 line
2.34.1