| LPCOpen Platform v1.03 LPCOpen Platform for NXP LPC Microcontrollers

- Main Page
- Modules
- Data Structures
- Files
- Related Pages

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
usbd_dfu.h
Go to the documentation of this file.
1 /*
2 * @brief Definition of DFU class descriptors and their bit defines
3 *
4 * @note
5 * Copyright(C) NXP Semiconductors, 2012
6 * All rights reserved.
7 *
8 * @par
9 * Software that is described herein is for illustrative purposes only
10 * which provides customers with programming information regarding the
11 * LPC products. This software is supplied "AS IS" without any warranties of
12 * any kind, and NXP Semiconductors and its licensor disclaim any and
13 * all warranties, express or implied, including all implied warranties of
14 * merchantability, fitness for a particular purpose and non-infringement of
15 * intellectual property rights. NXP Semiconductors assumes no responsibility
16 * or liability for the use of the software, conveys no license or rights under any
17 * patent, copyright, mask work right, or any other intellectual property rights in
18 * or to any products. NXP Semiconductors reserves the right to make changes
19 * in the software without notification. NXP Semiconductors also makes no
20 * representation or warranty that such application will be suitable for the
21 * specified use without further testing or modification.
22 *
23 * @par
24 * Permission to use, copy, modify, and distribute this software and its
25 * documentation is hereby granted, under NXP Semiconductors' and its
26 * licensor's relevant copyrights in the software, without fee, provided that it
27 * is used in conjunction with NXP Semiconductors microcontrollers. This
28 * copyright, permission, and disclaimer notice must appear in all copies of
29 * this code.
30 */
31
32 #include "usbd.h"
33
34 #ifndef __MW_USBD_DFU_H__
35 #define __MW_USBD_DFU_H__
36
37
43 #define USB_DFU_IF_NUM 0x0
44
45 #define USB_DFU_DESCRIPTOR_TYPE 0x21
46 #define USB_DFU_DESCRIPTOR_SIZE 9
47 #define USB_DFU_SUBCLASS 0x01
48 #define USB_DFU_XFER_SIZE 2048
49
50 /* DFU class-specific requests (Section 3, DFU Rev 1.1) */
51 #define USB_REQ_DFU_DETACH 0x00
52 #define USB_REQ_DFU_DNLOAD 0x01
53 #define USB_REQ_DFU_UPLOAD 0x02
54 #define USB_REQ_DFU_GETSTATUS 0x03
55 #define USB_REQ_DFU_CLRSTATUS 0x04
56 #define USB_REQ_DFU_GETSTATE 0x05
57 #define USB_REQ_DFU_ABORT 0x06
58
59 #define DFU_STATUS_OK 0x00
60 #define DFU_STATUS_errTARGET 0x01
61 #define DFU_STATUS_errFILE 0x02
62 #define DFU_STATUS_errWRITE 0x03
63 #define DFU_STATUS_errERASE 0x04
64 #define DFU_STATUS_errCHECK_ERASED 0x05
65 #define DFU_STATUS_errPROG 0x06
66 #define DFU_STATUS_errVERIFY 0x07
67 #define DFU_STATUS_errADDRESS 0x08
68 #define DFU_STATUS_errNOTDONE 0x09
69 #define DFU_STATUS_errFIRMWARE 0x0a
70 #define DFU_STATUS_errVENDOR 0x0b
71 #define DFU_STATUS_errUSBR 0x0c
72 #define DFU_STATUS_errPOR 0x0d
73 #define DFU_STATUS_errUNKNOWN 0x0e
74 #define DFU_STATUS_errSTALLEDPKT 0x0f
75
76 enum dfu_state {
77 DFU_STATE_appIDLE = 0,
78 DFU_STATE_appDETACH = 1,
79 DFU_STATE_dfuIDLE = 2,
80 DFU_STATE_dfuDNLOAD_SYNC = 3,
81 DFU_STATE_dfuDNBUSY = 4,
82 DFU_STATE_dfuDNLOAD_IDLE = 5,
83 DFU_STATE_dfuMANIFEST_SYNC = 6,
84 DFU_STATE_dfuMANIFEST = 7,
85 DFU_STATE_dfuMANIFEST_WAIT_RST= 8,
86 DFU_STATE_dfuUPLOAD_IDLE = 9,
87 DFU_STATE_dfuERROR = 10
88 };
89
90 #define DFU_EP0_NONE 0
91 #define DFU_EP0_UNHANDLED 1
92 #define DFU_EP0_STALL 2
93 #define DFU_EP0_ZLP 3
94 #define DFU_EP0_DATA 4
95
96 #define USB_DFU_CAN_DOWNLOAD (1 << 0)
97 #define USB_DFU_CAN_UPLOAD (1 << 1)
98 #define USB_DFU_MANIFEST_TOL (1 << 2)
99 #define USB_DFU_WILL_DETACH (1 << 3)
100
101 PRE_PACK struct POST_PACK _USB_DFU_FUNC_DESCRIPTOR {
102 uint8_t bLength;
103 uint8_t bDescriptorType;
104 uint8_t bmAttributes;
105 uint16_t wDetachTimeOut;
106 uint16_t wTransferSize;
107 uint16_t bcdDFUVersion;
108 };
109 typedef struct _USB_DFU_FUNC_DESCRIPTOR USB_DFU_FUNC_DESCRIPTOR;
110
111 PRE_PACK struct POST_PACK _DFU_STATUS {
112 uint8_t bStatus;
113 uint8_t bwPollTimeout[3];
114 uint8_t bState;
115 uint8_t iString;
116 };
117 typedef struct _DFU_STATUS DFU_STATUS_T;
118
119 #define DFU_FUNC_DESC_SIZE sizeof(USB_DFU_FUNC_DESCRIPTOR)
120 #define DFU_GET_STATUS_SIZE 0x6
121
122
123 #endif /* __MW_USBD_DFU_H__ */