usbd_dfuuser.h

Go to the documentation of this file.

/***********************************************************************
* $Id: mw_usbd_dfuuser.h.rca 1.2 Tue Nov  1 11:45:07 2011 nlv09221 Experimental $
*
* Project: USB device ROM Stack
*
* Description:
*     Device Firmware Upgrade Class Custom User Module Definitions.
*
***********************************************************************
*   Copyright(C) 2011, NXP Semiconductor
*   All rights reserved.
*
* Software that is described herein is for illustrative purposes only
* which provides customers with programming information regarding the
* products. This software is supplied "AS IS" without any warranties.
* NXP Semiconductors assumes no responsibility or liability for the
* use of the software, conveys no license or title under any patent,
* copyright, or mask work right to the product. NXP Semiconductors
* reserves the right to make changes in the software without
* notification. NXP Semiconductors also make no representation or
* warranty that such application will be suitable for the specified
* use without further testing or modification.
**********************************************************************/

#ifndef __DFUUSER_H__
#define __DFUUSER_H__

#include "usbd.h"
#include "usbd_dfu.h"
#include "usbd_core.h"

typedef struct USBD_DFU_INIT_PARAM
{
  /* memory allocation params */
  uint32_t mem_base;  
  uint32_t mem_size;  
  /* DFU paramas */
  uint16_t wTransferSize; 
  uint16_t pad;
  uint8_t* intf_desc;
  /* user defined functions */
  uint8_t (*DFU_Write)( uint32_t block_num, uint8_t** src, uint32_t length, uint8_t* bwPollTimeout);

  uint32_t (*DFU_Read)( uint32_t block_num, uint8_t** dst, uint32_t length);

  void (*DFU_Done)(void);

  void (*DFU_Detach)(USBD_HANDLE_T hUsb);

  ErrorCode_t (*DFU_Ep0_Hdlr) (USBD_HANDLE_T hUsb, void* data, uint32_t event);

} USBD_DFU_INIT_PARAM_T;


typedef struct USBD_DFU_API
{
  uint32_t (*GetMemSize)(USBD_DFU_INIT_PARAM_T* param);

  ErrorCode_t (*init)(USBD_HANDLE_T hUsb, USBD_DFU_INIT_PARAM_T* param, uint32_t init_state);

} USBD_DFU_API_T;

/*-----------------------------------------------------------------------------
 *  Private functions & structures prototypes
 *-----------------------------------------------------------------------------*/
typedef struct _USBD_DFU_CTRL_T
{
  /*ALIGNED(4)*/ DFU_STATUS_T dfu_req_get_status;
  uint16_t pad;
  uint8_t dfu_state;
  uint8_t dfu_status;
  uint8_t download_done;
  uint8_t if_num;                  /* interface number */

  uint8_t* xfr_buf;
  USB_DFU_FUNC_DESCRIPTOR* dfu_desc;

  USB_CORE_CTRL_T*  pUsbCtrl;
  /* user defined functions */
  /* return DFU_STATUS_ values defined in mw_usbd_dfu.h */
  uint8_t (*DFU_Write)( uint32_t block_num, uint8_t** src, uint32_t length, uint8_t* bwPollTimeout);
  /* return 
  * DFU_STATUS_ : values defined in mw_usbd_dfu.h in case of errors
  * 0 : If end of memory reached
  * length : Amount of data copied to destination buffer
  */
  uint32_t (*DFU_Read)( uint32_t block_num, uint8_t** dst, uint32_t length);
  /* callback called after download is finished */
  void (*DFU_Done)(void);
  /* callback called after USB_REQ_DFU_DETACH is recived */
  void (*DFU_Detach)(USBD_HANDLE_T hUsb);

} USBD_DFU_CTRL_T;

uint32_t mwDFU_GetMemSize(USBD_DFU_INIT_PARAM_T* param);
extern ErrorCode_t mwDFU_init(USBD_HANDLE_T hUsb, USBD_DFU_INIT_PARAM_T* param, uint32_t init_state);
#endif  /* __DFUUSER_H__ */