99 lines
4.3 KiB
C
99 lines
4.3 KiB
C
/*
|
|
* 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_DEVICE_H_
|
|
#define _TUSB_DFU_DEVICE_H_
|
|
|
|
#include "dfu.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
//--------------------------------------------------------------------+
|
|
// Class Driver Default Configure & Validation
|
|
//--------------------------------------------------------------------+
|
|
|
|
#if !defined(CFG_TUD_DFU_XFER_BUFSIZE)
|
|
#error "CFG_TUD_DFU_XFER_BUFSIZE must be defined, it has to be set to the buffer size used in TUD_DFU_DESCRIPTOR"
|
|
#endif
|
|
|
|
//--------------------------------------------------------------------+
|
|
// Application API
|
|
//--------------------------------------------------------------------+
|
|
|
|
// Must be called when the application is done with flashing started by
|
|
// tud_dfu_download_cb() and tud_dfu_manifest_cb().
|
|
// status is DFU_STATUS_OK if successful, any other error status will cause state to enter dfuError
|
|
void tud_dfu_finish_flashing(uint8_t status);
|
|
|
|
//--------------------------------------------------------------------+
|
|
// Application Callback API (weak is optional)
|
|
//--------------------------------------------------------------------+
|
|
|
|
// Note: alt is used as the partition number, in order to support multiple partitions like FLASH, EEPROM, etc.
|
|
|
|
// Invoked right before tud_dfu_download_cb() (state=DFU_DNBUSY) or tud_dfu_manifest_cb() (state=DFU_MANIFEST)
|
|
// Application return timeout in milliseconds (bwPollTimeout) for the next download/manifest operation.
|
|
// During this period, USB host won't try to communicate with us.
|
|
uint32_t tud_dfu_get_timeout_cb(uint8_t alt, uint8_t state);
|
|
|
|
// Invoked when received DFU_DNLOAD (wLength>0) following by DFU_GETSTATUS (state=DFU_DNBUSY) requests
|
|
// This callback could be returned before flashing op is complete (async).
|
|
// Once finished flashing, application must call tud_dfu_finish_flashing()
|
|
void tud_dfu_download_cb (uint8_t alt, uint16_t block_num, uint8_t const *data, uint16_t length);
|
|
|
|
// Invoked when download process is complete, received DFU_DNLOAD (wLength=0) following by DFU_GETSTATUS (state=Manifest)
|
|
// Application can do checksum, or actual flashing if buffered entire image previously.
|
|
// Once finished flashing, application must call tud_dfu_finish_flashing()
|
|
void tud_dfu_manifest_cb(uint8_t alt);
|
|
|
|
// Invoked when received DFU_UPLOAD request
|
|
// Application must populate data with up to length bytes and
|
|
// Return the number of written bytes
|
|
TU_ATTR_WEAK uint16_t tud_dfu_upload_cb(uint8_t alt, uint16_t block_num, uint8_t* data, uint16_t length);
|
|
|
|
// Invoked when a DFU_DETACH request is received
|
|
TU_ATTR_WEAK void tud_dfu_detach_cb(void);
|
|
|
|
// Invoked when the Host has terminated a download or upload transfer
|
|
TU_ATTR_WEAK void tud_dfu_abort_cb(uint8_t alt);
|
|
|
|
//--------------------------------------------------------------------+
|
|
// Internal Class Driver API
|
|
//--------------------------------------------------------------------+
|
|
void dfu_moded_init(void);
|
|
void dfu_moded_reset(uint8_t rhport);
|
|
uint16_t dfu_moded_open(uint8_t rhport, tusb_desc_interface_t const * itf_desc, uint16_t max_len);
|
|
bool dfu_moded_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _TUSB_DFU_MODE_DEVICE_H_ */
|