Add DFU Class per Version 1.1 Spec
This commit is contained in:
parent
161b8587bd
commit
1138f8cc70
|
@ -0,0 +1,107 @@
|
||||||
|
/*
|
||||||
|
* The MIT License (MIT)
|
||||||
|
*
|
||||||
|
* Copyright (c) 2021 XMOS LIMITED
|
||||||
|
*
|
||||||
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
* of this software and associated documentation files (the "Software"), to deal
|
||||||
|
* in the Software without restriction, including without limitation the rights
|
||||||
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
* copies of the Software, and to permit persons to whom the Software is
|
||||||
|
* furnished to do so, subject to the following conditions:
|
||||||
|
*
|
||||||
|
* The above copyright notice and this permission notice shall be included in
|
||||||
|
* all copies or substantial portions of the Software.
|
||||||
|
*
|
||||||
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
|
* THE SOFTWARE.
|
||||||
|
*
|
||||||
|
* This file is part of the TinyUSB stack.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef _TUSB_DFU_H_
|
||||||
|
#define _TUSB_DFU_H_
|
||||||
|
|
||||||
|
#include "common/tusb_common.h"
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
//--------------------------------------------------------------------+
|
||||||
|
// Common Definitions
|
||||||
|
//--------------------------------------------------------------------+
|
||||||
|
// DFU Protocol
|
||||||
|
typedef enum
|
||||||
|
{
|
||||||
|
DFU_PROTOCOL_RT = 0x01,
|
||||||
|
DFU_PROTOCOL_DFU = 0x02,
|
||||||
|
} dfu_protocol_type_t;
|
||||||
|
|
||||||
|
// DFU Descriptor Type
|
||||||
|
typedef enum
|
||||||
|
{
|
||||||
|
DFU_DESC_FUNCTIONAL = 0x21,
|
||||||
|
} dfu_descriptor_type_t;
|
||||||
|
|
||||||
|
// DFU Requests
|
||||||
|
typedef enum {
|
||||||
|
DFU_REQUEST_DETACH = 0,
|
||||||
|
DFU_REQUEST_DNLOAD = 1,
|
||||||
|
DFU_REQUEST_UPLOAD = 2,
|
||||||
|
DFU_REQUEST_GETSTATUS = 3,
|
||||||
|
DFU_REQUEST_CLRSTATUS = 4,
|
||||||
|
DFU_REQUEST_GETSTATE = 5,
|
||||||
|
DFU_REQUEST_ABORT = 6,
|
||||||
|
} dfu_requests_t;
|
||||||
|
|
||||||
|
// DFU States
|
||||||
|
typedef enum {
|
||||||
|
APP_IDLE = 0,
|
||||||
|
APP_DETACH = 1,
|
||||||
|
DFU_IDLE = 2,
|
||||||
|
DFU_DNLOAD_SYNC = 3,
|
||||||
|
DFU_DNBUSY = 4,
|
||||||
|
DFU_DNLOAD_IDLE = 5,
|
||||||
|
DFU_MANIFEST_SYNC = 6,
|
||||||
|
DFU_MANIFEST = 7,
|
||||||
|
DFU_MANIFEST_WAIT_RESET = 8,
|
||||||
|
DFU_UPLOAD_IDLE = 9,
|
||||||
|
DFU_ERROR = 10,
|
||||||
|
} dfu_mode_state_t;
|
||||||
|
|
||||||
|
// DFU Status
|
||||||
|
typedef enum {
|
||||||
|
DFU_STATUS_OK = 0x00,
|
||||||
|
DFU_STATUS_ERRTARGET = 0x01,
|
||||||
|
DFU_STATUS_ERRFILE = 0x02,
|
||||||
|
DFU_STATUS_ERRWRITE = 0x03,
|
||||||
|
DFU_STATUS_ERRERASE = 0x04,
|
||||||
|
DFU_STATUS_ERRCHECK_ERASED = 0x05,
|
||||||
|
DFU_STATUS_ERRPROG = 0x06,
|
||||||
|
DFU_STATUS_ERRVERIFY = 0x07,
|
||||||
|
DFU_STATUS_ERRADDRESS = 0x08,
|
||||||
|
DFU_STATUS_ERRNOTDONE = 0x09,
|
||||||
|
DFU_STATUS_ERRFIRMWARE = 0x0A,
|
||||||
|
DFU_STATUS_ERRVENDOR = 0x0B,
|
||||||
|
DFU_STATUS_ERRUSBR = 0x0C,
|
||||||
|
DFU_STATUS_ERRPOR = 0x0D,
|
||||||
|
DFU_STATUS_ERRUNKNOWN = 0x0E,
|
||||||
|
DFU_STATUS_ERRSTALLEDPKT = 0x0F,
|
||||||
|
} dfu_mode_device_status_t;
|
||||||
|
|
||||||
|
#define DFU_FUNC_ATTR_CAN_DOWNLOAD_BITMASK (1 << 0)
|
||||||
|
#define DFU_FUNC_ATTR_CAN_UPLOAD_BITMASK (1 << 1)
|
||||||
|
#define DFU_FUNC_ATTR_MANIFESTATION_TOLERANT_BITMASK (1 << 2)
|
||||||
|
#define DFU_FUNC_ATTR_WILL_DETACH_BITMASK (1 << 3)
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif /* _TUSB_DFU_H_ */
|
|
@ -34,34 +34,176 @@
|
||||||
//--------------------------------------------------------------------+
|
//--------------------------------------------------------------------+
|
||||||
// MACRO CONSTANT TYPEDEF
|
// MACRO CONSTANT TYPEDEF
|
||||||
//--------------------------------------------------------------------+
|
//--------------------------------------------------------------------+
|
||||||
typedef enum {
|
|
||||||
DFU_REQUEST_DETACH = 0,
|
//--------------------------------------------------------------------+
|
||||||
DFU_REQUEST_DNLOAD = 1,
|
// INTERNAL OBJECT & FUNCTION DECLARATION
|
||||||
DFU_REQUEST_UPLOAD = 2,
|
//--------------------------------------------------------------------+
|
||||||
DFU_REQUEST_GETSTATUS = 3,
|
typedef struct TU_ATTR_PACKED
|
||||||
DFU_REQUEST_CLRSTATUS = 4,
|
{
|
||||||
DFU_REQUEST_GETSTATE = 5,
|
dfu_mode_device_status_t status;
|
||||||
DFU_REQUEST_ABORT = 6,
|
dfu_mode_state_t state;
|
||||||
} dfu_requests_t;
|
uint8_t attrs;
|
||||||
|
bool blk_transfer_in_proc;
|
||||||
|
|
||||||
|
uint8_t itf_num;
|
||||||
|
CFG_TUSB_MEM_ALIGN uint8_t epin_buf[CFG_TUD_DFU_TRANSFER_BUFFER_SIZE];
|
||||||
|
CFG_TUSB_MEM_ALIGN uint8_t epout_buf[CFG_TUD_DFU_TRANSFER_BUFFER_SIZE];
|
||||||
|
} dfu_state_ctx_t;
|
||||||
|
|
||||||
typedef struct TU_ATTR_PACKED
|
typedef struct TU_ATTR_PACKED
|
||||||
{
|
{
|
||||||
uint8_t status;
|
uint8_t bStatus;
|
||||||
uint8_t poll_timeout[3];
|
uint8_t bwPollTimeout[3];
|
||||||
uint8_t state;
|
uint8_t bState;
|
||||||
uint8_t istring;
|
uint8_t iString;
|
||||||
} dfu_status_t;
|
} dfu_status_req_payload_t;
|
||||||
|
|
||||||
|
TU_VERIFY_STATIC( sizeof(dfu_status_req_payload_t) == 6, "size is not correct");
|
||||||
|
|
||||||
|
// Only a single dfu state is allowed
|
||||||
|
CFG_TUSB_MEM_SECTION static dfu_state_ctx_t _dfu_state_ctx;
|
||||||
|
|
||||||
|
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 bool dfu_state_machine(uint8_t rhport, tusb_control_request_t const * request);
|
||||||
|
|
||||||
|
//--------------------------------------------------------------------+
|
||||||
|
// Debug
|
||||||
|
//--------------------------------------------------------------------+
|
||||||
|
#if CFG_TUSB_DEBUG >= 2
|
||||||
|
|
||||||
|
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_GETSTATUS , .data = "GETSTATUS" },
|
||||||
|
{ .key = DFU_REQUEST_CLRSTATUS , .data = "CLRSTATUS" },
|
||||||
|
{ .key = DFU_REQUEST_GETSTATE , .data = "GETSTATE" },
|
||||||
|
{ .key = DFU_REQUEST_ABORT , .data = "ABORT" },
|
||||||
|
};
|
||||||
|
|
||||||
|
static tu_lookup_table_t const _dfu_request_table =
|
||||||
|
{
|
||||||
|
.count = TU_ARRAY_SIZE(_dfu_request_lookup),
|
||||||
|
.items = _dfu_request_lookup
|
||||||
|
};
|
||||||
|
|
||||||
|
static tu_lookup_entry_t const _dfu_mode_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" },
|
||||||
|
};
|
||||||
|
|
||||||
|
static tu_lookup_table_t const _dfu_mode_state_table =
|
||||||
|
{
|
||||||
|
.count = TU_ARRAY_SIZE(_dfu_mode_state_lookup),
|
||||||
|
.items = _dfu_mode_state_lookup
|
||||||
|
};
|
||||||
|
|
||||||
|
static tu_lookup_entry_t const _dfu_mode_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" },
|
||||||
|
};
|
||||||
|
|
||||||
|
static tu_lookup_table_t const _dfu_mode_status_table =
|
||||||
|
{
|
||||||
|
.count = TU_ARRAY_SIZE(_dfu_mode_status_lookup),
|
||||||
|
.items = _dfu_mode_status_lookup
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#define dfu_rtd_debug_print_context() \
|
||||||
|
{ \
|
||||||
|
TU_LOG2(" DFU at State: %s\r\n Status: %s\r\n", \
|
||||||
|
tu_lookup_find(&_dfu_mode_state_table, _dfu_state_ctx.state), \
|
||||||
|
tu_lookup_find(&_dfu_mode_status_table, _dfu_state_ctx.status) ); \
|
||||||
|
}
|
||||||
|
|
||||||
//--------------------------------------------------------------------+
|
//--------------------------------------------------------------------+
|
||||||
// USBD Driver API
|
// USBD Driver API
|
||||||
//--------------------------------------------------------------------+
|
//--------------------------------------------------------------------+
|
||||||
void dfu_rtd_init(void)
|
void dfu_rtd_init(void)
|
||||||
{
|
{
|
||||||
|
if ( tud_dfu_runtime_init_cb ) {
|
||||||
|
_dfu_state_ctx.state = (tud_dfu_runtime_init_cb() == DFU_PROTOCOL_DFU) ? APP_DETACH : APP_IDLE;
|
||||||
|
} else {
|
||||||
|
_dfu_state_ctx.state = APP_IDLE;
|
||||||
|
}
|
||||||
|
|
||||||
|
_dfu_state_ctx.status = DFU_STATUS_OK;
|
||||||
|
_dfu_state_ctx.attrs = tud_dfu_runtime_init_attrs_cb();
|
||||||
|
_dfu_state_ctx.blk_transfer_in_proc = false;
|
||||||
|
|
||||||
|
dfu_rtd_debug_print_context();
|
||||||
}
|
}
|
||||||
|
|
||||||
void dfu_rtd_reset(uint8_t rhport)
|
void dfu_rtd_reset(uint8_t rhport)
|
||||||
{
|
{
|
||||||
(void) rhport;
|
if ( tud_dfu_runtime_usb_reset_cb )
|
||||||
|
{
|
||||||
|
tud_dfu_runtime_usb_reset_cb(rhport, _dfu_state_ctx.state);
|
||||||
|
}
|
||||||
|
|
||||||
|
switch (_dfu_state_ctx.state)
|
||||||
|
{
|
||||||
|
case APP_DETACH:
|
||||||
|
{
|
||||||
|
_dfu_state_ctx.state = DFU_IDLE;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_IDLE:
|
||||||
|
case DFU_DNLOAD_SYNC:
|
||||||
|
case DFU_DNBUSY:
|
||||||
|
case DFU_DNLOAD_IDLE:
|
||||||
|
case DFU_MANIFEST_SYNC:
|
||||||
|
case DFU_MANIFEST:
|
||||||
|
case DFU_MANIFEST_WAIT_RESET:
|
||||||
|
case DFU_UPLOAD_IDLE:
|
||||||
|
{
|
||||||
|
_dfu_state_ctx.state = (tud_dfu_runtime_firmware_valid_check_cb()) ? APP_IDLE : DFU_ERROR;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_ERROR:
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
_dfu_state_ctx.state = APP_IDLE;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
_dfu_state_ctx.status = DFU_STATUS_OK;
|
||||||
|
_dfu_state_ctx.attrs = tud_dfu_runtime_init_attrs_cb();
|
||||||
|
_dfu_state_ctx.blk_transfer_in_proc = false;
|
||||||
|
dfu_rtd_debug_print_context();
|
||||||
}
|
}
|
||||||
|
|
||||||
uint16_t dfu_rtd_open(uint8_t rhport, tusb_desc_interface_t const * itf_desc, uint16_t max_len)
|
uint16_t dfu_rtd_open(uint8_t rhport, tusb_desc_interface_t const * itf_desc, uint16_t max_len)
|
||||||
|
@ -69,9 +211,10 @@ uint16_t dfu_rtd_open(uint8_t rhport, tusb_desc_interface_t const * itf_desc, ui
|
||||||
(void) rhport;
|
(void) rhport;
|
||||||
(void) max_len;
|
(void) max_len;
|
||||||
|
|
||||||
// Ensure this is DFU Runtime
|
// Ensure this is DFU Runtime or Mode
|
||||||
TU_VERIFY(itf_desc->bInterfaceSubClass == TUD_DFU_APP_SUBCLASS &&
|
TU_VERIFY(itf_desc->bInterfaceSubClass == TUD_DFU_APP_SUBCLASS &&
|
||||||
itf_desc->bInterfaceProtocol == DFU_PROTOCOL_RT, 0);
|
( (itf_desc->bInterfaceProtocol == DFU_PROTOCOL_RT)
|
||||||
|
| (itf_desc->bInterfaceProtocol == DFU_PROTOCOL_DFU) ), 0);
|
||||||
|
|
||||||
uint8_t const * p_desc = tu_desc_next( itf_desc );
|
uint8_t const * p_desc = tu_desc_next( itf_desc );
|
||||||
uint16_t drv_len = sizeof(tusb_desc_interface_t);
|
uint16_t drv_len = sizeof(tusb_desc_interface_t);
|
||||||
|
@ -90,9 +233,16 @@ uint16_t dfu_rtd_open(uint8_t rhport, tusb_desc_interface_t const * itf_desc, ui
|
||||||
// return false to stall control endpoint (e.g unsupported request)
|
// return false to stall control endpoint (e.g unsupported request)
|
||||||
bool dfu_rtd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request)
|
bool dfu_rtd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request)
|
||||||
{
|
{
|
||||||
// nothing to do with DATA and ACK stage
|
if ( (stage == CONTROL_STAGE_DATA) && (request->bRequest == DFU_DNLOAD_SYNC) )
|
||||||
|
{
|
||||||
|
dfu_mode_req_dnload_reply(rhport, request);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// nothing to do with any other DATA or ACK stage
|
||||||
if ( stage != CONTROL_STAGE_SETUP ) return true;
|
if ( stage != CONTROL_STAGE_SETUP ) return true;
|
||||||
|
|
||||||
|
|
||||||
TU_VERIFY(request->bmRequestType_bit.recipient == TUSB_REQ_RCPT_INTERFACE);
|
TU_VERIFY(request->bmRequestType_bit.recipient == TUSB_REQ_RCPT_INTERFACE);
|
||||||
|
|
||||||
// dfu-util will try to claim the interface with SET_INTERFACE request before sending DFU request
|
// dfu-util will try to claim the interface with SET_INTERFACE request before sending DFU request
|
||||||
|
@ -106,34 +256,487 @@ bool dfu_rtd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request
|
||||||
// Handle class request only from here
|
// Handle class request only from here
|
||||||
TU_VERIFY(request->bmRequestType_bit.type == TUSB_REQ_TYPE_CLASS);
|
TU_VERIFY(request->bmRequestType_bit.type == TUSB_REQ_TYPE_CLASS);
|
||||||
|
|
||||||
switch ( request->bRequest )
|
switch (request->bRequest)
|
||||||
{
|
{
|
||||||
case DFU_REQUEST_DETACH:
|
case DFU_REQUEST_DETACH:
|
||||||
tud_control_status(rhport, request);
|
case DFU_REQUEST_DNLOAD:
|
||||||
tud_dfu_runtime_reboot_to_dfu_cb();
|
case DFU_REQUEST_UPLOAD:
|
||||||
break;
|
|
||||||
|
|
||||||
case DFU_REQUEST_GETSTATUS:
|
case DFU_REQUEST_GETSTATUS:
|
||||||
|
case DFU_REQUEST_CLRSTATUS:
|
||||||
|
case DFU_REQUEST_GETSTATE:
|
||||||
|
case DFU_REQUEST_ABORT:
|
||||||
{
|
{
|
||||||
// status = OK, poll timeout = 0, state = app idle, istring = 0
|
return dfu_state_machine(rhport, request);
|
||||||
uint8_t status_response[6] = { 0, 0, 0, 0, 0, 0 };
|
|
||||||
tud_control_xfer(rhport, request, status_response, sizeof(status_response));
|
|
||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
|
|
||||||
default: return false; // stall unsupported request
|
default:
|
||||||
|
{
|
||||||
|
TU_LOG2(" DFU Nonstandard Request: %u\r\n", request->bRequest);
|
||||||
|
return ( tud_dfu_runtime_req_nonstandard_cb ) ? tud_dfu_runtime_req_nonstandard_cb(rhport, stage, request) : false;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
void tud_dfu_runtime_set_status(dfu_mode_device_status_t status)
|
||||||
|
{
|
||||||
|
_dfu_state_ctx.status = status;
|
||||||
|
}
|
||||||
|
|
||||||
|
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);
|
||||||
|
uint16_t retval = tud_dfu_runtime_req_upload_data_cb(block_num, (uint8_t *)&_dfu_state_ctx.epin_buf, wLength);
|
||||||
|
tud_control_xfer(rhport, request, &_dfu_state_ctx.epin_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;
|
||||||
|
if ( tud_dfu_runtime_get_poll_timeout_cb )
|
||||||
|
{
|
||||||
|
tud_dfu_runtime_get_poll_timeout_cb((uint8_t *)&resp.bwPollTimeout);
|
||||||
|
} else {
|
||||||
|
memset((uint8_t *)&resp.bwPollTimeout, 0x00, 3);
|
||||||
|
}
|
||||||
|
resp.bState = _dfu_state_ctx.state;
|
||||||
|
resp.iString = ( tud_dfu_runtime_get_status_desc_table_index_cb ) ? tud_dfu_runtime_get_status_desc_table_index_cb() : 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
|
||||||
|
|
||||||
|
// setup for data phase
|
||||||
|
tud_control_xfer(rhport, request, &_dfu_state_ctx.epout_buf, request->wLength);
|
||||||
|
}
|
||||||
|
|
||||||
|
static void dfu_runtime_start_status_poll_timeout()
|
||||||
|
{
|
||||||
|
uint8_t bwPollTimeout[3] = {0,0,0};
|
||||||
|
|
||||||
|
if ( tud_dfu_runtime_get_poll_timeout_cb )
|
||||||
|
{
|
||||||
|
tud_dfu_runtime_get_poll_timeout_cb((uint8_t *)&bwPollTimeout);
|
||||||
|
}
|
||||||
|
|
||||||
|
tud_dfu_runtime_start_poll_timeout_cb((uint8_t *)&bwPollTimeout);
|
||||||
|
}
|
||||||
|
|
||||||
|
void dfu_mode_req_dnload_reply(uint8_t rhport, tusb_control_request_t const * request)
|
||||||
|
{
|
||||||
|
dfu_runtime_start_status_poll_timeout();
|
||||||
|
tud_dfu_runtime_req_dnload_data_cb(request->wValue, (uint8_t *)&_dfu_state_ctx.epout_buf, request->wLength);
|
||||||
|
_dfu_state_ctx.blk_transfer_in_proc = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
void tud_dfu_runtime_poll_timeout_done()
|
||||||
|
{
|
||||||
|
if (_dfu_state_ctx.state == DFU_DNBUSY)
|
||||||
|
{
|
||||||
|
_dfu_state_ctx.state = DFU_DNLOAD_SYNC;
|
||||||
|
} else if (_dfu_state_ctx.state == DFU_MANIFEST)
|
||||||
|
{
|
||||||
|
_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_mode_state_table, _dfu_state_ctx.state));
|
||||||
|
|
||||||
|
switch (_dfu_state_ctx.state)
|
||||||
|
{
|
||||||
|
case APP_IDLE:
|
||||||
|
{
|
||||||
|
switch (request->bRequest)
|
||||||
|
{
|
||||||
|
case DFU_REQUEST_DETACH:
|
||||||
|
{
|
||||||
|
_dfu_state_ctx.state = APP_DETACH;
|
||||||
|
if ((_dfu_state_ctx.attrs & DFU_FUNC_ATTR_WILL_DETACH_BITMASK) == 1)
|
||||||
|
{
|
||||||
|
tud_dfu_runtime_reboot_to_dfu_cb();
|
||||||
|
} else {
|
||||||
|
tud_dfu_runtime_detach_start_timer_cb(request->wValue);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_REQUEST_GETSTATUS:
|
||||||
|
{
|
||||||
|
dfu_req_getstatus_reply(rhport, request);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_REQUEST_GETSTATE:
|
||||||
|
{
|
||||||
|
dfu_req_getstate_reply(rhport, request);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
_dfu_state_ctx.state = DFU_ERROR;
|
||||||
|
return false; // stall on all other requests
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case APP_DETACH:
|
||||||
|
{
|
||||||
|
switch (request->bRequest)
|
||||||
|
{
|
||||||
|
case DFU_REQUEST_GETSTATUS:
|
||||||
|
{
|
||||||
|
dfu_req_getstatus_reply(rhport, request);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_REQUEST_GETSTATE:
|
||||||
|
{
|
||||||
|
dfu_req_getstate_reply(rhport, request);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
_dfu_state_ctx.state = APP_IDLE;
|
||||||
|
return false; // stall on all other requests
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_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 {
|
||||||
|
_dfu_state_ctx.state = DFU_ERROR;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_REQUEST_UPLOAD:
|
||||||
|
{
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
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:
|
||||||
|
{
|
||||||
|
; // do nothing, but don't stall so continue on
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
_dfu_state_ctx.state = DFU_ERROR;
|
||||||
|
return false; // stall on all other requests
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_DNLOAD_SYNC:
|
||||||
|
{
|
||||||
|
switch (request->bRequest)
|
||||||
|
{
|
||||||
|
case DFU_REQUEST_GETSTATUS:
|
||||||
|
{
|
||||||
|
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;
|
||||||
|
|
||||||
|
case DFU_REQUEST_GETSTATE:
|
||||||
|
{
|
||||||
|
dfu_req_getstate_reply(rhport, request);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
_dfu_state_ctx.state = DFU_ERROR;
|
||||||
|
return false; // stall on all other requests
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_DNBUSY:
|
||||||
|
{
|
||||||
|
switch (request->bRequest)
|
||||||
|
{
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
_dfu_state_ctx.state = DFU_ERROR;
|
||||||
|
return false; // stall on all other requests
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
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_runtime_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;
|
||||||
|
|
||||||
|
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_runtime_abort_cb )
|
||||||
|
{
|
||||||
|
tud_dfu_runtime_abort_cb();
|
||||||
|
}
|
||||||
|
_dfu_state_ctx.state = DFU_IDLE;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
_dfu_state_ctx.state = DFU_ERROR;
|
||||||
|
return false; // stall on all other requests
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
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_runtime_firmware_valid_check_cb() )
|
||||||
|
{
|
||||||
|
_dfu_state_ctx.state = DFU_IDLE;
|
||||||
|
}
|
||||||
|
dfu_req_getstatus_reply(rhport, request);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_REQUEST_GETSTATE:
|
||||||
|
{
|
||||||
|
dfu_req_getstate_reply(rhport, request);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
_dfu_state_ctx.state = DFU_ERROR;
|
||||||
|
return false; // stall on all other requests
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_MANIFEST:
|
||||||
|
{
|
||||||
|
switch (request->bRequest)
|
||||||
|
{
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
return false; // stall on all other requests
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_MANIFEST_WAIT_RESET:
|
||||||
|
{
|
||||||
|
// 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;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_UPLOAD_IDLE:
|
||||||
|
{
|
||||||
|
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_runtime_abort_cb)
|
||||||
|
{
|
||||||
|
tud_dfu_runtime_abort_cb();
|
||||||
|
}
|
||||||
|
_dfu_state_ctx.state = DFU_IDLE;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
return false; // stall on all other requests
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_ERROR:
|
||||||
|
{
|
||||||
|
switch (request->bRequest)
|
||||||
|
{
|
||||||
|
case DFU_REQUEST_GETSTATUS:
|
||||||
|
{
|
||||||
|
dfu_req_getstatus_reply(rhport, request);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_REQUEST_CLRSTATUS:
|
||||||
|
{
|
||||||
|
_dfu_state_ctx.state = DFU_IDLE;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case DFU_REQUEST_GETSTATE:
|
||||||
|
{
|
||||||
|
dfu_req_getstate_reply(rhport, request);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
return false; // stall on all other requests
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
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 true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
bool dfu_rtd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes)
|
|
||||||
{
|
|
||||||
(void) rhport;
|
|
||||||
(void) ep_addr;
|
|
||||||
(void) result;
|
|
||||||
(void) xferred_bytes;
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
|
|
@ -29,36 +29,106 @@
|
||||||
|
|
||||||
#include "common/tusb_common.h"
|
#include "common/tusb_common.h"
|
||||||
#include "device/usbd.h"
|
#include "device/usbd.h"
|
||||||
|
#include "dfu.h"
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
|
||||||
//--------------------------------------------------------------------+
|
|
||||||
// Common Definitions
|
|
||||||
//--------------------------------------------------------------------+
|
|
||||||
|
|
||||||
// DFU Protocol
|
|
||||||
typedef enum
|
|
||||||
{
|
|
||||||
DFU_PROTOCOL_RT = 1,
|
|
||||||
DFU_PROTOCOL_DFU = 2,
|
|
||||||
} dfu_protocol_type_t;
|
|
||||||
|
|
||||||
// DFU Descriptor Type
|
|
||||||
typedef enum
|
|
||||||
{
|
|
||||||
DFU_DESC_FUNCTIONAL = 0x21,
|
|
||||||
} dfu_descriptor_type_t;
|
|
||||||
|
|
||||||
|
|
||||||
//--------------------------------------------------------------------+
|
//--------------------------------------------------------------------+
|
||||||
// Application Callback API (weak is optional)
|
// Application Callback API (weak is optional)
|
||||||
//--------------------------------------------------------------------+
|
//--------------------------------------------------------------------+
|
||||||
|
// Allow the application to update the status as required.
|
||||||
|
// Is set to DFU_STATUS_OK during internal initialization and USB reset
|
||||||
|
// Value is not checked to allow for custom statuses to be used
|
||||||
|
void tud_dfu_runtime_set_status(dfu_mode_device_status_t status);
|
||||||
|
|
||||||
// Invoked when received new data
|
// Invoked when a DFU_DETACH request is received and bitWillDetatch is set
|
||||||
TU_ATTR_WEAK void tud_dfu_runtime_reboot_to_dfu_cb(void);
|
void tud_dfu_runtime_reboot_to_dfu_cb();
|
||||||
|
|
||||||
|
// Invoked when a DFU_DETACH request is received and bitWillDetatch is not set
|
||||||
|
// This should start a timer for wTimeout ms
|
||||||
|
// The application should then look for a USB reset signal to occur before
|
||||||
|
// the timeout has elapsed. The reset signal will invoke tud_dfu_runtime_usb_reset_cb.
|
||||||
|
// If this reset signal is received before the timeout, then the application must
|
||||||
|
// switch to DFU mode.
|
||||||
|
// If the timer expires, the app does not need to do anything.
|
||||||
|
// NOTE: This callback should return immediately, and not implement the delay
|
||||||
|
// internally, as this can will hold up the USB stack
|
||||||
|
TU_ATTR_WEAK void tud_dfu_runtime_detach_start_timer_cb(uint16_t wTimeout);
|
||||||
|
|
||||||
|
// Invoked when a nonstandard request is received
|
||||||
|
// Use may be vendor specific.
|
||||||
|
// Return false to stall
|
||||||
|
TU_ATTR_WEAK bool tud_dfu_runtime_req_nonstandard_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request);
|
||||||
|
|
||||||
|
// Invoked when a reset is received to check if firmware is valid
|
||||||
|
bool tud_dfu_runtime_firmware_valid_check_cb();
|
||||||
|
|
||||||
|
// Invoked during initialization of the dfu driver to set attributes
|
||||||
|
// Return byte set with bitmasks:
|
||||||
|
// DFU_FUNC_ATTR_CAN_DOWNLOAD_BITMASK
|
||||||
|
// DFU_FUNC_ATTR_CAN_UPLOAD_BITMASK
|
||||||
|
// DFU_FUNC_ATTR_MANIFESTATION_TOLERANT_BITMASK
|
||||||
|
// DFU_FUNC_ATTR_WILL_DETACH_BITMASK
|
||||||
|
// Note: This should match the USB descriptor
|
||||||
|
uint8_t tud_dfu_runtime_init_attrs_cb();
|
||||||
|
|
||||||
|
// Invoked during initialization of the dfu driver to start as RT or DFU
|
||||||
|
// This will determine if the internal state machine will begin in
|
||||||
|
// APP_IDLE or DFU_IDLE
|
||||||
|
TU_ATTR_WEAK dfu_protocol_type_t tud_dfu_runtime_init_cb();
|
||||||
|
|
||||||
|
// Invoked during a DFU_GETSTATUS request to get for the string index
|
||||||
|
// to the status description string table.
|
||||||
|
TU_ATTR_WEAK uint8_t tud_dfu_runtime_get_status_desc_table_index_cb();
|
||||||
|
|
||||||
|
// Invoked during a USB reset
|
||||||
|
// Lets the app know that a USB reset has occurred so it can act accordingly,
|
||||||
|
// See tud_dfu_runtime_detach_start_timer_cb for how to handle the APP_DETACH state
|
||||||
|
// Other states will be application specific
|
||||||
|
TU_ATTR_WEAK void tud_dfu_runtime_usb_reset_cb(uint8_t rhport, dfu_mode_state_t state);
|
||||||
|
|
||||||
|
// Invoked during a DFU_GETSTATUS request to set the timeout in ms to use
|
||||||
|
// before the subsequent DFU_GETSTATUS requests.
|
||||||
|
// The purpose of this value is to allow the device to tell the host
|
||||||
|
// how long to wait between the DFU_DNLOAD and DFU_GETSTATUS checks
|
||||||
|
// to allow the device to have time to erase, write memory, etc.
|
||||||
|
// ms_timeout is a pointer to array of length 3.
|
||||||
|
// Refer to the USB DFU class specification for more details
|
||||||
|
TU_ATTR_WEAK void tud_dfu_runtime_get_poll_timeout_cb(uint8_t *ms_timeout);
|
||||||
|
|
||||||
|
// Invoked when a DFU_DNLOAD request is received
|
||||||
|
// This should start a timer for ms_timeout ms
|
||||||
|
// When the timer has elapsed, tud_dfu_runtime_poll_timeout_done must be called
|
||||||
|
// NOTE: This callback should return immediately, and not implement the delay
|
||||||
|
// internally, as this will hold up the class stack from receiving any packets
|
||||||
|
// during the DFU_DNLOAD_SYNC and DFU_DNBUSY states
|
||||||
|
void tud_dfu_runtime_start_poll_timeout_cb(uint8_t *ms_timeout);
|
||||||
|
|
||||||
|
// Must be called when the poll_timeout has elapsed
|
||||||
|
void tud_dfu_runtime_poll_timeout_done();
|
||||||
|
|
||||||
|
// Invoked when a DFU_DNLOAD request is received
|
||||||
|
// This callback takes the wBlockNum chunk of length length and provides it
|
||||||
|
// to the application at the data pointer. This data is only valid for this
|
||||||
|
// call, so the app must use it not or copy it.
|
||||||
|
void tud_dfu_runtime_req_dnload_data_cb(uint16_t wBlockNum, uint8_t* data, uint16_t length);
|
||||||
|
|
||||||
|
// Invoked during the last DFU_DNLOAD request, signifying that the host believes
|
||||||
|
// it is done transmitting data.
|
||||||
|
// Return true if the application agrees there is no more data
|
||||||
|
// Return false if the device disagrees, which will stall the pipe, and the Host
|
||||||
|
// should initiate a recovery procedure
|
||||||
|
bool tud_dfu_runtime_device_data_done_check_cb();
|
||||||
|
|
||||||
|
// Invoked when the Host has terminated a download or upload transfer
|
||||||
|
TU_ATTR_WEAK void tud_dfu_runtime_abort_cb();
|
||||||
|
|
||||||
|
// Invoked when a DFU_UPLOAD request is received
|
||||||
|
// This callback must populate data with up to length bytes
|
||||||
|
// Return the number of bytes to write
|
||||||
|
uint16_t tud_dfu_runtime_req_upload_data_cb(uint16_t block_num, uint8_t* data, uint16_t length);
|
||||||
|
|
||||||
//--------------------------------------------------------------------+
|
//--------------------------------------------------------------------+
|
||||||
// Internal Class Driver API
|
// Internal Class Driver API
|
||||||
|
@ -67,8 +137,11 @@ void dfu_rtd_init(void);
|
||||||
void dfu_rtd_reset(uint8_t rhport);
|
void dfu_rtd_reset(uint8_t rhport);
|
||||||
uint16_t dfu_rtd_open(uint8_t rhport, tusb_desc_interface_t const * itf_desc, uint16_t max_len);
|
uint16_t dfu_rtd_open(uint8_t rhport, tusb_desc_interface_t const * itf_desc, uint16_t max_len);
|
||||||
bool dfu_rtd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request);
|
bool dfu_rtd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request);
|
||||||
bool dfu_rtd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t event, uint32_t xferred_bytes);
|
|
||||||
|
|
||||||
|
//--------------------------------------------------------------------+
|
||||||
|
void dfu_mode_init(void);
|
||||||
|
void dfu_mode_reset(uint8_t rhport);
|
||||||
|
void dfu_mode_req_dnload_reply(uint8_t rhport, tusb_control_request_t const * request);
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
|
|
|
@ -421,6 +421,25 @@ typedef struct TU_ATTR_PACKED
|
||||||
char url[];
|
char url[];
|
||||||
} tusb_desc_webusb_url_t;
|
} tusb_desc_webusb_url_t;
|
||||||
|
|
||||||
|
// DFU Functional Descriptor
|
||||||
|
typedef struct TU_ATTR_PACKED
|
||||||
|
{
|
||||||
|
uint8_t bLength;
|
||||||
|
uint8_t bDescriptorType;
|
||||||
|
|
||||||
|
struct TU_ATTR_PACKED {
|
||||||
|
uint8_t bitCanDnload : 1;
|
||||||
|
uint8_t bitCanUpload : 1;
|
||||||
|
uint8_t bitManifestationTolerant : 1;
|
||||||
|
uint8_t bitWillDetach : 1;
|
||||||
|
uint8_t reserved : 4;
|
||||||
|
} bmAttributes;
|
||||||
|
|
||||||
|
uint16_t wDetachTimeOut;
|
||||||
|
uint16_t wTransferSize;
|
||||||
|
uint16_t bcdDFUVersion;
|
||||||
|
} tusb_desc_dfu_functional_t;
|
||||||
|
|
||||||
/*------------------------------------------------------------------*/
|
/*------------------------------------------------------------------*/
|
||||||
/* Types
|
/* Types
|
||||||
*------------------------------------------------------------------*/
|
*------------------------------------------------------------------*/
|
||||||
|
|
|
@ -182,7 +182,7 @@ static usbd_class_driver_t const _usbd_driver[] =
|
||||||
.reset = dfu_rtd_reset,
|
.reset = dfu_rtd_reset,
|
||||||
.open = dfu_rtd_open,
|
.open = dfu_rtd_open,
|
||||||
.control_xfer_cb = dfu_rtd_control_xfer_cb,
|
.control_xfer_cb = dfu_rtd_control_xfer_cb,
|
||||||
.xfer_cb = dfu_rtd_xfer_cb,
|
.xfer_cb = NULL,
|
||||||
.sof = NULL
|
.sof = NULL
|
||||||
},
|
},
|
||||||
#endif
|
#endif
|
||||||
|
|
|
@ -529,7 +529,7 @@ TU_ATTR_WEAK bool tud_vendor_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb
|
||||||
|
|
||||||
//------------- DFU Runtime -------------//
|
//------------- DFU Runtime -------------//
|
||||||
#define TUD_DFU_APP_CLASS (TUSB_CLASS_APPLICATION_SPECIFIC)
|
#define TUD_DFU_APP_CLASS (TUSB_CLASS_APPLICATION_SPECIFIC)
|
||||||
#define TUD_DFU_APP_SUBCLASS 0x01u
|
#define TUD_DFU_APP_SUBCLASS (APP_SUBCLASS_DFU_RUNTIME)
|
||||||
|
|
||||||
// Length of template descriptr: 18 bytes
|
// Length of template descriptr: 18 bytes
|
||||||
#define TUD_DFU_RT_DESC_LEN (9 + 9)
|
#define TUD_DFU_RT_DESC_LEN (9 + 9)
|
||||||
|
@ -542,6 +542,17 @@ TU_ATTR_WEAK bool tud_vendor_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb
|
||||||
/* Function */ \
|
/* Function */ \
|
||||||
9, DFU_DESC_FUNCTIONAL, _attr, U16_TO_U8S_LE(_timeout), U16_TO_U8S_LE(_xfer_size), U16_TO_U8S_LE(0x0101)
|
9, DFU_DESC_FUNCTIONAL, _attr, U16_TO_U8S_LE(_timeout), U16_TO_U8S_LE(_xfer_size), U16_TO_U8S_LE(0x0101)
|
||||||
|
|
||||||
|
// Length of template descriptr: 18 bytes
|
||||||
|
#define TUD_DFU_MODE_DESC_LEN (9 + 9)
|
||||||
|
|
||||||
|
// DFU runtime descriptor
|
||||||
|
// Interface number, string index, alternate setting, attributes, detach timeout, transfer size
|
||||||
|
#define TUD_DFU_MODE_DESCRIPTOR(_itfnum, _stridx, _alt_setting, _attr, _timeout, _xfer_size) \
|
||||||
|
/* Interface */ \
|
||||||
|
9, TUSB_DESC_INTERFACE, _itfnum, _alt_setting, 0, TUD_DFU_APP_CLASS, TUD_DFU_APP_SUBCLASS, DFU_PROTOCOL_DFU, _stridx, \
|
||||||
|
/* Function */ \
|
||||||
|
9, DFU_DESC_FUNCTIONAL, _attr, U16_TO_U8S_LE(_timeout), U16_TO_U8S_LE(_xfer_size), U16_TO_U8S_LE(0x0101)
|
||||||
|
|
||||||
|
|
||||||
//------------- CDC-ECM -------------//
|
//------------- CDC-ECM -------------//
|
||||||
|
|
||||||
|
|
|
@ -237,6 +237,10 @@
|
||||||
#define CFG_TUD_DFU_RUNTIME 0
|
#define CFG_TUD_DFU_RUNTIME 0
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
#ifndef CFG_TUD_DFU_TRANSFER_BUFFER_SIZE
|
||||||
|
#define CFG_TUD_DFU_TRANSFER_BUFFER_SIZE 64
|
||||||
|
#endif
|
||||||
|
|
||||||
#ifndef CFG_TUD_NET
|
#ifndef CFG_TUD_NET
|
||||||
#define CFG_TUD_NET 0
|
#define CFG_TUD_NET 0
|
||||||
#endif
|
#endif
|
||||||
|
|
Loading…
Reference in New Issue