summaryrefslogtreecommitdiff
path: root/digital/zigbit/bitcloud/stack/Components/HAL/drivers/USBClasses/DFU/include/dfuProtocol.h
blob: c525cfd1555ffd98e39e798149b4965253eb6fcf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/****************************************************************************//**
  \file dfuProtocol.h

  \brief Declaration of Device firmware upgrade commands.

  \author
    Atmel Corporation: http://www.atmel.com \n
    Support email: avr@atmel.com

  Copyright (c) 2008-2011, Atmel Corporation. All rights reserved.
  Licensed under Atmel's Limited License Agreement (BitCloudTM).

  \internal
  History:
    08/09/11 N. Fomin - Created
*******************************************************************************/
#ifndef _DFUPROTOCOL_H
#define _DFUPROTOCOL_H

/******************************************************************************
                   Includes section
******************************************************************************/
#include <types.h>
#include <usbSetupProcess.h>

/******************************************************************************
                   Define(s) section
******************************************************************************/
// data size in request structure
#define DFU_REQUEST_DATA_SIZE 6
// request codes for mass storage class
#define DFU_DETACH    0x00
#define DFU_GETSTATUS 0x03
#define DFU_GETSTATE  0x05

/******************************************************************************
                   Types section
******************************************************************************/
BEGIN_PACK
// Usb host request
typedef struct PACK
{
  UsbRequest_t request;
  uint8_t  bData[DFU_REQUEST_DATA_SIZE];
} UsbDfuRequest_t;

// Usb dfu get status response
typedef struct PACK
{
  uint8_t  bStatus;
  uint8_t  bPollTimeout[3];
  uint8_t  bState;
  uint8_t  iString;
} DfuGetStatusResponse_t;

// Usb dfu get state response
typedef struct PACK
{
  uint8_t  bState;
} DfuGetStateResponse_t;

typedef union PACK
{
  DfuGetStatusResponse_t getStatusResponse;
  DfuGetStateResponse_t getStateResponse;
} UsbDfuResponse_t;

END_PACK

/******************************************************************************
                   Prototypes section
******************************************************************************/
/**************************************************************************//**
\brief Device firmware upgrade request handler.
\param[in]
  data - pointer to host's request.
******************************************************************************/
void dfuRequestHandler(uint8_t *data);

#endif /* _DFUPROTOCOL_H */
// eof dfuProtocol.h