avnish aggarwal / Mbed 2 deprecated USB-MSD_SD_HelloWorld_Mbed-RAMVersion

ram version see usbmsd_sd.cpp ram ok fs CANNOT be installed - too small use for illustrative purpose only

Dependencies:   USBDevice USBMSD_SD mbed

Fork of USBMSD_SD_HelloWorld_Mbed by Samuel Mokrani

USBDevice/USBSERIAL/USBCDC.h@11:a26e7b7a1221, 2011-11-16 (annotated)

Committer:
samux
Date:
Wed Nov 16 17:17:42 2011 +0000
Revision:
11:a26e7b7a1221
GOOD COMMIT: msd and hid work even on MAC...

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 11:a26e7b7a1221 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
samux 11:a26e7b7a1221 2 *
samux 11:a26e7b7a1221 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
samux 11:a26e7b7a1221 4 * and associated documentation files (the "Software"), to deal in the Software without
samux 11:a26e7b7a1221 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
samux 11:a26e7b7a1221 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
samux 11:a26e7b7a1221 7 * Software is furnished to do so, subject to the following conditions:
samux 11:a26e7b7a1221 8 *
samux 11:a26e7b7a1221 9 * The above copyright notice and this permission notice shall be included in all copies or
samux 11:a26e7b7a1221 10 * substantial portions of the Software.
samux 11:a26e7b7a1221 11 *
samux 11:a26e7b7a1221 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
samux 11:a26e7b7a1221 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
samux 11:a26e7b7a1221 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
samux 11:a26e7b7a1221 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 11:a26e7b7a1221 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
samux 11:a26e7b7a1221 17 */
samux 11:a26e7b7a1221 18
samux 11:a26e7b7a1221 19 #ifndef USBCDC_H
samux 11:a26e7b7a1221 20 #define USBCDC_H
samux 11:a26e7b7a1221 21
samux 11:a26e7b7a1221 22 /* These headers are included for child class. */
samux 11:a26e7b7a1221 23 #include "USBEndpoints.h"
samux 11:a26e7b7a1221 24 #include "USBDescriptor.h"
samux 11:a26e7b7a1221 25 #include "USBDevice_Types.h"
samux 11:a26e7b7a1221 26
samux 11:a26e7b7a1221 27 #include "USBDevice.h"
samux 11:a26e7b7a1221 28
samux 11:a26e7b7a1221 29
samux 11:a26e7b7a1221 30
samux 11:a26e7b7a1221 31 class USBCDC: public USBDevice {
samux 11:a26e7b7a1221 32 public:
samux 11:a26e7b7a1221 33
samux 11:a26e7b7a1221 34 /*
samux 11:a26e7b7a1221 35 * Constructor
samux 11:a26e7b7a1221 36 *
samux 11:a26e7b7a1221 37 * @param vendor_id Your vendor_id
samux 11:a26e7b7a1221 38 * @param product_id Your product_id
samux 11:a26e7b7a1221 39 * @param product_release Your preoduct_release
samux 11:a26e7b7a1221 40 */
samux 11:a26e7b7a1221 41 USBCDC(uint16_t vendor_id, uint16_t product_id, uint16_t product_release);
samux 11:a26e7b7a1221 42
samux 11:a26e7b7a1221 43
samux 11:a26e7b7a1221 44 /*
samux 11:a26e7b7a1221 45 * Get device descriptor. Warning: this method has to store the length of the report descriptor in reportLength.
samux 11:a26e7b7a1221 46 *
samux 11:a26e7b7a1221 47 * @returns pointer to the device descriptor
samux 11:a26e7b7a1221 48 */
samux 11:a26e7b7a1221 49 virtual uint8_t * deviceDesc();
samux 11:a26e7b7a1221 50
samux 11:a26e7b7a1221 51 /*
samux 11:a26e7b7a1221 52 * Get string product descriptor
samux 11:a26e7b7a1221 53 *
samux 11:a26e7b7a1221 54 * @returns pointer to the string product descriptor
samux 11:a26e7b7a1221 55 */
samux 11:a26e7b7a1221 56 virtual uint8_t * stringIproductDesc();
samux 11:a26e7b7a1221 57
samux 11:a26e7b7a1221 58 /*
samux 11:a26e7b7a1221 59 * Get string interface descriptor
samux 11:a26e7b7a1221 60 *
samux 11:a26e7b7a1221 61 * @returns pointer to the string interface descriptor
samux 11:a26e7b7a1221 62 */
samux 11:a26e7b7a1221 63 virtual uint8_t * stringIinterfaceDesc();
samux 11:a26e7b7a1221 64
samux 11:a26e7b7a1221 65 /*
samux 11:a26e7b7a1221 66 * Get configuration descriptor
samux 11:a26e7b7a1221 67 *
samux 11:a26e7b7a1221 68 * @returns pointer to the configuration descriptor
samux 11:a26e7b7a1221 69 */
samux 11:a26e7b7a1221 70 virtual uint8_t * configurationDesc();
samux 11:a26e7b7a1221 71
samux 11:a26e7b7a1221 72 /*
samux 11:a26e7b7a1221 73 * Send a buffer to a certain endpoint
samux 11:a26e7b7a1221 74 *
samux 11:a26e7b7a1221 75 * @param endpoint endpoint which will be sent the buffer
samux 11:a26e7b7a1221 76 * @param buffer buffer to be sent
samux 11:a26e7b7a1221 77 * @param size length of the buffer
samux 11:a26e7b7a1221 78 * @returns true if successful
samux 11:a26e7b7a1221 79 */
samux 11:a26e7b7a1221 80 bool send(uint8_t endpoint, uint8_t * buffer, uint16_t size);
samux 11:a26e7b7a1221 81
samux 11:a26e7b7a1221 82 /*
samux 11:a26e7b7a1221 83 * Read a buffer from a certain endpoint. Warning: blocking
samux 11:a26e7b7a1221 84 *
samux 11:a26e7b7a1221 85 * @param endpoint endpoint to read
samux 11:a26e7b7a1221 86 * @param buffer buffer where will be stored bytes
samux 11:a26e7b7a1221 87 * @param size the number of bytes read will be stored in *size
samux 11:a26e7b7a1221 88 * @param maxSize the maximum length that can be read
samux 11:a26e7b7a1221 89 * @returns true if successful
samux 11:a26e7b7a1221 90 */
samux 11:a26e7b7a1221 91 bool read(uint8_t endpoint, uint8_t * buffer, uint16_t * size, uint16_t maxSize);
samux 11:a26e7b7a1221 92
samux 11:a26e7b7a1221 93 /*
samux 11:a26e7b7a1221 94 * Read a buffer from a certain endpoint. Warning: non blocking
samux 11:a26e7b7a1221 95 *
samux 11:a26e7b7a1221 96 * @param endpoint endpoint to read
samux 11:a26e7b7a1221 97 * @param buffer buffer where will be stored bytes
samux 11:a26e7b7a1221 98 * @param size the number of bytes read will be stored in *size
samux 11:a26e7b7a1221 99 * @param maxSize the maximum length that can be read
samux 11:a26e7b7a1221 100 * @returns true if successful
samux 11:a26e7b7a1221 101 */
samux 11:a26e7b7a1221 102 bool readNB(uint8_t endpoint, uint8_t * buffer, uint16_t * size, uint16_t maxSize);
samux 11:a26e7b7a1221 103
samux 11:a26e7b7a1221 104 virtual bool USBCallback_request();
samux 11:a26e7b7a1221 105 virtual bool USBCallback_setConfiguration(uint8_t configuration);
samux 11:a26e7b7a1221 106
samux 11:a26e7b7a1221 107 };
samux 11:a26e7b7a1221 108
samux 11:a26e7b7a1221 109 #endif