diff options
| author | Kévin Redon <kredon@sysmocom.de> | 2018-12-18 13:27:53 +0100 |
|---|---|---|
| committer | Kévin Redon <kredon@sysmocom.de> | 2019-01-16 18:40:31 +0100 |
| commit | c976a85af440ff2f1b4d274964870c0dadbf5198 (patch) | |
| tree | d7a1076c0325986b94dc847472a67f6298547d60 | |
| parent | 74a8e3b61594054e810c9e0833ae07832a7d7e49 (diff) | |
add documentation and fix timeout value
Change-Id: Ia1d6ef4e4a5c9929aefd149c4e3eaf2dfe37fea8
| -rw-r--r-- | usb/class/dfu/device/dfudf_desc.h | 6 | ||||
| -rw-r--r-- | usb/class/dfu/usb_protocol_dfu.h | 14 |
2 files changed, 10 insertions, 10 deletions
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 2e7323f..7f82743 100644 --- a/usb/class/dfu/usb_protocol_dfu.h +++ b/usb/class/dfu/usb_protocol_dfu.h @@ -79,15 +79,15 @@ COMPILER_PACK_SET(1) //! 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 */ \ |