summaryrefslogtreecommitdiff
path: root/tmk_core/protocol/arm_atsam/usb/udi_hid_kbd_desc.c
blob: 2d6e35e254e270c4612dcef9639aed18f1bdff7b (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
/**
 * \file
 *
 * \brief Default descriptors for a USB Device
 * with a single interface HID keyboard
 *
 * Copyright (c) 2009-2016 Atmel Corporation. All rights reserved.
 *
 * \asf_license_start
 *
 * \page License
 *
 * 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 Atmel may not be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * 4. This software may only be redistributed and used in connection with an
 *    Atmel microcontroller product.
 *
 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL 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.
 *
 * \asf_license_stop
 *
 */
/*
 * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
 */

#include "conf_usb.h"
#include "usb_protocol.h"
#include "udc_desc.h"
#include "udi_device_conf.h"
#include "udi_hid_kbd.h"
#include "udi_cdc.h"

/**
 * \ingroup udi_hid_keyboard_group
 * \defgroup udi_hid_keyboard_group_single_desc USB device descriptors for a single interface
 *
 * The following structures provide the USB device descriptors required
 * for USB Device with a single interface HID keyboard.
 *
 * It is ready to use and do not require more definition.
 * @{
 */

//! USB Device Descriptor
COMPILER_WORD_ALIGNED
UDC_DESC_STORAGE usb_dev_desc_t udc_device_desc = {
    .bLength                   = sizeof(usb_dev_desc_t),
    .bDescriptorType           = USB_DT_DEVICE,
    .bcdUSB                    = LE16(USB_V2_0),
    .bDeviceClass              = DEVICE_CLASS,
    .bDeviceSubClass           = DEVICE_SUBCLASS,
    .bDeviceProtocol           = DEVICE_PROTOCOL,
    .bMaxPacketSize0           = USB_DEVICE_EP_CTRL_SIZE,
    .idVendor                  = LE16(USB_DEVICE_VENDOR_ID),
    .idProduct                 = LE16(USB_DEVICE_PRODUCT_ID),
    .bcdDevice                 = LE16(USB_DEVICE_VERSION),
#ifdef USB_DEVICE_MANUFACTURE_NAME
    .iManufacturer             = 1,
#else
    .iManufacturer             = 0,  // No manufacture string
#endif
#ifdef USB_DEVICE_PRODUCT_NAME
    .iProduct                  = 2,
#else
    .iProduct                  = 0,  // No product string
#endif
#if (defined USB_DEVICE_SERIAL_NAME || defined USB_DEVICE_GET_SERIAL_NAME_POINTER)
    .iSerialNumber             = 3,
#else
    .iSerialNumber             = 0,  // No serial string
#endif
    .bNumConfigurations        = 1
};

#if 0
#ifdef USB_DEVICE_HS_SUPPORT
//! USB Device Qualifier Descriptor for HS
COMPILER_WORD_ALIGNED
UDC_DESC_STORAGE usb_dev_qual_desc_t udc_device_qual = {
    .bLength                   = sizeof(usb_dev_qual_desc_t),
    .bDescriptorType           = USB_DT_DEVICE_QUALIFIER,
    .bcdUSB                    = LE16(USB_V2_0),
    .bDeviceClass              = 0,
    .bDeviceSubClass           = 0,
    .bDeviceProtocol           = 0,
    .bMaxPacketSize0           = USB_DEVICE_EP_CTRL_SIZE,
    .bNumConfigurations        = 1
};
#endif
#endif

//! USB Device Configuration Descriptor filled for FS and HS
COMPILER_WORD_ALIGNED
UDC_DESC_STORAGE udc_desc_t udc_desc = {
    .conf.bLength              = sizeof(usb_conf_desc_t),
    .conf.bDescriptorType      = USB_DT_CONFIGURATION,
    .conf.wTotalLength         = LE16(sizeof(udc_desc_t)),
    .conf.bNumInterfaces       = USB_DEVICE_NB_INTERFACE,
    .conf.bConfigurationValue  = 1,
    .conf.iConfiguration       = 0,
    .conf.bmAttributes         = /* USB_CONFIG_ATTR_MUST_SET | */ USB_DEVICE_ATTR,
    .conf.bMaxPower            = USB_CONFIG_MAX_POWER(USB_DEVICE_POWER),
#ifdef KBD
    .hid_kbd                   = UDI_HID_KBD_DESC,
#endif
#ifdef RAW
    .hid_raw                   = UDI_HID_RAW_DESC,
#endif
#ifdef MOU
    .hid_mou                   = UDI_HID_MOU_DESC,
#endif
#ifdef EXK
  .hid_exk                   = UDI_HID_EXK_DESC,
#endif
#ifdef CON
  .hid_con                   = UDI_HID_CON_DESC,
#endif
#ifdef NKRO
  .hid_nkro                  = UDI_HID_NKRO_DESC,
#endif
#ifdef CDC
  .cdc_serial                = CDC_DESCRIPTOR,
#endif
};

UDC_DESC_STORAGE udi_api_t *udi_apis[USB_DEVICE_NB_INTERFACE] = {
  #ifdef KBD
    &udi_api_hid_kbd,
  #endif
  #ifdef RAW
    &udi_api_hid_raw,
  #endif
  #ifdef MOU
    &udi_api_hid_mou,
  #endif
  #ifdef EXK
    &udi_api_hid_exk,
  #endif
  #ifdef CON
    &udi_api_hid_con,
  #endif
  #ifdef NKRO
    &udi_api_hid_nkro,
  #endif
  #ifdef CDC
  &udi_api_cdc_comm, &udi_api_cdc_data,
  #endif
};

//! Add UDI with USB Descriptors FS & HS
UDC_DESC_STORAGE udc_config_speed_t   udc_config_fshs[1] = {{
    .desc          = (usb_conf_desc_t UDC_DESC_STORAGE*)&udc_desc,
    .udi_apis      = udi_apis,
}};

//! Add all information about USB Device in global structure for UDC
UDC_DESC_STORAGE udc_config_t udc_config = {
    .confdev_lsfs = &udc_device_desc,
    .conf_lsfs = udc_config_fshs,
};

//@}
//@}