1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
#include <chrono>
#include <thread>
#include <cstddef>
#include <stdexcept>
#include "hidapi/hidapi.h"
#include "include/misc.h"
#include "include/device.h"
#include "include/log.h"
#include <mutex>
#include "DeviceCommunicationExceptions.h"
std::mutex mex_dev_com;
using namespace nitrokey::device;
using namespace nitrokey::log;
using namespace std::chrono;
std::atomic_int Device::instances_count{0};
Device::Device(const uint16_t vid, const uint16_t pid, const DeviceModel model,
const milliseconds send_receive_delay, const int retry_receiving_count,
const milliseconds retry_timeout)
: m_vid(vid),
m_pid(pid),
m_retry_sending_count(3),
m_retry_receiving_count(retry_receiving_count),
m_retry_timeout(retry_timeout),
mp_devhandle(nullptr),
last_command_status(0),
m_model(model),
m_send_receive_delay(send_receive_delay)
{
instances_count++;
}
bool Device::disconnect() {
//called in object's destructor
LOG(__FUNCTION__, Loglevel::DEBUG_L2);
std::lock_guard<std::mutex> lock(mex_dev_com);
return _disconnect();
}
bool Device::_disconnect() {
LOG(std::string(__FUNCTION__) + std::string(m_model == DeviceModel::PRO ? "PRO" : "STORAGE"), Loglevel::DEBUG_L2);
LOG(std::string(__FUNCTION__) + std::string(" *IN* "), Loglevel::DEBUG_L2);
LOG(std::string("Disconnection success: ") + std::to_string(mp_devhandle == nullptr), Loglevel::DEBUG_L2);
if(mp_devhandle == nullptr) return false;
hid_close(mp_devhandle);
mp_devhandle = nullptr;
if (instances_count == 1){
LOG(std::string("Calling hid_exit"), Loglevel::DEBUG_L2);
hid_exit();
}
return true;
}
bool Device::connect() {
LOG(__FUNCTION__, Loglevel::DEBUG_L2);
std::lock_guard<std::mutex> lock(mex_dev_com);
return _connect();
}
bool Device::_connect() {
LOG(std::string(__FUNCTION__) + std::string(" *IN* "), Loglevel::DEBUG_L2);
// hid_init(); // done automatically on hid_open
mp_devhandle = hid_open(m_vid, m_pid, nullptr);
const auto success = mp_devhandle != nullptr;
LOG(std::string("Connection success: ") + std::to_string(success), Loglevel::DEBUG_L2);
return success;
}
int Device::send(const void *packet) {
LOG(__FUNCTION__, Loglevel::DEBUG_L2);
std::lock_guard<std::mutex> lock(mex_dev_com);
LOG(std::string(__FUNCTION__) + std::string(" *IN* "), Loglevel::DEBUG_L2);
if (mp_devhandle == nullptr) {
LOG(std::string("Connection fail") , Loglevel::DEBUG_L2);
throw DeviceNotConnected("Attempted HID send on an invalid descriptor.");
}
int send_feature_report = -1;
for (int i = 0; i < 3 && send_feature_report < 0; ++i) {
send_feature_report = hid_send_feature_report(
mp_devhandle, (const unsigned char *)(packet), HID_REPORT_SIZE);
if (send_feature_report < 0) _reconnect();
//add thread sleep?
LOG(std::string("Sending attempt: ")+std::to_string(i) + " / 3" , Loglevel::DEBUG_L2);
}
return send_feature_report;
}
int Device::recv(void *packet) {
LOG(__FUNCTION__, Loglevel::DEBUG_L2);
std::lock_guard<std::mutex> lock(mex_dev_com);
LOG(std::string(__FUNCTION__) + std::string(" *IN* "), Loglevel::DEBUG_L2);
int status;
int retry_count = 0;
if (mp_devhandle == nullptr){
LOG(std::string("Connection fail") , Loglevel::DEBUG_L2);
throw DeviceNotConnected("Attempted HID receive on an invalid descriptor.");
}
// FIXME extract error handling and repeating to parent function in
// device_proto:192
for (;;) {
status = (hid_get_feature_report(mp_devhandle, (unsigned char *)(packet),
HID_REPORT_SIZE));
// FIXME handle getting libhid error message somewhere else
auto pwherr = hid_error(mp_devhandle);
std::wstring wherr = (pwherr != nullptr) ? pwherr : L"No error message";
std::string herr(wherr.begin(), wherr.end());
LOG(std::string("libhid error message: ") + herr,
Loglevel::DEBUG_L2);
if (status > 0) break; // success
if (retry_count++ >= m_retry_receiving_count) {
LOG(
"Maximum retry count reached: " + std::to_string(retry_count),
Loglevel::WARNING);
LOG(
std::string("Counter stats: ") + m_counters.get_as_string(),
Loglevel::DEBUG);
break;
}
LOG("Retrying... " + std::to_string(retry_count),
Loglevel::DEBUG);
std::this_thread::sleep_for(m_retry_timeout);
}
return status;
}
bool Device::could_be_enumerated() {
LOG(__FUNCTION__, Loglevel::DEBUG_L2);
std::lock_guard<std::mutex> lock(mex_dev_com);
if (mp_devhandle==nullptr){
return false;
}
auto pInfo = hid_enumerate(m_vid, m_pid);
if (pInfo != nullptr){
hid_free_enumeration(pInfo);
return true;
}
return false;
// alternative:
// unsigned char buf[1];
// return hid_read_timeout(mp_devhandle, buf, sizeof(buf), 20) != -1;
}
void Device::show_stats() {
auto s = m_counters.get_as_string();
LOG(s, Loglevel::DEBUG_L2);
}
void Device::_reconnect() {
if (mex_dev_com.try_lock()){
throw std::runtime_error("mutex should be locked before entering this function");
}
LOG(__FUNCTION__, Loglevel::DEBUG_L2);
++m_counters.low_level_reconnect;
_disconnect();
_connect();
}
Device::~Device() {
show_stats();
disconnect();
instances_count--;
}
Stick10::Stick10():
Device(0x20a0, 0x4108, DeviceModel::PRO, 100ms, 5, 100ms)
{}
Stick20::Stick20():
Device(0x20a0, 0x4109, DeviceModel::STORAGE, 200ms, 5, 200ms)
{}
#include <sstream>
#define p(x) ss << #x << " " << x << ", ";
std::string Device::ErrorCounters::get_as_string() {
std::stringstream ss;
p(total_comm_runs);
p(communication_successful);
ss << "(";
p(command_successful_recv);
p(command_result_not_equal_0_recv);
ss << "), ";
p(sends_executed);
p(recv_executed);
p(successful_storage_commands);
p(total_retries);
ss << "(";
p(busy);
p(busy_progressbar);
p(CRC_other_than_awaited);
p(wrong_CRC);
ss << "), ";
p(low_level_reconnect);
p(sending_error);
p(receiving_error);
return ss.str();
}
#undef p
|
