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
203
204
205
206
207
208
209
210
211
212
213
214
215
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
|
/*
Copyright (C) 2016 Jonathan Struebel
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @file usbcfg.c
* @brief USB driver config.
*
* @addtogroup USB
* @{
*/
#include "hal.h"
#include "usbcfg.h"
/*
* Endpoints to be used for USBD1.
*/
#define USBD1_DATA_REQUEST_EP 1
#define USBD1_DATA_AVAILABLE_EP 1
/*
* USB HID Driver structure.
*/
USBHIDDriver UHD1;
/*
* Data used for feedback
*/
uint8_t increment_var = 0;
/*
* USB Device Descriptor.
*/
static const uint8_t hid_device_descriptor_data[18] = {
USB_DESC_DEVICE (0x0110, /* bcdUSB (1.1). */
0x00, /* bDeviceClass. */
0x00, /* bDeviceSubClass. */
0x00, /* bDeviceProtocol. */
0x40, /* bMaxPacketSize. */
0x0179, /* idVendor. */
0x0002, /* idProduct. */
0x0200, /* bcdDevice. */
1, /* iManufacturer. */
2, /* iProduct. */
3, /* iSerialNumber. */
1) /* bNumConfigurations. */
};
/*
* Device Descriptor wrapper.
*/
static const USBDescriptor hid_device_descriptor = {
sizeof hid_device_descriptor_data,
hid_device_descriptor_data
};
/*
* Configuration Descriptor tree for a HID device
*
* The HID Specifications version 1.11 require the following order:
* - Configuration Descriptor
* - Interface Descriptor
* - HID Descriptor
* - Endpoints Descriptors
*/
#define HID_DESCRIPTOR_OFFSET 18
#define HID_DESCRIPTOR_SIZE USB_DESC_HID_SIZE
static const uint8_t hid_configuration_descriptor_data[41] = {
/* Configuration Descriptor.*/
USB_DESC_CONFIGURATION(41, /* wTotalLength. */
0x01, /* bNumInterfaces. */
0x01, /* bConfigurationValue. */
0, /* iConfiguration. */
0xC0, /* bmAttributes (self powered). */
50), /* bMaxPower (100mA). */
/* Interface Descriptor.*/
USB_DESC_INTERFACE (0x00, /* bInterfaceNumber. */
0x00, /* bAlternateSetting. */
0x02, /* bNumEndpoints. */
0x03, /* bInterfaceClass (HID Interface
Class). */
0x00, /* bInterfaceSubClass (None). */
0x00, /* bInterfaceProtocol (None). */
0), /* iInterface. */
/* HID Descriptor.*/
USB_DESC_HID (0x0110, /* bcdHID. */
0x00, /* bCountryCode. */
0x01, /* bNumDescriptors. */
0x22, /* bDescriptorType (Report
Descriptor). */
34), /* wDescriptorLength. */
/* Endpoint 1 Descriptor.*/
USB_DESC_ENDPOINT (USBD1_DATA_AVAILABLE_EP, /* bEndpointAddress.*/
0x03, /* bmAttributes (Interrupt). */
0x0040, /* wMaxPacketSize. */
0x0A), /* bInterval (10ms). */
/* Endpoint 1 Descriptor.*/
USB_DESC_ENDPOINT (USBD1_DATA_REQUEST_EP|0x80, /* bEndpointAddress.*/
0x03, /* bmAttributes (Interrupt). */
0x0040, /* wMaxPacketSize. */
0x0A) /* bInterval (10ms). */
};
/*
* Configuration Descriptor wrapper.
*/
static const USBDescriptor hid_configuration_descriptor = {
sizeof hid_configuration_descriptor_data,
hid_configuration_descriptor_data
};
/*
* HID Descriptor wrapper.
*/
static const USBDescriptor hid_descriptor = {
HID_DESCRIPTOR_SIZE,
&hid_configuration_descriptor_data[HID_DESCRIPTOR_OFFSET]
};
/*
* HID Report Descriptor
*
* This is the description of the format and the content of the
* different IN or/and OUT reports that your application can
* receive/send
*
* See "Device Class Definition for Human Interface Devices (HID)"
* (http://www.usb.org/developers/hidpage/HID1_11.pdf) for the
* detailed description of all the fields
*/
static const uint8_t hid_report_descriptor_data[] = {
USB_DESC_BYTE (0x06), /* Usage Page - */
USB_DESC_WORD (0xFF00), /* Vendor Defined. */
USB_DESC_BYTE (0x09), /* Usage - */
USB_DESC_BYTE (0x01), /* Vendor Defined. */
USB_DESC_BYTE (0xA1), /* Collection - */
USB_DESC_BYTE (0x01), /* Application. */
USB_DESC_BYTE (0x09), /* Usage - */
USB_DESC_BYTE (0x01), /* Vendor Defined. */
USB_DESC_BYTE (0x15), /* Logical Minimum - */
USB_DESC_BYTE (0x00), /* 0. */
USB_DESC_BYTE (0x26), /* Logical Maximum - */
USB_DESC_WORD (0x00FF), /* 255. */
USB_DESC_BYTE (0x75), /* Report size - */
USB_DESC_BYTE (0x08), /* 8 bits. */
USB_DESC_BYTE (0x95), /* Report count - */
USB_DESC_BYTE (0x01), /* 1. */
USB_DESC_BYTE (0x81), /* Input - */
USB_DESC_BYTE (0x02), /* Data, Variable, Absolute. */
USB_DESC_BYTE (0x09), /* Usage - */
USB_DESC_BYTE (0x01), /* Vendor Defined. */
USB_DESC_BYTE (0x15), /* Logical Minimum - */
USB_DESC_BYTE (0x00), /* 0. */
USB_DESC_BYTE (0x26), /* Logical Maximum - */
USB_DESC_WORD (0x00FF), /* 255. */
USB_DESC_BYTE (0x75), /* Report Size - */
USB_DESC_BYTE (0x08), /* 8 bits. */
USB_DESC_BYTE (0x95), /* Report Count - */
USB_DESC_BYTE (0x01), /* 1. */
USB_DESC_BYTE (0x91), /* Output - */
USB_DESC_BYTE (0x02), /* Data, Variable, Absolute. */
USB_DESC_BYTE (0xC0) /* End Collection. */
};
/*
* HID Report Descriptor wrapper
*/
static const USBDescriptor hid_report_descriptor = {
sizeof hid_report_descriptor_data,
hid_report_descriptor_data
};
/*
* U.S. English language identifier.
*/
static const uint8_t hid_string0[] = {
USB_DESC_BYTE(2+2*1), /* bLength. */
USB_DESC_BYTE(USB_DESCRIPTOR_STRING), /* bDescriptorType. */
USB_DESC_WORD(0x0409) /* wLANGID (U.S. English). */
};
/*
* Vendor string.
*/
static const uint8_t hid_string1[] = {
USB_DESC_BYTE(2+2*7), /* bLength. */
USB_DESC_BYTE(USB_DESCRIPTOR_STRING), /* bDescriptorType. */
'N', 0, 'o', 0, 'p', 0, 'e', 0, 'L', 0, 'a', 0, 'b', 0,
};
/*
* Device Description string.
*/
static const uint8_t hid_string2[] = {
USB_DESC_BYTE(2+5*2), /* bLength. */
USB_DESC_BYTE(USB_DESCRIPTOR_STRING), /* bDescriptorType. */
'C', 0, 'h', 0, 'T', 0, 's', 0, 'y', 0,
};
/*
* Serial Number string.
*/
static const uint8_t hid_string3[] = {
USB_DESC_BYTE(2+2*3), /* bLength. */
USB_DESC_BYTE(USB_DESCRIPTOR_STRING), /* bDescriptorType. */
'0' + CH_KERNEL_MAJOR, 0,
'0' + CH_KERNEL_MINOR, 0,
'0' + CH_KERNEL_PATCH, 0
};
/*
* Strings wrappers array.
*/
static const USBDescriptor hid_strings[] = {
{sizeof hid_string0, hid_string0},
{sizeof hid_string1, hid_string1},
{sizeof hid_string2, hid_string2},
{sizeof hid_string3, hid_string3}
};
/*
* Handles the GET_DESCRIPTOR callback. All required descriptors must be
* handled here.
*/
static const USBDescriptor *get_descriptor(USBDriver *usbp,
uint8_t dtype,
uint8_t dindex,
uint16_t lang) {
(void)usbp;
(void)lang;
switch (dtype) {
case USB_DESCRIPTOR_DEVICE:
return &hid_device_descriptor;
case USB_DESCRIPTOR_CONFIGURATION:
return &hid_configuration_descriptor;
case USB_DESCRIPTOR_STRING:
if (dindex < 4)
return &hid_strings[dindex];
case USB_DESCRIPTOR_INTERFACE:
break;
case USB_DESCRIPTOR_ENDPOINT:
break;
case USB_DESCRIPTOR_HID:
return &hid_descriptor;
case HID_REPORT:
return &hid_report_descriptor;
default:
break;
}
return NULL;
}
/**
* @brief IN EP1 state.
*/
static USBInEndpointState ep1instate;
/**
* @brief OUT EP1 state.
*/
static USBOutEndpointState ep1outstate;
/**
* @brief EP1 initialization structure (both IN and OUT).
*/
static const USBEndpointConfig ep1config = {
USB_EP_MODE_TYPE_INTR,
NULL,
hidDataTransmitted,
hidDataReceived,
0x0040,
0x0040,
&ep1instate,
&ep1outstate,
2,
NULL
};
/*
* Handles the USB driver global events.
*/
static void usb_event(USBDriver *usbp, usbevent_t event) {
// (void)usbp;
switch (event) {
case USB_EVENT_RESET:
return;
case USB_EVENT_ADDRESS:
return;
case USB_EVENT_CONFIGURED:
osalSysLockFromISR();
/* Enables the endpoints specified into the configuration.
Note, this callback is invoked from an ISR so I-Class functions
must be used.*/
usbInitEndpointI(usbp, USBD1_DATA_REQUEST_EP, &ep1config);
/* Resetting the state of the CDC subsystem.*/
hidConfigureHookI(&UHD1);
osalSysUnlockFromISR();
return;
case USB_EVENT_UNCONFIGURED:
return;
case USB_EVENT_SUSPEND:
return;
case USB_EVENT_WAKEUP:
return;
case USB_EVENT_STALLED:
return;
}
return;
}
static bool req_handler(USBDriver *usbp) {
size_t n;
if ((usbp->setup[0] & USB_RTYPE_TYPE_MASK) == USB_RTYPE_TYPE_CLASS) {
switch (usbp->setup[1]) {
case HID_GET_REPORT:
n = hidGetReport(0, &increment_var, sizeof(increment_var));
usbSetupTransfer(usbp, &increment_var, n, NULL);
return true;
default:
return hidRequestsHook(usbp);
}
}
return hidRequestsHook(usbp);
}
#if 0
/*
* Handles the USB driver global events.
*/
static void sof_handler(USBDriver *usbp) {
(void)usbp;
osalSysLockFromISR();
sduSOFHookI(&SDU1);
osalSysUnlockFromISR();
}
#endif
/**
* @brief Generate HID Report
* @details This function generates the data for an HID report so
* that it can be transferred to the host.
*
* @param[in] id report ID
* @param[out] bp data buffer pointer
* @param[in] n the maximum number of bytes for data buffer
* @return number of bytes of report in data buffer
*/
size_t hidGetReport(uint8_t id, uint8_t *bp, size_t n) {
(void) id;
(void) n;
increment_var++;
*bp = increment_var;
return sizeof(increment_var);
}
/**
* @brief Set HID Report
* @details This function sets the data for an HID report
* that was transferred from the host.
*
* @param[in] id report ID
* @param[in] bp data buffer pointer
* @param[in] n the number of bytes in data buffer
* @return The operation status.
* @retval MSG_OK if the report was set.
*/
msg_t hidSetReport(uint8_t id, uint8_t *bp, size_t n) {
(void) id;
(void) n;
increment_var = *bp;
return MSG_OK;
}
/*
* USB driver configuration.
*/
const USBConfig usbcfg = {
usb_event,
get_descriptor,
req_handler,
NULL
/*sof_handler*/
};
/*
* USB HID driver configuration.
*/
const USBHIDConfig usbhidcfg = {
&USBD1,
USBD1_DATA_REQUEST_EP,
USBD1_DATA_AVAILABLE_EP
};
/** @} */
|
