mbed official / USBHost

USBHost library. NOTE: This library is only officially supported on the LPC1768 platform. For more information, please see the handbook page.

Dependencies:   FATFileSystem mbed-rtos

Dependents:   BTstack WallbotWii SD to Flash Data Transfer USBHost-MSD_HelloWorld ... more

Legacy Warning

This is an mbed 2 library. To learn more about mbed OS 5, visit the docs.

Pull requests against this repository are no longer supported. Please raise against mbed OS 5 as documented above.

USBHostHID/USBHostKeyboard.h@40:7c3b59bb364e, 2017-08-17 (annotated)

Committer:
Anna Bridge
Date:
Thu Aug 17 18:12:22 2017 +0100
Revision:
40:7c3b59bb364e
Parent:
37:f1e388e7b752 
DISCO_L475VG_IOT01A: Add support of USBHost

Who changed what in which revision?

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