Blame view

lufa-master/PolytechLille/PAD/Descriptors.c 9.13 KB
142ecdaf   rguillom   first commit
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
  /*
               LUFA Library
       Copyright (C) Dean Camera, 2019.
  
    dean [at] fourwalledcubicle [dot] com
             www.lufa-lib.org
  */
  
  /*
    Copyright 2010  OBinou (obconseil [at] gmail [dot] com)
    Copyright 2019  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  
    Permission to use, copy, modify, distribute, and sell this
    software and its documentation for any purpose is hereby granted
    without fee, provided that the above copyright notice appear in
    all copies and that both that the copyright notice and this
    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
    software without specific, written prior permission.
  
    The author disclaims all warranties with regard to this
    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.
  */
  
142ecdaf   rguillom   first commit
32
33
34
35
36
37
38
39
40
  /** \file
   *
   *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special
   *  computer-readable structures which the host requests upon device enumeration, to determine
   *  the device's capabilities and functions.
   */
  
  #include "Descriptors.h"
  
4dcf8810   rguillom   Descripteurs au p...
41
42
43
44
  /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
   *  device characteristics, including the supported USB version, control endpoint size and the
   *  number of device configurations. The descriptor is read out by the USB host when the enumeration
   *  process begins.
142ecdaf   rguillom   first commit
45
46
47
48
49
50
51
52
53
54
55
56
   */
  const USB_Descriptor_Device_t PROGMEM RelayBoard_DeviceDescriptor =
  {
  	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  
  	.USBSpecification       = VERSION_BCD(1,1,0),
  	.Class                  = USB_CSCP_VendorSpecificClass,
  	.SubClass               = USB_CSCP_NoDeviceSubclass,
  	.Protocol               = USB_CSCP_NoDeviceProtocol,
  
  	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  
4dcf8810   rguillom   Descripteurs au p...
57
58
  	.VendorID               = 0x04B4,		//A MODIFIER avec VendorID Carte
  	.ProductID              = 0xFD11,		//A MODIFIER
142ecdaf   rguillom   first commit
59
60
61
62
63
64
65
  	.ReleaseNumber          = VERSION_BCD(2,0,0),
  
  	.ManufacturerStrIndex   = STRING_ID_Manufacturer,
  	.ProductStrIndex        = STRING_ID_Product,
  	.SerialNumStrIndex      = STRING_ID_Serial,
  
  	.NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
4dcf8810   rguillom   Descripteurs au p...
66
  };
142ecdaf   rguillom   first commit
67
68
69
70
71
72
  
  /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
   *  of the device in one of its supported configurations, including information about any device interfaces
   *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
   *  a configuration so that the host may correctly communicate with the USB device.
   */
4dcf8810   rguillom   Descripteurs au p...
73
  const USB_Descriptor_Configuration_t PROGMEM RelayBoard_ConfigurationDescriptor =
142ecdaf   rguillom   first commit
74
75
76
77
78
79
  {
  	.Config =
  		{
  			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  
  			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
4dcf8810   rguillom   Descripteurs au p...
80
  			.TotalInterfaces        = 2,
142ecdaf   rguillom   first commit
81
82
83
84
  
  			.ConfigurationNumber    = 1,
  			.ConfigurationStrIndex  = NO_DESCRIPTOR,
  
4dcf8810   rguillom   Descripteurs au p...
85
  			.ConfigAttributes       = USB_CONFIG_ATTR_RESERVED,
142ecdaf   rguillom   first commit
86
  
4dcf8810   rguillom   Descripteurs au p...
87
  			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(500)
142ecdaf   rguillom   first commit
88
  		},
4dcf8810   rguillom   Descripteurs au p...
89
90
91
  
  	/* Description Interface SORTIE (LED)*/
  	.InferfaceOUT =
142ecdaf   rguillom   first commit
92
93
94
  		{
  			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  
4dcf8810   rguillom   Descripteurs au p...
95
96
  			.InterfaceNumber        = INTERFACE_ID_InterfaceOUT,
  			.AlternateSetting       = 0,
142ecdaf   rguillom   first commit
97
98
99
  
  			.TotalEndpoints         = 1,
  
4dcf8810   rguillom   Descripteurs au p...
100
101
102
  			.Class                  = USB_CSCP_VendorSpecificClass,
  			.SubClass               = 0x00,
  			.Protocol               = 0x00,
142ecdaf   rguillom   first commit
103
104
105
  
  			.InterfaceStrIndex      = NO_DESCRIPTOR
  		},
4dcf8810   rguillom   Descripteurs au p...
106
  	
752b62a9   rguillom   Descriptors + PAD...
107
  	/*
4dcf8810   rguillom   Descripteurs au p...
108
109
110
  	.HID_KeyboardHID =
  		{
  			.Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
142ecdaf   rguillom   first commit
111
  
4dcf8810   rguillom   Descripteurs au p...
112
113
114
115
116
117
  			.HIDSpec                = VERSION_BCD(1,1,1),
  			.CountryCode            = 0x00,
  			.TotalReportDescriptors = 1,
  			.HIDReportType          = HID_DTYPE_Report,
  			.HIDReportLength        = sizeof(KeyboardReport)
  		},
752b62a9   rguillom   Descriptors + PAD...
118
  	*/
4dcf8810   rguillom   Descripteurs au p...
119
  	
142ecdaf   rguillom   first commit
120
121
122
123
124
125
126
127
128
  	.ReportOUTEndpoint =
  		{
  			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  
  			.EndpointAddress        = KEYBOARD_OUT_EPADDR,
  			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  			.EndpointSize           = KEYBOARD_EPSIZE,
  			.PollingIntervalMS      = 0x05
  		},
4dcf8810   rguillom   Descripteurs au p...
129
130
131
  		
  
  		/* Description interface IN (Boutons)*/
142ecdaf   rguillom   first commit
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
  	.InterfaceIN =
  		{
  			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  
  			.InterfaceNumber        = INTERFACE_ID_InterfaceIN, //pas sur mais presque
  			.AlternateSetting       = 0x00,
  
  			.TotalEndpoints         = 2,
  
  			.Class                  = HID_CSCP_HIDClass,
  			.SubClass               = HID_CSCP_BootSubclass,
  			.Protocol               = HID_CSCP_KeyboardBootProtocol,
  
  			.InterfaceStrIndex      = NO_DESCRIPTOR
  		},
  
4dcf8810   rguillom   Descripteurs au p...
148
  	.ReportINEndpointBoutons =
142ecdaf   rguillom   first commit
149
150
151
  		{
  			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  
752b62a9   rguillom   Descriptors + PAD...
152
  			.EndpointAddress        = KEYBOARD_IN_Bout_EPADDR,
142ecdaf   rguillom   first commit
153
154
155
156
157
  			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  			.EndpointSize           = KEYBOARD_EPSIZE,
  			.PollingIntervalMS      = 0x05
  		},
  
752b62a9   rguillom   Descriptors + PAD...
158
  	.ReportINEndpointJoystick =
142ecdaf   rguillom   first commit
159
160
161
  		{
  			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  
752b62a9   rguillom   Descriptors + PAD...
162
  			.EndpointAddress        = KEYBOARD_IN_Joy_EPADDR,
142ecdaf   rguillom   first commit
163
164
165
166
167
168
  			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  			.EndpointSize           = KEYBOARD_EPSIZE,
  			.PollingIntervalMS      = 0x05
  		}
  };
  
142ecdaf   rguillom   first commit
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
  /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
   *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
   *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
   */
  const USB_Descriptor_String_t PROGMEM RelayBoard_LanguageString =
  {
  	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
  
  	.UnicodeString          = {LANGUAGE_ID_ENG}
  };
  
  /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
   *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
   *  Descriptor.
   */
  const USB_Descriptor_String_t PROGMEM RelayBoard_ManufacturerString = USB_STRING_DESCRIPTOR(L"SISPM");
  
  /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
   *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
   *  Descriptor.
   */
  const USB_Descriptor_String_t PROGMEM RelayBoard_ProductString = USB_STRING_DESCRIPTOR(L"RelayBoard");
  
  /** Serial number string. This is a Unicode string containing the device's unique serial number, expressed as a
   *  series of uppercase hexadecimal digits.
   */
  const USB_Descriptor_String_t PROGMEM RelayBoard_SerialString = USB_STRING_DESCRIPTOR(L"00001");
  
  /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
   *  documentation) by the application code so that the address and size of a requested descriptor can be given
   *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
   *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
   *  USB host.
   */
142ecdaf   rguillom   first commit
203
204
205
206
207
208
209
210
211
212
213
214
215
  uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                                      const uint16_t wIndex,
                                      const void** const DescriptorAddress)
  {
  	const uint8_t  DescriptorType   = (wValue >> 8);
  	const uint8_t  DescriptorNumber = (wValue & 0xFF);
  
  	const void* Address = NULL;
  	uint16_t    Size    = NO_DESCRIPTOR;
  
  	switch (DescriptorType)
  	{
  		case DTYPE_Device:
142ecdaf   rguillom   first commit
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
  			Address = &RelayBoard_DeviceDescriptor;
  			Size    = sizeof(USB_Descriptor_Device_t);
  			break;
  		case DTYPE_Configuration:
  			Address = &RelayBoard_ConfigurationDescriptor;
  			Size    = sizeof(USB_Descriptor_Configuration_t);
  			break;
  		case DTYPE_String:
  			switch (DescriptorNumber)
  			{
  				case STRING_ID_Language:
  					Address = &RelayBoard_LanguageString;
  					Size    = pgm_read_byte(&RelayBoard_LanguageString.Header.Size);
  					break;
  				case STRING_ID_Manufacturer:
  					Address = &RelayBoard_ManufacturerString;
  					Size    = pgm_read_byte(&RelayBoard_ManufacturerString.Header.Size);
  					break;
  				case STRING_ID_Product:
  					Address = &RelayBoard_ProductString;
  					Size    = pgm_read_byte(&RelayBoard_ProductString.Header.Size);
  					break;
  				case STRING_ID_Serial:
  					Address = &RelayBoard_SerialString;
  					Size    = pgm_read_byte(&RelayBoard_SerialString.Header.Size);
  					break;
  			}
  
  			break;
  	}
  
  	*DescriptorAddress = Address;
  	return Size;
  }