usb: dwc3: gadget: make cache-maintenance on event buffers more robust

Merely using dma_alloc_coherent does not ensure that there is no stale data left in the caches for the allocated DMA buffer (i.e. that the affected cacheline may still be dirty).

The original code was doing the following (on AArch64, which translates a 'flush' into a 'clean + invalidate'):

  # during initialisation:
      1. allocate buffers via memalign
      	 => buffers may still be modified (cached, dirty)
  # during interrupt processing
      2. clean + invalidate buffers
      	 => may commit stale data from a modified cacheline
      3. read from buffers

This could lead to garbage info being written to buffers before reading them during even-processing.

To make the event processing more robust, we use the following sequence for the cache-maintenance:

  # during initialisation:
      1. allocate buffers via memalign
      2. clean + invalidate buffers
      	 (we only need the 'invalidate' part, but dwc3_flush_cache()
	  always performs a 'clean + invalidate')
  # during interrupt processing
      3. read the buffers
      	 (we know these lines are not cached, due to the previous
	  invalidation and no other code touching them in-between)
      4. clean + invalidate buffers
      	 => writes back any modification we may have made during event
	    processing and ensures that the lines are not in the cache
	    the next time we enter interrupt processing

Note that with the original sequence, we observe reproducible (depending on the cache state: i.e. running dhcp/usb start before will upset caches to get us around this) issues in the event processing (a fatal synchronous abort in dwc3_gadget_uboot_handle_interrupt on the first time interrupt handling is invoked) when running USB mass storage emulation on our RK3399-Q7 with data-caches on.

Signed-off-by Philipp Tomsich <[email protected]>

---

 drivers/usb/dwc3/core.c   | 2 ++
 drivers/usb/dwc3/gadget.c | 5 +++--
 2 files changed, 5 insertions(+), 2 deletions(-)

drivers/usb/dwc3/core.c +0 -0

index b2c7eb1..f58c7ba 100644

drivers/usb/dwc3/core.c +0 -0

 	return evt;
 }
 

drivers/usb/dwc3/gadget.c +0 -0

index 1156662..61af71b 100644
@@ -2668,11 +2668,12 @@ void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc)
 		int i;

Quoted 56 lines · Philipp Tomsich

Merely using dma_alloc_coherent does not ensure that there is no stale data left in the caches for the allocated DMA buffer (i.e. that the affected cacheline may still be dirty).

The original code was doing the following (on AArch64, which translates a 'flush' into a 'clean + invalidate'):

 # during initialisation:
     1. allocate buffers via memalign
     	 => buffers may still be modified (cached, dirty)
 # during interrupt processing
     2. clean + invalidate buffers
     	 => may commit stale data from a modified cacheline
     3. read from buffers

This could lead to garbage info being written to buffers before reading them during even-processing.

To make the event processing more robust, we use the following sequence for the cache-maintenance:

 # during initialisation:
     1. allocate buffers via memalign
     2. clean + invalidate buffers
     	 (we only need the 'invalidate' part, but dwc3_flush_cache()
	  always performs a 'clean + invalidate')
 # during interrupt processing
     3. read the buffers
     	 (we know these lines are not cached, due to the previous
	  invalidation and no other code touching them in-between)
     4. clean + invalidate buffers
     	 => writes back any modification we may have made during event
	    processing and ensures that the lines are not in the cache
	    the next time we enter interrupt processing

Note that with the original sequence, we observe reproducible (depending on the cache state: i.e. running dhcp/usb start before will upset caches to get us around this) issues in the event processing (a fatal synchronous abort in dwc3_gadget_uboot_handle_interrupt on the first time interrupt handling is invoked) when running USB mass storage emulation on our RK3399-Q7 with data-caches on.

Signed-off-by Philipp Tomsich <[email protected]>

---

drivers/usb/dwc3/core.c | 2 ++
drivers/usb/dwc3/gadget.c | 5 +++--

2 files changed, 5 insertions(+), 2 deletions(-)

drivers/usb/dwc3/core.c +0 -0

index b2c7eb1..f58c7ba 100644
@@ -125,6 +125,8 @@ static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc,
 	if (!evt->buf)
 		return ERR_PTR(-ENOMEM);
 

drivers/usb/dwc3/core.c static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc, · line 129

Quoted 2 lines

drivers/usb/dwc3/core.c +2 -0

+	dwc3_flush_cache((long)evt->buf, evt->length);
+

Is the length aligned ? If not, you will get cache alignment warning. Also, address should be uintptr_t to avoid 32/64 bit issues .

Quoted 11 lines

drivers/usb/dwc3/core.c +0 -0

 	return evt;
 }
 

drivers/usb/dwc3/gadget.c +0 -0

index 1156662..61af71b 100644
@@ -2668,11 +2668,12 @@ void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc)
 		int i;
 		struct dwc3_event_buffer *evt;
 

drivers/usb/dwc3/gadget.c void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc) · line 2675

Quoted 8 lines

drivers/usb/dwc3/gadget.c +3 -1

+		dwc3_thread_interrupt(0, dwc);
+
+		/* Clean + Invalidate the buffers after touching them */
 		for (i = 0; i < dwc->num_event_buffers; i++) {
 			evt = dwc->ev_buffs[i];
 			dwc3_flush_cache((long)evt->buf, evt->length);
 		}
-

This makes me wonder, don't you need to invalidate the event buffer somewhere so that the new data would be fetched from RAM ?

drivers/usb/dwc3/gadget.c void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc) · line 2679

Quoted 4 lines

drivers/usb/dwc3/gadget.c +0 -1

-		dwc3_thread_interrupt(0, dwc);
 	}
 }

One last thing, is this patch needed in Linux too ?

Quoted 60 lines · Marek Vasut

Quoted 56 lines · Philipp Tomsich

Merely using dma_alloc_coherent does not ensure that there is no stale data left in the caches for the allocated DMA buffer (i.e. that the affected cacheline may still be dirty).

The original code was doing the following (on AArch64, which translates a 'flush' into a 'clean + invalidate'):

 # during initialisation:
     1. allocate buffers via memalign
     	 => buffers may still be modified (cached, dirty)
 # during interrupt processing
     2. clean + invalidate buffers
     	 => may commit stale data from a modified cacheline
     3. read from buffers

This could lead to garbage info being written to buffers before reading them during even-processing.

To make the event processing more robust, we use the following sequence for the cache-maintenance:

 # during initialisation:
     1. allocate buffers via memalign
     2. clean + invalidate buffers
     	 (we only need the 'invalidate' part, but dwc3_flush_cache()
	  always performs a 'clean + invalidate')
 # during interrupt processing
     3. read the buffers
     	 (we know these lines are not cached, due to the previous
	  invalidation and no other code touching them in-between)
     4. clean + invalidate buffers
     	 => writes back any modification we may have made during event
	    processing and ensures that the lines are not in the cache
	    the next time we enter interrupt processing

Note that with the original sequence, we observe reproducible (depending on the cache state: i.e. running dhcp/usb start before will upset caches to get us around this) issues in the event processing (a fatal synchronous abort in dwc3_gadget_uboot_handle_interrupt on the first time interrupt handling is invoked) when running USB mass storage emulation on our RK3399-Q7 with data-caches on.

Signed-off-by Philipp Tomsich <[email protected]>

---

drivers/usb/dwc3/core.c | 2 ++
drivers/usb/dwc3/gadget.c | 5 +++--

2 files changed, 5 insertions(+), 2 deletions(-)

drivers/usb/dwc3/core.c +0 -0

index b2c7eb1..f58c7ba 100644
@@ -125,6 +125,8 @@ static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc,
 	if (!evt->buf)
 		return ERR_PTR(-ENOMEM);
 

Quoted 5 lines

drivers/usb/dwc3/core.c static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc, · line 129

Quoted 2 lines

drivers/usb/dwc3/core.c +2 -0

+	dwc3_flush_cache((long)evt->buf, evt->length);
+

Is the length aligned ? If not, you will get cache alignment warning. Also, address should be uintptr_t to avoid 32/64 bit issues .

The length is a well-known value and aligned (it expands to PAGE_SIZE in the end).

Good point on the “long”, especially as I just copied this from other occurences and it’s consistently wrong throughout DWC3 in U-Boot:

	drivers/usb/dwc3/core.c:        dwc3_flush_cache((long)evt->buf, evt->length);
	drivers/usb/dwc3/ep0.c: dwc3_flush_cache((long)buf_dma, len);
	drivers/usb/dwc3/ep0.c: dwc3_flush_cache((long)trb, sizeof(*trb));
	drivers/usb/dwc3/ep0.c: dwc3_flush_cache((long)trb, sizeof(*trb));
	drivers/usb/dwc3/ep0.c:                 dwc3_flush_cache((long)trb, sizeof(*trb));
	drivers/usb/dwc3/ep0.c:         dwc3_flush_cache((long)dwc->ep0_bounce, DWC3_EP0_BOUNCE_SIZE);
	drivers/usb/dwc3/gadget.c:      dwc3_flush_cache((long)req->request.dma, req->request.length);
	drivers/usb/dwc3/gadget.c:      dwc3_flush_cache((long)dma, length);
	drivers/usb/dwc3/gadget.c:      dwc3_flush_cache((long)trb, sizeof(*trb));
	drivers/usb/dwc3/gadget.c:      dwc3_flush_cache((long)trb, sizeof(*trb));
	drivers/usb/dwc3/gadget.c:                      dwc3_flush_cache((long)evt->buf, evt->length);
	drivers/usb/dwc3/io.h:static inline void dwc3_flush_cache(int addr, int length)

Worst of all: the definition of dwc3_flush_cache in io.h has “int” as a type, which will eat us alive if the DWC3’s physical address is beyond 32-bit.

I’ll revise all of these and make a patch-series out of this.

Quoted 11 lines

Quoted 11 lines

drivers/usb/dwc3/core.c +0 -0

 	return evt;
 }
 

drivers/usb/dwc3/gadget.c +0 -0

index 1156662..61af71b 100644
@@ -2668,11 +2668,12 @@ void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc)
 		int i;
 		struct dwc3_event_buffer *evt;
 

Quoted 11 lines

drivers/usb/dwc3/gadget.c void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc) · line 2675

Quoted 8 lines

drivers/usb/dwc3/gadget.c +3 -1

+		dwc3_thread_interrupt(0, dwc);
+
+		/* Clean + Invalidate the buffers after touching them */
 		for (i = 0; i < dwc->num_event_buffers; i++) {
 			evt = dwc->ev_buffs[i];
 			dwc3_flush_cache((long)evt->buf, evt->length);
 		}
-

This makes me wonder, don't you need to invalidate the event buffer somewhere so that the new data would be fetched from RAM ?

We flush the event buffer before leaving the function.
So the cache line will not be present in the cache, when we enter this function again.

Quoted 6 lines

drivers/usb/dwc3/gadget.c void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc) · line 2679

Quoted 4 lines

drivers/usb/dwc3/gadget.c +0 -1

-		dwc3_thread_interrupt(0, dwc);
 	}
 }

One last thing, is this patch needed in Linux too ?

Linux deals properly with DMA allocations and manages them in appropriate memory regions (e.g. marked uncached). Also, some of the affected code-paths are U-Boot specific.

This really stems from a limitation of the way the DMA areas are allocated in U-Boot (i.e. from the heap, using a memalign) and how the cache-operations have been sequenced relative to the other code in the port to U-Boot.

Quoted 2 lines

Good point on the “long”, especially as I just copied this from other occurrences and it’s consistently wrong throughout DWC3 in U-Boot:

Hrm, I thought the driver was ported over from Linux, so is this broken in Linux too ?

Quoted 1 line

I’ll revise all of these and make a patch-series out of this.

Maybe you should check the Linux first and see if there are some fixes already.

Thanks

Quoted 23 lines

Quoted 22 lines

Quoted 9 lines

	return evt;
}

drivers/usb/dwc3/gadget.c +0 -0

index 1156662..61af71b 100644
@@ -2668,11 +2668,12 @@ void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc)
 		int i;

drivers/usb/dwc3/gadget.c void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc) · line 2675

Quoted 10 lines

drivers/usb/dwc3/gadget.c +3 -1

 		struct dwc3_event_buffer *evt;
 
+		dwc3_thread_interrupt(0, dwc);
+
+		/* Clean + Invalidate the buffers after touching them */
 		for (i = 0; i < dwc->num_event_buffers; i++) {
 			evt = dwc->ev_buffs[i];
 			dwc3_flush_cache((long)evt->buf, evt->length);
 		}
-

This makes me wonder, don't you need to invalidate the event buffer somewhere so that the new data would be fetched from RAM ?

Quoted 2 lines

We flush the event buffer before leaving the function.
So the cache line will not be present in the cache, when we enter this function again.

Then shouldn't we invalidate it instead ? flush and invalidate are two different things …

Quoted 7 lines · Marek Vasut

Quoted 2 lines

Good point on the “long”, especially as I just copied this from other occurrences and it’s consistently wrong throughout DWC3 in U-Boot:

Hrm, I thought the driver was ported over from Linux, so is this broken in Linux too ?

Apparently, the dwc3_flush_cache calls (and the function itself) have been introduced during the porting. There’s no explicit cache-maintenance in DWC3 for Linux.

Quoted 6 lines

Quoted 1 line

I’ll revise all of these and make a patch-series out of this.

Maybe you should check the Linux first and see if there are some fixes already.

Thanks

Given that this seems to have been introduced with the port to U-Boot, there’s no applicable fixes there.

Quoted 26 lines

Quoted 25 lines

Quoted 11 lines

Quoted 11 lines

	return evt;
}

drivers/usb/dwc3/gadget.c +0 -0

index 1156662..61af71b 100644
@@ -2668,11 +2668,12 @@ void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc)
 		int i;
 		struct dwc3_event_buffer *evt;
 

Quoted 11 lines

drivers/usb/dwc3/gadget.c void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc) · line 2675

Quoted 8 lines

drivers/usb/dwc3/gadget.c +3 -1

+		dwc3_thread_interrupt(0, dwc);
+
+		/* Clean + Invalidate the buffers after touching them */
 		for (i = 0; i < dwc->num_event_buffers; i++) {
 			evt = dwc->ev_buffs[i];
 			dwc3_flush_cache((long)evt->buf, evt->length);
 		}
-

This makes me wonder, don't you need to invalidate the event buffer somewhere so that the new data would be fetched from RAM ?

We flush the event buffer before leaving the function.
So the cache line will not be present in the cache, when we enter this function again.

Quoted 2 lines

Then shouldn't we invalidate it instead ? flush and invalidate are two different things …

The DWC3 flush expands to a clean+invalidate. It is not wrong, as long as it is used as in my patch:
a. before the first time data is expected to be written by the peripheral (i.e. before the peripheral is started)—to ensure that the cache line is not cached any longer…

b. after the driver modifies any buffers (i.e. anything modified will be written back) and before it next reads the buffers expecting possibly changed data (i.e. invalidating).

Quoted 6 lines

The DWC3 flush expands to a clean+invalidate. It is not wrong, as long as it is used as in my patch:
a. before the first time data is expected to be written by the peripheral (i.e. before the peripheral is started)—to ensure that the cache line is not cached any longer…

So invalidate() is enough ?

Quoted 4 lines

b. after the driver modifies any buffers (i.e. anything modified will be written back) and before it next reads the buffers expecting possibly changed data (i.e. invalidating).

So flush+invalidate ? Keep in mind this driver may not be used on ARMv7/v8 only …

Quoted 10 lines · Marek Vasut

Quoted 6 lines

The DWC3 flush expands to a clean+invalidate. It is not wrong, as long as it is used as in my patch:
a. before the first time data is expected to be written by the peripheral (i.e. before the peripheral is started)—to ensure that the cache line is not cached any longer…

So invalidate() is enough ?

If I had to write this from scratch, I’d got with the paranoid sequence of:

	handler():
	{
		invalidate
		do my stuff
		clean
	}

However, some architectures in U-Boot (e.g. ARMv8) don’t implement the invalidate verb. Given this, I’d rather stay as close to what’s already there.

Note that using flush (i.e. clean+invalidate) aligns with how caches are managed throughout various other drivers in U-Boot.

Quoted 5 lines

Quoted 4 lines

b. after the driver modifies any buffers (i.e. anything modified will be written back) and before it next reads the buffers expecting possibly changed data (i.e. invalidating).

Quoted 2 lines

So flush+invalidate ? Keep in mind this driver may not be used on ARMv7/v8 only …

Yes, a clean+invalidate.
The flush_dcache_range(…, …) function in U-Boot implements C+I semantics at least on arm, arm64, avr32, powerpc, xtensa …

Quoted 20 lines · Dr. Philipp Tomsich

Quoted 10 lines · Marek Vasut

Quoted 6 lines

The DWC3 flush expands to a clean+invalidate. It is not wrong, as long as it is used as in my patch:
a. before the first time data is expected to be written by the peripheral (i.e. before the peripheral is started)—to ensure that the cache line is not cached any longer…

So invalidate() is enough ?

If I had to write this from scratch, I’d got with the paranoid sequence of:

	handler():
	{
		invalidate
		do my stuff
		clean
	}

Quoted 2 lines

However, some architectures in U-Boot (e.g. ARMv8) don’t implement the invalidate verb. Given this, I’d rather stay as close to what’s already there.

invalidate_dcache_range() must be implemented if flush_dcache_range() is, otherwise it's a bug.

Quoted 8 lines

Note that using flush (i.e. clean+invalidate) aligns with how caches are managed throughout various other drivers in U-Boot.

Quoted 5 lines

Quoted 4 lines

b. after the driver modifies any buffers (i.e. anything modified will be written back) and before it next reads the buffers expecting possibly changed data (i.e. invalidating).

Quoted 6 lines

Quoted 2 lines

So flush+invalidate ? Keep in mind this driver may not be used on ARMv7/v8 only …

Yes, a clean+invalidate.
The flush_dcache_range(…, …) function in U-Boot implements C+I semantics at least on arm, arm64, avr32, powerpc, xtensa …

flush on arm926 does not invalidate the cacheline iirc .

Quoted 24 lines · Marek Vasut

Quoted 20 lines · Dr. Philipp Tomsich

Quoted 10 lines · Marek Vasut

Quoted 6 lines

The DWC3 flush expands to a clean+invalidate. It is not wrong, as long as it is used as in my patch:
a. before the first time data is expected to be written by the peripheral (i.e. before the peripheral is started)—to ensure that the cache line is not cached any longer…

So invalidate() is enough ?

If I had to write this from scratch, I’d got with the paranoid sequence of:

	handler():
	{
		invalidate
		do my stuff
		clean
	}

Quoted 5 lines

Quoted 2 lines

However, some architectures in U-Boot (e.g. ARMv8) don’t implement the invalidate verb. Given this, I’d rather stay as close to what’s already there.

invalidate_dcache_range() must be implemented if flush_dcache_range() is, otherwise it's a bug.

The ARMv8 implementation for invalidate currently maps back to a clean+invalidate (see arch/arm/cpu/armv8/cache_v8.c):

	/*
	 * Invalidates range in all levels of D-cache/unified cache
	 */
	void invalidate_dcache_range(unsigned long start, unsigned long stop)
	{
	        __asm_flush_dcache_range(start, stop);
	}

	/*
	 * Flush range(clean & invalidate) from all levels of D-cache/unified cache
	 */
	void flush_dcache_range(unsigned long start, unsigned long stop)
	{
	        __asm_flush_dcache_range(start, stop);
	}

I am a bit scared of either using (as this clearly is mislabeled) or changing (as other code might depend on things being as they are) the invalidate-function for ARMv8 at this point.

Quoted 8 lines

Quoted 8 lines

Note that using flush (i.e. clean+invalidate) aligns with how caches are managed throughout various other drivers in U-Boot.

Quoted 5 lines

Quoted 4 lines

b. after the driver modifies any buffers (i.e. anything modified will be written back) and before it next reads the buffers expecting possibly changed data (i.e. invalidating).

Quoted 8 lines

Quoted 6 lines

Quoted 2 lines

So flush+invalidate ? Keep in mind this driver may not be used on ARMv7/v8 only …

Yes, a clean+invalidate.
The flush_dcache_range(…, …) function in U-Boot implements C+I semantics at least on arm, arm64, avr32, powerpc, xtensa …

flush on arm926 does not invalidate the cacheline iirc .

I dug up an ARMv5 architecture manual (I didn’t think I’d ever need this again) to look at what the ARM926 does.

Here’s the code for reference:

	void flush_dcache_range(unsigned long start, unsigned long stop)
	{
        	if (!check_cache_range(start, stop))
                	return;

	        while (start < stop) {
        	        asm volatile("mcr p15, 0, %0, c7, c14, 1\n" : : "r"(start));
                	start += CONFIG_SYS_CACHELINE_SIZE;
	        }

        	asm volatile("mcr p15, 0, %0, c7, c10, 4\n" : : "r"(0));
	}

c7 are the cache-management functions, with the following opcodes:
— “c7, c14, 1” is “Clean and invalidate data cache line” on the modified virtual-address (MVA)
— “c7, c10, 4” is "Data Synchronization Barrier (formerly Drain Write Buffer)"

This discussion shows that (at some future point… and no, I am not volunteering for this) the naming of the cache-maintenance functions and the documentation for them should be reworked to avoid any confusion for the casual driver developer.

I’ll just go ahead and put together a v2 that also addresses the pointer-size concerns, as I don’t want to have the fix for our DWC3 issue held up by this.

Quoted 62 lines

Quoted 61 lines

Quoted 53 lines

Merely using dma_alloc_coherent does not ensure that there is no stale data left in the caches for the allocated DMA buffer (i.e. that the affected cacheline may still be dirty).

The original code was doing the following (on AArch64, which translates a 'flush' into a 'clean + invalidate'):

 # during initialisation:
     1. allocate buffers via memalign
     	 => buffers may still be modified (cached, dirty)
 # during interrupt processing
     2. clean + invalidate buffers
     	 => may commit stale data from a modified cacheline
     3. read from buffers

This could lead to garbage info being written to buffers before reading them during even-processing.

To make the event processing more robust, we use the following sequence for the cache-maintenance:

 # during initialisation:
     1. allocate buffers via memalign
     2. clean + invalidate buffers
     	 (we only need the 'invalidate' part, but dwc3_flush_cache()
	  always performs a 'clean + invalidate')
 # during interrupt processing
     3. read the buffers
     	 (we know these lines are not cached, due to the previous
	  invalidation and no other code touching them in-between)
     4. clean + invalidate buffers
     	 => writes back any modification we may have made during event
	    processing and ensures that the lines are not in the cache
	    the next time we enter interrupt processing

Note that with the original sequence, we observe reproducible (depending on the cache state: i.e. running dhcp/usb start before will upset caches to get us around this) issues in the event processing (a fatal synchronous abort in dwc3_gadget_uboot_handle_interrupt on the first time interrupt handling is invoked) when running USB mass storage emulation on our RK3399-Q7 with data-caches on.

Signed-off-by Philipp Tomsich <[email protected]>

---

drivers/usb/dwc3/core.c | 2 ++
drivers/usb/dwc3/gadget.c | 5 +++--

2 files changed, 5 insertions(+), 2 deletions(-)

drivers/usb/dwc3/core.c +0 -0

index b2c7eb1..f58c7ba 100644

drivers/usb/dwc3/core.c static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc, · line 129

Quoted 5 lines

drivers/usb/dwc3/core.c +2 -0

@@ -125,6 +125,8 @@ static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc,
 	if (!evt->buf)
 		return ERR_PTR(-ENOMEM);
 
+	dwc3_flush_cache((long)evt->buf, evt->length);
+

Is the length aligned ? If not, you will get cache alignment warning. Also, address should be uintptr_t to avoid 32/64 bit issues .

Quoted 1 line

The length is a well-known value and aligned (it expands to PAGE_SIZE in the end).

Uh, the event buffer is 4k ? That's quite big, but OK.

Quoted 1 line

Good point on the “long”, especially as I just copied this from other occurences and it’s consistently wrong throughout DWC3 in U-Boot:

Hrm, I thought the driver was ported over from Linux, so is this broken in Linux too ?

Quoted 5 lines

Quoted 2 lines

Good point on the “long”, especially as I just copied this from other occurences and it’s consistently wrong throughout DWC3 in U-Boot:

Hrm, I thought the driver was ported over from Linux, so is this broken in Linux too ?

haven't seen a problem in almost 6 years dealing with this IP.

Quoted 6 lines

Quoted 4 lines

Quoted 1 line

Good point on the “long”, especially as I just copied this from other occurences and it’s consistently wrong throughout DWC3 in U-Boot:

Hrm, I thought the driver was ported over from Linux, so is this broken in Linux too ?

haven't seen a problem in almost 6 years dealing with this IP.

The integer-sizes on the flushing really aren’t a big issue, as everyone runs from the lower 32bits as of today. And it could easily be another 6 years, before we hit the first 64bit address for any of the buffers being flushed. Even as the integer types on the dwc3_flush_range are consistently mismatches, that is just a sideshow and doesn’t cause any issues for anyone.

The big one for us is really the patch submitted to reorder the flushes (i.e. clean+invalidate operations), as we sometimes (depends both on what happened before that in U-Boot — e.g. using the network stack will always hide this — and on what configuration we compile into U-Boot) have cachelines matching the allocation via dma_alloc_coherent either as cached (or possibly even as modified) in our cache.

Any opinion on changing the sequencing of cache-maintenance relative to the payload?

Hi,

Quoted 62 lines · Marek Vasut

Quoted 62 lines

Quoted 61 lines

Quoted 53 lines

Merely using dma_alloc_coherent does not ensure that there is no stale data left in the caches for the allocated DMA buffer (i.e. that the affected cacheline may still be dirty).

The original code was doing the following (on AArch64, which translates a 'flush' into a 'clean + invalidate'):

 # during initialisation:
     1. allocate buffers via memalign
     	 => buffers may still be modified (cached, dirty)
 # during interrupt processing
     2. clean + invalidate buffers
     	 => may commit stale data from a modified cacheline
     3. read from buffers

This could lead to garbage info being written to buffers before reading them during even-processing.

To make the event processing more robust, we use the following sequence for the cache-maintenance:

 # during initialisation:
     1. allocate buffers via memalign
     2. clean + invalidate buffers
     	 (we only need the 'invalidate' part, but dwc3_flush_cache()
	  always performs a 'clean + invalidate')
 # during interrupt processing
     3. read the buffers
     	 (we know these lines are not cached, due to the previous
	  invalidation and no other code touching them in-between)
     4. clean + invalidate buffers
     	 => writes back any modification we may have made during event
	    processing and ensures that the lines are not in the cache
	    the next time we enter interrupt processing

Note that with the original sequence, we observe reproducible (depending on the cache state: i.e. running dhcp/usb start before will upset caches to get us around this) issues in the event processing (a fatal synchronous abort in dwc3_gadget_uboot_handle_interrupt on the first time interrupt handling is invoked) when running USB mass storage emulation on our RK3399-Q7 with data-caches on.

Signed-off-by Philipp Tomsich <[email protected]>

---

drivers/usb/dwc3/core.c | 2 ++
drivers/usb/dwc3/gadget.c | 5 +++--

2 files changed, 5 insertions(+), 2 deletions(-)

drivers/usb/dwc3/core.c +0 -0

index b2c7eb1..f58c7ba 100644

drivers/usb/dwc3/core.c static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc, · line 129

Quoted 5 lines

drivers/usb/dwc3/core.c +2 -0

@@ -125,6 +125,8 @@ static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc,
 	if (!evt->buf)
 		return ERR_PTR(-ENOMEM);
 
+	dwc3_flush_cache((long)evt->buf, evt->length);
+

Is the length aligned ? If not, you will get cache alignment warning. Also, address should be uintptr_t to avoid 32/64 bit issues .

Quoted 3 lines

Quoted 1 line

The length is a well-known value and aligned (it expands to PAGE_SIZE in the end).

Uh, the event buffer is 4k ? That's quite big, but OK.

it really isn't when you're dealing with LPM. I've seen 4k cause overflow events before.

Quoted 4 lines

Quoted 1 line

Good point on the “long”, especially as I just copied this from other occurences and it’s consistently wrong throughout DWC3 in U-Boot:

Hrm, I thought the driver was ported over from Linux, so is this broken in Linux too ?

haven't seen a problem in almost 6 years dealing with this IP.

Quoted 8 lines

drivers/usb/dwc3/core.c +0 -0

index b2c7eb1..f58c7ba 100644
@@ -125,6 +125,8 @@ static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc,
 	if (!evt->buf)
 		return ERR_PTR(-ENOMEM);
 

drivers/usb/dwc3/core.c static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc, · line 129

Quoted 2 lines

drivers/usb/dwc3/core.c +2 -0

+	dwc3_flush_cache((long)evt->buf, evt->length);
+

Is the length aligned ? If not, you will get cache alignment warning. Also, address should be uintptr_t to avoid 32/64 bit issues .

Quoted 8 lines

drivers/usb/dwc3/gadget.c +0 -0

index 1156662..61af71b 100644
@@ -2668,11 +2668,12 @@ void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc)
 		int i;
 		struct dwc3_event_buffer *evt;
 

drivers/usb/dwc3/gadget.c void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc) · line 2675

Quoted 8 lines

drivers/usb/dwc3/gadget.c +3 -1

+		dwc3_thread_interrupt(0, dwc);
+
+		/* Clean + Invalidate the buffers after touching them */
 		for (i = 0; i < dwc->num_event_buffers; i++) {
 			evt = dwc->ev_buffs[i];
 			dwc3_flush_cache((long)evt->buf, evt->length);
 		}
-

This makes me wonder, don't you need to invalidate the event buffer somewhere so that the new data would be fetched from RAM ?

Hi,

Quoted 8 lines · Marek Vasut

Quoted 8 lines

drivers/usb/dwc3/core.c +0 -0

index b2c7eb1..f58c7ba 100644
@@ -125,6 +125,8 @@ static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc,
 	if (!evt->buf)
 		return ERR_PTR(-ENOMEM);
 

Quoted 5 lines

drivers/usb/dwc3/core.c static struct dwc3_event_buffer *dwc3_alloc_one_event_buffer(struct dwc3 *dwc, · line 129

Quoted 2 lines

drivers/usb/dwc3/core.c +2 -0

+	dwc3_flush_cache((long)evt->buf, evt->length);
+

Is the length aligned ? If not, you will get cache alignment warning. Also, address should be uintptr_t to avoid 32/64 bit issues .

if it's not aligned to 128 bits (at least, IIRC), DWC3 won't work.

Quoted 8 lines

Quoted 8 lines

drivers/usb/dwc3/gadget.c +0 -0

index 1156662..61af71b 100644
@@ -2668,11 +2668,12 @@ void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc)
 		int i;
 		struct dwc3_event_buffer *evt;
 

Quoted 11 lines

drivers/usb/dwc3/gadget.c void dwc3_gadget_uboot_handle_interrupt(struct dwc3 *dwc) · line 2675

Quoted 8 lines

drivers/usb/dwc3/gadget.c +3 -1

+		dwc3_thread_interrupt(0, dwc);
+
+		/* Clean + Invalidate the buffers after touching them */
 		for (i = 0; i < dwc->num_event_buffers; i++) {
 			evt = dwc->ev_buffs[i];
 			dwc3_flush_cache((long)evt->buf, evt->length);
 		}
-

This makes me wonder, don't you need to invalidate the event buffer somewhere so that the new data would be fetched from RAM ?

nope. In linux we allocate from coherent