Point Labs / USBDevice

adds a USB serial port to your design

Dependents:   Example_WatchDog_Timer

USBSerial/USBCDC.h@6:d0945750af57, 2012-12-20 (annotated)

Committer:
samux
Date:
Thu Dec 20 17:05:37 2012 +0000
Revision:
6:d0945750af57
Parent:
1:80ab0d068708
Child:
15:849c0c0f2769
USBSerial: detect when a terminal is connected

Who changed what in which revision?

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