Maxim nexpaq / nexpaq_dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

libraries/USBHost/USBHostSerial/USBHostSerial.h@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nexpaq 0:6c56fb4bc5f0 1 /* mbed USBHost Library
nexpaq 0:6c56fb4bc5f0 2 * Copyright (c) 2006-2013 ARM Limited
nexpaq 0:6c56fb4bc5f0 3 *
nexpaq 0:6c56fb4bc5f0 4 * Licensed under the Apache License, Version 2.0 (the "License");
nexpaq 0:6c56fb4bc5f0 5 * you may not use this file except in compliance with the License.
nexpaq 0:6c56fb4bc5f0 6 * You may obtain a copy of the License at
nexpaq 0:6c56fb4bc5f0 7 *
nexpaq 0:6c56fb4bc5f0 8 * http://www.apache.org/licenses/LICENSE-2.0
nexpaq 0:6c56fb4bc5f0 9 *
nexpaq 0:6c56fb4bc5f0 10 * Unless required by applicable law or agreed to in writing, software
nexpaq 0:6c56fb4bc5f0 11 * distributed under the License is distributed on an "AS IS" BASIS,
nexpaq 0:6c56fb4bc5f0 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
nexpaq 0:6c56fb4bc5f0 13 * See the License for the specific language governing permissions and
nexpaq 0:6c56fb4bc5f0 14 * limitations under the License.
nexpaq 0:6c56fb4bc5f0 15 */
nexpaq 0:6c56fb4bc5f0 16
nexpaq 0:6c56fb4bc5f0 17 #ifndef USBHOSTSERIAL_H
nexpaq 0:6c56fb4bc5f0 18 #define USBHOSTSERIAL_H
nexpaq 0:6c56fb4bc5f0 19
nexpaq 0:6c56fb4bc5f0 20 #include "USBHostConf.h"
nexpaq 0:6c56fb4bc5f0 21
nexpaq 0:6c56fb4bc5f0 22 #if USBHOST_SERIAL
nexpaq 0:6c56fb4bc5f0 23
nexpaq 0:6c56fb4bc5f0 24 #include "USBHost.h"
nexpaq 0:6c56fb4bc5f0 25 #include "Stream.h"
nexpaq 0:6c56fb4bc5f0 26 #include "MtxCircBuffer.h"
nexpaq 0:6c56fb4bc5f0 27 #include "Callback.h"
nexpaq 0:6c56fb4bc5f0 28
nexpaq 0:6c56fb4bc5f0 29 /**
nexpaq 0:6c56fb4bc5f0 30 * A class to communicate a USB virtual serial port
nexpaq 0:6c56fb4bc5f0 31 */
nexpaq 0:6c56fb4bc5f0 32 class USBHostSerialPort : public Stream {
nexpaq 0:6c56fb4bc5f0 33 public:
nexpaq 0:6c56fb4bc5f0 34 /**
nexpaq 0:6c56fb4bc5f0 35 * Constructor
nexpaq 0:6c56fb4bc5f0 36 */
nexpaq 0:6c56fb4bc5f0 37 USBHostSerialPort();
nexpaq 0:6c56fb4bc5f0 38
nexpaq 0:6c56fb4bc5f0 39 enum IrqType {
nexpaq 0:6c56fb4bc5f0 40 RxIrq,
nexpaq 0:6c56fb4bc5f0 41 TxIrq
nexpaq 0:6c56fb4bc5f0 42 };
nexpaq 0:6c56fb4bc5f0 43
nexpaq 0:6c56fb4bc5f0 44 enum Parity {
nexpaq 0:6c56fb4bc5f0 45 None = 0,
nexpaq 0:6c56fb4bc5f0 46 Odd,
nexpaq 0:6c56fb4bc5f0 47 Even,
nexpaq 0:6c56fb4bc5f0 48 Mark,
nexpaq 0:6c56fb4bc5f0 49 Space
nexpaq 0:6c56fb4bc5f0 50 };
nexpaq 0:6c56fb4bc5f0 51
nexpaq 0:6c56fb4bc5f0 52 void connect(USBHost* _host, USBDeviceConnected * _dev,
nexpaq 0:6c56fb4bc5f0 53 uint8_t _serial_intf, USBEndpoint* _bulk_in, USBEndpoint* _bulk_out);
nexpaq 0:6c56fb4bc5f0 54
nexpaq 0:6c56fb4bc5f0 55 /**
nexpaq 0:6c56fb4bc5f0 56 * Check the number of bytes available.
nexpaq 0:6c56fb4bc5f0 57 *
nexpaq 0:6c56fb4bc5f0 58 * @returns the number of bytes available
nexpaq 0:6c56fb4bc5f0 59 */
nexpaq 0:6c56fb4bc5f0 60 uint8_t available();
nexpaq 0:6c56fb4bc5f0 61
nexpaq 0:6c56fb4bc5f0 62 /**
nexpaq 0:6c56fb4bc5f0 63 * Attach a member function to call when a packet is received.
nexpaq 0:6c56fb4bc5f0 64 *
nexpaq 0:6c56fb4bc5f0 65 * @param tptr pointer to the object to call the member function on
nexpaq 0:6c56fb4bc5f0 66 * @param mptr pointer to the member function to be called
nexpaq 0:6c56fb4bc5f0 67 * @param irq irq type
nexpaq 0:6c56fb4bc5f0 68 */
nexpaq 0:6c56fb4bc5f0 69 template<typename T>
nexpaq 0:6c56fb4bc5f0 70 inline void attach(T* tptr, void (T::*mptr)(void), IrqType irq = RxIrq) {
nexpaq 0:6c56fb4bc5f0 71 if ((mptr != NULL) && (tptr != NULL)) {
nexpaq 0:6c56fb4bc5f0 72 if (irq == RxIrq) {
nexpaq 0:6c56fb4bc5f0 73 rx.attach(tptr, mptr);
nexpaq 0:6c56fb4bc5f0 74 } else {
nexpaq 0:6c56fb4bc5f0 75 tx.attach(tptr, mptr);
nexpaq 0:6c56fb4bc5f0 76 }
nexpaq 0:6c56fb4bc5f0 77 }
nexpaq 0:6c56fb4bc5f0 78 }
nexpaq 0:6c56fb4bc5f0 79
nexpaq 0:6c56fb4bc5f0 80 /**
nexpaq 0:6c56fb4bc5f0 81 * Attach a callback called when a packet is received
nexpaq 0:6c56fb4bc5f0 82 *
nexpaq 0:6c56fb4bc5f0 83 * @param ptr function pointer
nexpaq 0:6c56fb4bc5f0 84 */
nexpaq 0:6c56fb4bc5f0 85 inline void attach(void (*fn)(void), IrqType irq = RxIrq) {
nexpaq 0:6c56fb4bc5f0 86 if (fn != NULL) {
nexpaq 0:6c56fb4bc5f0 87 if (irq == RxIrq) {
nexpaq 0:6c56fb4bc5f0 88 rx.attach(fn);
nexpaq 0:6c56fb4bc5f0 89 } else {
nexpaq 0:6c56fb4bc5f0 90 tx.attach(fn);
nexpaq 0:6c56fb4bc5f0 91 }
nexpaq 0:6c56fb4bc5f0 92 }
nexpaq 0:6c56fb4bc5f0 93 }
nexpaq 0:6c56fb4bc5f0 94
nexpaq 0:6c56fb4bc5f0 95 /** Set the baud rate of the serial port
nexpaq 0:6c56fb4bc5f0 96 *
nexpaq 0:6c56fb4bc5f0 97 * @param baudrate The baudrate of the serial port (default = 9600).
nexpaq 0:6c56fb4bc5f0 98 */
nexpaq 0:6c56fb4bc5f0 99 void baud(int baudrate = 9600);
nexpaq 0:6c56fb4bc5f0 100
nexpaq 0:6c56fb4bc5f0 101 /** Set the transmission format used by the Serial port
nexpaq 0:6c56fb4bc5f0 102 *
nexpaq 0:6c56fb4bc5f0 103 * @param bits The number of bits in a word (default = 8)
nexpaq 0:6c56fb4bc5f0 104 * @param parity The parity used (USBHostSerialPort::None, USBHostSerialPort::Odd, USBHostSerialPort::Even, USBHostSerialPort::Mark, USBHostSerialPort::Space; default = USBHostSerialPort::None)
nexpaq 0:6c56fb4bc5f0 105 * @param stop The number of stop bits (1 or 2; default = 1)
nexpaq 0:6c56fb4bc5f0 106 */
nexpaq 0:6c56fb4bc5f0 107 void format(int bits = 8, Parity parity = USBHostSerialPort::None, int stop_bits = 1);
nexpaq 0:6c56fb4bc5f0 108 virtual int writeBuf(const char* b, int s);
nexpaq 0:6c56fb4bc5f0 109 virtual int readBuf(char* b, int s);
nexpaq 0:6c56fb4bc5f0 110
nexpaq 0:6c56fb4bc5f0 111 protected:
nexpaq 0:6c56fb4bc5f0 112 virtual int _getc();
nexpaq 0:6c56fb4bc5f0 113 virtual int _putc(int c);
nexpaq 0:6c56fb4bc5f0 114
nexpaq 0:6c56fb4bc5f0 115 private:
nexpaq 0:6c56fb4bc5f0 116 USBHost * host;
nexpaq 0:6c56fb4bc5f0 117 USBDeviceConnected * dev;
nexpaq 0:6c56fb4bc5f0 118
nexpaq 0:6c56fb4bc5f0 119 USBEndpoint * bulk_in;
nexpaq 0:6c56fb4bc5f0 120 USBEndpoint * bulk_out;
nexpaq 0:6c56fb4bc5f0 121 uint32_t size_bulk_in;
nexpaq 0:6c56fb4bc5f0 122 uint32_t size_bulk_out;
nexpaq 0:6c56fb4bc5f0 123
nexpaq 0:6c56fb4bc5f0 124 void init();
nexpaq 0:6c56fb4bc5f0 125
nexpaq 0:6c56fb4bc5f0 126 MtxCircBuffer<uint8_t, 128> circ_buf;
nexpaq 0:6c56fb4bc5f0 127
nexpaq 0:6c56fb4bc5f0 128 uint8_t buf[64];
nexpaq 0:6c56fb4bc5f0 129
nexpaq 0:6c56fb4bc5f0 130 typedef struct {
nexpaq 0:6c56fb4bc5f0 131 uint32_t baudrate;
nexpaq 0:6c56fb4bc5f0 132 uint8_t stop_bits;
nexpaq 0:6c56fb4bc5f0 133 uint8_t parity;
nexpaq 0:6c56fb4bc5f0 134 uint8_t data_bits;
nexpaq 0:6c56fb4bc5f0 135 } PACKED LINE_CODING;
nexpaq 0:6c56fb4bc5f0 136
nexpaq 0:6c56fb4bc5f0 137 LINE_CODING line_coding;
nexpaq 0:6c56fb4bc5f0 138
nexpaq 0:6c56fb4bc5f0 139 void rxHandler();
nexpaq 0:6c56fb4bc5f0 140 void txHandler();
nexpaq 0:6c56fb4bc5f0 141 Callback<void()> rx;
nexpaq 0:6c56fb4bc5f0 142 Callback<void()> tx;
nexpaq 0:6c56fb4bc5f0 143
nexpaq 0:6c56fb4bc5f0 144 uint8_t serial_intf;
nexpaq 0:6c56fb4bc5f0 145 };
nexpaq 0:6c56fb4bc5f0 146
nexpaq 0:6c56fb4bc5f0 147 #if (USBHOST_SERIAL <= 1)
nexpaq 0:6c56fb4bc5f0 148
nexpaq 0:6c56fb4bc5f0 149 class USBHostSerial : public IUSBEnumerator, public USBHostSerialPort
nexpaq 0:6c56fb4bc5f0 150 {
nexpaq 0:6c56fb4bc5f0 151 public:
nexpaq 0:6c56fb4bc5f0 152 USBHostSerial();
nexpaq 0:6c56fb4bc5f0 153
nexpaq 0:6c56fb4bc5f0 154 /**
nexpaq 0:6c56fb4bc5f0 155 * Try to connect a serial device
nexpaq 0:6c56fb4bc5f0 156 *
nexpaq 0:6c56fb4bc5f0 157 * @return true if connection was successful
nexpaq 0:6c56fb4bc5f0 158 */
nexpaq 0:6c56fb4bc5f0 159 bool connect();
nexpaq 0:6c56fb4bc5f0 160
nexpaq 0:6c56fb4bc5f0 161 void disconnect();
nexpaq 0:6c56fb4bc5f0 162
nexpaq 0:6c56fb4bc5f0 163 /**
nexpaq 0:6c56fb4bc5f0 164 * Check if a any serial port is connected
nexpaq 0:6c56fb4bc5f0 165 *
nexpaq 0:6c56fb4bc5f0 166 * @returns true if a serial device is connected
nexpaq 0:6c56fb4bc5f0 167 */
nexpaq 0:6c56fb4bc5f0 168 bool connected();
nexpaq 0:6c56fb4bc5f0 169
nexpaq 0:6c56fb4bc5f0 170 protected:
nexpaq 0:6c56fb4bc5f0 171 USBHost* host;
nexpaq 0:6c56fb4bc5f0 172 USBDeviceConnected* dev;
nexpaq 0:6c56fb4bc5f0 173 uint8_t port_intf;
nexpaq 0:6c56fb4bc5f0 174 int ports_found;
nexpaq 0:6c56fb4bc5f0 175
nexpaq 0:6c56fb4bc5f0 176 //From IUSBEnumerator
nexpaq 0:6c56fb4bc5f0 177 virtual void setVidPid(uint16_t vid, uint16_t pid);
nexpaq 0:6c56fb4bc5f0 178 virtual bool parseInterface(uint8_t intf_nb, uint8_t intf_class, uint8_t intf_subclass, uint8_t intf_protocol); //Must return true if the interface should be parsed
nexpaq 0:6c56fb4bc5f0 179 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
nexpaq 0:6c56fb4bc5f0 180
nexpaq 0:6c56fb4bc5f0 181 private:
nexpaq 0:6c56fb4bc5f0 182 bool dev_connected;
nexpaq 0:6c56fb4bc5f0 183 };
nexpaq 0:6c56fb4bc5f0 184
nexpaq 0:6c56fb4bc5f0 185 #else // (USBHOST_SERIAL > 1)
nexpaq 0:6c56fb4bc5f0 186
nexpaq 0:6c56fb4bc5f0 187 class USBHostMultiSerial : public IUSBEnumerator {
nexpaq 0:6c56fb4bc5f0 188 public:
nexpaq 0:6c56fb4bc5f0 189 USBHostMultiSerial();
nexpaq 0:6c56fb4bc5f0 190 virtual ~USBHostMultiSerial();
nexpaq 0:6c56fb4bc5f0 191
nexpaq 0:6c56fb4bc5f0 192 USBHostSerialPort* getPort(int port)
nexpaq 0:6c56fb4bc5f0 193 {
nexpaq 0:6c56fb4bc5f0 194 return port < USBHOST_SERIAL ? ports[port] : NULL;
nexpaq 0:6c56fb4bc5f0 195 }
nexpaq 0:6c56fb4bc5f0 196
nexpaq 0:6c56fb4bc5f0 197 /**
nexpaq 0:6c56fb4bc5f0 198 * Try to connect a serial device
nexpaq 0:6c56fb4bc5f0 199 *
nexpaq 0:6c56fb4bc5f0 200 * @return true if connection was successful
nexpaq 0:6c56fb4bc5f0 201 */
nexpaq 0:6c56fb4bc5f0 202 bool connect();
nexpaq 0:6c56fb4bc5f0 203
nexpaq 0:6c56fb4bc5f0 204 void disconnect();
nexpaq 0:6c56fb4bc5f0 205
nexpaq 0:6c56fb4bc5f0 206 /**
nexpaq 0:6c56fb4bc5f0 207 * Check if a any serial port is connected
nexpaq 0:6c56fb4bc5f0 208 *
nexpaq 0:6c56fb4bc5f0 209 * @returns true if a serial device is connected
nexpaq 0:6c56fb4bc5f0 210 */
nexpaq 0:6c56fb4bc5f0 211 bool connected();
nexpaq 0:6c56fb4bc5f0 212
nexpaq 0:6c56fb4bc5f0 213 protected:
nexpaq 0:6c56fb4bc5f0 214 USBHost* host;
nexpaq 0:6c56fb4bc5f0 215 USBDeviceConnected* dev;
nexpaq 0:6c56fb4bc5f0 216 USBHostSerialPort* ports[USBHOST_SERIAL];
nexpaq 0:6c56fb4bc5f0 217 uint8_t port_intf[USBHOST_SERIAL];
nexpaq 0:6c56fb4bc5f0 218 int ports_found;
nexpaq 0:6c56fb4bc5f0 219
nexpaq 0:6c56fb4bc5f0 220 //From IUSBEnumerator
nexpaq 0:6c56fb4bc5f0 221 virtual void setVidPid(uint16_t vid, uint16_t pid);
nexpaq 0:6c56fb4bc5f0 222 virtual bool parseInterface(uint8_t intf_nb, uint8_t intf_class, uint8_t intf_subclass, uint8_t intf_protocol); //Must return true if the interface should be parsed
nexpaq 0:6c56fb4bc5f0 223 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
nexpaq 0:6c56fb4bc5f0 224
nexpaq 0:6c56fb4bc5f0 225 private:
nexpaq 0:6c56fb4bc5f0 226 bool dev_connected;
nexpaq 0:6c56fb4bc5f0 227 };
nexpaq 0:6c56fb4bc5f0 228 #endif // (USBHOST_SERIAL <= 1)
nexpaq 0:6c56fb4bc5f0 229
nexpaq 0:6c56fb4bc5f0 230 #endif
nexpaq 0:6c56fb4bc5f0 231
nexpaq 0:6c56fb4bc5f0 232 #endif