src/probe.h

   1 ///
   2 /// \file       probe.h
   3 ///             USB Blackberry detection routines
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2007, 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 "usbwrap.h"
  26 #include <vector>
  27 #include <iosfwd>
  28 #include <stdint.h>
  29
  30 namespace Barry {
  31
  32 struct ProbeResult
  33 {
  34         Usb::DeviceIDType m_dev;
  35         unsigned char m_interface;
  36         uint32_t m_pin;
  37         Usb::EndpointPair m_ep;
  38         uint8_t m_zeroSocketSequence;
  39         std::string m_description;
  40 };
  41
  42 std::ostream& operator<< (std::ostream &os, const ProbeResult &pr);
  43
  44
  45 class Probe
  46 {
  47         std::vector<ProbeResult> m_results;
  48
  49         bool CheckSize(const Data &data, unsigned int required);
  50         bool ParsePIN(const Data &data, ProbeResult &result);
  51         bool ParseDesc(const Data &data, ProbeResult &result);
  52
  53 protected:
  54         void ProbeDevice(Usb::DeviceIDType devid);
  55
  56 public:
  57         Probe();
  58
  59         int GetCount() const { return m_results.size(); }
  60         const ProbeResult& Get(int index) const { return m_results[index]; }
  61
  62         int FindActive(uint32_t pin = 0) const; // returns -1 if pin not found
  63                                                 // or if no devices
  64 };
  65
  66
  67 } // namespace Barry
  68
  69 #endif
  70