Device Firmware Update (DFU) Middleware Library 5.1
Data Structures

General Description

Data Structures

struct  cy_stc_dfu_params_t
 Working parameters for some DFU SDK APIs to be initialized before calling DFU API. More...
 
struct  cy_stc_dfu_enter_t
 Only used inside DFU Command_Enter(). More...
 

Typedefs

typedef cy_en_dfu_status_t(* Cy_DFU_CustomCommandHandler) (uint32_t command, uint8_t *packetData, uint32_t dataSize, uint32_t *rspSize, struct cy_stc_dfu_params_s *params, bool *noResponse)
 The type for custom command handlers.
 

Data Structure Documentation

◆ cy_stc_dfu_params_t

struct cy_stc_dfu_params_t
Data Fields
uint8_t * dataBuffer The pointer to a buffer that keeps data to read or write to an NVM.

It is required to be 4-byte aligned.

uint32_t dataOffset An offset within dataBuffer to put a next chunk of data.
uint8_t * packetBuffer The pointer to a buffer that keeps packets sent and received with the Transport API.

It is required to be 4-byte aligned.

uint32_t timeout The time (in milliseconds) for which the communication interface waits to receive a new data packet from Host in Cy_DFU_Continue().

A typical value is 20 ms.

uint32_t appId Set with the Set App Metadata DFU command.

Used to determine an appId of a DFU image

uint32_t appVerified Internal, flags if Verify Application is called before Exit.
uint32_t initCtl The initial value to the ctl parameter for Cy_DFU_ReadData and Cy_DFU_WriteData.

The DFU SDK functions call the Read/Write Data functions like this:
Cy_DFU_ReadData(addr, length, CY_DFU_IOCTL_COMPARE, params).

◆ cy_stc_dfu_enter_t

struct cy_stc_dfu_enter_t
Data Fields
uint32_t enterSiliconId The silicon ID for a device.
uint8_t enterRevision Silicon Revision for a device.
uint8_t enterDFUVersion[3] The DFU SDK version.