Jean-Philippe Brucker / BLE_HID

HID-over-GATT implementation with the BLE API. This library allows to create devices such as mouse, keyboard or joystick, over Bluetooth Low Energy.

Dependents:   BLENano_HID BLE_HID_MouseScrollDemo BLE_HID_KeyboardStreamDemo Shervs_TestKeyboard_TinyBLE ... more

The development repository is currently hosted on github. It contains examples and documentation. This is a snapshot of the library. The documentation can be read on github, or on docs.mbed.com.

USBHID_Types.h@3:4f8429a1905b, 2015-11-19 (annotated)

Committer:
Jean-Philippe Brucker
Date:
Thu Nov 19 15:00:39 2015 +0000
Revision:
3:4f8429a1905b
Version 0.3

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jean-Philippe Brucker 3:4f8429a1905b 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
Jean-Philippe Brucker 3:4f8429a1905b 2 *
Jean-Philippe Brucker 3:4f8429a1905b 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
Jean-Philippe Brucker 3:4f8429a1905b 4 * and associated documentation files (the "Software"), to deal in the Software without
Jean-Philippe Brucker 3:4f8429a1905b 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
Jean-Philippe Brucker 3:4f8429a1905b 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
Jean-Philippe Brucker 3:4f8429a1905b 7 * Software is furnished to do so, subject to the following conditions:
Jean-Philippe Brucker 3:4f8429a1905b 8 *
Jean-Philippe Brucker 3:4f8429a1905b 9 * The above copyright notice and this permission notice shall be included in all copies or
Jean-Philippe Brucker 3:4f8429a1905b 10 * substantial portions of the Software.
Jean-Philippe Brucker 3:4f8429a1905b 11 *
Jean-Philippe Brucker 3:4f8429a1905b 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
Jean-Philippe Brucker 3:4f8429a1905b 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Jean-Philippe Brucker 3:4f8429a1905b 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
Jean-Philippe Brucker 3:4f8429a1905b 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Jean-Philippe Brucker 3:4f8429a1905b 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Jean-Philippe Brucker 3:4f8429a1905b 17 */
Jean-Philippe Brucker 3:4f8429a1905b 18
Jean-Philippe Brucker 3:4f8429a1905b 19 #ifndef USBCLASS_HID_TYPES
Jean-Philippe Brucker 3:4f8429a1905b 20 #define USBCLASS_HID_TYPES
Jean-Philippe Brucker 3:4f8429a1905b 21
Jean-Philippe Brucker 3:4f8429a1905b 22 #include <stdint.h>
Jean-Philippe Brucker 3:4f8429a1905b 23
Jean-Philippe Brucker 3:4f8429a1905b 24 /* */
Jean-Philippe Brucker 3:4f8429a1905b 25 #define HID_VERSION_1_11 (0x0111)
Jean-Philippe Brucker 3:4f8429a1905b 26
Jean-Philippe Brucker 3:4f8429a1905b 27 /* HID Class */
Jean-Philippe Brucker 3:4f8429a1905b 28 #define HID_CLASS (3)
Jean-Philippe Brucker 3:4f8429a1905b 29 #define HID_SUBCLASS_NONE (0)
Jean-Philippe Brucker 3:4f8429a1905b 30 #define HID_PROTOCOL_NONE (0)
Jean-Philippe Brucker 3:4f8429a1905b 31
Jean-Philippe Brucker 3:4f8429a1905b 32 /* Descriptors */
Jean-Philippe Brucker 3:4f8429a1905b 33 #define HID_DESCRIPTOR (33)
Jean-Philippe Brucker 3:4f8429a1905b 34 #define HID_DESCRIPTOR_LENGTH (0x09)
Jean-Philippe Brucker 3:4f8429a1905b 35 #define REPORT_DESCRIPTOR (34)
Jean-Philippe Brucker 3:4f8429a1905b 36
Jean-Philippe Brucker 3:4f8429a1905b 37 /* Class requests */
Jean-Philippe Brucker 3:4f8429a1905b 38 #define GET_REPORT (0x1)
Jean-Philippe Brucker 3:4f8429a1905b 39 #define GET_IDLE (0x2)
Jean-Philippe Brucker 3:4f8429a1905b 40 #define SET_REPORT (0x9)
Jean-Philippe Brucker 3:4f8429a1905b 41 #define SET_IDLE (0xa)
Jean-Philippe Brucker 3:4f8429a1905b 42
Jean-Philippe Brucker 3:4f8429a1905b 43 /* HID Class Report Descriptor */
Jean-Philippe Brucker 3:4f8429a1905b 44 /* Short items: size is 0, 1, 2 or 3 specifying 0, 1, 2 or 4 (four) bytes */
Jean-Philippe Brucker 3:4f8429a1905b 45 /* of data as per HID Class standard */
Jean-Philippe Brucker 3:4f8429a1905b 46
Jean-Philippe Brucker 3:4f8429a1905b 47 /* Main items */
Jean-Philippe Brucker 3:4f8429a1905b 48 #define INPUT(size) (0x80 | size)
Jean-Philippe Brucker 3:4f8429a1905b 49 #define OUTPUT(size) (0x90 | size)
Jean-Philippe Brucker 3:4f8429a1905b 50 #define FEATURE(size) (0xb0 | size)
Jean-Philippe Brucker 3:4f8429a1905b 51 #define COLLECTION(size) (0xa0 | size)
Jean-Philippe Brucker 3:4f8429a1905b 52 #define END_COLLECTION(size) (0xc0 | size)
Jean-Philippe Brucker 3:4f8429a1905b 53
Jean-Philippe Brucker 3:4f8429a1905b 54 /* Global items */
Jean-Philippe Brucker 3:4f8429a1905b 55 #define USAGE_PAGE(size) (0x04 | size)
Jean-Philippe Brucker 3:4f8429a1905b 56 #define LOGICAL_MINIMUM(size) (0x14 | size)
Jean-Philippe Brucker 3:4f8429a1905b 57 #define LOGICAL_MAXIMUM(size) (0x24 | size)
Jean-Philippe Brucker 3:4f8429a1905b 58 #define PHYSICAL_MINIMUM(size) (0x34 | size)
Jean-Philippe Brucker 3:4f8429a1905b 59 #define PHYSICAL_MAXIMUM(size) (0x44 | size)
Jean-Philippe Brucker 3:4f8429a1905b 60 #define UNIT_EXPONENT(size) (0x54 | size)
Jean-Philippe Brucker 3:4f8429a1905b 61 #define UNIT(size) (0x64 | size)
Jean-Philippe Brucker 3:4f8429a1905b 62 #define REPORT_SIZE(size) (0x74 | size)
Jean-Philippe Brucker 3:4f8429a1905b 63 #define REPORT_ID(size) (0x84 | size)
Jean-Philippe Brucker 3:4f8429a1905b 64 #define REPORT_COUNT(size) (0x94 | size)
Jean-Philippe Brucker 3:4f8429a1905b 65 #define PUSH(size) (0xa4 | size)
Jean-Philippe Brucker 3:4f8429a1905b 66 #define POP(size) (0xb4 | size)
Jean-Philippe Brucker 3:4f8429a1905b 67
Jean-Philippe Brucker 3:4f8429a1905b 68 /* Local items */
Jean-Philippe Brucker 3:4f8429a1905b 69 #define USAGE(size) (0x08 | size)
Jean-Philippe Brucker 3:4f8429a1905b 70 #define USAGE_MINIMUM(size) (0x18 | size)
Jean-Philippe Brucker 3:4f8429a1905b 71 #define USAGE_MAXIMUM(size) (0x28 | size)
Jean-Philippe Brucker 3:4f8429a1905b 72 #define DESIGNATOR_INDEX(size) (0x38 | size)
Jean-Philippe Brucker 3:4f8429a1905b 73 #define DESIGNATOR_MINIMUM(size) (0x48 | size)
Jean-Philippe Brucker 3:4f8429a1905b 74 #define DESIGNATOR_MAXIMUM(size) (0x58 | size)
Jean-Philippe Brucker 3:4f8429a1905b 75 #define STRING_INDEX(size) (0x78 | size)
Jean-Philippe Brucker 3:4f8429a1905b 76 #define STRING_MINIMUM(size) (0x88 | size)
Jean-Philippe Brucker 3:4f8429a1905b 77 #define STRING_MAXIMUM(size) (0x98 | size)
Jean-Philippe Brucker 3:4f8429a1905b 78 #define DELIMITER(size) (0xa8 | size)
Jean-Philippe Brucker 3:4f8429a1905b 79
Jean-Philippe Brucker 3:4f8429a1905b 80 /* HID Report */
Jean-Philippe Brucker 3:4f8429a1905b 81 /* Where report IDs are used the first byte of 'data' will be the */
Jean-Philippe Brucker 3:4f8429a1905b 82 /* report ID and 'length' will include this report ID byte. */
Jean-Philippe Brucker 3:4f8429a1905b 83
Jean-Philippe Brucker 3:4f8429a1905b 84 #define MAX_HID_REPORT_SIZE (64)
Jean-Philippe Brucker 3:4f8429a1905b 85
Jean-Philippe Brucker 3:4f8429a1905b 86 typedef struct {
Jean-Philippe Brucker 3:4f8429a1905b 87 uint32_t length;
Jean-Philippe Brucker 3:4f8429a1905b 88 uint8_t data[MAX_HID_REPORT_SIZE];
Jean-Philippe Brucker 3:4f8429a1905b 89 } HID_REPORT;
Jean-Philippe Brucker 3:4f8429a1905b 90
Jean-Philippe Brucker 3:4f8429a1905b 91 #endif