usbd_dfuuser.h

Go to the documentation of this file.

/*
 * @brief Definition of functions exported by ROM based DFU function driver
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
  * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#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; 
  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;
  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;


#endif  /* __DFUUSER_H__ */