| 1 | /*
|
|---|
| 2 | * Copyright (c) 2011 Lubos Slovak
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup drvusbhid
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /** @file
|
|---|
| 33 | * USB HID keyboard device structure and API.
|
|---|
| 34 | */
|
|---|
| 35 |
|
|---|
| 36 | #ifndef USBHID_KBDDEV_H_
|
|---|
| 37 | #define USBHID_KBDDEV_H_
|
|---|
| 38 |
|
|---|
| 39 | #include <stdint.h>
|
|---|
| 40 |
|
|---|
| 41 | #include <usb/classes/hid.h>
|
|---|
| 42 | #include <ddf/driver.h>
|
|---|
| 43 | #include <usb/pipes.h>
|
|---|
| 44 |
|
|---|
| 45 | #include "hiddev.h"
|
|---|
| 46 |
|
|---|
| 47 | /*----------------------------------------------------------------------------*/
|
|---|
| 48 | /**
|
|---|
| 49 | * USB/HID keyboard device type.
|
|---|
| 50 | *
|
|---|
| 51 | * Holds a reference to generic USB/HID device structure and keyboard-specific
|
|---|
| 52 | * data, such as currently pressed keys, modifiers and lock keys.
|
|---|
| 53 | *
|
|---|
| 54 | * Also holds a IPC phone to the console (since there is now no other way to
|
|---|
| 55 | * communicate with it).
|
|---|
| 56 | *
|
|---|
| 57 | * @note Storing active lock keys in this structure results in their setting
|
|---|
| 58 | * being device-specific.
|
|---|
| 59 | */
|
|---|
| 60 | typedef struct {
|
|---|
| 61 | /** Structure holding generic USB/HID device information. */
|
|---|
| 62 | usbhid_dev_t *hid_dev;
|
|---|
| 63 |
|
|---|
| 64 | /** Currently pressed keys (not translated to key codes). */
|
|---|
| 65 | uint8_t *keys;
|
|---|
| 66 | /** Count of stored keys (i.e. number of keys in the report). */
|
|---|
| 67 | size_t key_count;
|
|---|
| 68 | /** Currently pressed modifiers (bitmap). */
|
|---|
| 69 | uint8_t modifiers;
|
|---|
| 70 |
|
|---|
| 71 | /** Currently active modifiers including locks. Sent to the console. */
|
|---|
| 72 | unsigned mods;
|
|---|
| 73 |
|
|---|
| 74 | /** Currently active lock keys. */
|
|---|
| 75 | unsigned lock_keys;
|
|---|
| 76 |
|
|---|
| 77 | /** IPC phone to the console device (for sending key events). */
|
|---|
| 78 | int console_phone;
|
|---|
| 79 |
|
|---|
| 80 | /** State of the structure (for checking before use). */
|
|---|
| 81 | int initialized;
|
|---|
| 82 | } usbhid_kbd_t;
|
|---|
| 83 |
|
|---|
| 84 | /*----------------------------------------------------------------------------*/
|
|---|
| 85 |
|
|---|
| 86 | int usbhid_kbd_try_add_device(ddf_dev_t *dev);
|
|---|
| 87 |
|
|---|
| 88 | #endif /* USBHID_KBDDEV_H_ */
|
|---|
| 89 |
|
|---|
| 90 | /**
|
|---|
| 91 | * @}
|
|---|
| 92 | */
|
|---|
