WANDongle.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 WANDONGLE_H
00020 #define WANDONGLE_H
00021 
00022 #include "USBHostConf.h"
00023 
00024 #ifdef USBHOST_3GMODULE
00025 
00026 #include "USBHost.h"
00027 #include "IUSBHostSerial.h"
00028 
00029 #include "rtos.h"
00030 
00031 #include "WANDongleSerialPort.h"
00032 #include "WANDongleInitializer.h"
00033 #include "IUSBEnumerator.h"
00034 
00035 #define WANDONGLE_MAX_OUTEP_SIZE 64
00036 #define WANDONGLE_MAX_INEP_SIZE 64
00037 
00038 /** A class to use a WAN (3G/LTE) access dongle
00039  *
00040  */
00041 class WANDongle : public IUSBEnumerator {
00042 public:
00043     /*
00044     * Constructor
00045     *
00046     * @param rootdir mount name
00047     */
00048     WANDongle();
00049 
00050     /*
00051     * Destructor
00052     */
00053     virtual ~WANDongle();
00054 
00055     /*
00056     * Check if a serial port device is connected
00057     *
00058     * @return true if a serial device is connected
00059     */
00060     bool connected();
00061 
00062     /*
00063      * Try to connect device
00064      *
00065      * * @return true if connection was successful
00066      */
00067     bool tryConnect();
00068 
00069     /*
00070      * Disconnect device
00071      *
00072      * * @return true if disconnection was successful
00073      */
00074     bool disconnect();
00075 
00076     int getDongleType();
00077 
00078     IUSBHostSerial& getSerial(int index);
00079     int getSerialCount();
00080     bool addInitializer(WANDongleInitializer* pInitializer);
00081 
00082     //From IUSBEnumerator
00083 
00084     virtual void setVidPid(uint16_t vid, uint16_t pid);
00085 
00086     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
00087 
00088     virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
00089 
00090 protected:
00091     USBHost * host;
00092     USBDeviceConnected * dev;
00093     bool dev_connected;
00094 
00095     WANDongleInitializer* m_pInitializer;
00096 
00097     void init();
00098 
00099     WANDongleSerialPort m_serial[WANDONGLE_MAX_SERIAL_PORTS];
00100     int m_serialCount;
00101 
00102     int m_totalInitializers;
00103     WANDongleInitializer* m_Initializers[WANDONGLE_MAX_INITIALIZERS];
00104 };
00105 
00106 #endif /* USBHOST_3GMODULE */
00107 
00108 #endif