|
|
@@ -26,7 +26,7 @@
|
|
|
|
|
|
#include "tusb_option.h"
|
|
|
|
|
|
-#if (TUSB_OPT_DEVICE_ENABLED && CFG_TUD_DFU_MODE)
|
|
|
+#if (TUSB_OPT_DEVICE_ENABLED && CFG_TUD_DFU)
|
|
|
|
|
|
#include "device/usbd.h"
|
|
|
#include "device/usbd_pvt.h"
|
|
|
@@ -40,24 +40,34 @@
|
|
|
//--------------------------------------------------------------------+
|
|
|
// INTERNAL OBJECT & FUNCTION DECLARATION
|
|
|
//--------------------------------------------------------------------+
|
|
|
-typedef struct TU_ATTR_PACKED
|
|
|
+typedef struct
|
|
|
{
|
|
|
- dfu_device_status_t status;
|
|
|
- dfu_state_t state;
|
|
|
- uint8_t attrs;
|
|
|
- bool blk_transfer_in_proc;
|
|
|
- CFG_TUSB_MEM_ALIGN uint8_t transfer_buf[CFG_TUD_DFU_TRANSFER_BUFFER_SIZE];
|
|
|
+ uint8_t attrs;
|
|
|
+ uint8_t alt;
|
|
|
+
|
|
|
+ dfu_state_t state;
|
|
|
+ dfu_status_t status;
|
|
|
+
|
|
|
+ bool flashing_in_progress;
|
|
|
+ uint16_t block;
|
|
|
+ uint16_t length;
|
|
|
+
|
|
|
+ CFG_TUSB_MEM_ALIGN uint8_t transfer_buf[CFG_TUD_DFU_XFER_BUFSIZE];
|
|
|
} dfu_state_ctx_t;
|
|
|
|
|
|
// Only a single dfu state is allowed
|
|
|
-CFG_TUSB_MEM_SECTION static dfu_state_ctx_t _dfu_state_ctx;
|
|
|
+CFG_TUSB_MEM_SECTION static dfu_state_ctx_t _dfu_ctx;
|
|
|
|
|
|
+static void reset_state(void)
|
|
|
+{
|
|
|
+ _dfu_ctx.state = DFU_IDLE;
|
|
|
+ _dfu_ctx.status = DFU_STATUS_OK;
|
|
|
+ _dfu_ctx.flashing_in_progress = false;
|
|
|
+}
|
|
|
|
|
|
-static void dfu_req_dnload_setup(uint8_t rhport, tusb_control_request_t const * request);
|
|
|
-static void dfu_req_getstatus_reply(uint8_t rhport, tusb_control_request_t const * request);
|
|
|
-static uint16_t dfu_req_upload(uint8_t rhport, tusb_control_request_t const * request, uint16_t block_num, uint16_t wLength);
|
|
|
-static void dfu_req_dnload_reply(uint8_t rhport, tusb_control_request_t const * request);
|
|
|
-static bool dfu_state_machine(uint8_t rhport, tusb_control_request_t const * request);
|
|
|
+static bool reply_getstatus(uint8_t rhport, tusb_control_request_t const * request, dfu_state_t state, dfu_status_t status, uint32_t timeout);
|
|
|
+static bool process_download_get_status(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request);
|
|
|
+static bool process_manifest_get_status(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request);
|
|
|
|
|
|
//--------------------------------------------------------------------+
|
|
|
// Debug
|
|
|
@@ -66,13 +76,13 @@ static bool dfu_state_machine(uint8_t rhport, tusb_control_request_t const * req
|
|
|
|
|
|
static tu_lookup_entry_t const _dfu_request_lookup[] =
|
|
|
{
|
|
|
- { .key = DFU_REQUEST_DETACH , .data = "DETACH" },
|
|
|
- { .key = DFU_REQUEST_DNLOAD , .data = "DNLOAD" },
|
|
|
- { .key = DFU_REQUEST_UPLOAD , .data = "UPLOAD" },
|
|
|
+ { .key = DFU_REQUEST_DETACH , .data = "DETACH" },
|
|
|
+ { .key = DFU_REQUEST_DNLOAD , .data = "DNLOAD" },
|
|
|
+ { .key = DFU_REQUEST_UPLOAD , .data = "UPLOAD" },
|
|
|
{ .key = DFU_REQUEST_GETSTATUS , .data = "GETSTATUS" },
|
|
|
{ .key = DFU_REQUEST_CLRSTATUS , .data = "CLRSTATUS" },
|
|
|
- { .key = DFU_REQUEST_GETSTATE , .data = "GETSTATE" },
|
|
|
- { .key = DFU_REQUEST_ABORT , .data = "ABORT" },
|
|
|
+ { .key = DFU_REQUEST_GETSTATE , .data = "GETSTATE" },
|
|
|
+ { .key = DFU_REQUEST_ABORT , .data = "ABORT" },
|
|
|
};
|
|
|
|
|
|
static tu_lookup_table_t const _dfu_request_table =
|
|
|
@@ -83,17 +93,17 @@ static tu_lookup_table_t const _dfu_request_table =
|
|
|
|
|
|
static tu_lookup_entry_t const _dfu_state_lookup[] =
|
|
|
{
|
|
|
- { .key = APP_IDLE , .data = "APP_IDLE" },
|
|
|
- { .key = APP_DETACH , .data = "APP_DETACH" },
|
|
|
- { .key = DFU_IDLE , .data = "DFU_IDLE" },
|
|
|
- { .key = DFU_DNLOAD_SYNC , .data = "DFU_DNLOAD_SYNC" },
|
|
|
- { .key = DFU_DNBUSY , .data = "DFU_DNBUSY" },
|
|
|
- { .key = DFU_DNLOAD_IDLE , .data = "DFU_DNLOAD_IDLE" },
|
|
|
- { .key = DFU_MANIFEST_SYNC , .data = "DFU_MANIFEST_SYNC" },
|
|
|
- { .key = DFU_MANIFEST , .data = "DFU_MANIFEST" },
|
|
|
- { .key = DFU_MANIFEST_WAIT_RESET , .data = "DFU_MANIFEST_WAIT_RESET" },
|
|
|
- { .key = DFU_UPLOAD_IDLE , .data = "DFU_UPLOAD_IDLE" },
|
|
|
- { .key = DFU_ERROR , .data = "DFU_ERROR" },
|
|
|
+ { .key = APP_IDLE , .data = "APP_IDLE" },
|
|
|
+ { .key = APP_DETACH , .data = "APP_DETACH" },
|
|
|
+ { .key = DFU_IDLE , .data = "IDLE" },
|
|
|
+ { .key = DFU_DNLOAD_SYNC , .data = "DNLOAD_SYNC" },
|
|
|
+ { .key = DFU_DNBUSY , .data = "DNBUSY" },
|
|
|
+ { .key = DFU_DNLOAD_IDLE , .data = "DNLOAD_IDLE" },
|
|
|
+ { .key = DFU_MANIFEST_SYNC , .data = "MANIFEST_SYNC" },
|
|
|
+ { .key = DFU_MANIFEST , .data = "MANIFEST" },
|
|
|
+ { .key = DFU_MANIFEST_WAIT_RESET , .data = "MANIFEST_WAIT_RESET" },
|
|
|
+ { .key = DFU_UPLOAD_IDLE , .data = "UPLOAD_IDLE" },
|
|
|
+ { .key = DFU_ERROR , .data = "ERROR" },
|
|
|
};
|
|
|
|
|
|
static tu_lookup_table_t const _dfu_state_table =
|
|
|
@@ -104,22 +114,22 @@ static tu_lookup_table_t const _dfu_state_table =
|
|
|
|
|
|
static tu_lookup_entry_t const _dfu_status_lookup[] =
|
|
|
{
|
|
|
- { .key = DFU_STATUS_OK , .data = "OK" },
|
|
|
- { .key = DFU_STATUS_ERRTARGET , .data = "errTARGET" },
|
|
|
- { .key = DFU_STATUS_ERRFILE , .data = "errFILE" },
|
|
|
- { .key = DFU_STATUS_ERRWRITE , .data = "errWRITE" },
|
|
|
- { .key = DFU_STATUS_ERRERASE , .data = "errERASE" },
|
|
|
- { .key = DFU_STATUS_ERRCHECK_ERASED , .data = "errCHECK_ERASED" },
|
|
|
- { .key = DFU_STATUS_ERRPROG , .data = "errPROG" },
|
|
|
- { .key = DFU_STATUS_ERRVERIFY , .data = "errVERIFY" },
|
|
|
- { .key = DFU_STATUS_ERRADDRESS , .data = "errADDRESS" },
|
|
|
- { .key = DFU_STATUS_ERRNOTDONE , .data = "errNOTDONE" },
|
|
|
- { .key = DFU_STATUS_ERRFIRMWARE , .data = "errFIRMWARE" },
|
|
|
- { .key = DFU_STATUS_ERRVENDOR , .data = "errVENDOR" },
|
|
|
- { .key = DFU_STATUS_ERRUSBR , .data = "errUSBR" },
|
|
|
- { .key = DFU_STATUS_ERRPOR , .data = "errPOR" },
|
|
|
- { .key = DFU_STATUS_ERRUNKNOWN , .data = "errUNKNOWN" },
|
|
|
- { .key = DFU_STATUS_ERRSTALLEDPKT , .data = "errSTALLEDPKT" },
|
|
|
+ { .key = DFU_STATUS_OK , .data = "OK" },
|
|
|
+ { .key = DFU_STATUS_ERR_TARGET , .data = "errTARGET" },
|
|
|
+ { .key = DFU_STATUS_ERR_FILE , .data = "errFILE" },
|
|
|
+ { .key = DFU_STATUS_ERR_WRITE , .data = "errWRITE" },
|
|
|
+ { .key = DFU_STATUS_ERR_ERASE , .data = "errERASE" },
|
|
|
+ { .key = DFU_STATUS_ERR_CHECK_ERASED , .data = "errCHECK_ERASED" },
|
|
|
+ { .key = DFU_STATUS_ERR_PROG , .data = "errPROG" },
|
|
|
+ { .key = DFU_STATUS_ERR_VERIFY , .data = "errVERIFY" },
|
|
|
+ { .key = DFU_STATUS_ERR_ADDRESS , .data = "errADDRESS" },
|
|
|
+ { .key = DFU_STATUS_ERR_NOTDONE , .data = "errNOTDONE" },
|
|
|
+ { .key = DFU_STATUS_ERR_FIRMWARE , .data = "errFIRMWARE" },
|
|
|
+ { .key = DFU_STATUS_ERR_VENDOR , .data = "errVENDOR" },
|
|
|
+ { .key = DFU_STATUS_ERR_USBR , .data = "errUSBR" },
|
|
|
+ { .key = DFU_STATUS_ERR_POR , .data = "errPOR" },
|
|
|
+ { .key = DFU_STATUS_ERR_UNKNOWN , .data = "errUNKNOWN" },
|
|
|
+ { .key = DFU_STATUS_ERR_STALLEDPKT , .data = "errSTALLEDPKT" },
|
|
|
};
|
|
|
|
|
|
static tu_lookup_table_t const _dfu_status_table =
|
|
|
@@ -130,57 +140,59 @@ static tu_lookup_table_t const _dfu_status_table =
|
|
|
|
|
|
#endif
|
|
|
|
|
|
-#define dfu_debug_print_context() \
|
|
|
-{ \
|
|
|
- TU_LOG2(" DFU at State: %s\r\n Status: %s\r\n", \
|
|
|
- tu_lookup_find(&_dfu_state_table, _dfu_state_ctx.state), \
|
|
|
- tu_lookup_find(&_dfu_status_table, _dfu_state_ctx.status) ); \
|
|
|
-}
|
|
|
-
|
|
|
//--------------------------------------------------------------------+
|
|
|
// USBD Driver API
|
|
|
//--------------------------------------------------------------------+
|
|
|
-void dfu_moded_init(void)
|
|
|
+void dfu_moded_reset(uint8_t rhport)
|
|
|
{
|
|
|
- _dfu_state_ctx.state = DFU_IDLE;
|
|
|
- _dfu_state_ctx.status = DFU_STATUS_OK;
|
|
|
- _dfu_state_ctx.attrs = 0;
|
|
|
- _dfu_state_ctx.blk_transfer_in_proc = false;
|
|
|
+ (void) rhport;
|
|
|
+
|
|
|
+ _dfu_ctx.attrs = 0;
|
|
|
+ _dfu_ctx.alt = 0;
|
|
|
|
|
|
- dfu_debug_print_context();
|
|
|
+ reset_state();
|
|
|
}
|
|
|
|
|
|
-void dfu_moded_reset(uint8_t rhport)
|
|
|
+void dfu_moded_init(void)
|
|
|
{
|
|
|
- (void) rhport;
|
|
|
-
|
|
|
- _dfu_state_ctx.state = DFU_IDLE;
|
|
|
- _dfu_state_ctx.status = DFU_STATUS_OK;
|
|
|
- _dfu_state_ctx.blk_transfer_in_proc = false;
|
|
|
- dfu_debug_print_context();
|
|
|
+ dfu_moded_reset(0);
|
|
|
}
|
|
|
|
|
|
uint16_t dfu_moded_open(uint8_t rhport, tusb_desc_interface_t const * itf_desc, uint16_t max_len)
|
|
|
{
|
|
|
(void) rhport;
|
|
|
- (void) max_len;
|
|
|
-
|
|
|
- // Ensure this is DFU Mode
|
|
|
- TU_VERIFY((itf_desc->bInterfaceSubClass == TUD_DFU_APP_SUBCLASS) &&
|
|
|
- (itf_desc->bInterfaceProtocol == DFU_PROTOCOL_DFU), 0);
|
|
|
|
|
|
- uint8_t const * p_desc = tu_desc_next( itf_desc );
|
|
|
- uint16_t drv_len = sizeof(tusb_desc_interface_t);
|
|
|
+ //------------- Interface (with Alt) descriptor -------------//
|
|
|
+ uint8_t const itf_num = itf_desc->bInterfaceNumber;
|
|
|
+ uint8_t alt_count = 0;
|
|
|
|
|
|
- if ( TUSB_DESC_FUNCTIONAL == tu_desc_type(p_desc) )
|
|
|
+ uint16_t drv_len = 0;
|
|
|
+ while(itf_desc->bInterfaceSubClass == TUD_DFU_APP_SUBCLASS && itf_desc->bInterfaceProtocol == DFU_PROTOCOL_DFU)
|
|
|
{
|
|
|
- tusb_desc_dfu_functional_t const *dfu_desc = (tusb_desc_dfu_functional_t const *)p_desc;
|
|
|
- _dfu_state_ctx.attrs = (uint8_t)dfu_desc->bAttributes;
|
|
|
+ TU_ASSERT(max_len > drv_len, 0);
|
|
|
+
|
|
|
+ // Alternate must have the same interface number
|
|
|
+ TU_ASSERT(itf_desc->bInterfaceNumber == itf_num, 0);
|
|
|
|
|
|
- drv_len += tu_desc_len(p_desc);
|
|
|
- p_desc = tu_desc_next(p_desc);
|
|
|
+ // Alt should increase by one every time
|
|
|
+ TU_ASSERT(itf_desc->bAlternateSetting == alt_count, 0);
|
|
|
+ alt_count++;
|
|
|
+
|
|
|
+ drv_len += tu_desc_len(itf_desc);
|
|
|
+ itf_desc = (tusb_desc_interface_t const *) tu_desc_next(itf_desc);
|
|
|
}
|
|
|
|
|
|
+ //------------- DFU Functional descriptor -------------//
|
|
|
+ tusb_desc_dfu_functional_t const *func_desc = (tusb_desc_dfu_functional_t const *) itf_desc;
|
|
|
+ TU_ASSERT(tu_desc_type(func_desc) == TUSB_DESC_FUNCTIONAL, 0);
|
|
|
+ drv_len += sizeof(tusb_desc_dfu_functional_t);
|
|
|
+
|
|
|
+ _dfu_ctx.attrs = func_desc->bAttributes;
|
|
|
+
|
|
|
+ // CFG_TUD_DFU_XFER_BUFSIZE has to be set to the buffer size used in TUD_DFU_DESCRIPTOR
|
|
|
+ uint16_t const transfer_size = tu_le16toh( tu_unaligned_read16(&func_desc->wTransferSize) );
|
|
|
+ TU_ASSERT(transfer_size <= CFG_TUD_DFU_XFER_BUFSIZE, drv_len);
|
|
|
+
|
|
|
return drv_len;
|
|
|
}
|
|
|
|
|
|
@@ -189,434 +201,258 @@ uint16_t dfu_moded_open(uint8_t rhport, tusb_desc_interface_t const * itf_desc,
|
|
|
// return false to stall control endpoint (e.g unsupported request)
|
|
|
bool dfu_moded_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request)
|
|
|
{
|
|
|
- // nothing to do with DATA stage
|
|
|
- if ( stage == CONTROL_STAGE_DATA ) return true;
|
|
|
-
|
|
|
TU_VERIFY(request->bmRequestType_bit.recipient == TUSB_REQ_RCPT_INTERFACE);
|
|
|
|
|
|
- if(stage == CONTROL_STAGE_SETUP)
|
|
|
- {
|
|
|
- // dfu-util will try to claim the interface with SET_INTERFACE request before sending DFU request
|
|
|
- if ( TUSB_REQ_TYPE_STANDARD == request->bmRequestType_bit.type &&
|
|
|
- TUSB_REQ_SET_INTERFACE == request->bRequest )
|
|
|
- {
|
|
|
- tud_control_status(rhport, request);
|
|
|
- return true;
|
|
|
- }
|
|
|
- }
|
|
|
-
|
|
|
- // Handle class request only from here
|
|
|
- TU_VERIFY(request->bmRequestType_bit.type == TUSB_REQ_TYPE_CLASS);
|
|
|
+ TU_LOG2(" DFU State : %s, Status: %s\r\n", tu_lookup_find(&_dfu_state_table, _dfu_ctx.state), tu_lookup_find(&_dfu_status_table, _dfu_ctx.status));
|
|
|
|
|
|
- switch (request->bRequest)
|
|
|
+ if ( request->bmRequestType_bit.type == TUSB_REQ_TYPE_STANDARD )
|
|
|
{
|
|
|
- case DFU_REQUEST_DNLOAD:
|
|
|
- {
|
|
|
- if ( (stage == CONTROL_STAGE_ACK)
|
|
|
- && ((_dfu_state_ctx.attrs & DFU_FUNC_ATTR_CAN_DOWNLOAD_BITMASK) != 0)
|
|
|
- && (_dfu_state_ctx.state == DFU_DNLOAD_SYNC))
|
|
|
- {
|
|
|
- dfu_req_dnload_reply(rhport, request);
|
|
|
- return true;
|
|
|
- }
|
|
|
- } // fallthrough
|
|
|
- case DFU_REQUEST_DETACH:
|
|
|
- case DFU_REQUEST_UPLOAD:
|
|
|
- case DFU_REQUEST_GETSTATUS:
|
|
|
- case DFU_REQUEST_CLRSTATUS:
|
|
|
- case DFU_REQUEST_GETSTATE:
|
|
|
- case DFU_REQUEST_ABORT:
|
|
|
+ // Standard request include GET/SET_INTERFACE
|
|
|
+ switch ( request->bRequest )
|
|
|
{
|
|
|
- if(stage == CONTROL_STAGE_SETUP)
|
|
|
- {
|
|
|
- return dfu_state_machine(rhport, request);
|
|
|
- }
|
|
|
- }
|
|
|
- break;
|
|
|
+ case TUSB_REQ_SET_INTERFACE:
|
|
|
+ if ( stage == CONTROL_STAGE_SETUP )
|
|
|
+ {
|
|
|
+ // Switch Alt interface and reset state machine
|
|
|
+ _dfu_ctx.alt = (uint8_t) request->wValue;
|
|
|
+ reset_state();
|
|
|
+ return tud_control_status(rhport, request);
|
|
|
+ }
|
|
|
+ break;
|
|
|
|
|
|
- default:
|
|
|
- {
|
|
|
- TU_LOG2(" DFU Nonstandard Request: %u\r\n", request->bRequest);
|
|
|
- return false; // stall unsupported request
|
|
|
+ case TUSB_REQ_GET_INTERFACE:
|
|
|
+ if(stage == CONTROL_STAGE_SETUP)
|
|
|
+ {
|
|
|
+ return tud_control_xfer(rhport, request, &_dfu_ctx.alt, 1);
|
|
|
+ }
|
|
|
+ break;
|
|
|
+
|
|
|
+ // unsupported request
|
|
|
+ default: return false;
|
|
|
}
|
|
|
- break;
|
|
|
}
|
|
|
-
|
|
|
- return true;
|
|
|
-}
|
|
|
-
|
|
|
-static uint16_t dfu_req_upload(uint8_t rhport, tusb_control_request_t const * request, uint16_t block_num, uint16_t wLength)
|
|
|
-{
|
|
|
- TU_VERIFY( wLength <= CFG_TUD_DFU_TRANSFER_BUFFER_SIZE, 0);
|
|
|
- uint16_t retval = tud_dfu_req_upload_data_cb(block_num, (uint8_t *)_dfu_state_ctx.transfer_buf, wLength);
|
|
|
- tud_control_xfer(rhport, request, _dfu_state_ctx.transfer_buf, retval);
|
|
|
- return retval;
|
|
|
-}
|
|
|
-
|
|
|
-static void dfu_req_getstatus_reply(uint8_t rhport, tusb_control_request_t const * request)
|
|
|
-{
|
|
|
- dfu_status_req_payload_t resp;
|
|
|
-
|
|
|
- resp.bStatus = _dfu_state_ctx.status;
|
|
|
- memset((uint8_t *)&resp.bwPollTimeout, 0x00, 3);
|
|
|
- resp.bState = _dfu_state_ctx.state;
|
|
|
- resp.iString = 0;
|
|
|
-
|
|
|
- tud_control_xfer(rhport, request, &resp, sizeof(dfu_status_req_payload_t));
|
|
|
-}
|
|
|
-
|
|
|
-static void dfu_req_getstate_reply(uint8_t rhport, tusb_control_request_t const * request)
|
|
|
-{
|
|
|
- tud_control_xfer(rhport, request, &_dfu_state_ctx.state, 1);
|
|
|
-}
|
|
|
-
|
|
|
-static void dfu_req_dnload_setup(uint8_t rhport, tusb_control_request_t const * request)
|
|
|
-{
|
|
|
- // TODO: add "zero" copy mode so the buffer we read into can be provided by the user
|
|
|
- // if they wish, there still will be the internal control buffer copy to this buffer
|
|
|
- // but this mode would provide zero copy from the class driver to the application
|
|
|
-
|
|
|
- TU_VERIFY( request->wLength <= CFG_TUD_DFU_TRANSFER_BUFFER_SIZE, );
|
|
|
- // setup for data phase
|
|
|
- tud_control_xfer(rhport, request, _dfu_state_ctx.transfer_buf, request->wLength);
|
|
|
-}
|
|
|
-
|
|
|
-static void dfu_req_dnload_reply(uint8_t rhport, tusb_control_request_t const * request)
|
|
|
-{
|
|
|
- (void) rhport;
|
|
|
- TU_VERIFY( request->wLength <= CFG_TUD_DFU_TRANSFER_BUFFER_SIZE, );
|
|
|
- tud_dfu_req_dnload_data_cb(request->wValue, (uint8_t *)_dfu_state_ctx.transfer_buf, request->wLength);
|
|
|
- _dfu_state_ctx.blk_transfer_in_proc = false;
|
|
|
-}
|
|
|
-
|
|
|
-void tud_dfu_dnload_complete(void)
|
|
|
-{
|
|
|
- if (_dfu_state_ctx.state == DFU_DNBUSY)
|
|
|
- {
|
|
|
- _dfu_state_ctx.state = DFU_DNLOAD_SYNC;
|
|
|
- } else if (_dfu_state_ctx.state == DFU_MANIFEST)
|
|
|
+ else if ( request->bmRequestType_bit.type == TUSB_REQ_TYPE_CLASS )
|
|
|
{
|
|
|
- _dfu_state_ctx.state = ((_dfu_state_ctx.attrs & DFU_FUNC_ATTR_MANIFESTATION_TOLERANT_BITMASK) != 0)
|
|
|
- ? DFU_MANIFEST_WAIT_RESET : DFU_MANIFEST_SYNC;
|
|
|
- }
|
|
|
-}
|
|
|
-
|
|
|
-static bool dfu_state_machine(uint8_t rhport, tusb_control_request_t const * request)
|
|
|
-{
|
|
|
- TU_LOG2(" DFU Request: %s\r\n", tu_lookup_find(&_dfu_request_table, request->bRequest));
|
|
|
- TU_LOG2(" DFU State Machine: %s\r\n", tu_lookup_find(&_dfu_state_table, _dfu_state_ctx.state));
|
|
|
+ TU_LOG2(" DFU Request: %s\r\n", tu_lookup_find(&_dfu_request_table, request->bRequest));
|
|
|
|
|
|
- switch (_dfu_state_ctx.state)
|
|
|
- {
|
|
|
- case DFU_IDLE:
|
|
|
+ // Class request
|
|
|
+ switch ( request->bRequest )
|
|
|
{
|
|
|
- switch (request->bRequest)
|
|
|
- {
|
|
|
- case DFU_REQUEST_DNLOAD:
|
|
|
+ case DFU_REQUEST_DETACH:
|
|
|
+ if ( stage == CONTROL_STAGE_SETUP )
|
|
|
{
|
|
|
- if( ((_dfu_state_ctx.attrs & DFU_FUNC_ATTR_CAN_DOWNLOAD_BITMASK) != 0)
|
|
|
- && (request->wLength > 0) )
|
|
|
- {
|
|
|
- _dfu_state_ctx.state = DFU_DNLOAD_SYNC;
|
|
|
- _dfu_state_ctx.blk_transfer_in_proc = true;
|
|
|
- dfu_req_dnload_setup(rhport, request);
|
|
|
- } else {
|
|
|
- _dfu_state_ctx.state = DFU_ERROR;
|
|
|
- }
|
|
|
+ tud_control_status(rhport, request);
|
|
|
}
|
|
|
- break;
|
|
|
-
|
|
|
- case DFU_REQUEST_UPLOAD:
|
|
|
+ else if ( stage == CONTROL_STAGE_ACK )
|
|
|
{
|
|
|
- if( ((_dfu_state_ctx.attrs & DFU_FUNC_ATTR_CAN_UPLOAD_BITMASK) != 0) )
|
|
|
- {
|
|
|
- _dfu_state_ctx.state = DFU_UPLOAD_IDLE;
|
|
|
- dfu_req_upload(rhport, request, request->wValue, request->wLength);
|
|
|
- } else {
|
|
|
- _dfu_state_ctx.state = DFU_ERROR;
|
|
|
- }
|
|
|
+ if ( tud_dfu_detach_cb ) tud_dfu_detach_cb();
|
|
|
}
|
|
|
- break;
|
|
|
+ break;
|
|
|
|
|
|
- case DFU_REQUEST_GETSTATUS:
|
|
|
+ case DFU_REQUEST_CLRSTATUS:
|
|
|
+ if ( stage == CONTROL_STAGE_SETUP )
|
|
|
{
|
|
|
- dfu_req_getstatus_reply(rhport, request);
|
|
|
+ reset_state();
|
|
|
+ tud_control_status(rhport, request);
|
|
|
}
|
|
|
- break;
|
|
|
+ break;
|
|
|
|
|
|
- case DFU_REQUEST_GETSTATE:
|
|
|
+ case DFU_REQUEST_GETSTATE:
|
|
|
+ if ( stage == CONTROL_STAGE_SETUP )
|
|
|
{
|
|
|
- dfu_req_getstate_reply(rhport, request);
|
|
|
+ tud_control_xfer(rhport, request, &_dfu_ctx.state, 1);
|
|
|
}
|
|
|
- break;
|
|
|
+ break;
|
|
|
|
|
|
- case DFU_REQUEST_ABORT:
|
|
|
+ case DFU_REQUEST_ABORT:
|
|
|
+ if ( stage == CONTROL_STAGE_SETUP )
|
|
|
{
|
|
|
- ; // do nothing, but don't stall so continue on
|
|
|
+ reset_state();
|
|
|
+ tud_control_status(rhport, request);
|
|
|
}
|
|
|
- break;
|
|
|
-
|
|
|
- default:
|
|
|
+ else if ( stage == CONTROL_STAGE_ACK )
|
|
|
{
|
|
|
- _dfu_state_ctx.state = DFU_ERROR;
|
|
|
- return false; // stall on all other requests
|
|
|
+ if ( tud_dfu_abort_cb ) tud_dfu_abort_cb(_dfu_ctx.alt);
|
|
|
}
|
|
|
- break;
|
|
|
- }
|
|
|
- }
|
|
|
- break;
|
|
|
+ break;
|
|
|
|
|
|
- case DFU_DNLOAD_SYNC:
|
|
|
- {
|
|
|
- switch (request->bRequest)
|
|
|
- {
|
|
|
- case DFU_REQUEST_GETSTATUS:
|
|
|
+ case DFU_REQUEST_UPLOAD:
|
|
|
+ if ( stage == CONTROL_STAGE_SETUP )
|
|
|
{
|
|
|
- if ( _dfu_state_ctx.blk_transfer_in_proc )
|
|
|
- {
|
|
|
- _dfu_state_ctx.state = DFU_DNBUSY;
|
|
|
- dfu_req_getstatus_reply(rhport, request);
|
|
|
- } else {
|
|
|
- _dfu_state_ctx.state = DFU_DNLOAD_IDLE;
|
|
|
- dfu_req_getstatus_reply(rhport, request);
|
|
|
- }
|
|
|
- }
|
|
|
- break;
|
|
|
+ TU_VERIFY(_dfu_ctx.attrs & DFU_ATTR_CAN_UPLOAD);
|
|
|
+ TU_VERIFY(tud_dfu_upload_cb);
|
|
|
+ TU_VERIFY(request->wLength <= CFG_TUD_DFU_XFER_BUFSIZE);
|
|
|
|
|
|
- case DFU_REQUEST_GETSTATE:
|
|
|
- {
|
|
|
- dfu_req_getstate_reply(rhport, request);
|
|
|
- }
|
|
|
- break;
|
|
|
+ uint16_t const xfer_len = tud_dfu_upload_cb(_dfu_ctx.alt, request->wValue, _dfu_ctx.transfer_buf, request->wLength);
|
|
|
|
|
|
- default:
|
|
|
- {
|
|
|
- _dfu_state_ctx.state = DFU_ERROR;
|
|
|
- return false; // stall on all other requests
|
|
|
+ return tud_control_xfer(rhport, request, _dfu_ctx.transfer_buf, xfer_len);
|
|
|
}
|
|
|
- break;
|
|
|
- }
|
|
|
- }
|
|
|
- break;
|
|
|
+ break;
|
|
|
|
|
|
- case DFU_DNBUSY:
|
|
|
- {
|
|
|
- switch (request->bRequest)
|
|
|
- {
|
|
|
- default:
|
|
|
+ case DFU_REQUEST_DNLOAD:
|
|
|
+ if ( stage == CONTROL_STAGE_SETUP )
|
|
|
{
|
|
|
- _dfu_state_ctx.state = DFU_ERROR;
|
|
|
- return false; // stall on all other requests
|
|
|
- }
|
|
|
- break;
|
|
|
- }
|
|
|
- }
|
|
|
- break;
|
|
|
+ TU_VERIFY(_dfu_ctx.attrs & DFU_ATTR_CAN_DOWNLOAD);
|
|
|
+ TU_VERIFY(_dfu_ctx.state == DFU_IDLE || _dfu_ctx.state == DFU_DNLOAD_IDLE);
|
|
|
+ TU_VERIFY(request->wLength <= CFG_TUD_DFU_XFER_BUFSIZE);
|
|
|
|
|
|
- case DFU_DNLOAD_IDLE:
|
|
|
- {
|
|
|
- switch (request->bRequest)
|
|
|
- {
|
|
|
- case DFU_REQUEST_DNLOAD:
|
|
|
- {
|
|
|
- if( ((_dfu_state_ctx.attrs & DFU_FUNC_ATTR_CAN_DOWNLOAD_BITMASK) != 0)
|
|
|
- && (request->wLength > 0) )
|
|
|
- {
|
|
|
- _dfu_state_ctx.state = DFU_DNLOAD_SYNC;
|
|
|
- _dfu_state_ctx.blk_transfer_in_proc = true;
|
|
|
- dfu_req_dnload_setup(rhport, request);
|
|
|
- } else {
|
|
|
- if ( tud_dfu_device_data_done_check_cb() )
|
|
|
- {
|
|
|
- _dfu_state_ctx.state = DFU_MANIFEST_SYNC;
|
|
|
- tud_control_status(rhport, request);
|
|
|
- } else {
|
|
|
- _dfu_state_ctx.state = DFU_ERROR;
|
|
|
- return false; // stall
|
|
|
- }
|
|
|
- }
|
|
|
- }
|
|
|
- break;
|
|
|
+ // set to true for both download and manifest
|
|
|
+ _dfu_ctx.flashing_in_progress = true;
|
|
|
+
|
|
|
+ // save block and length for flashing
|
|
|
+ _dfu_ctx.block = request->wValue;
|
|
|
+ _dfu_ctx.length = request->wLength;
|
|
|
|
|
|
- case DFU_REQUEST_GETSTATUS:
|
|
|
+ if ( request->wLength )
|
|
|
{
|
|
|
- dfu_req_getstatus_reply(rhport, request);
|
|
|
+ // Download with payload -> transition to DOWNLOAD SYNC
|
|
|
+ _dfu_ctx.state = DFU_DNLOAD_SYNC;
|
|
|
+ return tud_control_xfer(rhport, request, _dfu_ctx.transfer_buf, request->wLength);
|
|
|
}
|
|
|
- break;
|
|
|
-
|
|
|
- case DFU_REQUEST_GETSTATE:
|
|
|
+ else
|
|
|
{
|
|
|
- dfu_req_getstate_reply(rhport, request);
|
|
|
+ // Download is complete -> transition to MANIFEST SYNC
|
|
|
+ _dfu_ctx.state = DFU_MANIFEST_SYNC;
|
|
|
+ return tud_control_status(rhport, request);
|
|
|
}
|
|
|
+ }
|
|
|
+ break;
|
|
|
+
|
|
|
+ case DFU_REQUEST_GETSTATUS:
|
|
|
+ switch ( _dfu_ctx.state )
|
|
|
+ {
|
|
|
+ case DFU_DNLOAD_SYNC:
|
|
|
+ return process_download_get_status(rhport, stage, request);
|
|
|
break;
|
|
|
|
|
|
- case DFU_REQUEST_ABORT:
|
|
|
- {
|
|
|
- if ( tud_dfu_abort_cb )
|
|
|
- {
|
|
|
- tud_dfu_abort_cb();
|
|
|
- }
|
|
|
- _dfu_state_ctx.state = DFU_IDLE;
|
|
|
- }
|
|
|
+ case DFU_MANIFEST_SYNC:
|
|
|
+ return process_manifest_get_status(rhport, stage, request);
|
|
|
break;
|
|
|
|
|
|
default:
|
|
|
- {
|
|
|
- _dfu_state_ctx.state = DFU_ERROR;
|
|
|
- return false; // stall on all other requests
|
|
|
- }
|
|
|
+ if ( stage == CONTROL_STAGE_SETUP ) return reply_getstatus(rhport, request, _dfu_ctx.state, _dfu_ctx.status, 0);
|
|
|
break;
|
|
|
}
|
|
|
+ break;
|
|
|
+
|
|
|
+ default: return false; // stall unsupported request
|
|
|
}
|
|
|
- break;
|
|
|
+ }else
|
|
|
+ {
|
|
|
+ return false; // unsupported request
|
|
|
+ }
|
|
|
|
|
|
- case DFU_MANIFEST_SYNC:
|
|
|
- {
|
|
|
- switch (request->bRequest)
|
|
|
- {
|
|
|
- case DFU_REQUEST_GETSTATUS:
|
|
|
- {
|
|
|
- if ((_dfu_state_ctx.attrs & DFU_FUNC_ATTR_MANIFESTATION_TOLERANT_BITMASK) != 0)
|
|
|
- {
|
|
|
- _dfu_state_ctx.state = DFU_MANIFEST;
|
|
|
- dfu_req_getstatus_reply(rhport, request);
|
|
|
- } else {
|
|
|
- if ( tud_dfu_firmware_valid_check_cb() )
|
|
|
- {
|
|
|
- _dfu_state_ctx.state = DFU_IDLE;
|
|
|
- }
|
|
|
- dfu_req_getstatus_reply(rhport, request);
|
|
|
- }
|
|
|
- }
|
|
|
- break;
|
|
|
+ return true;
|
|
|
+}
|
|
|
|
|
|
- case DFU_REQUEST_GETSTATE:
|
|
|
- {
|
|
|
- dfu_req_getstate_reply(rhport, request);
|
|
|
- }
|
|
|
- break;
|
|
|
+void tud_dfu_finish_flashing(uint8_t status)
|
|
|
+{
|
|
|
+ _dfu_ctx.flashing_in_progress = false;
|
|
|
|
|
|
- default:
|
|
|
- {
|
|
|
- _dfu_state_ctx.state = DFU_ERROR;
|
|
|
- return false; // stall on all other requests
|
|
|
- }
|
|
|
- break;
|
|
|
- }
|
|
|
+ if ( status == DFU_STATUS_OK )
|
|
|
+ {
|
|
|
+ if (_dfu_ctx.state == DFU_DNBUSY)
|
|
|
+ {
|
|
|
+ _dfu_ctx.state = DFU_DNLOAD_SYNC;
|
|
|
}
|
|
|
- break;
|
|
|
-
|
|
|
- case DFU_MANIFEST:
|
|
|
+ else if (_dfu_ctx.state == DFU_MANIFEST)
|
|
|
{
|
|
|
- switch (request->bRequest)
|
|
|
- {
|
|
|
- default:
|
|
|
- {
|
|
|
- return false; // stall on all other requests
|
|
|
- }
|
|
|
- break;
|
|
|
- }
|
|
|
+ _dfu_ctx.state = (_dfu_ctx.attrs & DFU_ATTR_MANIFESTATION_TOLERANT)
|
|
|
+ ? DFU_MANIFEST_SYNC : DFU_MANIFEST_WAIT_RESET;
|
|
|
}
|
|
|
- break;
|
|
|
+ }
|
|
|
+ else
|
|
|
+ {
|
|
|
+ // failed while flashing, move to dfuError
|
|
|
+ _dfu_ctx.state = DFU_ERROR;
|
|
|
+ _dfu_ctx.status = status;
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+static bool process_download_get_status(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request)
|
|
|
+{
|
|
|
+ if ( stage == CONTROL_STAGE_SETUP )
|
|
|
+ {
|
|
|
+ // only transition to next state on CONTROL_STAGE_ACK
|
|
|
+ dfu_state_t next_state;
|
|
|
+ uint32_t timeout;
|
|
|
|
|
|
- case DFU_MANIFEST_WAIT_RESET:
|
|
|
+ if ( _dfu_ctx.flashing_in_progress )
|
|
|
{
|
|
|
- // technically we should never even get here, but we will handle it just in case
|
|
|
- TU_LOG2(" DFU was in DFU_MANIFEST_WAIT_RESET and got unexpected request: %u\r\n", request->bRequest);
|
|
|
- switch (request->bRequest)
|
|
|
- {
|
|
|
- default:
|
|
|
- {
|
|
|
- return false; // stall on all other requests
|
|
|
- }
|
|
|
- break;
|
|
|
- }
|
|
|
+ next_state = DFU_DNBUSY;
|
|
|
+ timeout = tud_dfu_get_timeout_cb(_dfu_ctx.alt, (uint8_t) next_state);
|
|
|
}
|
|
|
- break;
|
|
|
-
|
|
|
- case DFU_UPLOAD_IDLE:
|
|
|
+ else
|
|
|
{
|
|
|
- switch (request->bRequest)
|
|
|
- {
|
|
|
- case DFU_REQUEST_UPLOAD:
|
|
|
- {
|
|
|
- if (dfu_req_upload(rhport, request, request->wValue, request->wLength) != request->wLength)
|
|
|
- {
|
|
|
- _dfu_state_ctx.state = DFU_IDLE;
|
|
|
- }
|
|
|
- }
|
|
|
- break;
|
|
|
-
|
|
|
- case DFU_REQUEST_GETSTATUS:
|
|
|
- {
|
|
|
- dfu_req_getstatus_reply(rhport, request);
|
|
|
- }
|
|
|
- break;
|
|
|
-
|
|
|
- case DFU_REQUEST_GETSTATE:
|
|
|
- {
|
|
|
- dfu_req_getstate_reply(rhport, request);
|
|
|
- }
|
|
|
- break;
|
|
|
-
|
|
|
- case DFU_REQUEST_ABORT:
|
|
|
- {
|
|
|
- if (tud_dfu_abort_cb)
|
|
|
- {
|
|
|
- tud_dfu_abort_cb();
|
|
|
- }
|
|
|
- _dfu_state_ctx.state = DFU_IDLE;
|
|
|
- }
|
|
|
- break;
|
|
|
-
|
|
|
- default:
|
|
|
- {
|
|
|
- return false; // stall on all other requests
|
|
|
- }
|
|
|
- break;
|
|
|
- }
|
|
|
+ next_state = DFU_DNLOAD_IDLE;
|
|
|
+ timeout = 0;
|
|
|
}
|
|
|
- break;
|
|
|
|
|
|
- case DFU_ERROR:
|
|
|
+ return reply_getstatus(rhport, request, next_state, _dfu_ctx.status, timeout);
|
|
|
+ }
|
|
|
+ else if ( stage == CONTROL_STAGE_ACK )
|
|
|
+ {
|
|
|
+ if ( _dfu_ctx.flashing_in_progress )
|
|
|
{
|
|
|
- switch (request->bRequest)
|
|
|
- {
|
|
|
- case DFU_REQUEST_GETSTATUS:
|
|
|
- {
|
|
|
- dfu_req_getstatus_reply(rhport, request);
|
|
|
- }
|
|
|
- break;
|
|
|
+ _dfu_ctx.state = DFU_DNBUSY;
|
|
|
+ tud_dfu_download_cb(_dfu_ctx.alt, _dfu_ctx.block, _dfu_ctx.transfer_buf, _dfu_ctx.length);
|
|
|
+ }else
|
|
|
+ {
|
|
|
+ _dfu_ctx.state = DFU_DNLOAD_IDLE;
|
|
|
+ }
|
|
|
+ }
|
|
|
|
|
|
- case DFU_REQUEST_CLRSTATUS:
|
|
|
- {
|
|
|
- _dfu_state_ctx.state = DFU_IDLE;
|
|
|
- }
|
|
|
- break;
|
|
|
+ return true;
|
|
|
+}
|
|
|
|
|
|
- case DFU_REQUEST_GETSTATE:
|
|
|
- {
|
|
|
- dfu_req_getstate_reply(rhport, request);
|
|
|
- }
|
|
|
- break;
|
|
|
+static bool process_manifest_get_status(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request)
|
|
|
+{
|
|
|
+ if ( stage == CONTROL_STAGE_SETUP )
|
|
|
+ {
|
|
|
+ // only transition to next state on CONTROL_STAGE_ACK
|
|
|
+ dfu_state_t next_state;
|
|
|
+ uint32_t timeout;
|
|
|
|
|
|
- default:
|
|
|
- {
|
|
|
- return false; // stall on all other requests
|
|
|
- }
|
|
|
- break;
|
|
|
- }
|
|
|
+ if ( _dfu_ctx.flashing_in_progress )
|
|
|
+ {
|
|
|
+ next_state = DFU_MANIFEST;
|
|
|
+ timeout = tud_dfu_get_timeout_cb(_dfu_ctx.alt, next_state);
|
|
|
+ }
|
|
|
+ else
|
|
|
+ {
|
|
|
+ next_state = DFU_IDLE;
|
|
|
+ timeout = 0;
|
|
|
}
|
|
|
- break;
|
|
|
|
|
|
- default:
|
|
|
- _dfu_state_ctx.state = DFU_ERROR;
|
|
|
- TU_LOG2(" DFU ERROR: Unexpected state\r\nStalling control pipe\r\n");
|
|
|
- return false; // Unexpected state, stall and change to error
|
|
|
+ return reply_getstatus(rhport, request, next_state, _dfu_ctx.status, timeout);
|
|
|
+ }
|
|
|
+ else if ( stage == CONTROL_STAGE_ACK )
|
|
|
+ {
|
|
|
+ if ( _dfu_ctx.flashing_in_progress )
|
|
|
+ {
|
|
|
+ _dfu_ctx.state = DFU_MANIFEST;
|
|
|
+ tud_dfu_manifest_cb(_dfu_ctx.alt);
|
|
|
+ }
|
|
|
+ else
|
|
|
+ {
|
|
|
+ _dfu_ctx.state = DFU_IDLE;
|
|
|
+ }
|
|
|
}
|
|
|
|
|
|
return true;
|
|
|
}
|
|
|
|
|
|
+static bool reply_getstatus(uint8_t rhport, tusb_control_request_t const * request, dfu_state_t state, dfu_status_t status, uint32_t timeout)
|
|
|
+{
|
|
|
+ dfu_status_response_t resp;
|
|
|
+ resp.bStatus = (uint8_t) status;
|
|
|
+ resp.bwPollTimeout[0] = TU_U32_BYTE0(timeout);
|
|
|
+ resp.bwPollTimeout[1] = TU_U32_BYTE1(timeout);
|
|
|
+ resp.bwPollTimeout[2] = TU_U32_BYTE2(timeout);
|
|
|
+ resp.bState = (uint8_t) state;
|
|
|
+ resp.iString = 0;
|
|
|
+
|
|
|
+ return tud_control_xfer(rhport, request, &resp, sizeof(dfu_status_response_t));
|
|
|
+}
|
|
|
|
|
|
#endif
|