Removes polltimeout behaviour and restructures

Moves dfu_req_dnload_reply to ACK stage of a DNREQUEST.

Removes unneeded variables due to other simplifications.
This commit is contained in:
Jeremiah McCarthy 2021-04-22 17:45:33 -04:00
parent 8c80ddeb54
commit b8e5885c2b
2 changed files with 34 additions and 72 deletions

View File

@ -44,10 +44,6 @@ typedef struct TU_ATTR_PACKED
dfu_state_t state; dfu_state_t state;
uint8_t attrs; uint8_t attrs;
bool blk_transfer_in_proc; bool blk_transfer_in_proc;
uint8_t itf_num;
uint16_t last_block_num;
uint16_t last_transfer_len;
CFG_TUSB_MEM_ALIGN uint8_t transfer_buf[CFG_TUD_DFU_TRANSFER_BUFFER_SIZE]; CFG_TUSB_MEM_ALIGN uint8_t transfer_buf[CFG_TUD_DFU_TRANSFER_BUFFER_SIZE];
} dfu_state_ctx_t; } dfu_state_ctx_t;
@ -58,7 +54,7 @@ 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_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 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 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(void); 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 dfu_state_machine(uint8_t rhport, tusb_control_request_t const * request);
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
@ -148,8 +144,6 @@ void dfu_moded_init(void)
_dfu_state_ctx.status = DFU_STATUS_OK; _dfu_state_ctx.status = DFU_STATUS_OK;
_dfu_state_ctx.attrs = 0; _dfu_state_ctx.attrs = 0;
_dfu_state_ctx.blk_transfer_in_proc = false; _dfu_state_ctx.blk_transfer_in_proc = false;
_dfu_state_ctx.last_block_num = 0;
_dfu_state_ctx.last_transfer_len = 0;
dfu_debug_print_context(); dfu_debug_print_context();
} }
@ -191,8 +185,6 @@ void dfu_moded_reset(uint8_t rhport)
_dfu_state_ctx.status = DFU_STATUS_OK; _dfu_state_ctx.status = DFU_STATUS_OK;
_dfu_state_ctx.blk_transfer_in_proc = false; _dfu_state_ctx.blk_transfer_in_proc = false;
_dfu_state_ctx.last_block_num = 0;
_dfu_state_ctx.last_transfer_len = 0;
dfu_debug_print_context(); dfu_debug_print_context();
} }
@ -225,17 +217,13 @@ 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) // 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) bool dfu_moded_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request)
{ {
if ( (stage == CONTROL_STAGE_DATA) && (_dfu_state_ctx.state == DFU_DNLOAD_SYNC) ) // nothing to do with DATA stage
{ if ( stage == CONTROL_STAGE_DATA ) return true;
dfu_req_dnload_reply();
return true;
}
// nothing to do with any other DATA or ACK stage
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);
if(stage == CONTROL_STAGE_SETUP)
{
// 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
if ( TUSB_REQ_TYPE_STANDARD == request->bmRequestType_bit.type && if ( TUSB_REQ_TYPE_STANDARD == request->bmRequestType_bit.type &&
TUSB_REQ_SET_INTERFACE == request->bRequest ) TUSB_REQ_SET_INTERFACE == request->bRequest )
@ -243,22 +231,35 @@ bool dfu_moded_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_reque
tud_control_status(rhport, request); tud_control_status(rhport, request);
return true; return true;
} }
}
// 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_DNLOAD: 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_UPLOAD:
case DFU_REQUEST_GETSTATUS: case DFU_REQUEST_GETSTATUS:
case DFU_REQUEST_CLRSTATUS: case DFU_REQUEST_CLRSTATUS:
case DFU_REQUEST_GETSTATE: case DFU_REQUEST_GETSTATE:
case DFU_REQUEST_ABORT: case DFU_REQUEST_ABORT:
{
if(stage == CONTROL_STAGE_SETUP)
{ {
return dfu_state_machine(rhport, request); return dfu_state_machine(rhport, request);
} }
}
break; break;
default: default:
@ -285,12 +286,7 @@ static void dfu_req_getstatus_reply(uint8_t rhport, tusb_control_request_t const
dfu_status_req_payload_t resp; dfu_status_req_payload_t resp;
resp.bStatus = _dfu_state_ctx.status; resp.bStatus = _dfu_state_ctx.status;
if ( tud_dfu_get_poll_timeout_cb )
{
tud_dfu_get_poll_timeout_cb((uint8_t *)&resp.bwPollTimeout);
} else {
memset((uint8_t *)&resp.bwPollTimeout, 0x00, 3); memset((uint8_t *)&resp.bwPollTimeout, 0x00, 3);
}
resp.bState = _dfu_state_ctx.state; resp.bState = _dfu_state_ctx.state;
resp.iString = 0; resp.iString = 0;
@ -304,8 +300,6 @@ static void dfu_req_getstate_reply(uint8_t rhport, tusb_control_request_t const
static void dfu_req_dnload_setup(uint8_t rhport, tusb_control_request_t const * request) static void dfu_req_dnload_setup(uint8_t rhport, tusb_control_request_t const * request)
{ {
_dfu_state_ctx.last_block_num = request->wValue;
_dfu_state_ctx.last_transfer_len = request->wLength;
// TODO: add "zero" copy mode so the buffer we read into can be provided by the user // 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 // 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 // but this mode would provide zero copy from the class driver to the application
@ -314,26 +308,14 @@ static void dfu_req_dnload_setup(uint8_t rhport, tusb_control_request_t const *
tud_control_xfer(rhport, request, &_dfu_state_ctx.transfer_buf, request->wLength); tud_control_xfer(rhport, request, &_dfu_state_ctx.transfer_buf, request->wLength);
} }
static void dfu_req_dnload_reply(void) static void dfu_req_dnload_reply(uint8_t rhport, tusb_control_request_t const * request)
{ {
uint8_t bwPollTimeout[3] = {0,0,0}; (void) rhport;
tud_dfu_req_dnload_data_cb(request->wValue, (uint8_t *)&_dfu_state_ctx.transfer_buf, request->wLength);
if ( tud_dfu_get_poll_timeout_cb )
{
tud_dfu_get_poll_timeout_cb((uint8_t *)&bwPollTimeout);
}
tud_dfu_start_poll_timeout_cb((uint8_t *)&bwPollTimeout);
// TODO: I want the real xferred len, not what is expected. May need to change usbd.c to do this.
tud_dfu_req_dnload_data_cb(_dfu_state_ctx.last_block_num, (uint8_t *)&_dfu_state_ctx.transfer_buf, _dfu_state_ctx.last_transfer_len);
_dfu_state_ctx.blk_transfer_in_proc = false; _dfu_state_ctx.blk_transfer_in_proc = false;
_dfu_state_ctx.last_block_num = 0;
_dfu_state_ctx.last_transfer_len = 0;
} }
void tud_dfu_poll_timeout_done(void) void tud_dfu_dnload_complete(void)
{ {
if (_dfu_state_ctx.state == DFU_DNBUSY) if (_dfu_state_ctx.state == DFU_DNBUSY)
{ {

View File

@ -45,36 +45,16 @@ bool tud_dfu_firmware_valid_check_cb(void);
// Invoked when the device must reboot to dfu runtime mode // Invoked when the device must reboot to dfu runtime mode
void tud_dfu_reboot_to_rt_cb(void); void tud_dfu_reboot_to_rt_cb(void);
// 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_get_status_desc_table_index_cb(void);
// 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_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_start_poll_timeout_cb(uint8_t *ms_timeout);
// Must be called when the poll_timeout has elapsed
void tud_dfu_poll_timeout_done(void);
// Invoked when a DFU_DNLOAD request is received // Invoked when a DFU_DNLOAD request is received
// This callback takes the wBlockNum chunk of length length and provides it // 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 // 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. // call, so the app must use it not or copy it.
void tud_dfu_req_dnload_data_cb(uint16_t wBlockNum, uint8_t* data, uint16_t length); void tud_dfu_req_dnload_data_cb(uint16_t wBlockNum, uint8_t* data, uint16_t length);
// Must be called when the application is done using the last block of data
// provided by tud_dfu_req_dnload_data_cb
void tud_dfu_dnload_complete(void);
// Invoked during the last DFU_DNLOAD request, signifying that the host believes // Invoked during the last DFU_DNLOAD request, signifying that the host believes
// it is done transmitting data. // it is done transmitting data.
// Return true if the application agrees there is no more data // Return true if the application agrees there is no more data