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 
00030 
00031 class USBCDC: public USBDevice {
00032 public:
00033 
00034     /*
00035     * Constructor
00036     *
00037     * @param vendor_id Your vendor_id
00038     * @param product_id Your product_id
00039     * @param product_release Your preoduct_release
00040     */
00041     USBCDC(uint16_t vendor_id, uint16_t product_id, uint16_t product_release);
00042 
00043 protected:
00044     
00045     /*
00046     * Get device descriptor. Warning: this method has to store the length of the report descriptor in reportLength.
00047     *
00048     * @returns pointer to the device descriptor
00049     */
00050     virtual uint8_t * deviceDesc();
00051     
00052     /*
00053     * Get string product descriptor
00054     *
00055     * @returns pointer to the string product descriptor
00056     */
00057     virtual uint8_t * stringIproductDesc();
00058     
00059     /*
00060     * Get string interface descriptor
00061     *
00062     * @returns pointer to the string interface descriptor
00063     */
00064     virtual uint8_t * stringIinterfaceDesc();
00065     
00066     /*
00067     * Get configuration descriptor
00068     *
00069     * @returns pointer to the configuration descriptor
00070     */
00071     virtual uint8_t * configurationDesc();
00072     
00073     /*
00074     * Send a buffer
00075     *
00076     * @param endpoint endpoint which will be sent the buffer
00077     * @param buffer buffer to be sent
00078     * @param size length of the buffer
00079     * @returns true if successful
00080     */
00081     bool send(uint8_t * buffer, uint16_t size);
00082     
00083     /*
00084     * Read a buffer from a certain endpoint. Warning: blocking
00085     *
00086     * @param endpoint endpoint to read
00087     * @param buffer buffer where will be stored bytes
00088     * @param size the number of bytes read will be stored in *size
00089     * @param maxSize the maximum length that can be read
00090     * @returns true if successful
00091     */
00092     bool readEP(uint8_t * buffer, uint16_t * size);
00093     
00094     /*
00095     * Read a buffer from a certain endpoint. Warning: non blocking
00096     *
00097     * @param endpoint endpoint to read
00098     * @param buffer buffer where will be stored bytes
00099     * @param size the number of bytes read will be stored in *size
00100     * @param maxSize the maximum length that can be read
00101     * @returns true if successful
00102     */
00103     bool readEP_NB(uint8_t * buffer, uint16_t * size);
00104 
00105     virtual bool USBCallback_request();
00106     virtual bool USBCallback_setConfiguration(uint8_t configuration);
00107 
00108 };
00109 
00110 #endif