Change in osmo-asf4-dfu[master]: add documentation and fix timeout value

[Kévin Redon]

Kévin Redon has uploaded this change for review. ( https://gerrit.osmocom.org/12499


Change subject: add documentation and fix timeout value
......................................................................

add documentation and fix timeout value

Change-Id: Ia1d6ef4e4a5c9929aefd149c4e3eaf2dfe37fea8
---
M usb/class/dfu/device/dfudf_desc.h
M usb/class/dfu/usb_protocol_dfu.h
2 files changed, 10 insertions(+), 10 deletions(-)



  git pull ssh://gerrit.osmocom.org:29418/osmo-asf4-dfu refs/changes/99/12499/1

diff --git a/usb/class/dfu/device/dfudf_desc.h b/usb/class/dfu/device/dfudf_desc.h
index f9eca38..5590e16 100644
--- a/usb/class/dfu/device/dfudf_desc.h
+++ b/usb/class/dfu/device/dfudf_desc.h
@@ -84,9 +84,9 @@
 	                     USB_DFU_PROTOCOL_DFU, \
 	                     CONF_USB_DFUD_IINTERFACE), \
 	                     USB_DFU_FUNC_DESC_BYTES(USB_DFU_ATTRIBUTES_CAN_DOWNLOAD | USB_DFU_ATTRIBUTES_WILL_DETACH, \
-	                     	                     200, /* maximum time in milliseconds to detach (and reboot) */ \
-	                     	                     1024, /* maximum transfer size */ \
-	                     	                     0x0110 /*< DFU specification version 1.1 used */ )
+	                     	                     0, /**< detaching makes only sense in run-time mode */ \
+	                     	                     1024, /**< transfer size corresponds to page size for optimal flash writing */ \
+	                     	                     0x0110 /**< DFU specification version 1.1 used */ )
 
 #define DFUD_STR_DESCES \
 	CONF_USB_DFUD_LANGID_DESC \
diff --git a/usb/class/dfu/usb_protocol_dfu.h b/usb/class/dfu/usb_protocol_dfu.h
index 24ec78f..9d5ba17 100644
--- a/usb/class/dfu/usb_protocol_dfu.h
+++ b/usb/class/dfu/usb_protocol_dfu.h
@@ -79,15 +79,15 @@
 
 //! DFU Functional Descriptor
 typedef struct usb_dfu_func_desc {
-	uint8_t bFunctionLength;
-	uint8_t bDescriptorType;
-	uint8_t bmAttributes;
-	le16_t  wDetachTimeOut;
-	le16_t  wTransferSize;
-	le16_t  bcdDFUVersion;
+	uint8_t bFunctionLength; /**< Size of this descriptor, in bytes (always 9) */
+	uint8_t bDescriptorType; /**< DFU FUNCTIONAL descriptor type (always 0x21) */
+	uint8_t bmAttributes; /**< DFU attributes bit mask */
+	le16_t  wDetachTimeOut; /**< Time, in milliseconds, that the device will wait after receipt of the DFU_DETACH request */
+	le16_t  wTransferSize; /**< Maximum number of bytes that the device can accept per control-write transaction */
+	le16_t  bcdDFUVersion; /**< Numeric expression identifying the version of the DFU Specification release */
 } usb_dfu_func_desc_t;
 
-#define USB_DFU_FUNC_DESC_LEN 0x09
+#define USB_DFU_FUNC_DESC_LEN 9
 #define USB_DFU_FUNC_DESC_TYPE 0x21
 #define USB_DFU_FUNC_DESC_BYTES(bmAttributes, wDetachTimeOut, wTransferSize, bcdDFUVersion) \
 	USB_DFU_FUNC_DESC_LEN, /* bFunctionLength */ \

-- 
To view, visit https://gerrit.osmocom.org/12499
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-asf4-dfu
Gerrit-Branch: master
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ia1d6ef4e4a5c9929aefd149c4e3eaf2dfe37fea8
Gerrit-Change-Number: 12499
Gerrit-PatchSet: 1
Gerrit-Owner: Kévin Redon <kredon at sysmocom.de>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20190109/3918b290/attachment.htm>