1 /* 2 * Copyright 2009-2010, François Revol, <revol@free.fr>. 3 * Sponsored by TuneTracker Systems. 4 * Based on the Haiku usb_serial driver which is: 5 * 6 * Copyright (c) 2007-2008 by Michael Lotz 7 * Heavily based on the original usb_serial driver which is: 8 * 9 * Copyright (c) 2003 by Siarzhuk Zharski <imker@gmx.li> 10 * Distributed under the terms of the MIT License. 11 */ 12 #ifndef _SERIAL_DEVICE_H_ 13 #define _SERIAL_DEVICE_H_ 14 15 #include "Driver.h" 16 17 class SerialDevice { 18 public: 19 /* SerialDevice(struct serial_config_descriptor 20 *device, uint32 ioBase, uint32 irq, SerialDevice *master=NULL);*/ 21 SerialDevice(const struct serial_support_descriptor 22 *device, uint32 ioBase, uint32 irq, const SerialDevice *master=NULL); 23 virtual ~SerialDevice(); 24 25 static SerialDevice * MakeDevice(struct serial_config_descriptor 26 *device); 27 28 status_t Init(); 29 30 const struct serial_support_descriptor *SupportDescriptor() const 31 { return fSupportDescriptor; }; 32 struct serial_config_descriptor *ConfigDescriptor() const 33 { return fDevice; }; 34 //uint16 ProductID() const { return fProductID; }; 35 //uint16 VendorID() const { return fVendorID; }; 36 const char * Description() const { return fDescription; }; 37 38 const SerialDevice * Master() const { return fMaster ? fMaster : this; }; 39 40 char * ReadBuffer() { return fReadBuffer; }; 41 size_t ReadBufferSize() { return fReadBufferSize; }; 42 43 char * WriteBuffer() { return fWriteBuffer; }; 44 size_t WriteBufferSize() { return fWriteBufferSize; }; 45 46 void SetModes(); 47 bool Service(struct tty *ptty, struct ddrover *ddr, 48 uint flags); 49 50 int32 InterruptHandler(); 51 52 status_t Open(uint32 flags); 53 status_t Read(char *buffer, size_t *numBytes); 54 status_t Write(const char *buffer, size_t *numBytes); 55 status_t Control(uint32 op, void *arg, size_t length); 56 status_t Select(uint8 event, uint32 ref, selectsync *sync); 57 status_t DeSelect(uint8 event, selectsync *sync); 58 status_t Close(); 59 status_t Free(); 60 61 bool IsOpen() { return fDeviceOpen; }; 62 void Removed(); 63 bool IsRemoved() { return fDeviceRemoved; }; 64 65 /* virtual interface to be overriden as necessary */ 66 virtual status_t AddDevice(const struct serial_config_descriptor *device); 67 68 virtual status_t ResetDevice(); 69 70 //virtual status_t SetLineCoding(usb_serial_line_coding *coding); 71 virtual status_t SetControlLineState(uint16 state); 72 73 virtual void OnRead(char **buffer, size_t *numBytes); 74 virtual void OnWrite(const char *buffer, size_t *numBytes, 75 size_t *packetBytes); 76 virtual void OnClose(); 77 78 uint32 IOBase() const { return fIOBase; }; 79 uint32 IRQ() const { return fIRQ; }; 80 81 protected: 82 void SetReadBufferSize(size_t size) { fReadBufferSize = size; }; 83 void SetWriteBufferSize(size_t size) { fWriteBufferSize = size; }; 84 void SetInterruptBufferSize(size_t size) { fInterruptBufferSize = size; }; 85 private: 86 static int32 DeviceThread(void *data); 87 88 static void ReadCallbackFunction(void *cookie, 89 int32 status, void *data, 90 uint32 actualLength); 91 static void WriteCallbackFunction(void *cookie, 92 int32 status, void *data, 93 uint32 actualLength); 94 static void InterruptCallbackFunction(void *cookie, 95 int32 status, void *data, 96 uint32 actualLength); 97 98 uint8 ReadReg8(int reg); 99 void WriteReg8(int reg, uint8 value); 100 void OrReg8(int reg, uint8 value); 101 void AndReg8(int reg, uint8 value); 102 void MaskReg8(int reg, uint8 value); 103 104 const struct serial_support_descriptor *fSupportDescriptor; 105 struct serial_config_descriptor *fDevice; // USB device handle 106 const char * fDescription; // informational description 107 bool fDeviceOpen; 108 bool fDeviceRemoved; 109 110 bus_type fBus; 111 uint32 fIOBase; 112 uint32 fIRQ; 113 const SerialDevice * fMaster; 114 115 /* line coding */ 116 //usb_serial_line_coding fLineCoding; 117 118 /* data buffers */ 119 area_id fBufferArea; 120 char * fReadBuffer; 121 size_t fReadBufferSize; 122 char * fWriteBuffer; 123 size_t fWriteBufferSize; 124 char * fInterruptBuffer; 125 size_t fInterruptBufferSize; 126 127 /* variables used in callback functionality */ 128 size_t fActualLengthRead; 129 uint32 fStatusRead; 130 size_t fActualLengthWrite; 131 uint32 fStatusWrite; 132 size_t fActualLengthInterrupt; 133 uint32 fStatusInterrupt; 134 135 /* semaphores used in callbacks */ 136 sem_id fDoneRead; 137 sem_id fDoneWrite; 138 139 uint16 fControlOut; 140 bool fInputStopped; 141 struct ttyfile fTTYFile; 142 struct tty fTTY; 143 struct ddrover fRover; 144 145 /* device thread management */ 146 thread_id fDeviceThread; 147 bool fStopDeviceThread; 148 149 /* device locks to ensure no concurent reads/writes */ 150 mutex fReadLock; 151 mutex fWriteLock; 152 }; 153 154 #endif // _SERIAL_DEVICE_H_ 155