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