USBCDC.h

00001 /* Copyright (c) 2010-2011 mbed.org, MIT License
00002 *
00003 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
00004 * and associated documentation files (the "Software"), to deal in the Software without
00005 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
00006 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
00007 * Software is furnished to do so, subject to the following conditions:
00008 *
00009 * The above copyright notice and this permission notice shall be included in all copies or
00010 * substantial portions of the Software.
00011 *
00012 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
00013 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00014 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
00015 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00016 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00017 */
00018 
00019 #ifndef USBCDC_H
00020 #define USBCDC_H
00021 
00022 /* These headers are included for child class. */
00023 #include "USBEndpoints.h"
00024 #include "USBDescriptor.h"
00025 #include "USBDevice_Types.h"
00026 
00027 #include "USBDevice.h"
00028 
00029 class USBCDC: public USBDevice {
00030 public:
00031 
00032     /*
00033     * Constructor
00034     *
00035     * @param vendor_id Your vendor_id
00036     * @param product_id Your product_id
00037     * @param product_release Your preoduct_release
00038     */
00039     USBCDC(uint16_t vendor_id, uint16_t product_id, uint16_t product_release);
00040 
00041 protected:
00042     
00043     /*
00044     * Get device descriptor. Warning: this method has to store the length of the report descriptor in reportLength.
00045     *
00046     * @returns pointer to the device descriptor
00047     */
00048     virtual uint8_t * deviceDesc();
00049     
00050     /*
00051     * Get string product descriptor
00052     *
00053     * @returns pointer to the string product descriptor
00054     */
00055     virtual uint8_t * stringIproductDesc();
00056     
00057     /*
00058     * Get string interface descriptor
00059     *
00060     * @returns pointer to the string interface descriptor
00061     */
00062     virtual uint8_t * stringIinterfaceDesc();
00063     
00064     /*
00065     * Get configuration descriptor
00066     *
00067     * @returns pointer to the configuration descriptor
00068     */
00069     virtual uint8_t * configurationDesc();
00070     
00071     /*
00072     * Send a buffer
00073     *
00074     * @param endpoint endpoint which will be sent the buffer
00075     * @param buffer buffer to be sent
00076     * @param size length of the buffer
00077     * @returns true if successful
00078     */
00079     bool send(uint8_t * buffer, uint32_t size);
00080     
00081     /*
00082     * Read a buffer from a certain endpoint. Warning: blocking
00083     *
00084     * @param endpoint endpoint to read
00085     * @param buffer buffer where will be stored bytes
00086     * @param size the number of bytes read will be stored in *size
00087     * @param maxSize the maximum length that can be read
00088     * @returns true if successful
00089     */
00090     bool readEP(uint8_t * buffer, uint32_t * size);
00091     
00092     /*
00093     * Read a buffer from a certain endpoint. Warning: non blocking
00094     *
00095     * @param endpoint endpoint to read
00096     * @param buffer buffer where will be stored bytes
00097     * @param size the number of bytes read will be stored in *size
00098     * @param maxSize the maximum length that can be read
00099     * @returns true if successful
00100     */
00101     bool readEP_NB(uint8_t * buffer, uint32_t * size);
00102 
00103     virtual bool USBCallback_request();
00104     virtual bool USBCallback_setConfiguration(uint8_t configuration);
00105 
00106 };
00107 
00108 #endif