Descriptors.h 7.13 KB
Newer Older
1
2
/*
             LUFA Library
3
     Copyright (C) Dean Camera, 2012.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
*/

/*
10
  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
  Permission to use, copy, modify, distribute, and sell this
13
  software and its documentation for any purpose is hereby granted
14
  without fee, provided that the above copyright notice appear in
15
  all copies and that both that the copyright notice and this
16
17
18
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
19
20
  software without specific, written prior permission.

21
  The author disclaims all warranties with regard to this
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *
 *  Header file for Descriptors.c.
 */

#ifndef _DESCRIPTORS_H_
#define _DESCRIPTORS_H_

	/* Includes: */
		#include <LUFA/Drivers/USB/USB.h>

42
43
		#include "Config/AppConfig.h"

44
45
46
	/* Macros: */
		/** Descriptor type value for a DFU class functional descriptor. */
		#define DTYPE_DFUFunctional               0x21
47

48
49
50
51
52
53
54
55
56
		/** DFU attribute mask, indicating that the DFU device will detach and re-attach when a DFU_DETACH
		 *  command is issued, rather than the host issuing a USB Reset.
		 */
		#define ATTR_WILL_DETATCH                 (1 << 3)

		/** DFU attribute mask, indicating that the DFU device can communicate during the manifestation phase
		 *  (memory programming phase).
		 */
		#define ATTR_MANEFESTATION_TOLLERANT      (1 << 2)
57

58
59
		/** DFU attribute mask, indicating that the DFU device can accept DFU_UPLOAD requests to send data from
		 *  the device to the host.
60
		 */
61
62
63
64
		#define ATTR_CAN_UPLOAD                   (1 << 1)

		/** DFU attribute mask, indicating that the DFU device can accept DFU_DNLOAD requests to send data from
		 *  the host to the device.
65
		 */
66
67
68
69
70
71
72
		#define ATTR_CAN_DOWNLOAD                 (1 << 0)

		#if defined(__AVR_AT90USB1287__)
			#define PRODUCT_ID_CODE               0x2FFB
			#define AVR_SIGNATURE_1               0x1E
			#define AVR_SIGNATURE_2               0x97
			#define AVR_SIGNATURE_3               0x82
73
74
75
76
77
		#elif defined(__AVR_AT90USB647__)
			#define PRODUCT_ID_CODE               0x2FF9
			#define AVR_SIGNATURE_1               0x1E
			#define AVR_SIGNATURE_2               0x96
			#define AVR_SIGNATURE_3               0x82
78
79
80
81
82
		#elif defined(__AVR_AT90USB1286__)
			#define PRODUCT_ID_CODE               0x2FFB
			#define AVR_SIGNATURE_1               0x1E
			#define AVR_SIGNATURE_2               0x97
			#define AVR_SIGNATURE_3               0x82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
		#elif defined(__AVR_AT90USB646__)
			#define PRODUCT_ID_CODE               0x2FF9
			#define AVR_SIGNATURE_1               0x1E
			#define AVR_SIGNATURE_2               0x96
			#define AVR_SIGNATURE_3               0x82
		#elif defined(__AVR_ATmega32U6__)
			#define PRODUCT_ID_CODE               0x2FFB
			#define AVR_SIGNATURE_1               0x1E
			#define AVR_SIGNATURE_2               0x95
			#define AVR_SIGNATURE_3               0x88
		#elif defined(__AVR_ATmega32U4__)
			#define PRODUCT_ID_CODE               0x2FF4
			#define AVR_SIGNATURE_1               0x1E
			#define AVR_SIGNATURE_2               0x95
			#define AVR_SIGNATURE_3               0x87
		#elif defined(__AVR_ATmega16U4__)
			#define PRODUCT_ID_CODE               0x2FF3
			#define AVR_SIGNATURE_1               0x1E
			#define AVR_SIGNATURE_2               0x94
			#define AVR_SIGNATURE_3               0x88
103
104
105
106
107
		#elif defined(__AVR_ATmega32U2__)
			#define PRODUCT_ID_CODE               0x2FF0
			#define AVR_SIGNATURE_1               0x1E
			#define AVR_SIGNATURE_2               0x95
			#define AVR_SIGNATURE_3               0x8A
108
109
110
111
112
113
114
115
116
117
118
119
120
121
		#elif defined(__AVR_ATmega16U2__)
			#define PRODUCT_ID_CODE               0x2FEF
			#define AVR_SIGNATURE_1               0x1E
			#define AVR_SIGNATURE_2               0x94
			#define AVR_SIGNATURE_3               0x89
		#elif defined(__AVR_AT90USB162__)
			#define PRODUCT_ID_CODE               0x2FFA
			#define AVR_SIGNATURE_1               0x1E
			#define AVR_SIGNATURE_2               0x94
			#define AVR_SIGNATURE_3               0x82
		#elif defined(__AVR_ATmega8U2__)
			#define PRODUCT_ID_CODE               0x2FF7
			#define AVR_SIGNATURE_1               0x1E
			#define AVR_SIGNATURE_2               0x93
122
			#define AVR_SIGNATURE_3               0x89
123
124
125
		#elif defined(__AVR_AT90USB82__)
			#define PRODUCT_ID_CODE               0x2FEE
			#define AVR_SIGNATURE_1               0x1E
126
127
			#define AVR_SIGNATURE_2               0x94
			#define AVR_SIGNATURE_3               0x82
128
129
130
		#else
			#error The selected AVR part is not currently supported by this bootloader.
		#endif
131

132
133
134
		#if !defined(PRODUCT_ID_CODE)
			#error Current AVR model is not supported by this bootloader.
		#endif
135

136
137
138
139
140
141
	/* Type Defines: */
		/** Type define for a DFU class function descriptor. This descriptor gives DFU class information
		 *  to the host when read, indicating the DFU device's capabilities.
		 */
		typedef struct
		{
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
			USB_Descriptor_Header_t Header; /**< Standard descriptor header structure */

			uint8_t                 Attributes; /**< DFU device attributes, a mask comprising of the
			                                     *  ATTR_* macros listed in this source file
			                                     */
			uint16_t                DetachTimeout; /**< Timeout in milliseconds between a USB_DETACH
			                                        *  command being issued and the device detaching
			                                        *  from the USB bus
			                                        */
			uint16_t                TransferSize; /**< Maximum number of bytes the DFU device can accept
			                                       *  from the host in a transaction
			                                       */
			uint16_t                DFUSpecification; /**< BCD packed DFU specification number this DFU
			                                           *  device complies with
			                                           */
157
		} USB_Descriptor_DFU_Functional_t;
158

159
160
161
162
163
164
165
		/** Type define for the device configuration descriptor structure. This must be defined in the
		 *  application code, as the configuration descriptor contains several sub-descriptors which
		 *  vary between devices, and which describe the device's usage to the host.
		 */
		typedef struct
		{
			USB_Descriptor_Configuration_Header_t Config;
166

167
			// DFU Interface
168
			USB_Descriptor_Interface_t            DFU_Interface;
169
			USB_Descriptor_DFU_Functional_t       DFU_Functional;
170
		} USB_Descriptor_Configuration_t;
171

172
	/* Function Prototypes: */
173
174
		uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
		                                    const uint8_t wIndex,
175
176
		                                    const void** const DescriptorAddress)
		                                    ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
177
178

#endif
179