mbed official / USBDevice Featured

USB device stack

Dependents:   mbed-mX-USB-TEST1 USBMSD_SD_HID_HelloWorld HidTest MIDI_usb_bridge ... 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.

USBHID/USBKeyboard.h@71:53949e6131f6, 2017-07-27 (annotated)

Committer:
Kojto
Date:
Thu Jul 27 12:14:04 2017 +0100
Revision:
71:53949e6131f6
Parent:
70:2c525a50f1b6 
Update libraries



Fixes the previous commmit, as some devices were not copied. USBDevice contains

now targets directory with all targets implementations

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 1:80ab0d068708 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
samux 1:80ab0d068708 2 *
samux 1:80ab0d068708 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
samux 1:80ab0d068708 4 * and associated documentation files (the "Software"), to deal in the Software without
samux 1:80ab0d068708 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
samux 1:80ab0d068708 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
samux 1:80ab0d068708 7 * Software is furnished to do so, subject to the following conditions:
samux 1:80ab0d068708 8 *
samux 1:80ab0d068708 9 * The above copyright notice and this permission notice shall be included in all copies or
samux 1:80ab0d068708 10 * substantial portions of the Software.
samux 1:80ab0d068708 11 *
samux 1:80ab0d068708 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
samux 1:80ab0d068708 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
samux 1:80ab0d068708 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
samux 1:80ab0d068708 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 1:80ab0d068708 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
samux 1:80ab0d068708 17 */
samux 1:80ab0d068708 18
samux 1:80ab0d068708 19 #ifndef USBKEYBOARD_H
samux 1:80ab0d068708 20 #define USBKEYBOARD_H
samux 1:80ab0d068708 21
samux 1:80ab0d068708 22 #include "USBHID.h"
samux 1:80ab0d068708 23 #include "Stream.h"
samux 1:80ab0d068708 24
Kojto 70:2c525a50f1b6 25 /* Modifiers, left keys then right keys. */
samux 1:80ab0d068708 26 enum MODIFIER_KEY {
Kojto 70:2c525a50f1b6 27 KEY_CTRL = 0x01,
Kojto 70:2c525a50f1b6 28 KEY_SHIFT = 0x02,
Kojto 70:2c525a50f1b6 29 KEY_ALT = 0x04,
Kojto 70:2c525a50f1b6 30 KEY_LOGO = 0x08,
Kojto 70:2c525a50f1b6 31 KEY_RCTRL = 0x10,
Kojto 70:2c525a50f1b6 32 KEY_RSHIFT = 0x20,
Kojto 70:2c525a50f1b6 33 KEY_RALT = 0x40,
Kojto 70:2c525a50f1b6 34 KEY_RLOGO = 0x80,
samux 1:80ab0d068708 35 };
samux 1:80ab0d068708 36
samux 1:80ab0d068708 37
samux 1:80ab0d068708 38 enum MEDIA_KEY {
samux 1:80ab0d068708 39 KEY_NEXT_TRACK, /*!< next Track Button */
samux 1:80ab0d068708 40 KEY_PREVIOUS_TRACK, /*!< Previous track Button */
samux 1:80ab0d068708 41 KEY_STOP, /*!< Stop Button */
samux 1:80ab0d068708 42 KEY_PLAY_PAUSE, /*!< Play/Pause Button */
samux 1:80ab0d068708 43 KEY_MUTE, /*!< Mute Button */
samux 1:80ab0d068708 44 KEY_VOLUME_UP, /*!< Volume Up Button */
samux 1:80ab0d068708 45 KEY_VOLUME_DOWN, /*!< Volume Down Button */
samux 1:80ab0d068708 46 };
samux 1:80ab0d068708 47
samux 1:80ab0d068708 48 enum FUNCTION_KEY {
samux 1:80ab0d068708 49 KEY_F1 = 128, /* F1 key */
samux 1:80ab0d068708 50 KEY_F2, /* F2 key */
samux 1:80ab0d068708 51 KEY_F3, /* F3 key */
samux 1:80ab0d068708 52 KEY_F4, /* F4 key */
samux 1:80ab0d068708 53 KEY_F5, /* F5 key */
samux 1:80ab0d068708 54 KEY_F6, /* F6 key */
samux 1:80ab0d068708 55 KEY_F7, /* F7 key */
samux 1:80ab0d068708 56 KEY_F8, /* F8 key */
samux 1:80ab0d068708 57 KEY_F9, /* F9 key */
samux 1:80ab0d068708 58 KEY_F10, /* F10 key */
samux 1:80ab0d068708 59 KEY_F11, /* F11 key */
samux 1:80ab0d068708 60 KEY_F12, /* F12 key */
mbed_official 25:7c72828865f3 61
samux 1:80ab0d068708 62 KEY_PRINT_SCREEN, /* Print Screen key */
samux 1:80ab0d068708 63 KEY_SCROLL_LOCK, /* Scroll lock */
samux 1:80ab0d068708 64 KEY_CAPS_LOCK, /* caps lock */
samux 1:80ab0d068708 65 KEY_NUM_LOCK, /* num lock */
samux 1:80ab0d068708 66 KEY_INSERT, /* Insert key */
samux 1:80ab0d068708 67 KEY_HOME, /* Home key */
samux 1:80ab0d068708 68 KEY_PAGE_UP, /* Page Up key */
samux 1:80ab0d068708 69 KEY_PAGE_DOWN, /* Page Down key */
mbed_official 25:7c72828865f3 70
samux 1:80ab0d068708 71 RIGHT_ARROW, /* Right arrow */
samux 1:80ab0d068708 72 LEFT_ARROW, /* Left arrow */
samux 1:80ab0d068708 73 DOWN_ARROW, /* Down arrow */
samux 1:80ab0d068708 74 UP_ARROW, /* Up arrow */
samux 1:80ab0d068708 75 };
samux 1:80ab0d068708 76
samux 1:80ab0d068708 77 /**
samux 1:80ab0d068708 78 * USBKeyboard example
samux 1:80ab0d068708 79 * @code
samux 1:80ab0d068708 80 *
samux 1:80ab0d068708 81 * #include "mbed.h"
samux 1:80ab0d068708 82 * #include "USBKeyboard.h"
samux 1:80ab0d068708 83 *
samux 1:80ab0d068708 84 * USBKeyboard key;
samux 1:80ab0d068708 85 *
samux 1:80ab0d068708 86 * int main(void)
samux 1:80ab0d068708 87 * {
samux 1:80ab0d068708 88 * while (1)
samux 1:80ab0d068708 89 * {
samux 1:80ab0d068708 90 * key.printf("Hello World\r\n");
samux 1:80ab0d068708 91 * wait(1);
samux 1:80ab0d068708 92 * }
samux 1:80ab0d068708 93 * }
samux 1:80ab0d068708 94 *
samux 1:80ab0d068708 95 * @endcode
samux 1:80ab0d068708 96 */
samux 1:80ab0d068708 97 class USBKeyboard: public USBHID, public Stream {
samux 1:80ab0d068708 98 public:
samux 1:80ab0d068708 99
samux 1:80ab0d068708 100 /**
samux 1:80ab0d068708 101 * Constructor
samux 1:80ab0d068708 102 *
samux 1:80ab0d068708 103 *
samux 1:80ab0d068708 104 * @param leds Leds bus: first: NUM_LOCK, second: CAPS_LOCK, third: SCROLL_LOCK
samux 1:80ab0d068708 105 * @param vendor_id Your vendor_id (default: 0x1235)
samux 1:80ab0d068708 106 * @param product_id Your product_id (default: 0x0050)
samux 1:80ab0d068708 107 * @param product_release Your preoduct_release (default: 0x0001)
samux 1:80ab0d068708 108 *
samux 1:80ab0d068708 109 */
samux 1:80ab0d068708 110 USBKeyboard(uint16_t vendor_id = 0x1235, uint16_t product_id = 0x0050, uint16_t product_release = 0x0001):
samux 1:80ab0d068708 111 USBHID(0, 0, vendor_id, product_id, product_release, false) {
samux 1:80ab0d068708 112 lock_status = 0;
samux 1:80ab0d068708 113 connect();
samux 1:80ab0d068708 114 };
samux 1:80ab0d068708 115
samux 1:80ab0d068708 116 /**
samux 1:80ab0d068708 117 * To send a character defined by a modifier(CTRL, SHIFT, ALT) and the key
samux 1:80ab0d068708 118 *
samux 1:80ab0d068708 119 * @code
samux 1:80ab0d068708 120 * //To send CTRL + s (save)
samux 1:80ab0d068708 121 * keyboard.keyCode('s', KEY_CTRL);
samux 1:80ab0d068708 122 * @endcode
samux 1:80ab0d068708 123 *
samux 1:80ab0d068708 124 * @param modifier bit 0: KEY_CTRL, bit 1: KEY_SHIFT, bit 2: KEY_ALT (default: 0)
samux 1:80ab0d068708 125 * @param key character to send
samux 1:80ab0d068708 126 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 127 */
samux 1:80ab0d068708 128 bool keyCode(uint8_t key, uint8_t modifier = 0);
samux 1:80ab0d068708 129
samux 1:80ab0d068708 130 /**
samux 1:80ab0d068708 131 * Send a character
samux 1:80ab0d068708 132 *
samux 1:80ab0d068708 133 * @param c character to be sent
samux 1:80ab0d068708 134 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 135 */
samux 1:80ab0d068708 136 virtual int _putc(int c);
samux 1:80ab0d068708 137
samux 1:80ab0d068708 138 /**
samux 1:80ab0d068708 139 * Control media keys
samux 1:80ab0d068708 140 *
samux 1:80ab0d068708 141 * @param key media key pressed (KEY_NEXT_TRACK, KEY_PREVIOUS_TRACK, KEY_STOP, KEY_PLAY_PAUSE, KEY_MUTE, KEY_VOLUME_UP, KEY_VOLUME_DOWN)
samux 1:80ab0d068708 142 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 143 */
samux 1:80ab0d068708 144 bool mediaControl(MEDIA_KEY key);
samux 1:80ab0d068708 145
samux 1:80ab0d068708 146 /*
samux 1:80ab0d068708 147 * To define the report descriptor. Warning: this method has to store the length of the report descriptor in reportLength.
samux 1:80ab0d068708 148 *
samux 1:80ab0d068708 149 * @returns pointer to the report descriptor
samux 1:80ab0d068708 150 */
samux 1:80ab0d068708 151 virtual uint8_t * reportDesc();
samux 1:80ab0d068708 152
samux 1:80ab0d068708 153 /*
samux 1:80ab0d068708 154 * Called when a data is received on the OUT endpoint. Useful to switch on LED of LOCK keys
samux 1:80ab0d068708 155 *
samux 1:80ab0d068708 156 * @returns if handle by subclass, return true
samux 1:80ab0d068708 157 */
mbed_official 47:a0cd9646ecd1 158 virtual bool EPINT_OUT_callback();
samux 1:80ab0d068708 159
samux 1:80ab0d068708 160 /**
samux 1:80ab0d068708 161 * Read status of lock keys. Useful to switch-on/off leds according to key pressed. Only the first three bits of the result is important:
samux 1:80ab0d068708 162 * - First bit: NUM_LOCK
samux 1:80ab0d068708 163 * - Second bit: CAPS_LOCK
samux 1:80ab0d068708 164 * - Third bit: SCROLL_LOCK
samux 1:80ab0d068708 165 *
samux 1:80ab0d068708 166 * @returns status of lock keys
samux 1:80ab0d068708 167 */
samux 1:80ab0d068708 168 uint8_t lockStatus();
samux 1:80ab0d068708 169
samux 1:80ab0d068708 170 protected:
samux 1:80ab0d068708 171 /*
samux 1:80ab0d068708 172 * Get configuration descriptor
samux 1:80ab0d068708 173 *
samux 1:80ab0d068708 174 * @returns pointer to the configuration descriptor
samux 1:80ab0d068708 175 */
samux 1:80ab0d068708 176 virtual uint8_t * configurationDesc();
samux 1:80ab0d068708 177
samux 1:80ab0d068708 178 private:
samux 1:80ab0d068708 179 //dummy otherwise it doesn,t compile (we must define all methods of an abstract class)
samux 1:80ab0d068708 180 virtual int _getc() {
samux 1:80ab0d068708 181 return -1;
samux 1:80ab0d068708 182 };
samux 1:80ab0d068708 183
samux 1:80ab0d068708 184 uint8_t lock_status;
samux 1:80ab0d068708 185
samux 1:80ab0d068708 186 };
samux 1:80ab0d068708 187
samux 1:80ab0d068708 188 #endif