Renato Grottesi / microbit-dal

MicroBit as BLE gamepad

Dependencies:   BLE_API mbed-dev-bin nRF51822

Dependents:   microbit

Fork of microbit-dal by Lancaster University

BLE_HID/HID_types.h@75:df904445f561, 2017-01-30 (annotated)

Committer:
rengro01
Date:
Mon Jan 30 08:29:06 2017 +0000
Revision:
75:df904445f561
Parent:
74:1b9850e39cd1 
MicroBit as BLE gamepad

Who changed what in which revision?

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