doku newon / DokuUSBDevice

Modified a little for 32k byte buffer.

Dependents:   Peach_AudioChannelDividerAndCompensator

USBSerial/USBCDC.h@61:ff0388dee94f, 2015-10-18 (annotated)

Committer:
dokunewon
Date:
Sun Oct 18 08:16:03 2015 +0000
Revision:
61:ff0388dee94f
Parent:
25:7c72828865f3 
Change a little.

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
mbed_official 19:fcb63a105965 38 * @param connect_blocking define if the connection must be blocked if USB not plugged in
samux 1:80ab0d068708 39 */
mbed_official 19:fcb63a105965 40 USBCDC(uint16_t vendor_id, uint16_t product_id, uint16_t product_release, bool connect_blocking);
samux 1:80ab0d068708 41
samux 1:80ab0d068708 42 protected:
mbed_official 25:7c72828865f3 43
samux 1:80ab0d068708 44 /*
samux 1:80ab0d068708 45 * Get device descriptor. Warning: this method has to store the length of the report descriptor in reportLength.
samux 1:80ab0d068708 46 *
samux 1:80ab0d068708 47 * @returns pointer to the device descriptor
samux 1:80ab0d068708 48 */
samux 1:80ab0d068708 49 virtual uint8_t * deviceDesc();
mbed_official 25:7c72828865f3 50
samux 1:80ab0d068708 51 /*
samux 1:80ab0d068708 52 * Get string product descriptor
samux 1:80ab0d068708 53 *
samux 1:80ab0d068708 54 * @returns pointer to the string product descriptor
samux 1:80ab0d068708 55 */
samux 1:80ab0d068708 56 virtual uint8_t * stringIproductDesc();
mbed_official 25:7c72828865f3 57
samux 1:80ab0d068708 58 /*
samux 1:80ab0d068708 59 * Get string interface descriptor
samux 1:80ab0d068708 60 *
samux 1:80ab0d068708 61 * @returns pointer to the string interface descriptor
samux 1:80ab0d068708 62 */
samux 1:80ab0d068708 63 virtual uint8_t * stringIinterfaceDesc();
mbed_official 25:7c72828865f3 64
samux 1:80ab0d068708 65 /*
samux 1:80ab0d068708 66 * Get configuration descriptor
samux 1:80ab0d068708 67 *
samux 1:80ab0d068708 68 * @returns pointer to the configuration descriptor
samux 1:80ab0d068708 69 */
samux 1:80ab0d068708 70 virtual uint8_t * configurationDesc();
mbed_official 25:7c72828865f3 71
samux 1:80ab0d068708 72 /*
samux 1:80ab0d068708 73 * Send a buffer
samux 1:80ab0d068708 74 *
samux 1:80ab0d068708 75 * @param endpoint endpoint which will be sent the buffer
samux 1:80ab0d068708 76 * @param buffer buffer to be sent
samux 1:80ab0d068708 77 * @param size length of the buffer
samux 1:80ab0d068708 78 * @returns true if successful
samux 1:80ab0d068708 79 */
samux 1:80ab0d068708 80 bool send(uint8_t * buffer, uint32_t size);
mbed_official 25:7c72828865f3 81
samux 1:80ab0d068708 82 /*
samux 1:80ab0d068708 83 * Read a buffer from a certain endpoint. Warning: blocking
samux 1:80ab0d068708 84 *
samux 1:80ab0d068708 85 * @param endpoint endpoint to read
samux 1:80ab0d068708 86 * @param buffer buffer where will be stored bytes
samux 1:80ab0d068708 87 * @param size the number of bytes read will be stored in *size
samux 1:80ab0d068708 88 * @param maxSize the maximum length that can be read
samux 1:80ab0d068708 89 * @returns true if successful
samux 1:80ab0d068708 90 */
samux 1:80ab0d068708 91 bool readEP(uint8_t * buffer, uint32_t * size);
mbed_official 25:7c72828865f3 92
samux 1:80ab0d068708 93 /*
samux 1:80ab0d068708 94 * Read a buffer from a certain endpoint. Warning: non blocking
samux 1:80ab0d068708 95 *
samux 1:80ab0d068708 96 * @param endpoint endpoint to read
samux 1:80ab0d068708 97 * @param buffer buffer where will be stored bytes
samux 1:80ab0d068708 98 * @param size the number of bytes read will be stored in *size
samux 1:80ab0d068708 99 * @param maxSize the maximum length that can be read
samux 1:80ab0d068708 100 * @returns true if successful
samux 1:80ab0d068708 101 */
samux 1:80ab0d068708 102 bool readEP_NB(uint8_t * buffer, uint32_t * size);
mbed_official 15:849c0c0f2769 103
mbed_official 15:849c0c0f2769 104 /*
mbed_official 15:849c0c0f2769 105 * Called by USBCallback_requestCompleted when CDC line coding is changed
mbed_official 15:849c0c0f2769 106 * Warning: Called in ISR
mbed_official 15:849c0c0f2769 107 *
mbed_official 15:849c0c0f2769 108 * @param baud The baud rate
mbed_official 15:849c0c0f2769 109 * @param bits The number of bits in a word (5-8)
mbed_official 15:849c0c0f2769 110 * @param parity The parity
mbed_official 15:849c0c0f2769 111 * @param stop The number of stop bits (1 or 2)
mbed_official 15:849c0c0f2769 112 */
mbed_official 15:849c0c0f2769 113 virtual void lineCodingChanged(int baud, int bits, int parity, int stop) {};
mbed_official 25:7c72828865f3 114
samux 6:d0945750af57 115 protected:
samux 1:80ab0d068708 116 virtual bool USBCallback_request();
mbed_official 15:849c0c0f2769 117 virtual void USBCallback_requestCompleted(uint8_t *buf, uint32_t length);
samux 1:80ab0d068708 118 virtual bool USBCallback_setConfiguration(uint8_t configuration);
samux 6:d0945750af57 119 volatile bool terminal_connected;
samux 1:80ab0d068708 120
samux 1:80ab0d068708 121 };
samux 1:80ab0d068708 122
samux 1:80ab0d068708 123 #endif