menu: added new Keywords tag to .desktop files
[barry.git] / src / probe.h
blob5a44e9a1d8382438bdfb158cc2b1a23fdf9999f7
1 ///
2 /// \file probe.h
3 /// USB Blackberry detection routines
4 ///
6 /*
7 Copyright (C) 2005-2013, Net Direct Inc. (http://www.netdirect.ca/)
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.
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.
18 See the GNU General Public License in the COPYING file at the
19 root directory of this project for more details.
22 #ifndef __BARRY_PROBE_H__
23 #define __BARRY_PROBE_H__
25 #include "dll.h"
26 #include "usbwrap.h"
27 #include "pin.h"
28 #include <vector>
29 #include <iosfwd>
30 #include <stdint.h>
32 namespace Barry {
34 class Probe;
36 struct BXEXPORT ProbeResult
38 friend class Probe;
40 Usb::DeviceID m_dev;
41 unsigned char m_interface;
42 unsigned char m_altsetting;
43 Barry::Pin m_pin;
44 Usb::EndpointPair m_ep;
45 Usb::EndpointPair m_epModem;
46 // Specifies if it's necessary to clear halt on the
47 // endpoints before using them. On some devices such
48 // as the 8830 it's essential to clear halt. On other
49 // devices such as the Curve 8520 calling clear halt
50 // can cause them to get into a state where they drop
51 // packets.
52 bool m_needClearHalt;
53 // Specifies if it's necessary to call usb_set_altinterface()
54 // before attempting to use the end points for this device.
56 // This can help to re-synchronize the state between the USB
57 // host and the device. However it can also cause usb-storage
58 // URBs to be lost on some device, so it's only used as a
59 // last resort.
60 bool m_needSetAltInterface;
61 uint8_t m_zeroSocketSequence;
62 std::string m_description;
64 // data from a possible ConfigFile (filled in automatically by
65 // the probe code if available)
66 std::string m_cfgDeviceName;
68 private:
69 // All ProbeResult objects should come from Probe, therefore
70 // this constructor is private to force the issue.
71 ProbeResult()
72 : m_dev(0), m_interface(0), m_pin(0)
73 , m_needClearHalt(false), m_needSetAltInterface(false)
74 , m_zeroSocketSequence(0)
77 public:
78 void DumpAll(std::ostream &os) const;
79 bool HasIpModem() const { return m_epModem.IsComplete(); }
81 std::string GetDisplayName() const;
83 bool operator==(const Barry::Pin &pin) const
85 return m_pin == pin;
89 BXEXPORT std::ostream& operator<< (std::ostream &os, const ProbeResult &pr);
92 class BXEXPORT Probe
94 public:
95 typedef std::vector<ProbeResult> Results;
97 enum LogExceptionBits {
98 LOG_BUSY = 0x0001,
99 LOG_ACCESS = 0x0002,
100 LOG_PERM = 0x0004
103 private:
104 Usb::DeviceList m_devices;
105 Results m_results;
107 unsigned int m_log_exceptions;
108 std::vector<std::string> m_fail_msgs;
109 int m_fail_count;
111 bool m_epp_override;
112 Usb::EndpointPair m_epp;
114 BXLOCAL bool CheckSize(const Data &data, unsigned int required);
115 BXLOCAL bool ParsePIN(const Data &data, uint32_t &pin);
116 BXLOCAL bool ParseDesc(const Data &data, std::string &desc);
118 protected:
119 void ProbeMatching(int vendor, int product,
120 const char *busname, const char *devname);
121 void ProbeDevice(Usb::DeviceID& devid);
122 void ProbeDeviceEndpoints(Usb::Device &dev, Usb::EndpointPairings &ed, ProbeResult &result);
123 bool ProbePair(Usb::Device &dev, const Usb::EndpointPair &ep,
124 uint32_t &pin, std::string &desc, uint8_t &zeroSocketSequence,
125 bool &needClearHalt);
126 bool ProbeModem(Usb::Device &dev, const Usb::EndpointPair &ep);
128 public:
129 /// log_exceptions is a bitmask of low level USB errors to
130 /// log instead of throw on. If 0, all USB errors will cause
131 /// an exception, and thereby stop the probe. If the error
132 /// is set in the bitmask, the exception will be caught, and
133 /// logged in m_fail_msgs, which can be retrieved through
134 /// GetFailCount() and GetFailMsg(). If auto_dump_log is true,
135 /// all logged messages will be dumped as well, via the eout() macro,
136 /// to make sure they are seen, even if the application
137 /// programmer doesn't deal with them via the API.
138 Probe(const char *busname = 0, const char *devname = 0,
139 const Usb::EndpointPair *epp = 0,
140 unsigned int log_exceptions = LOG_BUSY | LOG_ACCESS | LOG_PERM,
141 bool auto_dump_log = true);
143 const Results& GetResults() const { return m_results; }
145 int GetCount() const { return m_results.size(); }
146 int GetFailCount() const { return m_fail_count; }
148 const std::string& GetFailMsg(int index) const { return m_fail_msgs.at(index); }
149 const ProbeResult& Get(int index) const { return m_results.at(index); }
151 int FindActive(Barry::Pin pin = 0) const; // returns -1 if pin not found
152 // or if no devices
153 static int FindActive(const Results &results, Barry::Pin pin = 0);
154 static int Find(const Results &results, Barry::Pin pin = 0);
158 } // namespace Barry
160 #endif