added missing files

[clinton/Smoothieware.git] / src / libs / USBDevice / USBHID / USBHID.h

/* Copyright (c) 2010-2011 mbed.org, MIT License\r
*\r
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software\r
* and associated documentation files (the "Software"), to deal in the Software without\r
* restriction, including without limitation the rights to use, copy, modify, merge, publish,\r
* distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the\r
* Software is furnished to do so, subject to the following conditions:\r
*\r
* The above copyright notice and this permission notice shall be included in all copies or\r
* substantial portions of the Software.\r
*\r
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING\r
* BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\r
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,\r
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
*/\r
\r
#ifndef USB_HID_H\r
#define USB_HID_H\r
\r
/* These headers are included for child class. */\r
#include "USBEndpoints.h"\r
#include "USBDescriptor.h"\r
#include "USBDevice_Types.h"\r
\r
#include "USBHID_Types.h"\r
#include "USBDevice.h"\r
\r
\r
/**\r
 * USBHID example\r
 * @code\r
 * #include "mbed.h"\r
 * #include "USBHID.h"\r
 *\r
 * USBHID hid;\r
 * HID_REPORT recv;\r
 * BusOut leds(LED1,LED2,LED3,LED4);\r
 *\r
 * int main(void) {\r
 *    while (1) {\r
 *        hid.read(&recv);\r
 *        leds = recv.data[0];\r
 *    }\r
 * }\r
 * @endcode\r
 */\r
\r
class USBHID: public USBDevice {\r
public:\r
\r
    /**\r
    * Constructor\r
    *\r
    * @param output_report_length Maximum length of a sent report (up to 64 bytes) (default: 64 bytes)\r
    * @param input_report_length Maximum length of a received report (up to 64 bytes) (default: 64 bytes)\r
    * @param vendor_id Your vendor_id\r
    * @param product_id Your product_id\r
    * @param product_release Your preoduct_release\r
    * @param connect Connect the device\r
    */\r
    USBHID(uint8_t output_report_length = 64, uint8_t input_report_length = 64, uint16_t vendor_id = 0x1234, uint16_t product_id = 0x0006, uint16_t product_release = 0x0001, bool connect = true);\r
\r
\r
    /**\r
    * Send a Report. warning: blocking\r
    *\r
    * @param report Report which will be sent (a report is defined by all data and the length)\r
    * @returns true if successful\r
    */\r
    bool send(HID_REPORT *report);\r
    \r
    \r
    /**\r
    * Send a Report. warning: non blocking\r
    *\r
    * @param report Report which will be sent (a report is defined by all data and the length)\r
    * @returns true if successful\r
    */\r
    bool sendNB(HID_REPORT *report);\r
    \r
    /**\r
    * Read a report: blocking\r
    *\r
    * @param report pointer to the report to fill\r
    * @returns true if successful\r
    */\r
    bool read(HID_REPORT * report);\r
    \r
    /**\r
    * Read a report: non blocking\r
    *\r
    * @param report pointer to the report to fill\r
    * @returns true if successful\r
    */\r
    bool readNB(HID_REPORT * report);\r
\r
protected:\r
    uint16_t reportLength;\r
    \r
    /*\r
    * Get the Report descriptor\r
    *\r
    * @returns pointer to the report descriptor\r
    */\r
    virtual uint8_t * reportDesc();\r
\r
    /*\r
    * Get the length of the report descriptor\r
    *\r
    * @returns the length of the report descriptor\r
    */\r
    virtual uint16_t reportDescLength();\r
\r
    /*\r
    * Get string product descriptor\r
    *\r
    * @returns pointer to the string product descriptor\r
    */\r
    virtual uint8_t * stringIproductDesc();\r
    \r
    /*\r
    * Get string interface descriptor\r
    *\r
    * @returns pointer to the string interface descriptor\r
    */\r
    virtual uint8_t * stringIinterfaceDesc();\r
    \r
    /*\r
    * Get configuration descriptor\r
    *\r
    * @returns pointer to the configuration descriptor\r
    */\r
    virtual uint8_t * configurationDesc();\r
\r
\r
    /*\r
    * HID Report received by SET_REPORT request. Warning: Called in ISR context\r
    * First byte of data will be the report ID\r
    *\r
    * @param report Data and length received\r
    */\r
    virtual void HID_callbackSetReport(HID_REPORT *report){};\r
\r
\r
    /*\r
    * Called by USBDevice on Endpoint0 request. Warning: Called in ISR context\r
    * This is used to handle extensions to standard requests\r
    * and class specific requests\r
    *\r
    * @returns true if class handles this request\r
    */\r
    virtual bool USBCallback_request();\r
\r
\r
    /*\r
    * Called by USBDevice layer. Set configuration of the device.\r
    * For instance, you can add all endpoints that you need on this function.\r
    *\r
    * @param configuration Number of the configuration\r
    * @returns true if class handles this request\r
    */\r
    virtual bool USBCallback_setConfiguration(uint8_t configuration);\r
\r
private:\r
    HID_REPORT outputReport;\r
    uint8_t output_length;\r
    uint8_t input_length;\r
};\r
\r
#endif\r