WANDongleInitializer.h

00001 /* Copyright (c) 2010-2012 mbed.org, MIT License
00002 *
00003 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
00004 * and associated documentation files (the "Software"), to deal in the Software without
00005 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
00006 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
00007 * Software is furnished to do so, subject to the following conditions:
00008 *
00009 * The above copyright notice and this permission notice shall be included in all copies or
00010 * substantial portions of the Software.
00011 *
00012 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
00013 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00014 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
00015 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00016 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00017 */
00018 
00019 #ifndef WANDONGLEINITIALIZER_H
00020 #define WANDONGLEINITIALIZER_H
00021 
00022 #include "USBHostConf.h"
00023 
00024 #ifdef USBHOST_3GMODULE
00025 
00026 #include <stdint.h>
00027 
00028 #include "USBHost.h"
00029 #include "IUSBEnumerator.h"
00030 
00031 // [TODO] move these declarations to a proper place
00032 #define WANDONGLE_MAX_SERIAL_PORTS 2
00033 #define WANDONGLE_MAX_INITIALIZERS 6
00034 
00035 #define WAN_DONGLE_TYPE_UNKNOWN    (-1)
00036 
00037 class WANDongleInitializer : public IUSBEnumerator
00038 {
00039 protected:
00040     WANDongleInitializer(USBHost* pHost) { m_pHost = pHost; }
00041     USBHost* m_pHost;
00042     uint8_t m_serialIntfMap[WANDONGLE_MAX_SERIAL_PORTS];
00043 
00044 public:
00045     virtual ~WANDongleInitializer() {}
00046     virtual uint16_t getMSDVid() = 0;
00047     virtual uint16_t getMSDPid() = 0;
00048 
00049     virtual uint16_t getSerialVid() = 0;
00050     virtual uint16_t getSerialPid() = 0;
00051 
00052     virtual bool switchMode(USBDeviceConnected* pDev) = 0;
00053 
00054     virtual USBEndpoint* getEp(USBDeviceConnected* pDev, int serialPortNumber, bool tx) {
00055         return pDev->getEndpoint(m_serialIntfMap[serialPortNumber], BULK_ENDPOINT, tx ? OUT : IN, 0);
00056     }
00057 
00058     virtual int getSerialPortCount() = 0;
00059 
00060     virtual void setVidPid(uint16_t vid, uint16_t pid) = 0;
00061 
00062     virtual bool parseInterface(uint8_t intf_nb, uint8_t intf_class, uint8_t intf_subclass, uint8_t intf_protocol) = 0; //Must return true if the interface should be parsed
00063 
00064     virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir) = 0; //Must return true if the endpoint will be used
00065 
00066     virtual int getType() = 0;
00067 
00068     virtual uint8_t getSerialIntf(int index) { return m_serialIntfMap[index]; }
00069 };
00070 
00071 #endif /* USBHOST_3GMODULE */
00072 
00073 #endif