tool/mbed/mbed-sdk/libraries/USBHost/USBHostHID/USBHostKeyboard.h

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