David Godfrey / test_USBHost

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   FATFileSystem mbed-rtos

Fork of USBHost by mbed official

USBHostHID/USBHostKeyboard.h@8:93da8ea2708b, 2013-03-14 (annotated)

Committer:
samux
Date:
Thu Mar 14 11:49:53 2013 +0000
Revision:
8:93da8ea2708b
Parent:
4:b320d68e98e7
Child:
24:868cbfe611a7
update doc + license

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
samux 1:0a457e34fa9e 26 /**
samux 1:0a457e34fa9e 27 * A class to communicate a USB keyboard
samux 1:0a457e34fa9e 28 */
mbed_official 0:a554658735bf 29 class USBHostKeyboard : public IUSBEnumerator {
mbed_official 0:a554658735bf 30 public:
mbed_official 0:a554658735bf 31
mbed_official 0:a554658735bf 32 /**
mbed_official 0:a554658735bf 33 * Constructor
mbed_official 0:a554658735bf 34 */
mbed_official 0:a554658735bf 35 USBHostKeyboard();
mbed_official 0:a554658735bf 36
mbed_official 0:a554658735bf 37 /**
mbed_official 0:a554658735bf 38 * Try to connect a keyboard device
mbed_official 0:a554658735bf 39 *
samux 3:0f5c32575eb8 40 * @return true if connection was successful
mbed_official 0:a554658735bf 41 */
mbed_official 0:a554658735bf 42 bool connect();
mbed_official 0:a554658735bf 43
mbed_official 0:a554658735bf 44 /**
mbed_official 0:a554658735bf 45 * Check if a keyboard is connected
mbed_official 0:a554658735bf 46 *
mbed_official 0:a554658735bf 47 * @returns true if a keyboard is connected
mbed_official 0:a554658735bf 48 */
mbed_official 0:a554658735bf 49 bool connected();
mbed_official 0:a554658735bf 50
mbed_official 0:a554658735bf 51 /**
mbed_official 0:a554658735bf 52 * Attach a callback called when a keyboard event is received
mbed_official 0:a554658735bf 53 *
samux 2:5e8fdc541b98 54 * @param ptr function pointer
mbed_official 0:a554658735bf 55 */
mbed_official 0:a554658735bf 56 inline void attach(void (*ptr)(uint8_t key)) {
mbed_official 0:a554658735bf 57 if (ptr != NULL) {
mbed_official 0:a554658735bf 58 onKey = ptr;
mbed_official 0:a554658735bf 59 }
mbed_official 0:a554658735bf 60 }
mbed_official 0:a554658735bf 61
mbed_official 0:a554658735bf 62 /**
mbed_official 0:a554658735bf 63 * Attach a callback called when a keyboard event is received
mbed_official 0:a554658735bf 64 *
samux 2:5e8fdc541b98 65 * @param ptr function pointer
mbed_official 0:a554658735bf 66 */
mbed_official 0:a554658735bf 67 inline void attach(void (*ptr)(uint8_t keyCode, uint8_t modifier)) {
mbed_official 0:a554658735bf 68 if (ptr != NULL) {
mbed_official 0:a554658735bf 69 onKeyCode = ptr;
mbed_official 0:a554658735bf 70 }
mbed_official 0:a554658735bf 71 }
mbed_official 0:a554658735bf 72
mbed_official 0:a554658735bf 73 protected:
mbed_official 0:a554658735bf 74 //From IUSBEnumerator
mbed_official 0:a554658735bf 75 virtual void setVidPid(uint16_t vid, uint16_t pid);
mbed_official 0:a554658735bf 76 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 77 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 78
mbed_official 0:a554658735bf 79 private:
mbed_official 0:a554658735bf 80 USBHost * host;
mbed_official 0:a554658735bf 81 USBDeviceConnected * dev;
mbed_official 0:a554658735bf 82 USBEndpoint * int_in;
mbed_official 0:a554658735bf 83 uint8_t report[9];
mbed_official 0:a554658735bf 84 int keyboard_intf;
mbed_official 0:a554658735bf 85 bool keyboard_device_found;
mbed_official 0:a554658735bf 86
mbed_official 0:a554658735bf 87 bool dev_connected;
mbed_official 0:a554658735bf 88
mbed_official 0:a554658735bf 89 void rxHandler();
mbed_official 0:a554658735bf 90
mbed_official 0:a554658735bf 91 void (*onKey)(uint8_t key);
mbed_official 0:a554658735bf 92 void (*onKeyCode)(uint8_t key, uint8_t modifier);
mbed_official 0:a554658735bf 93
mbed_official 0:a554658735bf 94 int report_id;
mbed_official 0:a554658735bf 95
mbed_official 0:a554658735bf 96 void init();
mbed_official 0:a554658735bf 97
mbed_official 0:a554658735bf 98 };
mbed_official 0:a554658735bf 99
mbed_official 0:a554658735bf 100 #endif
mbed_official 0:a554658735bf 101
mbed_official 0:a554658735bf 102 #endif