Hanna
Sourcecode Kontrollplatine
Descriptors.h
gehe zur Dokumentation dieser Datei
1 
19 /*
20  Copyright 2010 OBinou (obconseil [at] gmail [dot] com)
21  Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)
22 
23  Permission to use, copy, modify, distribute, and sell this
24  software and its documentation for any purpose is hereby granted
25  without fee, provided that the above copyright notice appear in
26  all copies and that both that the copyright notice and this
27  permission notice and warranty disclaimer appear in supporting
28  documentation, and that the name of the author not be used in
29  advertising or publicity pertaining to distribution of the
30  software without specific, written prior permission.
31 
32  The author disclaim all warranties with regard to this
33  software, including all implied warranties of merchantability
34  and fitness. In no event shall the author be liable for any
35  special, indirect or consequential damages or any damages
36  whatsoever resulting from loss of use, data or profits, whether
37  in an action of contract, negligence or other tortious action,
38  arising out of or in connection with the use or performance of
39  this software.
40  */
41 
42 #ifndef _DESCRIPTORS_H_
43 #define _DESCRIPTORS_H_
44 
45 /* Includes: */
46 #include <avr/pgmspace.h>
47 #include "usb_defaults.h"
48 
49 /* Macros: */
50 
52 // Endpoint Macros
54 
55 #define CDC_NOTIFICATION_EPADDR (ENDPOINT_DIR_IN | 2)
56 
58 #define CDC_TX_EPADDR (ENDPOINT_DIR_IN | 3)
59 
61 #define CDC_RX_EPADDR (ENDPOINT_DIR_OUT | 4)
62 
64 #define CDC_NOTIFICATION_EPSIZE 8
65 
67 #define CDC_TXRX_EPSIZE 64
68 
70 // CDC Macros
72 
75 #define CDC_CONTROL_LINE_OUT_DTR (1 << 0)
76 
80 #define CDC_CONTROL_LINE_OUT_RTS (1 << 1)
81 
85 #define CDC_CONTROL_LINE_IN_DCD (1 << 0)
86 
90 #define CDC_CONTROL_LINE_IN_DSR (1 << 1)
91 
95 #define CDC_CONTROL_LINE_IN_BREAK (1 << 2)
96 
100 #define CDC_CONTROL_LINE_IN_RING (1 << 3)
101 
105 #define CDC_CONTROL_LINE_IN_FRAMEERROR (1 << 4)
106 
110 #define CDC_CONTROL_LINE_IN_PARITYERROR (1 << 5)
111 
115 #define CDC_CONTROL_LINE_IN_OVERRUNERROR (1 << 6)
116 
118 // CDC class-specific Macros
120 
127 #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize) \
128  struct \
129  { \
130  USB_Descriptor_Header_t Header; \
131  uint8_t SubType; \
132  uint8_t Data[DataSize]; \
133  }
134 
136 // CDC Enums
138 
141 enum CDC_Descriptor_ClassSubclassProtocol_t
142 {
143  CDC_CSCP_CDCClass = 0x02,
146  CDC_CSCP_NoSpecificSubclass = 0x00,
149  CDC_CSCP_ACMSubclass = 0x02,
152  CDC_CSCP_ATCommandProtocol = 0x01,
155  CDC_CSCP_NoSpecificProtocol = 0x00,
158  CDC_CSCP_VendorSpecificProtocol = 0xFF,
161  CDC_CSCP_CDCDataClass = 0x0A,
164  CDC_CSCP_NoDataSubclass = 0x00,
167  CDC_CSCP_NoDataProtocol = 0x00,
170 };
171 
173 enum CDC_ClassRequests_t
174 {
175  CDC_REQ_SendEncapsulatedCommand = 0x00,
176  CDC_REQ_GetEncapsulatedResponse = 0x01,
177  CDC_REQ_SetLineEncoding = 0x20,
178  CDC_REQ_GetLineEncoding = 0x21,
179  CDC_REQ_SetControlLineState = 0x22,
180  CDC_REQ_SendBreak = 0x23,
181 };
182 
184 enum CDC_ClassNotifications_t
185 {
186  CDC_NOTIF_SerialState = 0x20,
191 };
192 
194 enum CDC_DescriptorSubtypes_t
195 {
196  CDC_DSUBTYPE_CSInterface_Header = 0x00,
197  CDC_DSUBTYPE_CSInterface_CallManagement = 0x01,
198  CDC_DSUBTYPE_CSInterface_ACM = 0x02,
199  CDC_DSUBTYPE_CSInterface_DirectLine = 0x03,
200  CDC_DSUBTYPE_CSInterface_TelephoneRinger = 0x04,
201  CDC_DSUBTYPE_CSInterface_TelephoneCall = 0x05,
202  CDC_DSUBTYPE_CSInterface_Union = 0x06,
203  CDC_DSUBTYPE_CSInterface_CountrySelection = 0x07,
204  CDC_DSUBTYPE_CSInterface_TelephoneOpModes = 0x08,
205  CDC_DSUBTYPE_CSInterface_USBTerminal = 0x09,
206  CDC_DSUBTYPE_CSInterface_NetworkChannel = 0x0A,
207  CDC_DSUBTYPE_CSInterface_ProtocolUnit = 0x0B,
208  CDC_DSUBTYPE_CSInterface_ExtensionUnit = 0x0C,
209  CDC_DSUBTYPE_CSInterface_MultiChannel = 0x0D,
210  CDC_DSUBTYPE_CSInterface_CAPI = 0x0E,
211  CDC_DSUBTYPE_CSInterface_Ethernet = 0x0F,
212  CDC_DSUBTYPE_CSInterface_ATM = 0x10,
213 };
214 
216 enum CDC_LineEncodingFormats_t
217 {
218  CDC_LINEENCODING_OneStopBit = 0,
219  CDC_LINEENCODING_OneAndAHalfStopBits = 1,
220  CDC_LINEENCODING_TwoStopBits = 2,
221 };
222 
224 enum CDC_LineEncodingParity_t
225 {
226  CDC_PARITY_None = 0,
227  CDC_PARITY_Odd = 1,
228  CDC_PARITY_Even = 2,
229  CDC_PARITY_Mark = 3,
230  CDC_PARITY_Space = 4,
231 };
232 
234 // CDC typedefs
236 
246 typedef struct
247 {
248  USB_Descriptor_Header_t Header;
249  uint8_t Subtype;
252  uint16_t CDCSpecification;
255 }ATTR_PACKED USB_CDC_Descriptor_FunctionalHeader_t;
256 
268 typedef struct
269 {
270  uint8_t bFunctionLength;
271  uint8_t bDescriptorType;
274  uint8_t bDescriptorSubType;
277  uint16_t bcdCDC;
278 }ATTR_PACKED USB_CDC_StdDescriptor_FunctionalHeader_t;
279 
289 typedef struct
290 {
291  USB_Descriptor_Header_t Header;
292  uint8_t Subtype;
295  uint8_t Capabilities;
299 }ATTR_PACKED USB_CDC_Descriptor_FunctionalACM_t;
300 
311 typedef struct
312 {
313  uint8_t bFunctionLength;
314  uint8_t bDescriptorType;
317  uint8_t bDescriptorSubType;
320  uint8_t bmCapabilities;
324 }ATTR_PACKED USB_CDC_StdDescriptor_FunctionalACM_t;
325 
335 typedef struct
336 {
337  USB_Descriptor_Header_t Header;
338  uint8_t Subtype;
341  uint8_t MasterInterfaceNumber;
342  uint8_t SlaveInterfaceNumber;
343 }ATTR_PACKED USB_CDC_Descriptor_FunctionalUnion_t;
344 
355 typedef struct
356 {
357  uint8_t bFunctionLength;
358  uint8_t bDescriptorType;
361  uint8_t bDescriptorSubType;
364  uint8_t bMasterInterface;
365  uint8_t bSlaveInterface0;
366 }ATTR_PACKED USB_CDC_StdDescriptor_FunctionalUnion_t;
367 
375 typedef struct
376 {
377  uint32_t BaudRateBPS;
378  uint8_t CharFormat;
381  uint8_t ParityType;
384  uint8_t DataBits;
385 }ATTR_PACKED CDC_LineEncoding_t;
386 
387 /* Type Defines: */
392 typedef struct
393 {
394  USB_Descriptor_Configuration_Header_t Config;
395 
396  // CDC Control Interface
397  USB_Descriptor_Interface_t CDC_CCI_Interface;
398  USB_CDC_Descriptor_FunctionalHeader_t CDC_Functional_Header;
399  USB_CDC_Descriptor_FunctionalACM_t CDC_Functional_ACM;
400  USB_CDC_Descriptor_FunctionalUnion_t CDC_Functional_Union;
401  USB_Descriptor_Endpoint_t CDC_NotificationEndpoint;
402 
403  // CDC Data Interface
404  USB_Descriptor_Interface_t CDC_DCI_Interface;
405  USB_Descriptor_Endpoint_t CDC_DataOutEndpoint;
406  USB_Descriptor_Endpoint_t CDC_DataInEndpoint;
407 } USB_Descriptor_Configuration_t;
408 
410 // CDC Prototypes
412 /* Function Prototypes: */
413 uint16_t CALLBACK_USB_GetDescriptor ( const uint16_t wValue,
414  const uint8_t wIndex, const void** const DescriptorAddress ) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
415 
416 #endif
417 
usb_defaults.h
Bibliothek zur USB-Kommunikation von Jürgen W.
ATTR_PACKED::bDescriptorSubType
uint8_t bDescriptorSubType
Definition: Descriptors.h:274
CDC_Descriptor_ClassSubclassProtocol_t
CDC_Descriptor_ClassSubclassProtocol_t
Definition: Descriptors.h:141
ATTR_PACKED::CDCSpecification
uint16_t CDCSpecification
Definition: Descriptors.h:252
ATTR_PACKED::DataBits
uint8_t DataBits
Definition: Descriptors.h:384
ATTR_PACKED::bcdCDC
uint16_t bcdCDC
Definition: Descriptors.h:277
CDC_ClassNotifications_t
CDC_ClassNotifications_t
Definition: Descriptors.h:184
ATTR_PACKED::Capabilities
uint8_t Capabilities
Definition: Descriptors.h:295
ATTR_PACKED::ParityType
uint8_t ParityType
Definition: Descriptors.h:381
CDC_ClassRequests_t
CDC_ClassRequests_t
Definition: Descriptors.h:173
ATTR_PACKED::bFunctionLength
uint8_t bFunctionLength
Definition: Descriptors.h:270
ATTR_PACKED::bMasterInterface
uint8_t bMasterInterface
Definition: Descriptors.h:364
ATTR_PACKED::Subtype
uint8_t Subtype
Definition: Descriptors.h:249
ATTR_PACKED::bDescriptorType
uint8_t bDescriptorType
Definition: Descriptors.h:271
CDC_LineEncodingFormats_t
CDC_LineEncodingFormats_t
Definition: Descriptors.h:216
ATTR_PACKED::bSlaveInterface0
uint8_t bSlaveInterface0
Definition: Descriptors.h:365
ATTR_PACKED::bmCapabilities
uint8_t bmCapabilities
Definition: Descriptors.h:320
ATTR_PACKED::SlaveInterfaceNumber
uint8_t SlaveInterfaceNumber
Definition: Descriptors.h:342
ATTR_PACKED::BaudRateBPS
uint32_t BaudRateBPS
Definition: Descriptors.h:377
CALLBACK_USB_GetDescriptor
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, const void **const DescriptorAddress) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3)
Definition: Descriptors.c:182
CDC_LineEncodingParity_t
CDC_LineEncodingParity_t
Definition: Descriptors.h:224
ATTR_PACKED::Header
USB_Descriptor_Header_t Header
Definition: Descriptors.h:248
ATTR_PACKED::MasterInterfaceNumber
uint8_t MasterInterfaceNumber
Definition: Descriptors.h:341
ATTR_PACKED::CharFormat
uint8_t CharFormat
Definition: Descriptors.h:378
CDC_DescriptorSubtypes_t
CDC_DescriptorSubtypes_t
Definition: Descriptors.h:194
by Hanna