Skip to contentSkip to conversation

dfu: Provide proper Poll Timeout values

PATCH New Lukasz Majewski 4 participants 15 messages Dec 9, 2013 – Dec 10, 2013 USB

lore
Share & tools
lore
#0 lore raw

cover dfu: Provide proper Poll Timeout values

This patch series adds support for DFU's proper Poll Timeout setting. This fixes problem with "dying" transmission of a large files (like rootfs).

Moreover some very simple clean-up patches have been included.

Test HW:
Exynos4210 - TRATS board

Lukasz Majewski (4):
dfu: Export allocated dfu buffer size
usb: dfu: f_dfu: Provide infrastructure to adjust DFU's Poll Timeout
value
usb: f_dfu: cosmetic: Code cleanup
ARM: trats: dfu: Enable default Poll Timeout for Trats board

 drivers/dfu/dfu.c          |    5 +++++
 drivers/usb/gadget/f_dfu.c |   43 ++++++++++++++++++++++++++++++++++++++-----
 drivers/usb/gadget/f_dfu.h |    2 ++
 include/configs/trats.h    |    1 +
 include/dfu.h              |    4 ++++
 5 files changed, 50 insertions(+), 5 deletions(-)
Signature · 1 line
1.7.10.4
#1 lore raw

PATCH 1/4 dfu: Export allocated dfu buffer size

The method for exporting size of allocated buffer is provided. It is afterwards used by USB's dfu function code.

---
 drivers/dfu/dfu.c |    5 +++++
 include/dfu.h     |    1 +
 2 files changed, 6 insertions(+)
drivers/dfu/dfu.c +5 -0
index 1eb92e5..07011e9 100644
@@ -74,6 +74,11 @@ unsigned char *dfu_free_buf(void)
 	return dfu_buf;
 }
 
+unsigned long dfu_get_buf_size(void)
+{
+	return dfu_buf_size;
+}
+
 unsigned char *dfu_get_buf(void)
 {
 	char *s;
include/dfu.h +1 -0
index cc14044..9a50721 100644
@@ -131,6 +131,7 @@ bool dfu_reset(void);
 int dfu_init_env_entities(char *interface, int dev);
 unsigned char *dfu_get_buf(void);
 unsigned char *dfu_free_buf(void);
+unsigned long dfu_get_buf_size(void);
 
 int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
 int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
Signature · 1 line
1.7.10.4
#2 lore raw

PATCH 1/4 dfu: Export allocated dfu buffer size

Hello Lukasz,

Am 09.12.2013 16:20, schrieb Lukasz Majewski:

Quoted 8 lines

The method for exporting size of allocated buffer is provided. It is afterwards used by USB's dfu function code.

---
  drivers/dfu/dfu.c |    5 +++++
  include/dfu.h     |    1 +
  2 files changed, 6 insertions(+)

Tested on the dxr2 board. "dfu -l" "dfu -U" and "dfu -D" worked.

bye,
Heiko

Signature · 2 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
#3 lore raw

PATCH 2/4 usb: dfu: f_dfu: Provide infrastructure to adjust DFU's Poll Timeout value

In reply to Lukasz Majewski

It is necessary to deter the host from sending subsequent DFU_GETSTATUS request in the case of e.g. writing the buffer to medium.

Here the timeout is increased when we fill up the whole buffer. This delay allows eMMC memory to perform its internal operations. Otherwise we end up with HOST's error regarding GET_STATUS receive timeout.

---
 drivers/usb/gadget/f_dfu.c |   39 ++++++++++++++++++++++++++++++++++++---
 drivers/usb/gadget/f_dfu.h |    2 ++
 include/dfu.h              |    3 +++
 3 files changed, 41 insertions(+), 3 deletions(-)
drivers/usb/gadget/f_dfu.c +36 -3
index 37d04a1..b4b4aa4 100644
@@ -40,6 +40,7 @@ struct f_dfu {
 
 	/* Send/received block number is handy for data integrity check */
 	int                             blk_seq_num;
+	unsigned int                    poll_timeout;
 };
 
 typedef int (*dfu_state_fn) (struct f_dfu *,
@@ -128,6 +129,33 @@ static struct usb_gadget_strings *dfu_strings[] = {
 	NULL,
 };
 
+static void dfu_set_poll_timeout(struct dfu_status *dstat, unsigned int ms)
+{
+	/*
+	 * The bwPollTimeout DFU_GETSTATUS request payload provides information
+	 * about minimum time, in milliseconds, that the host should wait before
+	 * sending a subsequent DFU_GETSTATUS request
+	 *
+	 * This permits the device to vary the delay depending on its need to
+	 * erase or program the memory
+	 *
+	 */
+
+	unsigned char *p = (unsigned char *)&ms;
+
+	if (!ms || (ms & ~DFU_POLL_TIMEOUT_MASK)) {
+		dstat->bwPollTimeout[0] = 0;
+		dstat->bwPollTimeout[1] = 0;
+		dstat->bwPollTimeout[2] = 0;
+
+		return;
+	}
+
+	dstat->bwPollTimeout[0] = *p++;
+	dstat->bwPollTimeout[1] = *p++;
+	dstat->bwPollTimeout[2] = *p;
+}
+
 /*-------------------------------------------------------------------------*/
 
 static void dnload_request_complete(struct usb_ep *ep, struct usb_request *req)
@@ -157,11 +185,15 @@ static void handle_getstatus(struct usb_request *req)
 		break;
 	}
 
+	dfu_set_poll_timeout(dstat, 0);
+
+	if (f_dfu->poll_timeout)
+		if (!(f_dfu->blk_seq_num %
+		      (dfu_get_buf_size() / DFU_USB_BUFSIZ)))
+			dfu_set_poll_timeout(dstat, f_dfu->poll_timeout);
+
 	/* send status response */
 	dstat->bStatus = f_dfu->dfu_status;
-	dstat->bwPollTimeout[0] = 0;
-	dstat->bwPollTimeout[1] = 0;
-	dstat->bwPollTimeout[2] = 0;
 	dstat->bState = f_dfu->dfu_state;
 	dstat->iString = 0;
 }
@@ -725,6 +757,7 @@ static int dfu_bind_config(struct usb_configuration *c)
 	f_dfu->usb_function.disable = dfu_disable;
 	f_dfu->usb_function.strings = dfu_generic_strings,
 	f_dfu->usb_function.setup = dfu_handle,
+	f_dfu->poll_timeout = DFU_DEFAULT_POLL_TIMEOUT;
 
 	status = usb_add_function(c, &f_dfu->usb_function);
 	if (status)
drivers/usb/gadget/f_dfu.h +2 -0
index cc2c455..0c29954 100644
@@ -82,4 +82,6 @@ struct dfu_function_descriptor {
 	__le16				wTransferSize;
 	__le16				bcdDFUVersion;
 } __packed;
+
+#define DFU_POLL_TIMEOUT_MASK           (0xFFFFFFUL)
 #endif /* __F_DFU_H_ */
include/dfu.h +3 -0
index 9a50721..f973426 100644
@@ -77,6 +77,9 @@ static inline unsigned int get_mmc_blk_size(int dev)
 #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
 #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
 #endif
+#ifndef DFU_DEFAULT_POLL_TIMEOUT
+#define DFU_DEFAULT_POLL_TIMEOUT 0
+#endif
 
 struct dfu_entity {
 	char			name[DFU_NAME_SIZE];
Signature · 1 line
1.7.10.4
#4 lore raw

PATCH 2/4 usb: dfu: f_dfu: Provide infrastructure to adjust DFU's Poll Timeout value

Hi Lukasz,

drivers/usb/gadget/f_dfu.h struct dfu_function_descriptor { · line 86

Quoted 10 lines · Lukasz Majewski
drivers/usb/gadget/f_dfu.h +2 -0
index cc2c455..0c29954 100644
@@ -82,4 +82,6 @@ struct dfu_function_descriptor {
  	__le16				wTransferSize;
  	__le16				bcdDFUVersion;
  } __packed;
+
+#define DFU_POLL_TIMEOUT_MASK           (0xFFFFFFUL)

Why this value? How about (~0UL)?

drivers/usb/gadget/f_dfu.h struct dfu_function_descriptor { · line 87

Quoted 1 line
drivers/usb/gadget/f_dfu.h +0 -0
  #endif /* __F_DFU_H_ */

Best Regards,
Bo Shen

#5 lore raw

PATCH 2/4 usb: dfu: f_dfu: Provide infrastructure to adjust DFU's Poll Timeout value

Hi Bo,

Quoted 15 lines

Hi Lukasz,

drivers/usb/gadget/f_dfu.h struct dfu_function_descriptor { · line 86

Quoted 10 lines · Lukasz Majewski
drivers/usb/gadget/f_dfu.h +2 -0
index cc2c455..0c29954 100644
@@ -82,4 +82,6 @@ struct dfu_function_descriptor {
  	__le16				wTransferSize;
  	__le16				bcdDFUVersion;
  } __packed;
+
+#define DFU_POLL_TIMEOUT_MASK           (0xFFFFFFUL)

Why this value? How about (~0UL)?

According to DFU 1.1 standard, the bwPolTimeout field of DFU_GETSTATUS request has 3 bytes in size.

Quoted 5 lines

drivers/usb/gadget/f_dfu.h struct dfu_function_descriptor { · line 87

Quoted 2 lines
drivers/usb/gadget/f_dfu.h +0 -0
  #endif /* __F_DFU_H_ */

Best Regards,
Bo Shen

Signature · 5 lines
Best regards,

Lukasz Majewski

Samsung R&D Institute Poland (SRPOL) | Linux Platform Group
#6 lore raw

PATCH 2/4 usb: dfu: f_dfu: Provide infrastructure to adjust DFU's Poll Timeout value

Hi Lukasz,

Quoted 18 lines · Lukasz Majewski

Hi Bo,

Quoted 15 lines

Hi Lukasz,

drivers/usb/gadget/f_dfu.h struct dfu_function_descriptor { · line 86

Quoted 10 lines · Lukasz Majewski
drivers/usb/gadget/f_dfu.h +2 -0
index cc2c455..0c29954 100644
@@ -82,4 +82,6 @@ struct dfu_function_descriptor {
   	__le16				wTransferSize;
   	__le16				bcdDFUVersion;
   } __packed;
+
+#define DFU_POLL_TIMEOUT_MASK           (0xFFFFFFUL)

Why this value? How about (~0UL)?

Quoted 2 lines

According to DFU 1.1 standard, the bwPolTimeout field of DFU_GETSTATUS request has 3 bytes in size.

Thanks for clarify this.

Tested OK on sama5d3xek board.

Quoted 6 lines
Quoted 5 lines

drivers/usb/gadget/f_dfu.h struct dfu_function_descriptor { · line 87

Quoted 2 lines
drivers/usb/gadget/f_dfu.h +0 -0
   #endif /* __F_DFU_H_ */

Best Regards,
Bo Shen

Best Regards,
Bo Shen

#7 lore raw

PATCH 2/4 usb: dfu: f_dfu: Provide infrastructure to adjust DFU's Poll Timeout value

In reply to Lukasz Majewski

Hello Lukasz,

Am 09.12.2013 16:20, schrieb Lukasz Majewski:

Quoted 7 lines

It is necessary to deter the host from sending subsequent DFU_GETSTATUS request in the case of e.g. writing the buffer to medium.

Here the timeout is increased when we fill up the whole buffer. This delay allows eMMC memory to perform its internal operations. Otherwise we end up with HOST's error regarding GET_STATUS receive timeout.

Quoted 6 lines
---
  drivers/usb/gadget/f_dfu.c |   39 ++++++++++++++++++++++++++++++++++++---
  drivers/usb/gadget/f_dfu.h |    2 ++
  include/dfu.h              |    3 +++
  3 files changed, 41 insertions(+), 3 deletions(-)

Tested on the dxr2 board. "dfu -l" "dfu -U" and "dfu -D" worked.

bye,
Heiko

Signature · 2 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
#8 lore raw

PATCH 3/4 usb: f_dfu: cosmetic: Code cleanup

In reply to Lukasz Majewski

Code cleanup for dfu_bind_config function

---
 drivers/usb/gadget/f_dfu.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/usb/gadget/f_dfu.c +2 -2
index b4b4aa4..a045864 100644
@@ -755,8 +755,8 @@ static int dfu_bind_config(struct usb_configuration *c)
 	f_dfu->usb_function.unbind = dfu_unbind;
 	f_dfu->usb_function.set_alt = dfu_set_alt;
 	f_dfu->usb_function.disable = dfu_disable;
-	f_dfu->usb_function.strings = dfu_generic_strings,
-	f_dfu->usb_function.setup = dfu_handle,
+	f_dfu->usb_function.strings = dfu_generic_strings;
+	f_dfu->usb_function.setup = dfu_handle;
 	f_dfu->poll_timeout = DFU_DEFAULT_POLL_TIMEOUT;
 
 	status = usb_add_function(c, &f_dfu->usb_function);
Signature · 1 line
1.7.10.4
#9 lore raw

PATCH 3/4 usb: f_dfu: cosmetic: Code cleanup

Hello Lukasz,

Am 09.12.2013 16:20, schrieb Lukasz Majewski:

Quoted 6 lines

Code cleanup for dfu_bind_config function

---
  drivers/usb/gadget/f_dfu.c |    4 ++--
  1 file changed, 2 insertions(+), 2 deletions(-)

Tested on the dxr2 board. "dfu -l" "dfu -U" and "dfu -D" worked.

bye,
Heiko

Signature · 2 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
#10 lore raw

PATCH 4/4 ARM: trats: dfu: Enable default Poll Timeout for Trats board

In reply to Lukasz Majewski

Provide default Poll Timeout value for Trats board.

---
 include/configs/trats.h |    1 +
 1 file changed, 1 insertion(+)
include/configs/trats.h +1 -0
index 3d080c4..1e37996 100644
@@ -98,6 +98,7 @@
 #define CONFIG_THOR_FUNCTION
 
 #define CONFIG_SYS_DFU_DATA_BUF_SIZE SZ_32M
+#define DFU_DEFAULT_POLL_TIMEOUT 300
 #define CONFIG_DFU_FUNCTION
 #define CONFIG_DFU_MMC
 
Signature · 1 line
1.7.10.4
#11 lore raw

PATCH 4/4 ARM: trats: dfu: Enable default Poll Timeout for Trats board

Hello Lukasz,

Am 09.12.2013 16:20, schrieb Lukasz Majewski:

Quoted 6 lines

Provide default Poll Timeout value for Trats board.

---
  include/configs/trats.h |    1 +
  1 file changed, 1 insertion(+)

Tested on the dxr2 board. "dfu -l" "dfu -U" and "dfu -D" worked.

bye,
Heiko

Signature · 2 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
#12 lore raw

cover dfu: Provide proper Poll Timeout values

In reply to Lukasz Majewski

Hi Heiko,

Quoted 6 lines

This patch series adds support for DFU's proper Poll Timeout setting. This fixes problem with "dying" transmission of a large files (like rootfs).

Moreover some very simple clean-up patches have been included.

I'd have a little request. Please check if those patches doesn't break anything on NAND related boards.

Thanks in advance.

Quoted 18 lines

Test HW:
Exynos4210 - TRATS board

Lukasz Majewski (4):
dfu: Export allocated dfu buffer size
usb: dfu: f_dfu: Provide infrastructure to adjust DFU's Poll Timeout
value
usb: f_dfu: cosmetic: Code cleanup
ARM: trats: dfu: Enable default Poll Timeout for Trats board

 drivers/dfu/dfu.c          |    5 +++++
 drivers/usb/gadget/f_dfu.c |   43
++++++++++++++++++++++++++++++++++++++-----
drivers/usb/gadget/f_dfu.h |    2 ++ include/configs/trats.h    |
1 + include/dfu.h              |    4 ++++
 5 files changed, 50 insertions(+), 5 deletions(-)
Signature · 5 lines
Best regards,

Lukasz Majewski

Samsung R&D Institute Poland (SRPOL) | Linux Platform Group
#13 lore raw

cover dfu: Provide proper Poll Timeout values

Hello Lukasz,

How are you?

Am 10.12.2013 10:54, schrieb Lukasz Majewski:

Quoted 11 lines

Hi Heiko,

Quoted 6 lines

This patch series adds support for DFU's proper Poll Timeout setting. This fixes problem with "dying" transmission of a large files (like rootfs).

Moreover some very simple clean-up patches have been included.

I'd have a little request. Please check if those patches doesn't break anything on NAND related boards.

I had them on my list, but I am hopelessly under water ...

I try to test them today ... feel free to trigger my again, if I forget it ...

bye,
Heiko

Signature · 2 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Applied
#14 lore raw

cover dfu: Provide proper Poll Timeout values

In reply to Lukasz Majewski
Quoted 17 lines · Lukasz Majewski

This patch series adds support for DFU's proper Poll Timeout setting. This fixes problem with "dying" transmission of a large files (like rootfs).

Moreover some very simple clean-up patches have been included.

Test HW:
Exynos4210 - TRATS board

Lukasz Majewski (4):
dfu: Export allocated dfu buffer size
usb: dfu: f_dfu: Provide infrastructure to adjust DFU's Poll Timeout
value
usb: f_dfu: cosmetic: Code cleanup
ARM: trats: dfu: Enable default Poll Timeout for Trats board

Quoted 7 lines
 drivers/dfu/dfu.c          |    5 +++++
 drivers/usb/gadget/f_dfu.c |   43
++++++++++++++++++++++++++++++++++++++----- drivers/usb/gadget/f_dfu.h |  
 2 ++
 include/configs/trats.h    |    1 +
 include/dfu.h              |    4 ++++
 5 files changed, 50 insertions(+), 5 deletions(-)

Applied all, thanks

Best regards,
Marek Vasut