dfu.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2020 Mesotic SAS
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
 
#include "usb.h"
#include "usb/descriptor.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define USB_IF_DESCRIPTOR_DFU           0x21   
#define USB_DFU_VERSION_BCD             0x0110 

#ifndef USB_DFU_DETACH_TIMEOUT_MS
#define USB_DFU_DETACH_TIMEOUT_MS 255
#endif

#define USB_DFU_CAN_DOWNLOAD            0x01    
#define USB_DFU_CAN_UPLOAD              0x02    
#define USB_DFU_MANIFEST_TOLERANT       0x04    
#define USB_DFU_WILL_DETACH             0x08    

#define USB_DFU_INTERFACE               0xFE 

#define USB_DFU_SUBCLASS_DFU            0x01 

#define USB_DFU_PROTOCOL_RUNTIME_MODE   0x01 
#define USB_DFU_PROTOCOL_DFU_MODE       0x02 

#define DFU_DETACH      0x00        
#define DFU_DOWNLOAD    0x01        
#define DFU_UPLOAD      0x02        
#define DFU_GET_STATUS  0x03        
#define DFU_CLR_STATUS  0x04        
#define DFU_GET_STATE   0x05        
#define DFU_ABORT       0x06        

typedef enum {
    USB_DFU_STATE_APP_IDLE,               
    USB_DFU_STATE_APP_DETACH,             
    USB_DFU_STATE_DFU_IDLE,               
    USB_DFU_STATE_DFU_DL_SYNC,            
    USB_DFU_STATE_DFU_DL_BUSY,            
    USB_DFU_STATE_DFU_DL_IDLE,            
    USB_DFU_STATE_DFU_MANIFEST_SYNC,      
    USB_DFU_STATE_DFU_MANIFEST,           
    USB_DFU_STATE_DFU_MANIFEST_WAIT_RST,  
    USB_DFU_STATE_DFU_UP_IDLE,            
    USB_DFU_STATE_DFU_ERROR               
} usb_dfu_state_t;

typedef struct __attribute__((packed)) {
    uint8_t length;              
    uint8_t type;                
    uint8_t attribute;           
    uint16_t detach_timeout;     
    uint16_t xfer_size;          
    uint16_t bcd_dfu;            
} usb_desc_if_dfu_t;

typedef struct __attribute__((packed))  {
    uint8_t status;             
    uint32_t timeout : 24;      
    uint8_t state;              
    uint8_t string;             
} dfu_get_status_pkt_t;
 
#ifdef __cplusplus
}
#endif