z ysaito / USBHost3

2018.07.26

Dependencies:   FATFileSystem3 mbed-rtos

Fork of USBHost by mbed official

USBHostHID/USBHostKeyboard.h@0:a554658735bf, 2013-03-06 (annotated)

Committer:
mbed_official
Date:
Wed Mar 06 16:27:14 2013 +0000
Revision:
0:a554658735bf
Child:
1:0a457e34fa9e
first commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:a554658735bf 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
mbed_official 0:a554658735bf 2 *
mbed_official 0:a554658735bf 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
mbed_official 0:a554658735bf 4 * and associated documentation files (the "Software"), to deal in the Software without
mbed_official 0:a554658735bf 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
mbed_official 0:a554658735bf 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
mbed_official 0:a554658735bf 7 * Software is furnished to do so, subject to the following conditions:
mbed_official 0:a554658735bf 8 *
mbed_official 0:a554658735bf 9 * The above copyright notice and this permission notice shall be included in all copies or
mbed_official 0:a554658735bf 10 * substantial portions of the Software.
mbed_official 0:a554658735bf 11 *
mbed_official 0:a554658735bf 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
mbed_official 0:a554658735bf 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
mbed_official 0:a554658735bf 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
mbed_official 0:a554658735bf 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:a554658735bf 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
mbed_official 0:a554658735bf 17 */
mbed_official 0:a554658735bf 18
mbed_official 0:a554658735bf 19 #ifndef USBHOSTKEYBOARD_H
mbed_official 0:a554658735bf 20 #define USBHOSTKEYBOARD_H
mbed_official 0:a554658735bf 21
mbed_official 0:a554658735bf 22 #include "USBHostConf.h"
mbed_official 0:a554658735bf 23
mbed_official 0:a554658735bf 24 #if USBHOST_KEYBOARD
mbed_official 0:a554658735bf 25
mbed_official 0:a554658735bf 26 #include "USBHost.h"
mbed_official 0:a554658735bf 27
mbed_official 0:a554658735bf 28 class USBHostKeyboard : public IUSBEnumerator {
mbed_official 0:a554658735bf 29 public:
mbed_official 0:a554658735bf 30
mbed_official 0:a554658735bf 31 /**
mbed_official 0:a554658735bf 32 * Constructor
mbed_official 0:a554658735bf 33 */
mbed_official 0:a554658735bf 34 USBHostKeyboard();
mbed_official 0:a554658735bf 35
mbed_official 0:a554658735bf 36 /**
mbed_official 0:a554658735bf 37 * Try to connect a keyboard device
mbed_official 0:a554658735bf 38 *
mbed_official 0:a554658735bf 39 * * @return true if connection was successful
mbed_official 0:a554658735bf 40 */
mbed_official 0:a554658735bf 41 bool connect();
mbed_official 0:a554658735bf 42
mbed_official 0:a554658735bf 43 /**
mbed_official 0:a554658735bf 44 * Check if a keyboard is connected
mbed_official 0:a554658735bf 45 *
mbed_official 0:a554658735bf 46 * @returns true if a keyboard is connected
mbed_official 0:a554658735bf 47 */
mbed_official 0:a554658735bf 48 bool connected();
mbed_official 0:a554658735bf 49
mbed_official 0:a554658735bf 50 /**
mbed_official 0:a554658735bf 51 * Attach a callback called when a keyboard event is received
mbed_official 0:a554658735bf 52 *
mbed_official 0:a554658735bf 53 * @param fptr function pointer
mbed_official 0:a554658735bf 54 */
mbed_official 0:a554658735bf 55 inline void attach(void (*ptr)(uint8_t key)) {
mbed_official 0:a554658735bf 56 if (ptr != NULL) {
mbed_official 0:a554658735bf 57 onKey = ptr;
mbed_official 0:a554658735bf 58 }
mbed_official 0:a554658735bf 59 }
mbed_official 0:a554658735bf 60
mbed_official 0:a554658735bf 61 /**
mbed_official 0:a554658735bf 62 * Attach a callback called when a keyboard event is received
mbed_official 0:a554658735bf 63 *
mbed_official 0:a554658735bf 64 * @param fptr function pointer
mbed_official 0:a554658735bf 65 */
mbed_official 0:a554658735bf 66 inline void attach(void (*ptr)(uint8_t keyCode, uint8_t modifier)) {
mbed_official 0:a554658735bf 67 if (ptr != NULL) {
mbed_official 0:a554658735bf 68 onKeyCode = ptr;
mbed_official 0:a554658735bf 69 }
mbed_official 0:a554658735bf 70 }
mbed_official 0:a554658735bf 71
mbed_official 0:a554658735bf 72 protected:
mbed_official 0:a554658735bf 73 //From IUSBEnumerator
mbed_official 0:a554658735bf 74 virtual void setVidPid(uint16_t vid, uint16_t pid);
mbed_official 0:a554658735bf 75 virtual bool parseInterface(uint8_t intf_nb, uint8_t intf_class, uint8_t intf_subclass, uint8_t intf_protocol); //Must return true if the interface should be parsed
mbed_official 0:a554658735bf 76 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
mbed_official 0:a554658735bf 77
mbed_official 0:a554658735bf 78 private:
mbed_official 0:a554658735bf 79 USBHost * host;
mbed_official 0:a554658735bf 80 USBDeviceConnected * dev;
mbed_official 0:a554658735bf 81 USBEndpoint * int_in;
mbed_official 0:a554658735bf 82 uint8_t report[9];
mbed_official 0:a554658735bf 83 int keyboard_intf;
mbed_official 0:a554658735bf 84 bool keyboard_device_found;
mbed_official 0:a554658735bf 85
mbed_official 0:a554658735bf 86 bool dev_connected;
mbed_official 0:a554658735bf 87
mbed_official 0:a554658735bf 88 void rxHandler();
mbed_official 0:a554658735bf 89
mbed_official 0:a554658735bf 90 void (*onKey)(uint8_t key);
mbed_official 0:a554658735bf 91 void (*onKeyCode)(uint8_t key, uint8_t modifier);
mbed_official 0:a554658735bf 92
mbed_official 0:a554658735bf 93 int report_id;
mbed_official 0:a554658735bf 94
mbed_official 0:a554658735bf 95 void init();
mbed_official 0:a554658735bf 96
mbed_official 0:a554658735bf 97 };
mbed_official 0:a554658735bf 98
mbed_official 0:a554658735bf 99 #endif
mbed_official 0:a554658735bf 100
mbed_official 0:a554658735bf 101 #endif
mbed_official 0:a554658735bf 102