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
|
/* ----------------------------------------------------------------------------
* 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 HIDDKeyboardInputReport.h
!!!Purpose
Class for manipulating HID keyboard input reports.
!!!Usage
-# Initialize a newly created input report with
HIDDKeyboardInputReport_Initialize.
-# Change the standard keys that are pressed and released using
HIDDKeyboardInputReport_PressStandardKey and
HIDDKeyboardInputReport_ReleaseStandardKey.
-# Change the modifier keys that are currently pressed and released
using HIDDKeyboardInputReport_PressModifierKey and
HIDDKeyboardInputReport_ReleaseModifierKey.
*/
#ifndef HIDDKEYBOARDINPUTREPORT_H
#define HIDDKEYBOARDINPUTREPORT_H
//------------------------------------------------------------------------------
// Definitions
//------------------------------------------------------------------------------
/// Maximum number of simultaneous key presses.
#define HIDDKeyboardInputReport_MAXKEYPRESSES 3
//------------------------------------------------------------------------------
// Types
//------------------------------------------------------------------------------
#ifdef __ICCARM__ // IAR
#pragma pack(1) // IAR
#define __attribute__(...) // IAR
#endif // IAR
//------------------------------------------------------------------------------
/// HID input report structure used by the keyboard driver to notify the
/// host of pressed keys.
///
/// The first byte is used to report the state of modifier keys. The
/// other three contains the keycodes of the currently pressed keys.
//------------------------------------------------------------------------------
typedef struct {
/// State of modifier keys.
unsigned char bmModifierKeys:8;
/// Key codes of pressed keys.
unsigned char pressedKeys[HIDDKeyboardInputReport_MAXKEYPRESSES];
} __attribute__ ((packed)) HIDDKeyboardInputReport; // GCC
#ifdef __ICCARM__ // IAR
#pragma pack() // IAR
#endif // IAR
//------------------------------------------------------------------------------
// Exported functions
//------------------------------------------------------------------------------
/*
Function: HIDDKeyboardInputReport_Initialize
Initializes a keyboard input report instance.
Parameters:
report - Pointer to a HIDDKeyboardInputReport instance.
*/
extern void HIDDKeyboardInputReport_Initialize(HIDDKeyboardInputReport *report);
/*
Function: HIDDKeyboardInputReport_PressStandardKey
Reports a standard key as being pressed.
Parameters:
report - Pointer to a HIDDKeyboardInputReport instance.
key - Key code of the standard key.
*/
extern void HIDDKeyboardInputReport_PressStandardKey(
HIDDKeyboardInputReport *report,
unsigned char key);
/*
Function: HIDDKeyboardInputReport_ReleaseStandardKey
Reports a standard key as not being pressed anymore.
Parameters:
report - Pointer to a HIDDKeyboardInputReport instance.
key - Key code of the standard key
*/
extern void HIDDKeyboardInputReport_ReleaseStandardKey(
HIDDKeyboardInputReport *report,
unsigned char key);
/*
Function: HIDDKeyboardInputReport_PressModifierKey
Reports a modifier key as being currently pressed.
Parameters:
report - Pointer to a HIDDKeyboardInputReport instance.
key - Key code of the modifier key.
*/
extern void HIDDKeyboardInputReport_PressModifierKey(
HIDDKeyboardInputReport *report,
unsigned char key);
/*
Function: HIDDKeyboardInputReport_ReleaseModifierKey
Reports a modifier key as not being pressed anymore.
Parameters:
report - Pointer to a HIDDKeyboardInputReport instance.
key - Key code of the modifier key.
*/
extern void HIDDKeyboardInputReport_ReleaseModifierKey(
HIDDKeyboardInputReport *report,
unsigned char key);
#endif //#ifndef HIDDKEYBOARDINPUTREPORT_H
|
