src/probe.h

   1 ///
   2 /// \file       probe.h
   3 ///             USB Blackberry detection routines
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2010, Net Direct Inc. (http://www.netdirect.ca/)
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  17
  18     See the GNU General Public License in the COPYING file at the
  19     root directory of this project for more details.
  20 */
  21
  22 #ifndef __BARRY_PROBE_H__
  23 #define __BARRY_PROBE_H__
  24
  25 #include "dll.h"
  26 #include "usbwrap.h"
  27 #include "pin.h"
  28 #include <vector>
  29 #include <iosfwd>
  30 #include <stdint.h>
  31
  32 namespace Barry {
  33
  34 struct BXEXPORT ProbeResult
  35 {
  36         Usb::DeviceIDType m_dev;
  37         unsigned char m_interface;
  38         Barry::Pin m_pin;
  39         Usb::EndpointPair m_ep;
  40         Usb::EndpointPair m_epModem;
  41         uint8_t m_zeroSocketSequence;
  42         std::string m_description;
  43
  44         // data from a possible ConfigFile (filled in automatically by
  45         // the probe code if available)
  46         std::string m_cfgDeviceName;
  47
  48         ProbeResult()
  49                 : m_dev(0), m_interface(0), m_pin(0), m_zeroSocketSequence(0)
  50                 {}
  51         void DumpAll(std::ostream &os) const;
  52         bool HasIpModem() const { return m_epModem.IsComplete(); }
  53
  54         bool operator==(const Barry::Pin &pin) const
  55         {
  56                 return m_pin == pin;
  57         }
  58 };
  59
  60 BXEXPORT std::ostream& operator<< (std::ostream &os, const ProbeResult &pr);
  61
  62
  63 class BXEXPORT Probe
  64 {
  65 public:
  66         typedef std::vector<ProbeResult>                Results;
  67
  68 private:
  69         Results m_results;
  70
  71         std::vector<std::string> m_fail_msgs;
  72         int m_fail_count;
  73
  74         bool m_epp_override;
  75         Usb::EndpointPair m_epp;
  76
  77         BXLOCAL bool CheckSize(const Data &data, unsigned int required);
  78         BXLOCAL bool ParsePIN(const Data &data, uint32_t &pin);
  79         BXLOCAL bool ParseDesc(const Data &data, std::string &desc);
  80
  81 protected:
  82         void ProbeMatching(int vendor, int product,
  83                 const char *busname, const char *devname);
  84         void ProbeDevice(Usb::DeviceIDType devid);
  85         bool ProbePair(Usb::Device &dev, const Usb::EndpointPair &ep,
  86                 uint32_t &pin, std::string &desc, uint8_t &zeroSocketSequence);
  87         bool ProbeModem(Usb::Device &dev, const Usb::EndpointPair &ep);
  88
  89 public:
  90         Probe(const char *busname = 0, const char *devname = 0,
  91                 const Usb::EndpointPair *epp = 0);
  92
  93         const Results& GetResults() const { return m_results; }
  94
  95         int GetCount() const { return m_results.size(); }
  96         int GetFailCount() const { return m_fail_count; }
  97
  98         const std::string& GetFailMsg(int index) const { return m_fail_msgs[index]; }
  99         const ProbeResult& Get(int index) const { return m_results[index]; }
 100
 101         int FindActive(Barry::Pin pin = 0) const; // returns -1 if pin not found
 102                                                 // or if no devices
 103         static int FindActive(const Results &results, Barry::Pin pin = 0);
 104         static int Find(const Results &results, Barry::Pin pin = 0);
 105 };
 106
 107
 108 } // namespace Barry
 109
 110 #endif
 111