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
|
/*
* descriptors.h
*
* Created on: Nov 26, 2012
* Author: hathachtware License Agreement (BSD License)
* Copyright (c) 2012, hathach (tinyusb.net)All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
* SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
*
* This file is part of the tinyUSB stack
*/
#ifndef _DESCRIPTORS_H_
#define _DESCRIPTORS_H_
#include "tusb.h"
#define CFG_USB_STRING_MANUFACTURER "tinyUSB"
#define CFG_USB_STRING_PRODUCT "Device Keyboard"
#define CFG_USB_STRING_SERIAL "1234"
#define CFG_USB_VENDORID 0x1FC9
/* USB Serial uses the MCUs unique 128-bit chip ID via an IAP call = 32 hex chars */
#define USB_STRING_SERIAL_LEN 32
#define USB_STRING_LEN(n) (2 + ((n)<<1))
typedef ATTR_PREPACKED struct ATTR_PACKED _USB_STR_DESCRIPTOR
{
USB_COMMON_DESCRIPTOR LangID;
uint16_t strLangID[1];
USB_COMMON_DESCRIPTOR Manufacturer;
uint16_t strManufacturer[sizeof(CFG_USB_STRING_MANUFACTURER)-1]; // exclude null-character
USB_COMMON_DESCRIPTOR Product;
uint16_t strProduct[sizeof(CFG_USB_STRING_PRODUCT)-1]; // exclude null-character
USB_COMMON_DESCRIPTOR Serial;
uint16_t strSerial[sizeof(CFG_USB_STRING_SERIAL)-1];
} USB_STR_DESCRIPTOR;
// USB Interface Assosication Descriptor
#define USB_DEVICE_CLASS_IAD USB_DEVICE_CLASS_MISCELLANEOUS
#define USB_DEVICE_SUBCLASS_IAD 0x02
#define USB_DEVICE_PROTOCOL_IAD 0x01
///////////////////////////////////////////////////////////////////////
// Interface Assosication Descriptor if device is CDC + other class
#define IAD_DESC_REQUIRED ( defined(TUSB_CFG_DEVICE_CDC) && (DEVICE_CLASS_HID) )
#ifdef TUSB_CFG_DEVICE_CDC
#define INTERFACES_OF_CDC 2
#else
#define INTERFACES_OF_CDC 0
#endif
#ifdef TUSB_CFG_DEVICE_HID_KEYBOARD
#define INTERFACES_OF_HID_KEYBOARD 1
#else
#define INTERFACES_OF_HID_KEYBOARD 0
#endif
#ifdef TUSB_CFG_DEVICE_HID_MOUSE
#define INTERFACES_OF_HID_MOUSE 1
#else
#define INTERFACES_OF_HID_MOUSE 0
#endif
#ifdef CFG_USB_HID_GENERIC
#define INTERFACES_OF_HID_GENERIC 1
#else
#define INTERFACES_OF_HID_GENERIC 0
#endif
#ifdef CFG_USB_MASS_STORAGE
#define INTERFACES_OF_MASS_STORAGE 2
#else
#define INTERFACES_OF_MASS_STORAGE 0
#endif
#define INTERFACE_INDEX_CDC 0
#define INTERFACE_INDEX_HID_KEYBOARD (INTERFACE_INDEX_CDC + INTERFACES_OF_CDC )
#define INTERFACE_INDEX_HID_MOUSE (INTERFACE_INDEX_HID_KEYBOARD + INTERFACES_OF_HID_KEYBOARD )
#define INTERFACE_INDEX_HID_GENERIC (INTERFACE_INDEX_HID_MOUSE + INTERFACES_OF_HID_MOUSE )
#define INTERFACE_INDEX_MASS_STORAGE (INTERFACE_INDEX_HID_GENERIC + INTERFACES_OF_HID_GENERIC )
#define TOTAL_INTEFACES (INTERFACES_OF_CDC + INTERFACES_OF_HID_KEYBOARD + INTERFACES_OF_HID_MOUSE + INTERFACES_OF_HID_GENERIC + INTERFACES_OF_MASS_STORAGE)
// Bitmap: MassStorage | Generic | Mouse | Key | CDC
#define PRODUCTID_BITMAP(interface, n) ( (INTERFACES_OF_##interface ? 1 : 0) << (n) )
#define USB_PRODUCT_ID (0x2000 | ( PRODUCTID_BITMAP(CDC, 0) | PRODUCTID_BITMAP(HID_KEYBOARD, 1) | PRODUCTID_BITMAP(HID_MOUSE, 2) | \
PRODUCTID_BITMAP(HID_GENERIC, 3) | PRODUCTID_BITMAP(MASS_STORAGE, 4) ) )
///////////////////////////////////////////////////////////////////////
typedef struct
{
USB_CONFIGURATION_DESCRIPTOR Config;
#if IAD_DESC_REQUIRED
USB_Descriptor_InterfaceAssociation_t CDC_IAD;
#endif
#ifdef TUSB_CFG_DEVICE_CDC
//CDC - Serial
//CDC Control Interface
USB_INTERFACE_DESCRIPTOR CDC_CCI_Interface;
CDC_HEADER_DESCRIPTOR CDC_Header;
CDC_ABSTRACT_CONTROL_MANAGEMENT_DESCRIPTOR CDC_ACM;
CDC_UNION_1SLAVE_DESCRIPTOR CDC_Union;
USB_ENDPOINT_DESCRIPTOR CDC_NotificationEndpoint;
//CDC Data Interface
USB_INTERFACE_DESCRIPTOR CDC_DCI_Interface;
USB_ENDPOINT_DESCRIPTOR CDC_DataOutEndpoint;
USB_ENDPOINT_DESCRIPTOR CDC_DataInEndpoint;
#endif
#ifdef TUSB_CFG_DEVICE_HID_KEYBOARD
//Keyboard HID Interface
USB_INTERFACE_DESCRIPTOR HID_KeyboardInterface;
HID_DESCRIPTOR HID_KeyboardHID;
USB_ENDPOINT_DESCRIPTOR HID_KeyboardEndpoint;
#endif
#ifdef TUSB_CFG_DEVICE_HID_MOUSE
//Mouse HID Interface
USB_INTERFACE_DESCRIPTOR HID_MouseInterface;
HID_DESCRIPTOR HID_MouseHID;
USB_ENDPOINT_DESCRIPTOR HID_MouseEndpoint;
#endif
unsigned char ConfigDescTermination;
} USB_FS_CONFIGURATION_DESCRIPTOR;
extern const USB_DEVICE_DESCRIPTOR USB_DeviceDescriptor;
extern const USB_FS_CONFIGURATION_DESCRIPTOR USB_FsConfigDescriptor;
extern const USB_STR_DESCRIPTOR USB_StringDescriptor;
extern const uint8_t HID_KeyboardReportDescriptor[];
extern const uint8_t HID_MouseReportDescriptor[];
#endif
|
