3 /// USB Blackberry detection routines
7 Copyright (C) 2005-2010, 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__
36 struct BXEXPORT ProbeResult
40 Usb::DeviceIDType m_dev
;
41 unsigned char m_interface
;
43 Usb::EndpointPair m_ep
;
44 Usb::EndpointPair m_epModem
;
45 // Specifies if it's necessary to clear halt on the
46 // endpoints before using them. On some devices such
47 // as the 8830 it's essential to clear halt. On other
48 // devices such as the Curve 8520 calling clear halt
49 // can cause them to get into a state where they drop
52 // Specifies if it's necessary to call usb_set_altinterface()
53 // before attempting to use the end points for this device.
55 // This can help to re-synchronize the state between the USB
56 // host and the device. However it can also cause usb-storage
57 // URBs to be lost on some device, so it's only used as a
59 bool m_needSetAltInterface
;
60 uint8_t m_zeroSocketSequence
;
61 std::string m_description
;
63 // data from a possible ConfigFile (filled in automatically by
64 // the probe code if available)
65 std::string m_cfgDeviceName
;
68 // All ProbeResult objects should come from Probe, therefore
69 // this constructor is private to force the issue.
71 : m_dev(0), m_interface(0), m_pin(0)
72 , m_needClearHalt(false), m_needSetAltInterface(false)
73 , m_zeroSocketSequence(0)
77 void DumpAll(std::ostream
&os
) const;
78 bool HasIpModem() const { return m_epModem
.IsComplete(); }
80 bool operator==(const Barry::Pin
&pin
) const
86 BXEXPORT
std::ostream
& operator<< (std::ostream
&os
, const ProbeResult
&pr
);
92 typedef std::vector
<ProbeResult
> Results
;
97 std::vector
<std::string
> m_fail_msgs
;
101 Usb::EndpointPair m_epp
;
103 BXLOCAL
bool CheckSize(const Data
&data
, unsigned int required
);
104 BXLOCAL
bool ParsePIN(const Data
&data
, uint32_t &pin
);
105 BXLOCAL
bool ParseDesc(const Data
&data
, std::string
&desc
);
108 void ProbeMatching(int vendor
, int product
,
109 const char *busname
, const char *devname
);
110 void ProbeDevice(Usb::DeviceIDType devid
);
111 void ProbeDeviceEndpoints(Usb::Device
&dev
, Usb::EndpointDiscovery
&ed
, ProbeResult
&result
);
112 bool ProbePair(Usb::Device
&dev
, const Usb::EndpointPair
&ep
,
113 uint32_t &pin
, std::string
&desc
, uint8_t &zeroSocketSequence
,
114 bool &needClearHalt
);
115 bool ProbeModem(Usb::Device
&dev
, const Usb::EndpointPair
&ep
);
118 Probe(const char *busname
= 0, const char *devname
= 0,
119 const Usb::EndpointPair
*epp
= 0);
121 const Results
& GetResults() const { return m_results
; }
123 int GetCount() const { return m_results
.size(); }
124 int GetFailCount() const { return m_fail_count
; }
126 const std::string
& GetFailMsg(int index
) const { return m_fail_msgs
.at(index
); }
127 const ProbeResult
& Get(int index
) const { return m_results
.at(index
); }
129 int FindActive(Barry::Pin pin
= 0) const; // returns -1 if pin not found
131 static int FindActive(const Results
&results
, Barry::Pin pin
= 0);
132 static int Find(const Results
&results
, Barry::Pin pin
= 0);