Suga koubou / Mbed 2 deprecated XTouch-djay-bridge

X-TOUCH to djay bridge

Dependencies:   mbed mbed-rtos FATFileSystem

USBHost/USBHostSerial/USBHostSerial.h@1:0dac72ab5910, 2019-06-05 (annotated)

Committer:
okini3939
Date:
Wed Jun 05 04:54:37 2019 +0000
Revision:
1:0dac72ab5910
sample

Who changed what in which revision?

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