new USB framework

[clinton/Smoothieware.git] / src / libs / USBDevice / USBSerial / USBCDC.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 USBCDC_H\r
#define USBCDC_H\r
\r
#include "USB.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 "descriptor_cdc.h"\r
\r
class USBCDC: public USB_Endpoint_Receiver {\r
public:\r
\r
    /*\r
    * Constructor\r
    *\r
    * @param vendor_id Your vendor_id\r
    * @param product_id Your product_id\r
    * @param product_release Your preoduct_release\r
    */\r
    USBCDC(USB *);\r
\r
protected:\r
\r
    /*\r
    * Get device descriptor. Warning: this method has to store the length of the report descriptor in reportLength.\r
    *\r
    * @returns pointer to the device descriptor\r
    */\r
//     virtual uint8_t * deviceDesc();\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
    * Send a buffer\r
    *\r
    * @param endpoint endpoint which will be sent the buffer\r
    * @param buffer buffer to be sent\r
    * @param size length of the buffer\r
    * @returns true if successful\r
    */\r
    bool send(uint8_t * buffer, uint32_t size);\r
\r
    /*\r
    * Read a buffer from a certain endpoint. Warning: blocking\r
    *\r
    * @param endpoint endpoint to read\r
    * @param buffer buffer where will be stored bytes\r
    * @param size the number of bytes read will be stored in *size\r
    * @param maxSize the maximum length that can be read\r
    * @returns true if successful\r
    */\r
    bool readEP(uint8_t * buffer, uint32_t * size);\r
\r
    /*\r
    * Read a buffer from a certain endpoint. Warning: non blocking\r
    *\r
    * @param endpoint endpoint to read\r
    * @param buffer buffer where will be stored bytes\r
    * @param size the number of bytes read will be stored in *size\r
    * @param maxSize the maximum length that can be read\r
    * @returns true if successful\r
    */\r
    bool readEP_NB(uint8_t * buffer, uint32_t * size);\r
\r
//     virtual bool USBCallback_request(CONTROL_TRANSFER *);\r
//     virtual bool USBCallback_setConfiguration(uint8_t configuration);\r
\r
//     virtual bool EpCallback(uint8_t, uint8_t);\r
//     virtual bool USB_Setup_Callback(CONTROL_TRANSFER *);\r
\r
    virtual bool USBEvent_Request(CONTROL_TRANSFER&);\r
    virtual bool USBEvent_RequestComplete(CONTROL_TRANSFER&, uint8_t*, uint32_t);\r
\r
//     virtual bool USBEvent_EPIn(uint8_t, uint8_t) = 0;\r
//     virtual bool USBEvent_EPOut(uint8_t, uint8_t)= 0;\r
\r
\r
    USB *usb;\r
\r
    // USB Descriptors\r
    usbdesc_interface   CDC_if;\r
    usbcdc_header       CDC_header;\r
    usbcdc_callmgmt     CDC_callmgmt;\r
    usbcdc_acm          CDC_acm;\r
    usbcdc_union        CDC_union;\r
\r
    usbdesc_interface   CDC_slaveif;\r
\r
    usbdesc_endpoint    CDC_intep;\r
    usbdesc_endpoint    CDC_BulkIn;\r
    usbdesc_endpoint    CDC_BulkOut;\r
};\r
\r
#endif\r