aboutsummaryrefslogtreecommitdiffstats
path: root/core/usb/descriptors.h
blob: 6e96024f72db90d8280394b1b67e80720d4af227 (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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
/* insert license */
#ifndef __DESCRIPTORS_H
#define __DESCRIPTORS_H


#include "libmaple.h"
#include "usb_lib.h"

#define USB_DESCRIPTOR_TYPE_DEVICE        0x01
#define USB_DESCRIPTOR_TYPE_CONFIGURATION 0x02
#define USB_DESCRIPTOR_TYPE_STRING        0x03
#define USB_DESCRIPTOR_TYPE_INTERFACE     0x04
#define USB_DESCRIPTOR_TYPE_ENDPOINT      0x05

#define USB_DEVICE_CLASS_CDC              0x02
#define USB_DEVICE_SUBCLASS_CDC           0x00

#define USB_CONFIG_ATTR_BUSPOWERED        0b10000000
#define USB_CONFIG_ATTR_SELF_POWERED       0b11000000

#define EP_TYPE_INTERRUPT                 0x03
#define EP_TYPE_BULK                      0x02

#define USB_DESCRIPTOR_ENDPOINT_IN        0x80
#define USB_DESCRIPTOR_ENDPOINT_OUT       0x00

#define USB_DESCRIPTOR_STRING_LEN(x) (2 + (x << 1))


#if defined(__cplusplus)
extern "C" {
#endif

#define USB_DESCRIPTOR_STRING(len)		\
  struct {					\
    uint8 bLength;				\
    uint8 bDescriptorType;			\
    uint16 bString[len];			\
  }

#define CDC_FUCNTIONAL_DESCRIPTOR(DataSize)	\
  struct					\
  {						\
    uint8 bLength;				\
    uint8 bDescriptorType;			\
    uint8 SubType;				\
    uint8 Data[DataSize];			\
  }

typedef struct {
  uint8                 bLength;
  uint8                 bDescriptorType;
  uint16                bcdUSB;
  uint8                 bDeviceClass;
  uint8                 bDeviceSubClass;
  uint8                 bDeviceProtocol;
  uint8                 bMaxPacketSize0;
  uint16                idVendor;
  uint16                idProduct;
  uint16                bcdDevice;
  uint8                 iManufacturer;
  uint8                 iProduct;
  uint8                 iSerialNumber;
  uint8                 bNumConfigurations;
} USB_Descriptor_Device;

typedef struct {
  uint8_t                 bLength;
  uint8_t                 bDescriptorType;
  uint16_t                wTotalLength;
  uint8_t                 bNumInterfaces;
  uint8_t                 bConfigurationValue;
  uint8_t                 iConfiguration;
  uint8_t                 bmAttributes;
  uint8_t                 bMaxPower;
} USB_Descriptor_Config_Header;

typedef struct {
  uint8_t                 bLength;
  uint8_t                 bDescriptorType;
  uint8_t                 bInterfaceNumber;
  uint8_t                 bAlternateSetting;
  uint8_t                 bNumEndpoints;
  uint8_t                 bInterfaceClass;
  uint8_t                 bInterfaceSubClass;
  uint8_t                 bInterfaceProtocol;
  uint8_t                 iInterface;
} USB_Descriptor_Interface;

typedef struct {
  uint8_t                 bLength;
  uint8_t                 bDescriptorType;
  uint8_t                 bEndpointAddress;
  uint8_t                 bmAttributes;
  uint16_t                wMaxPacketSize;
  uint8_t                 bInterval;
} USB_Descriptor_Endpoint;

typedef struct {
  /* config header */
  uint8_t                 bLength;
  uint8_t                 bDescriptorType;
  uint16_t                wTotalLength;
  uint8_t                 bNumInterfaces;
  uint8_t                 bConfigurationValue;
  uint8_t                 iConfiguration;
  uint8_t                 bmAttributes;
  uint8_t                 bMaxPower;

  USB_Descriptor_Interface            CCI_Interface;
  struct {						
    uint8 bLength;				
    uint8 bDescriptorType;			
    uint8 SubType;				
    uint8 Data[2];			
  }                                   CDC_Functional_IntHeader;
  struct {						
    uint8 bLength;				
    uint8 bDescriptorType;			
    uint8 SubType;				
    uint8 Data[2];			
  }                                   CDC_Functional_CallManagement;
  struct {						
    uint8 bLength;				
    uint8 bDescriptorType;			
    uint8 SubType;				
    uint8 Data[1];			
  }                                   CDC_Functional_ACM;
  struct {						
    uint8 bLength;				
    uint8 bDescriptorType;			
    uint8 SubType;				
    uint8 Data[2];			
  }                                   CDC_Functional_Union;

  /*
  USB_Descriptor_Endpoint             ManagementEndpoint;
  */
  uint8_t                 EP1_bLength;
  uint8_t                 EP1_bDescriptorType;
  uint8_t                 EP1_bEndpointAddress;
  uint8_t                 EP1_bmAttributes;
  uint8_t                 EP1_wMaxPacketSize0;
  uint8_t                 EP1_wMaxPacketSize1;
  uint8_t                 EP1_bInterval;

  /*
  USB_Descriptor_Interface            DCI_Interface;
  */

  uint8_t                 DCI_bLength;
  uint8_t                 DCI_bDescriptorType;
  uint8_t                 DCI_bInterfaceNumber;
  uint8_t                 DCI_bAlternateSetting;
  uint8_t                 DCI_bNumEndpoints;
  uint8_t                 DCI_bInterfaceClass;
  uint8_t                 DCI_bInterfaceSubClass;
  uint8_t                 DCI_bInterfaceProtocol;
  uint8_t                 DCI_iInterface;

  /*
  USB_Descriptor_Endpoint             DataOutEndpoint;
  USB_Descriptor_Endpoint             DataInEndpoint;
  */

  uint8_t                 EP2_bLength;
  uint8_t                 EP2_bDescriptorType;
  uint8_t                 EP2_bEndpointAddress;
  uint8_t                 EP2_bmAttributes;
  uint8_t                 EP2_wMaxPacketSize0;
  uint8_t                 EP2_wMaxPacketSize1;
  uint8_t                 EP2_bInterval;

  uint8_t                 EP3_bLength;
  uint8_t                 EP3_bDescriptorType;
  uint8_t                 EP3_bEndpointAddress;
  uint8_t                 EP3_bmAttributes;
  uint8_t                 EP3_wMaxPacketSize0;
  uint8_t                 EP3_wMaxPacketSize1;
  uint8_t                 EP3_bInterval;

  
}USB_Descriptor_Config;
 
  typedef struct {
    uint8          bLength;
    uint8          bDescriptorType;
    uint16         bString[];
  } USB_Descriptor_String;

extern const USB_Descriptor_Device usbVcomDescriptor_Device;
extern const USB_Descriptor_Config usbVcomDescriptor_Config;

extern const uint8 usbVcomDescriptor_LangID[USB_DESCRIPTOR_STRING_LEN(1)];
extern const uint8 usbVcomDescriptor_iManufacturer[USB_DESCRIPTOR_STRING_LEN(8)];
extern const uint8 usbVcomDescriptor_iProduct[USB_DESCRIPTOR_STRING_LEN(8)];

#if defined(__cplusplus)
  }
#endif

#endif  // __DESCRIPTORS_H