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
|
/* ----------------------------------------------------------------------------
* ATMEL Microcontroller Software Support
* ----------------------------------------------------------------------------
* Copyright (c) 2008, Atmel Corporation
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the disclaimer below.
*
* Atmel's name may not be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* DISCLAIMER: 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
* 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.
* ----------------------------------------------------------------------------
*/
/**
\unit HIDDKeyboardDriverDescriptors
!!!Purpose
Definitions of the descriptors required by the HID device keyboard
driver.
!!!Usage
-# Use the hiddKeyboardDriverDescriptors variable to initialize a
USBDDriver instance.
-# Send hiddReportDescriptor to the host when a GET_DESCRIPTOR request
for the report descriptor is received.
*/
#ifndef HIDDKEYBOARDDRIVERDESCRIPTORS_H
#define HIDDKEYBOARDDRIVERDESCRIPTORS_H
//------------------------------------------------------------------------------
// Headers
//------------------------------------------------------------------------------
#include <usb/device/core/USBDDriverDescriptors.h>
#include <usb/common/hid/HIDKeypad.h>
//------------------------------------------------------------------------------
// Definitions
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
/// \page "HID Endpoints"
/// This page lists endpoint addresses and polling settings.
///
/// !Endpoints
/// - HIDDKeyboardDriverDescriptors_INTERRUPTIN
/// - HIDDKeyboardDriverDescriptors_INTERRUPTOUT
///
/// !Polling Rates
/// - HIDDKeyboardDriverDescriptors_INTERRUPTIN_POLLING
/// - HIDDKeyboardDriverDescriptors_INTERRUPTOUT_POLLING
/// Interrupt IN endpoint number.
#define HIDDKeyboardDriverDescriptors_INTERRUPTIN 1
/// Interrupt IN endpoint polling rate (in milliseconds).
#define HIDDKeyboardDriverDescriptors_INTERRUPTIN_POLLING 10
/// Interrupt OUT endpoint number.
#define HIDDKeyboardDriverDescriptors_INTERRUPTOUT 2
/// Interrupt OUT endpoint polling rate (in milliseconds).
#define HIDDKeyboardDriverDescriptors_INTERRUPTOUT_POLLING 10
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
/// \page "HID Keypad keys"
/// This page lists definition for HID keypad keys.
///
/// !Keys
/// - HIDDKeyboardDriverDescriptors_FIRSTMODIFIERKEY
/// - HIDDKeyboardDriverDescriptors_LASTMODIFIERKEY
/// - HIDDKeyboardDriverDescriptors_FIRSTSTANDARDKEY
/// - HIDDKeyboardDriverDescriptors_LASTSTANDARDKEY
/// Key code of the first accepted modifier key.
#define HIDDKeyboardDriverDescriptors_FIRSTMODIFIERKEY HIDKeypad_LEFTCONTROL
/// Key code of the last accepted modifier key.
#define HIDDKeyboardDriverDescriptors_LASTMODIFIERKEY HIDKeypad_RIGHTGUI
/// Key code of the first accepted standard key.
#define HIDDKeyboardDriverDescriptors_FIRSTSTANDARDKEY 0
/// Key code of the last accepted standard key.
#define HIDDKeyboardDriverDescriptors_LASTSTANDARDKEY HIDKeypad_NUMLOCK
//------------------------------------------------------------------------------
/// Size of the report descriptor in bytes.
#define HIDDKeyboardDriverDescriptors_REPORTSIZE 61
//------------------------------------------------------------------------------
// Exported variables
//------------------------------------------------------------------------------
extern USBDDriverDescriptors hiddKeyboardDriverDescriptors;
extern const unsigned char hiddReportDescriptor[];
#endif //#ifndef HIDDKEYBOARDDRIVERDESCRIPTORS_H
|
