Douglas Choi / Mbed 2 deprecated DISCO-F746NG_Monttory_Base

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:   AUDIO_DISCO_F746NG BSP_DISCO_F746NG EEPROM_DISCO_F746NG LCD_DISCO_F746NG QSPI_DISCO_F746NG SD_DISCO_F746NG SDRAM_DISCO_F746NG TS_DISCO_F746NG FATFileSystem mbed-rtos mbed

DISCO_F746NG_USBHost/USBHostHID/USBHostKeyboard.h@13:98d873b3e6db, 2017-10-21 (annotated)

Committer:
DouglasK
Date:
Sat Oct 21 03:18:01 2017 +0000
Revision:
13:98d873b3e6db
Monttory Base 01

Who changed what in which revision?

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