Suga koubou / Mbed 2 deprecated USB_CDC_MSD_Hello

USB CDC (serial) and USB MSC (strage) Composite Device. http://mbed.org/users/okini3939/notebook/USB_Device/

Dependencies:   ChaNFSSD mbed ChaNFS

USBDevice/USBHID/USBKeyboard.h@0:9b1d17d54055, 2011-12-16 (annotated)

Committer:
okini3939
Date:
Fri Dec 16 15:22:36 2011 +0000
Revision:
0:9b1d17d54055

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


okini3939

0:9b1d17d54055


     1

/* Copyright (c) 2010-2011 mbed.org, MIT License





okini3939

0:9b1d17d54055


     2

*





okini3939

0:9b1d17d54055


     3

* Permission is hereby granted, free of charge, to any person obtaining a copy of this software





okini3939

0:9b1d17d54055


     4

* and associated documentation files (the "Software"), to deal in the Software without





okini3939

0:9b1d17d54055


     5

* restriction, including without limitation the rights to use, copy, modify, merge, publish,





okini3939

0:9b1d17d54055


     6

* distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the





okini3939

0:9b1d17d54055


     7

* Software is furnished to do so, subject to the following conditions:





okini3939

0:9b1d17d54055


     8

*





okini3939

0:9b1d17d54055


     9

* The above copyright notice and this permission notice shall be included in all copies or





okini3939

0:9b1d17d54055


    10

* substantial portions of the Software.





okini3939

0:9b1d17d54055


    11

*





okini3939

0:9b1d17d54055


    12

* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING





okini3939

0:9b1d17d54055


    13

* BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND





okini3939

0:9b1d17d54055


    14

* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,





okini3939

0:9b1d17d54055


    15

* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,





okini3939

0:9b1d17d54055


    16

* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.





okini3939

0:9b1d17d54055


    17

*/





okini3939

0:9b1d17d54055


    18







okini3939

0:9b1d17d54055


    19

#ifndef USBKEYBOARD_H





okini3939

0:9b1d17d54055


    20

#define USBKEYBOARD_H





okini3939

0:9b1d17d54055


    21







okini3939

0:9b1d17d54055


    22

#include "USBHID.h"





okini3939

0:9b1d17d54055


    23

#include "Stream.h"





okini3939

0:9b1d17d54055


    24







okini3939

0:9b1d17d54055


    25

/* Modifiers */





okini3939

0:9b1d17d54055


    26

enum MODIFIER_KEY





okini3939

0:9b1d17d54055


    27

{





okini3939

0:9b1d17d54055


    28

    KEY_CTRL = 1,





okini3939

0:9b1d17d54055


    29

    KEY_SHIFT = 2,





okini3939

0:9b1d17d54055


    30

    KEY_ALT = 4,





okini3939

0:9b1d17d54055


    31

};





okini3939

0:9b1d17d54055


    32







okini3939

0:9b1d17d54055


    33







okini3939

0:9b1d17d54055


    34

enum MEDIA_KEY





okini3939

0:9b1d17d54055


    35

{





okini3939

0:9b1d17d54055


    36

    KEY_NEXT_TRACK,     /*!< next Track Button */





okini3939

0:9b1d17d54055


    37

    KEY_PREVIOUS_TRACK, /*!< Previous track Button */





okini3939

0:9b1d17d54055


    38

    KEY_STOP,           /*!< Stop Button */





okini3939

0:9b1d17d54055


    39

    KEY_PLAY_PAUSE,     /*!< Play/Pause Button */





okini3939

0:9b1d17d54055


    40

    KEY_MUTE,           /*!< Mute Button */





okini3939

0:9b1d17d54055


    41

    KEY_VOLUME_UP,      /*!< Volume Up Button */





okini3939

0:9b1d17d54055


    42

    KEY_VOLUME_DOWN,    /*!< Volume Down Button */





okini3939

0:9b1d17d54055


    43

};





okini3939

0:9b1d17d54055


    44







okini3939

0:9b1d17d54055


    45

enum FUNCTION_KEY





okini3939

0:9b1d17d54055


    46

{





okini3939

0:9b1d17d54055


    47

    KEY_F1 = 128,   /* F1 key */





okini3939

0:9b1d17d54055


    48

    KEY_F2,         /* F2 key */





okini3939

0:9b1d17d54055


    49

    KEY_F3,         /* F3 key */





okini3939

0:9b1d17d54055


    50

    KEY_F4,         /* F4 key */





okini3939

0:9b1d17d54055


    51

    KEY_F5,         /* F5 key */





okini3939

0:9b1d17d54055


    52

    KEY_F6,         /* F6 key */





okini3939

0:9b1d17d54055


    53

    KEY_F7,         /* F7 key */





okini3939

0:9b1d17d54055


    54

    KEY_F8,         /* F8 key */





okini3939

0:9b1d17d54055


    55

    KEY_F9,         /* F9 key */





okini3939

0:9b1d17d54055


    56

    KEY_F10,        /* F10 key */





okini3939

0:9b1d17d54055


    57

    KEY_F11,        /* F11 key */





okini3939

0:9b1d17d54055


    58

    KEY_F12,        /* F12 key */





okini3939

0:9b1d17d54055


    59

    KEY_PRINT_SCREEN,   /* Print Screen key */





okini3939

0:9b1d17d54055


    60

    KEY_SCROLL_LOCK, /* Scroll lock */





okini3939

0:9b1d17d54055


    61

    KEY_CAPS_LOCK,   /* caps lock */





okini3939

0:9b1d17d54055


    62

    KEY_NUM_LOCK,   /* num lock */





okini3939

0:9b1d17d54055


    63

    KEY_INSERT,         /* Insert key */





okini3939

0:9b1d17d54055


    64

    KEY_HOME,           /* Home key */





okini3939

0:9b1d17d54055


    65

    KEY_PAGE_UP,        /* Page Up key */





okini3939

0:9b1d17d54055


    66

    KEY_PAGE_DOWN,      /* Page Down key */





okini3939

0:9b1d17d54055


    67

};





okini3939

0:9b1d17d54055


    68







okini3939

0:9b1d17d54055


    69

/** 





okini3939

0:9b1d17d54055


    70

 * USBKeyboard example





okini3939

0:9b1d17d54055


    71

 * @code





okini3939

0:9b1d17d54055


    72

 *





okini3939

0:9b1d17d54055


    73

 * #include "mbed.h"





okini3939

0:9b1d17d54055


    74

 * #include "USBKeyboard.h"





okini3939

0:9b1d17d54055


    75

 *





okini3939

0:9b1d17d54055


    76

 * USBKeyboard key;





okini3939

0:9b1d17d54055


    77

 * 





okini3939

0:9b1d17d54055


    78

 * int main(void)





okini3939

0:9b1d17d54055


    79

 * {





okini3939

0:9b1d17d54055


    80

 *   while (1)





okini3939

0:9b1d17d54055


    81

 *   {





okini3939

0:9b1d17d54055


    82

 *       key.printf("Hello World\r\n");





okini3939

0:9b1d17d54055


    83

 *       wait(1);





okini3939

0:9b1d17d54055


    84

 *   }





okini3939

0:9b1d17d54055


    85

 * }





okini3939

0:9b1d17d54055


    86

 *





okini3939

0:9b1d17d54055


    87

 * @endcode





okini3939

0:9b1d17d54055


    88

 */





okini3939

0:9b1d17d54055


    89

class USBKeyboard: public USBHID, public Stream





okini3939

0:9b1d17d54055


    90

{





okini3939

0:9b1d17d54055


    91

    public:





okini3939

0:9b1d17d54055


    92

    





okini3939

0:9b1d17d54055


    93

        /**





okini3939

0:9b1d17d54055


    94

        *   Constructor





okini3939

0:9b1d17d54055


    95

        *





okini3939

0:9b1d17d54055


    96

        *





okini3939

0:9b1d17d54055


    97

        * @param leds Leds bus: first: NUM_LOCK, second: CAPS_LOCK, third: SCROLL_LOCK





okini3939

0:9b1d17d54055


    98

        * @param vendor_id Your vendor_id (default: 0x1235)





okini3939

0:9b1d17d54055


    99

        * @param product_id Your product_id (default: 0x0050)





okini3939

0:9b1d17d54055


   100

        * @param product_release Your preoduct_release (default: 0x0001)





okini3939

0:9b1d17d54055


   101

        *





okini3939

0:9b1d17d54055


   102

        */





okini3939

0:9b1d17d54055


   103

        USBKeyboard(uint16_t vendor_id = 0x1235, uint16_t product_id = 0x0050, uint16_t product_release = 0x0001): 





okini3939

0:9b1d17d54055


   104

            USBHID(0, 0, vendor_id, product_id, product_release, false){





okini3939

0:9b1d17d54055


   105

                lock_status = 0;





okini3939

0:9b1d17d54055


   106

                connect();





okini3939

0:9b1d17d54055


   107

            };





okini3939

0:9b1d17d54055


   108

        





okini3939

0:9b1d17d54055


   109

        /**





okini3939

0:9b1d17d54055


   110

        * To send a character defined by a modifier(CTRL, SHIFT, ALT) and the key 





okini3939

0:9b1d17d54055


   111

        *





okini3939

0:9b1d17d54055


   112

        * @code





okini3939

0:9b1d17d54055


   113

        * //To send CTRL + s (save)





okini3939

0:9b1d17d54055


   114

        *  keyboard.keyCode('s', KEY_CTRL);





okini3939

0:9b1d17d54055


   115

        * @endcode





okini3939

0:9b1d17d54055


   116

        *





okini3939

0:9b1d17d54055


   117

        * @param modifier bit 0: KEY_CTRL, bit 1: KEY_SHIFT, bit 2: KEY_ALT (default: 0)





okini3939

0:9b1d17d54055


   118

        * @param key character to send





okini3939

0:9b1d17d54055


   119

        * @returns true if there is no error, false otherwise





okini3939

0:9b1d17d54055


   120

        */





okini3939

0:9b1d17d54055


   121

        bool keyCode(uint8_t key, uint8_t modifier = 0);





okini3939

0:9b1d17d54055


   122

        





okini3939

0:9b1d17d54055


   123

        /**





okini3939

0:9b1d17d54055


   124

        * Send a character





okini3939

0:9b1d17d54055


   125

        *





okini3939

0:9b1d17d54055


   126

        * @param c character to be sent





okini3939

0:9b1d17d54055


   127

        * @returns true if there is no error, false otherwise





okini3939

0:9b1d17d54055


   128

        */





okini3939

0:9b1d17d54055


   129

        virtual int _putc(int c);





okini3939

0:9b1d17d54055


   130

        





okini3939

0:9b1d17d54055


   131

        /**





okini3939

0:9b1d17d54055


   132

        * Control media keys





okini3939

0:9b1d17d54055


   133

        *





okini3939

0:9b1d17d54055


   134

        * @param key media key pressed (KEY_NEXT_TRACK, KEY_PREVIOUS_TRACK, KEY_STOP, KEY_PLAY_PAUSE, KEY_MUTE, KEY_VOLUME_UP, KEY_VOLUME_DOWN)





okini3939

0:9b1d17d54055


   135

        * @returns true if there is no error, false otherwise





okini3939

0:9b1d17d54055


   136

        */





okini3939

0:9b1d17d54055


   137

        bool mediaControl(MEDIA_KEY key);





okini3939

0:9b1d17d54055


   138

        





okini3939

0:9b1d17d54055


   139

        /*





okini3939

0:9b1d17d54055


   140

        * To define the report descriptor. Warning: this method has to store the length of the report descriptor in reportLength.





okini3939

0:9b1d17d54055


   141

        *





okini3939

0:9b1d17d54055


   142

        * @returns pointer to the report descriptor





okini3939

0:9b1d17d54055


   143

        */





okini3939

0:9b1d17d54055


   144

        virtual uint8_t * reportDesc();





okini3939

0:9b1d17d54055


   145

        





okini3939

0:9b1d17d54055


   146

        /*





okini3939

0:9b1d17d54055


   147

        * Called when a data is received on the OUT endpoint. Useful to switch on LED of LOCK keys





okini3939

0:9b1d17d54055


   148

        *





okini3939

0:9b1d17d54055


   149

        * @returns if handle by subclass, return true





okini3939

0:9b1d17d54055


   150

        */





okini3939

0:9b1d17d54055


   151

        virtual bool EP1_OUT_callback();





okini3939

0:9b1d17d54055


   152

        





okini3939

0:9b1d17d54055


   153

        /**





okini3939

0:9b1d17d54055


   154

        * 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:





okini3939

0:9b1d17d54055


   155

        *   - First bit: NUM_LOCK





okini3939

0:9b1d17d54055


   156

        *   - Second bit: CAPS_LOCK





okini3939

0:9b1d17d54055


   157

        *   - Third bit: SCROLL_LOCK





okini3939

0:9b1d17d54055


   158

        *





okini3939

0:9b1d17d54055


   159

        * @returns status of lock keys





okini3939

0:9b1d17d54055


   160

        */





okini3939

0:9b1d17d54055


   161

        uint8_t lockStatus();





okini3939

0:9b1d17d54055


   162

        





okini3939

0:9b1d17d54055


   163

   private:





okini3939

0:9b1d17d54055


   164

        //dummy otherwise it doesn,t compile (we must define all methods of an abstract class)





okini3939

0:9b1d17d54055


   165

        virtual int _getc() { return -1;};





okini3939

0:9b1d17d54055


   166

        





okini3939

0:9b1d17d54055


   167

        uint8_t lock_status;





okini3939

0:9b1d17d54055


   168

};





okini3939

0:9b1d17d54055


   169







okini3939

0:9b1d17d54055


   170

#endif