usbd_dfu.h File Reference

USB Device Firmware Upgrade (DFU) public header. More...

#include <stdint.h>

Go to the source code of this file.

Data Structures
struct	usb_dfu_descriptor
struct	usbd_dfu_image

Macros
#define	USB_DFU_SUBCLASS   0x01
#define	USB_DFU_PROTOCOL_RUNTIME   0x01
#define	USB_DFU_PROTOCOL_DFU   0x02
#define	USB_DFU_REQ_DETACH   0x00
#define	USB_DFU_REQ_DNLOAD   0x01
#define	USB_DFU_REQ_UPLOAD   0x02
#define	USB_DFU_REQ_GETSTATUS   0x03
#define	USB_DFU_REQ_CLRSTATUS   0x04
#define	USB_DFU_REQ_GETSTATE   0x05
#define	USB_DFU_REQ_ABORT   0x06
#define	USB_DESC_DFU_FUNCTIONAL   0x21
#define	USB_DFU_ATTR_WILL_DETACH   BIT(3)
#define	USB_DFU_ATTR_MANIFESTATION_TOLERANT   BIT(2)
#define	USB_DFU_ATTR_CAN_UPLOAD   BIT(1)
#define	USB_DFU_ATTR_CAN_DNLOAD   BIT(0)
#define	USB_DFU_VERSION   0x0110
#define	USBD_DFU_DEFINE_IMG(id, iname, ipriv, iread, iwrite, inext)
	Define USB DFU image.

Enumerations
enum	usb_dfu_status {   ERR_OK = 0x00 , ERR_TARGET = 0x01 , ERR_FILE = 0x02 , ERR_WRITE = 0x03 ,   ERR_ERASE = 0x04 , ERR_CHECK_ERASED = 0x05 , ERR_PROG = 0x06 , ERR_VERIFY = 0x07 ,   ERR_ADDRESS = 0x08 , ERR_NOTDONE = 0x09 , ERR_FIRMWARE = 0x0A , ERR_VENDOR = 0x0B ,   ERR_USBR = 0x0C , ERR_POR = 0x0D , ERR_UNKNOWN = 0x0E , ERR_STALLEDPKT = 0x0F }
enum	usb_dfu_state {   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_RST = 8 , DFU_UPLOAD_IDLE = 9 , DFU_ERROR = 10 , DFU_STATE_MAX = 11 }

Detailed Description

USB Device Firmware Upgrade (DFU) public header.

Header exposes API for registering DFU images.

Macro Definition Documentation

USB_DESC_DFU_FUNCTIONAL

#define USB_DESC_DFU_FUNCTIONAL   0x21

USB_DFU_ATTR_CAN_DNLOAD

#define USB_DFU_ATTR_CAN_DNLOAD   BIT(0)

USB_DFU_ATTR_CAN_UPLOAD

#define USB_DFU_ATTR_CAN_UPLOAD   BIT(1)

USB_DFU_ATTR_MANIFESTATION_TOLERANT

#define USB_DFU_ATTR_MANIFESTATION_TOLERANT   BIT(2)

USB_DFU_ATTR_WILL_DETACH

#define USB_DFU_ATTR_WILL_DETACH   BIT(3)

USB_DFU_PROTOCOL_DFU

#define USB_DFU_PROTOCOL_DFU   0x02

USB_DFU_PROTOCOL_RUNTIME

#define USB_DFU_PROTOCOL_RUNTIME   0x01

USB_DFU_REQ_ABORT

#define USB_DFU_REQ_ABORT   0x06

USB_DFU_REQ_CLRSTATUS

#define USB_DFU_REQ_CLRSTATUS   0x04

USB_DFU_REQ_DETACH

#define USB_DFU_REQ_DETACH   0x00

USB_DFU_REQ_DNLOAD

#define USB_DFU_REQ_DNLOAD   0x01

USB_DFU_REQ_GETSTATE

#define USB_DFU_REQ_GETSTATE   0x05

USB_DFU_REQ_GETSTATUS

#define USB_DFU_REQ_GETSTATUS   0x03

USB_DFU_REQ_UPLOAD

#define USB_DFU_REQ_UPLOAD   0x02

USB_DFU_SUBCLASS

#define USB_DFU_SUBCLASS   0x01

USB_DFU_VERSION

#define USB_DFU_VERSION   0x0110

Enumeration Type Documentation

usb_dfu_state

enum usb_dfu_state

Enumerator
APP_IDLE
APP_DETACH
DFU_IDLE
DFU_DNLOAD_SYNC
DFU_DNBUSY
DFU_DNLOAD_IDLE
DFU_MANIFEST_SYNC
DFU_MANIFEST
DFU_MANIFEST_WAIT_RST
DFU_UPLOAD_IDLE
DFU_ERROR
DFU_STATE_MAX

usb_dfu_status

enum usb_dfu_status

Enumerator
ERR_OK
ERR_TARGET
ERR_FILE
ERR_WRITE
ERR_ERASE
ERR_CHECK_ERASED
ERR_PROG
ERR_VERIFY
ERR_ADDRESS
ERR_NOTDONE
ERR_FIRMWARE
ERR_VENDOR
ERR_USBR
ERR_POR
ERR_UNKNOWN
ERR_STALLEDPKT