Emiel Estiévenart / USBDevice

Base station firmware

USBHID/USBHID_Types.h@0:ecc3925d3f8c, 2016-05-24 (annotated)

Committer:
Perijah
Date:
Tue May 24 13:16:55 2016 +0000
Revision:
0:ecc3925d3f8c
Base station firmware

Who changed what in which revision?

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