Maxim Integrated / USBDevice

USB device stack

Dependents:   blinky_max32630fthr FTHR_USB_serial FTHR_OLED HSP_RPC_GUI_3_0_1 ... more

Fork of USBDevice by mbed official

USBSerial/USBCDC.h@69:dad310740b28, 2018-09-11 (annotated)

Committer:
Emre.Eken@IST-LT-36262.maxim-ic.internal
Date:
Tue Sep 11 15:17:01 2018 +0300
Revision:
69:dad310740b28
Parent:
25:7c72828865f3 
makes a variable public instead of protected

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