Maxim Integrated / Mbed OS Host_Software_MAX32664GWEB_HR_EXTENDED

ME11B Sample Code in Maxim Integrated Team

Dependencies:   BMI160 max32630hsp3 MemoryLCD USBDevice

Fork of Host_Software_MAX32664GWEB_HR_EXTENDED by Seyhmus Cacina

Drivers/USBDevice/USBSerial/USBCDC.h@0:ac4dea3e2894, 2019-03-18 (annotated)

Committer:
seyhmus.cacina
Date:
Mon Mar 18 10:21:53 2019 +0300
Revision:
0:ac4dea3e2894
ME11B Sample Code First Commit

Who changed what in which revision?

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