EL4121 Embedded System / mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

features/unsupported/USBHost/USBHostHID/USBHostKeyboard.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

UserRevisionLine numberNew contents of line
be_bryan 0:b74591d5ab33 1 /* mbed USBHost Library
be_bryan 0:b74591d5ab33 2 * Copyright (c) 2006-2013 ARM Limited
be_bryan 0:b74591d5ab33 3 *
be_bryan 0:b74591d5ab33 4 * Licensed under the Apache License, Version 2.0 (the "License");
be_bryan 0:b74591d5ab33 5 * you may not use this file except in compliance with the License.
be_bryan 0:b74591d5ab33 6 * You may obtain a copy of the License at
be_bryan 0:b74591d5ab33 7 *
be_bryan 0:b74591d5ab33 8 * http://www.apache.org/licenses/LICENSE-2.0
be_bryan 0:b74591d5ab33 9 *
be_bryan 0:b74591d5ab33 10 * Unless required by applicable law or agreed to in writing, software
be_bryan 0:b74591d5ab33 11 * distributed under the License is distributed on an "AS IS" BASIS,
be_bryan 0:b74591d5ab33 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
be_bryan 0:b74591d5ab33 13 * See the License for the specific language governing permissions and
be_bryan 0:b74591d5ab33 14 * limitations under the License.
be_bryan 0:b74591d5ab33 15 */
be_bryan 0:b74591d5ab33 16
be_bryan 0:b74591d5ab33 17 #ifndef USBHOSTKEYBOARD_H
be_bryan 0:b74591d5ab33 18 #define USBHOSTKEYBOARD_H
be_bryan 0:b74591d5ab33 19
be_bryan 0:b74591d5ab33 20 #include "USBHostConf.h"
be_bryan 0:b74591d5ab33 21
be_bryan 0:b74591d5ab33 22 #if USBHOST_KEYBOARD
be_bryan 0:b74591d5ab33 23
be_bryan 0:b74591d5ab33 24 #include "USBHost.h"
be_bryan 0:b74591d5ab33 25
be_bryan 0:b74591d5ab33 26 /**
be_bryan 0:b74591d5ab33 27 * A class to communicate a USB keyboard
be_bryan 0:b74591d5ab33 28 */
be_bryan 0:b74591d5ab33 29 class USBHostKeyboard : public IUSBEnumerator
be_bryan 0:b74591d5ab33 30 {
be_bryan 0:b74591d5ab33 31 public:
be_bryan 0:b74591d5ab33 32
be_bryan 0:b74591d5ab33 33 /**
be_bryan 0:b74591d5ab33 34 * Constructor
be_bryan 0:b74591d5ab33 35 */
be_bryan 0:b74591d5ab33 36 USBHostKeyboard();
be_bryan 0:b74591d5ab33 37
be_bryan 0:b74591d5ab33 38 /**
be_bryan 0:b74591d5ab33 39 * Try to connect a keyboard device
be_bryan 0:b74591d5ab33 40 *
be_bryan 0:b74591d5ab33 41 * @return true if connection was successful
be_bryan 0:b74591d5ab33 42 */
be_bryan 0:b74591d5ab33 43 bool connect();
be_bryan 0:b74591d5ab33 44
be_bryan 0:b74591d5ab33 45 /**
be_bryan 0:b74591d5ab33 46 * Check if a keyboard is connected
be_bryan 0:b74591d5ab33 47 *
be_bryan 0:b74591d5ab33 48 * @returns true if a keyboard is connected
be_bryan 0:b74591d5ab33 49 */
be_bryan 0:b74591d5ab33 50 bool connected();
be_bryan 0:b74591d5ab33 51
be_bryan 0:b74591d5ab33 52 /**
be_bryan 0:b74591d5ab33 53 * Attach a callback called when a keyboard event is received
be_bryan 0:b74591d5ab33 54 *
be_bryan 0:b74591d5ab33 55 * @param ptr function pointer
be_bryan 0:b74591d5ab33 56 */
be_bryan 0:b74591d5ab33 57 inline void attach(void (*ptr)(uint8_t key))
be_bryan 0:b74591d5ab33 58 {
be_bryan 0:b74591d5ab33 59 if (ptr != NULL) {
be_bryan 0:b74591d5ab33 60 onKey = ptr;
be_bryan 0:b74591d5ab33 61 }
be_bryan 0:b74591d5ab33 62 }
be_bryan 0:b74591d5ab33 63
be_bryan 0:b74591d5ab33 64 /**
be_bryan 0:b74591d5ab33 65 * Attach a callback called when a keyboard event is received
be_bryan 0:b74591d5ab33 66 *
be_bryan 0:b74591d5ab33 67 * @param ptr function pointer
be_bryan 0:b74591d5ab33 68 */
be_bryan 0:b74591d5ab33 69 inline void attach(void (*ptr)(uint8_t keyCode, uint8_t modifier))
be_bryan 0:b74591d5ab33 70 {
be_bryan 0:b74591d5ab33 71 if (ptr != NULL) {
be_bryan 0:b74591d5ab33 72 onKeyCode = ptr;
be_bryan 0:b74591d5ab33 73 }
be_bryan 0:b74591d5ab33 74 }
be_bryan 0:b74591d5ab33 75
be_bryan 0:b74591d5ab33 76 protected:
be_bryan 0:b74591d5ab33 77 //From IUSBEnumerator
be_bryan 0:b74591d5ab33 78 virtual void setVidPid(uint16_t vid, uint16_t pid);
be_bryan 0:b74591d5ab33 79 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
be_bryan 0:b74591d5ab33 80 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
be_bryan 0:b74591d5ab33 81
be_bryan 0:b74591d5ab33 82 private:
be_bryan 0:b74591d5ab33 83 USBHost * host;
be_bryan 0:b74591d5ab33 84 USBDeviceConnected * dev;
be_bryan 0:b74591d5ab33 85 USBEndpoint * int_in;
be_bryan 0:b74591d5ab33 86 uint8_t report[9];
be_bryan 0:b74591d5ab33 87 int keyboard_intf;
be_bryan 0:b74591d5ab33 88 bool keyboard_device_found;
be_bryan 0:b74591d5ab33 89
be_bryan 0:b74591d5ab33 90 bool dev_connected;
be_bryan 0:b74591d5ab33 91
be_bryan 0:b74591d5ab33 92 void rxHandler();
be_bryan 0:b74591d5ab33 93
be_bryan 0:b74591d5ab33 94 void (*onKey)(uint8_t key);
be_bryan 0:b74591d5ab33 95 void (*onKeyCode)(uint8_t key, uint8_t modifier);
be_bryan 0:b74591d5ab33 96
be_bryan 0:b74591d5ab33 97 int report_id;
be_bryan 0:b74591d5ab33 98
be_bryan 0:b74591d5ab33 99 void init();
be_bryan 0:b74591d5ab33 100
be_bryan 0:b74591d5ab33 101 };
be_bryan 0:b74591d5ab33 102
be_bryan 0:b74591d5ab33 103 #endif
be_bryan 0:b74591d5ab33 104
be_bryan 0:b74591d5ab33 105 #endif