USBHost library for WAVE file player
Fork of USBHost by
USBHostSerial/USBHostSerial.h
- Committer:
- samux
- Date:
- 2013-03-14
- Revision:
- 8:93da8ea2708b
- Parent:
- 7:e7e63ac7ae5f
- Child:
- 13:b58a2204422f
File content as of revision 8:93da8ea2708b:
/* mbed USBHost Library * Copyright (c) 2006-2013 ARM Limited * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef USBHOSTSERIAL_H #define USBHOSTSERIAL_H #include "USBHostConf.h" #if USBHOST_SERIAL #include "USBHost.h" #include "Stream.h" #include "MtxCircBuffer.h" /** * A class to communicate a USB virtual serial port */ class USBHostSerial : public IUSBEnumerator, public Stream { public: /** * Constructor */ USBHostSerial(); enum IrqType { RxIrq, TxIrq }; enum Parity { None = 0, Odd, Even, Mark, Space }; /** * Check if a virtual serial port is connected * * @returns true if a serial device is connected */ bool connected(); /** * Try to connect a serial device * * @return true if connection was successful */ bool connect(); /** * Check the number of bytes available. * * @returns the number of bytes available */ uint8_t available(); /** * Attach a member function to call when a packet is received. * * @param tptr pointer to the object to call the member function on * @param mptr pointer to the member function to be called * @param irq irq type */ template<typename T> inline void attach(T* tptr, void (T::*mptr)(void), IrqType irq = RxIrq) { if ((mptr != NULL) && (tptr != NULL)) { if (irq == RxIrq) { rx.attach(tptr, mptr); } else { tx.attach(tptr, mptr); } } } /** * Attach a callback called when a packet is received * * @param ptr function pointer */ inline void attach(void (*fn)(void), IrqType irq = RxIrq) { if (fn != NULL) { if (irq == RxIrq) { rx.attach(fn); } else { tx.attach(fn); } } } /** Set the baud rate of the serial port * * @param baudrate The baudrate of the serial port (default = 9600). */ void baud(int baudrate = 9600); /** Set the transmission format used by the Serial port * * @param bits The number of bits in a word (default = 8) * @param parity The parity used (USBHostSerial::None, USBHostSerial::Odd, USBHostSerial::Even, USBHostSerial::Mark, USBHostSerial::Space; default = USBHostSerial::None) * @param stop The number of stop bits (1 or 2; default = 1) */ void format(int bits = 8, Parity parity = USBHostSerial::None, int stop_bits = 1); protected: //From IUSBEnumerator virtual void setVidPid(uint16_t vid, uint16_t pid); 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 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used virtual int _getc(); virtual int _putc(int c); private: USBHost * host; USBDeviceConnected * dev; USBEndpoint * bulk_in; USBEndpoint * bulk_out; uint32_t size_bulk_in; uint32_t size_bulk_out; bool dev_connected; void init(); MtxCircBuffer<uint8_t, 64> circ_buf; uint8_t buf[64]; typedef __packed struct { uint32_t baudrate; uint8_t stop_bits; uint8_t parity; uint8_t data_bits; } LINE_CODING; LINE_CODING line_coding; void rxHandler(); void txHandler(); FunctionPointer rx; FunctionPointer tx; int serial_intf; bool serial_device_found; }; #endif #endif