summaryrefslogtreecommitdiff
path: root/at91lib/usb/device/hid-keyboard/HIDDKeyboardInputReport.c
blob: 3257bdbae29c45cece16f38adc120888818fa7c6 (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
/* ----------------------------------------------------------------------------
 *         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.
 * ----------------------------------------------------------------------------
 */

/*
    Title: HIDDKeyboardInputReport implementation

    About: Purpose
        Implementation of the HIDDKeyboardInputReport class.
*/

//------------------------------------------------------------------------------
//         Headers
//------------------------------------------------------------------------------

#include "HIDDKeyboardInputReport.h"
#include "HIDDKeyboardDriverDescriptors.h"
#include <utility/assert.h>

//------------------------------------------------------------------------------
//         Exported functions
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
/// Initializes a keyboard input report instance.
/// \param report Pointer to a HIDDKeyboardInputReport instance.
//------------------------------------------------------------------------------
void HIDDKeyboardInputReport_Initialize(HIDDKeyboardInputReport *report)
{
    unsigned int i;

    report->bmModifierKeys = 0;
    for (i = 0; i < HIDDKeyboardInputReport_MAXKEYPRESSES; i++) {
    
        report->pressedKeys[i] = 0;
    }
}

//------------------------------------------------------------------------------
/// Reports a standard key as being pressed.
/// \param report Pointer to a HIDDKeyboardInputReport instance.
/// \param key Key code of the standard key.
//------------------------------------------------------------------------------
void HIDDKeyboardInputReport_PressStandardKey(HIDDKeyboardInputReport *report,
                                              unsigned char key)
{
    ASSERT(key <= HIDDKeyboardDriverDescriptors_LASTSTANDARDKEY,
           "Invalid standard key code (%d)\n\r",
           key);

    // Find first available slot
    unsigned int i = 0;
    unsigned char found = 0;
    while ((i < HIDDKeyboardInputReport_MAXKEYPRESSES) && !found) {

        // Free slot: no key referenced (code = 0) or ErrorRollOver
        if ((report->pressedKeys[i] == 0)
            || (report->pressedKeys[i] == HIDKeypad_ERRORROLLOVER)) {

            found = 1;
            report->pressedKeys[i] = key;
        }
        
        i++;
    }

    // Report ErrorRollOver in all fields if too many keys are pressed
    if (!found) {

        for (i=0; i < HIDDKeyboardInputReport_MAXKEYPRESSES; i++) {

            report->pressedKeys[i] = HIDKeypad_ERRORROLLOVER;
        }
    }
}

//------------------------------------------------------------------------------
/// Reports a standard key as not being pressed anymore.
/// \param report Pointer to a HIDDKeyboardInputReport instance.
/// \param key Key code of the standard key
//------------------------------------------------------------------------------
void HIDDKeyboardInputReport_ReleaseStandardKey(HIDDKeyboardInputReport *report,
                                                unsigned char key)
{
    ASSERT(key <= HIDDKeyboardDriverDescriptors_LASTSTANDARDKEY,
           "Invalid standard key code (%d)\n\r",
           key);

    // Look for key in array
    unsigned int i = 0;
    unsigned char found = 0;
    while ((i < HIDDKeyboardInputReport_MAXKEYPRESSES) && !found) {

        if (report->pressedKeys[i] == key) {

            found = 1;
            report->pressedKeys[i] = 0;
        }

        i++;
    }
}

//------------------------------------------------------------------------------
/// Reports a modifier key as being currently pressed.
/// \param report Pointer to a HIDDKeyboardInputReport instance.
/// \param key Key code of the modifier key.
//------------------------------------------------------------------------------
void HIDDKeyboardInputReport_PressModifierKey(HIDDKeyboardInputReport *report,
                                              unsigned char key)
{
    ASSERT((key >= HIDDKeyboardDriverDescriptors_FIRSTMODIFIERKEY)
           && (key <= HIDDKeyboardDriverDescriptors_LASTMODIFIERKEY),
           "Invalid standard key code (%d)\n\r",
           key);

    // Set corresponding bit
    unsigned char bit = key - HIDDKeyboardDriverDescriptors_FIRSTMODIFIERKEY;
    report->bmModifierKeys |= 1 << bit;
}

//------------------------------------------------------------------------------
/// Reports a modifier key as not being pressed anymore.
/// \param report Pointer to a HIDDKeyboardInputReport instance.
/// \param key Key code of the modifier key.
//------------------------------------------------------------------------------
void HIDDKeyboardInputReport_ReleaseModifierKey(HIDDKeyboardInputReport *report,
                                                unsigned char key)
{
    ASSERT((key >= HIDDKeyboardDriverDescriptors_FIRSTMODIFIERKEY)
           && (key <= HIDDKeyboardDriverDescriptors_LASTMODIFIERKEY),
           "Invalid standard key code (%d)\n\r",
           key);

    // Clear corresponding bit
    unsigned char bit = key - HIDDKeyboardDriverDescriptors_FIRSTMODIFIERKEY;
    report->bmModifierKeys &= ~(1 << bit);
}

personal git repositories of Harald Welte. Your mileage may vary