Ganesh Subramaniam / USBHost

USBHost library

Dependencies:   FATFileSystem

Dependents:   Project RoboticsCatAndMouse_HumanDriver RoboticsCatAndMouse_AutonomousDriver

Fork of USBHost by mbed official

USBHostSerial/USBHostSerial.h@1:0a457e34fa9e, 2013-03-06 (annotated)

Committer:
samux
Date:
Wed Mar 06 17:10:32 2013 +0000
Revision:
1:0a457e34fa9e
Parent:
0:a554658735bf
Child:
2:5e8fdc541b98
add doxygen comments

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:a554658735bf 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
mbed_official 0:a554658735bf 2 *
mbed_official 0:a554658735bf 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
mbed_official 0:a554658735bf 4 * and associated documentation files (the "Software"), to deal in the Software without
mbed_official 0:a554658735bf 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
mbed_official 0:a554658735bf 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
mbed_official 0:a554658735bf 7 * Software is furnished to do so, subject to the following conditions:
mbed_official 0:a554658735bf 8 *
mbed_official 0:a554658735bf 9 * The above copyright notice and this permission notice shall be included in all copies or
mbed_official 0:a554658735bf 10 * substantial portions of the Software.
mbed_official 0:a554658735bf 11 *
mbed_official 0:a554658735bf 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
mbed_official 0:a554658735bf 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
mbed_official 0:a554658735bf 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
mbed_official 0:a554658735bf 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:a554658735bf 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
mbed_official 0:a554658735bf 17 */
mbed_official 0:a554658735bf 18
mbed_official 0:a554658735bf 19 #ifndef USBHOSTSERIAL_H
mbed_official 0:a554658735bf 20 #define USBHOSTSERIAL_H
mbed_official 0:a554658735bf 21
mbed_official 0:a554658735bf 22 #include "USBHostConf.h"
mbed_official 0:a554658735bf 23
mbed_official 0:a554658735bf 24 #if USBHOST_SERIAL
mbed_official 0:a554658735bf 25
mbed_official 0:a554658735bf 26 #include "USBHost.h"
mbed_official 0:a554658735bf 27 #include "Stream.h"
mbed_official 0:a554658735bf 28 #include "MtxCircBuffer.h"
mbed_official 0:a554658735bf 29
samux 1:0a457e34fa9e 30 /**
samux 1:0a457e34fa9e 31 * A class to communicate a USB virtual serial port
samux 1:0a457e34fa9e 32 */
mbed_official 0:a554658735bf 33 class USBHostSerial : public IUSBEnumerator, public Stream {
mbed_official 0:a554658735bf 34 public:
mbed_official 0:a554658735bf 35 /**
mbed_official 0:a554658735bf 36 * Constructor
mbed_official 0:a554658735bf 37 */
mbed_official 0:a554658735bf 38 USBHostSerial();
mbed_official 0:a554658735bf 39
mbed_official 0:a554658735bf 40 enum IrqType {
mbed_official 0:a554658735bf 41 RxIrq,
mbed_official 0:a554658735bf 42 TxIrq
mbed_official 0:a554658735bf 43 };
mbed_official 0:a554658735bf 44
mbed_official 0:a554658735bf 45 /**
mbed_official 0:a554658735bf 46 * Check if a virtual serial port is connected
mbed_official 0:a554658735bf 47 *
mbed_official 0:a554658735bf 48 * @returns true if a serial device is connected
mbed_official 0:a554658735bf 49 */
mbed_official 0:a554658735bf 50 bool connected();
mbed_official 0:a554658735bf 51
mbed_official 0:a554658735bf 52 /**
mbed_official 0:a554658735bf 53 * Try to connect a serial device
mbed_official 0:a554658735bf 54 *
mbed_official 0:a554658735bf 55 * * @return true if connection was successful
mbed_official 0:a554658735bf 56 */
mbed_official 0:a554658735bf 57 bool connect();
mbed_official 0:a554658735bf 58
mbed_official 0:a554658735bf 59 /**
mbed_official 0:a554658735bf 60 * Check the number of bytes available.
mbed_official 0:a554658735bf 61 *
mbed_official 0:a554658735bf 62 * @returns the number of bytes available
mbed_official 0:a554658735bf 63 */
mbed_official 0:a554658735bf 64 uint8_t available();
mbed_official 0:a554658735bf 65
mbed_official 0:a554658735bf 66 /**
mbed_official 0:a554658735bf 67 * Attach a member function to call when a packet is received.
mbed_official 0:a554658735bf 68 *
mbed_official 0:a554658735bf 69 * @param tptr pointer to the object to call the member function on
mbed_official 0:a554658735bf 70 * @param mptr pointer to the member function to be called
mbed_official 0:a554658735bf 71 */
mbed_official 0:a554658735bf 72 template<typename T>
mbed_official 0:a554658735bf 73 inline void attach(T* tptr, void (T::*mptr)(void), IrqType irq = RxIrq) {
mbed_official 0:a554658735bf 74 if ((mptr != NULL) && (tptr != NULL)) {
mbed_official 0:a554658735bf 75 if (irq == RxIrq) {
mbed_official 0:a554658735bf 76 rx.attach(tptr, mptr);
mbed_official 0:a554658735bf 77 } else {
mbed_official 0:a554658735bf 78 tx.attach(tptr, mptr);
mbed_official 0:a554658735bf 79 }
mbed_official 0:a554658735bf 80 }
mbed_official 0:a554658735bf 81 }
mbed_official 0:a554658735bf 82
mbed_official 0:a554658735bf 83 /**
mbed_official 0:a554658735bf 84 * Attach a callback called when a packet is received
mbed_official 0:a554658735bf 85 *
mbed_official 0:a554658735bf 86 * @param fptr function pointer
mbed_official 0:a554658735bf 87 */
mbed_official 0:a554658735bf 88 inline void attach(void (*fn)(void), IrqType irq = RxIrq) {
mbed_official 0:a554658735bf 89 if (fn != NULL) {
mbed_official 0:a554658735bf 90 if (irq == RxIrq) {
mbed_official 0:a554658735bf 91 rx.attach(fn);
mbed_official 0:a554658735bf 92 } else {
mbed_official 0:a554658735bf 93 tx.attach(fn);
mbed_official 0:a554658735bf 94 }
mbed_official 0:a554658735bf 95 }
mbed_official 0:a554658735bf 96 }
mbed_official 0:a554658735bf 97
mbed_official 0:a554658735bf 98
mbed_official 0:a554658735bf 99 protected:
mbed_official 0:a554658735bf 100 //From IUSBEnumerator
mbed_official 0:a554658735bf 101 virtual void setVidPid(uint16_t vid, uint16_t pid);
mbed_official 0:a554658735bf 102 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
mbed_official 0:a554658735bf 103 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
mbed_official 0:a554658735bf 104
mbed_official 0:a554658735bf 105 virtual int _getc();
mbed_official 0:a554658735bf 106 virtual int _putc(int c);
mbed_official 0:a554658735bf 107
mbed_official 0:a554658735bf 108 private:
mbed_official 0:a554658735bf 109 USBHost * host;
mbed_official 0:a554658735bf 110 USBDeviceConnected * dev;
mbed_official 0:a554658735bf 111 USBEndpoint * bulk_in;
mbed_official 0:a554658735bf 112 USBEndpoint * bulk_out;
mbed_official 0:a554658735bf 113 uint32_t size_bulk_in;
mbed_official 0:a554658735bf 114 uint32_t size_bulk_out;
mbed_official 0:a554658735bf 115
mbed_official 0:a554658735bf 116 bool dev_connected;
mbed_official 0:a554658735bf 117
mbed_official 0:a554658735bf 118 void init();
mbed_official 0:a554658735bf 119
mbed_official 0:a554658735bf 120 MtxCircBuffer<uint8_t, 64> circ_buf;
mbed_official 0:a554658735bf 121
mbed_official 0:a554658735bf 122 uint8_t buf[64];
mbed_official 0:a554658735bf 123
mbed_official 0:a554658735bf 124 void rxHandler();
mbed_official 0:a554658735bf 125 void txHandler();
mbed_official 0:a554658735bf 126 FunctionPointer rx;
mbed_official 0:a554658735bf 127 FunctionPointer tx;
mbed_official 0:a554658735bf 128
mbed_official 0:a554658735bf 129 int serial_intf;
mbed_official 0:a554658735bf 130 bool serial_device_found;
mbed_official 0:a554658735bf 131
mbed_official 0:a554658735bf 132 };
mbed_official 0:a554658735bf 133
mbed_official 0:a554658735bf 134 #endif
mbed_official 0:a554658735bf 135
mbed_official 0:a554658735bf 136 #endif
mbed_official 0:a554658735bf 137