]> sigrok.org Git - libsigrok.git/blame - src/hardware/testo/api.c
lascar-el-usb: lascar_scan(): Fix USB device list leak
[libsigrok.git] / src / hardware / testo / api.c
CommitLineData
0acdd793
BV
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
6ec6c43b 20#include <config.h>
6dcb9723 21#include <string.h>
0acdd793
BV
22#include "protocol.h"
23
6dcb9723
BV
24#define SERIALCOMM "115200/8n1"
25
0acdd793 26SR_PRIV struct sr_dev_driver testo_driver_info;
695dc859 27static int dev_acquisition_stop(struct sr_dev_inst *sdi);
6dcb9723 28
584560f1 29static const uint32_t scanopts[] = {
6dcb9723
BV
30 SR_CONF_CONN,
31};
32
584560f1 33static const uint32_t devopts[] = {
6dcb9723 34 SR_CONF_MULTIMETER,
6dcb9723 35 SR_CONF_CONTINUOUS,
91b77e6b
LPC
36 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_GET,
37 SR_CONF_LIMIT_MSEC | SR_CONF_SET | SR_CONF_GET,
6dcb9723
BV
38};
39
329733d9
UH
40static const uint8_t TESTO_x35_REQUEST[] = { 0x12, 0, 0, 0, 1, 1, 0x55, 0xd1, 0xb7 };
41
42static const struct testo_model models[] = {
6dcb9723
BV
43 { "435", 9, TESTO_x35_REQUEST },
44};
0acdd793 45
4f840ce9 46static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
0acdd793
BV
47{
48 return std_init(sr_ctx, di, LOG_PREFIX);
49}
50
4f840ce9 51static GSList *scan(struct sr_dev_driver *di, GSList *options)
0acdd793
BV
52{
53 struct drv_context *drvc;
6dcb9723
BV
54 struct dev_context *devc;
55 struct sr_config *src;
56 struct sr_dev_inst *sdi;
57 struct sr_usb_dev_inst *usb;
58 struct libusb_device_descriptor des;
59 libusb_device **devlist;
60 struct libusb_device_handle *hdl;
61 GSList *conn_devices, *devices, *l;
bde9fbd1 62 int ret, i;
6dcb9723 63 const char *str;
bde9fbd1 64 char manufacturer[64], product[64], connection_id[64];
0acdd793
BV
65
66 devices = NULL;
41812aca 67 drvc = di->context;
0acdd793
BV
68 drvc->instances = NULL;
69
6dcb9723
BV
70 conn_devices = NULL;
71 for (l = options; l; l = l->next) {
72 src = l->data;
73 if (src->key != SR_CONF_CONN)
74 continue;
75 str = g_variant_get_string(src->data, NULL);
76 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, str);
77 }
78
79 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
80 for (i = 0; devlist[i]; i++) {
81 if (conn_devices) {
82 usb = NULL;
83 for (l = conn_devices; l; l = l->next) {
84 usb = l->data;
85 if (usb->bus == libusb_get_bus_number(devlist[i])
86 && usb->address == libusb_get_device_address(devlist[i]))
87 break;
88 }
89 if (!l)
90 /* This device matched none of the ones that
91 * matched the conn specification. */
92 continue;
93 }
94
2a8f2d41 95 libusb_get_device_descriptor(devlist[i], &des);
6dcb9723
BV
96
97 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
98 continue;
99
100 manufacturer[0] = product[0] = '\0';
101 if (des.iManufacturer && (ret = libusb_get_string_descriptor_ascii(
102 hdl, des.iManufacturer, (unsigned char *) manufacturer,
103 sizeof(manufacturer))) < 0) {
104 sr_warn("Failed to get manufacturer string descriptor: %s.",
105 libusb_error_name(ret));
106 }
107 if (des.iProduct && (ret = libusb_get_string_descriptor_ascii(
108 hdl, des.iProduct, (unsigned char *) product,
109 sizeof(product))) < 0) {
110 sr_warn("Failed to get product string descriptor: %s.",
111 libusb_error_name(ret));
112 }
113 libusb_close(hdl);
114
115 if (strncmp(manufacturer, "testo", 5))
116 continue;
117
bde9fbd1
SA
118 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
119
6dcb9723
BV
120 /* Hardcode the 435 for now.*/
121 if (strcmp(product, "testo 435/635/735"))
122 continue;
123
aac29cc1 124 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be
UH
125 sdi->status = SR_ST_INACTIVE;
126 sdi->vendor = g_strdup("Testo");
127 sdi->model = g_strdup("435/635/735");
6dcb9723
BV
128 sdi->driver = di;
129 sdi->inst_type = SR_INST_USB;
130 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
131 libusb_get_device_address(devlist[i]), NULL);
bde9fbd1 132 sdi->connection_id = g_strdup(connection_id);
6dcb9723
BV
133 devc = g_malloc(sizeof(struct dev_context));
134 devc->model = &models[0];
91b77e6b 135 sr_sw_limits_init(&devc->sw_limits);
6dcb9723
BV
136 sdi->priv = devc;
137 if (testo_probe_channels(sdi) != SR_OK)
138 continue;
139 drvc->instances = g_slist_append(drvc->instances, sdi);
140 devices = g_slist_append(devices, sdi);
141 }
142 libusb_free_device_list(devlist, 1);
143 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
0acdd793
BV
144
145 return devices;
146}
147
0acdd793
BV
148static int dev_open(struct sr_dev_inst *sdi)
149{
4f840ce9 150 struct sr_dev_driver *di = sdi->driver;
41812aca 151 struct drv_context *drvc = di->context;
6dcb9723
BV
152 struct sr_usb_dev_inst *usb;
153 libusb_device **devlist;
154 int ret, i;
bde9fbd1 155 char connection_id[64];
6dcb9723 156
6dcb9723
BV
157 usb = sdi->conn;
158 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
159 for (i = 0; devlist[i]; i++) {
bde9fbd1
SA
160 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
161 if (strcmp(sdi->connection_id, connection_id))
6dcb9723
BV
162 continue;
163 if ((ret = libusb_open(devlist[i], &usb->devhdl))) {
164 sr_err("Failed to open device: %s.", libusb_error_name(ret));
165 return SR_ERR;
166 }
167 break;
168 }
169 libusb_free_device_list(devlist, 1);
170 if (!devlist[i]) {
171 sr_err("Device not found.");
172 return SR_ERR;
173 }
0acdd793 174
88b1d4e5
BV
175 if (libusb_has_capability(LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER)) {
176 if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
177 if ((ret = libusb_detach_kernel_driver(usb->devhdl, 0)) < 0) {
178 sr_err("Failed to detach kernel driver: %s.",
179 libusb_error_name(ret));
180 return SR_ERR;
181 }
182 }
183 }
184
6dcb9723
BV
185 if ((ret = libusb_claim_interface(usb->devhdl, 0))) {
186 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
187 return SR_ERR;
188 }
0acdd793
BV
189 sdi->status = SR_ST_ACTIVE;
190
191 return SR_OK;
192}
193
194static int dev_close(struct sr_dev_inst *sdi)
195{
6dcb9723
BV
196 struct sr_usb_dev_inst *usb;
197
6dcb9723
BV
198 usb = sdi->conn;
199 if (!usb->devhdl)
200 /* Nothing to do. */
201 return SR_OK;
0acdd793 202
6dcb9723
BV
203 libusb_release_interface(usb->devhdl, 0);
204 libusb_close(usb->devhdl);
205 usb->devhdl = NULL;
0acdd793
BV
206 sdi->status = SR_ST_INACTIVE;
207
208 return SR_OK;
209}
210
584560f1 211static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
0acdd793
BV
212 const struct sr_channel_group *cg)
213{
91b77e6b 214 struct dev_context *devc = sdi->priv;
6dcb9723
BV
215 struct sr_usb_dev_inst *usb;
216 char str[128];
0acdd793 217
0acdd793
BV
218 (void)cg;
219
0acdd793 220 switch (key) {
6dcb9723
BV
221 case SR_CONF_CONN:
222 if (!sdi || !sdi->conn)
223 return SR_ERR_ARG;
224 usb = sdi->conn;
225 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
226 *data = g_variant_new_string(str);
227 break;
91b77e6b
LPC
228 case SR_CONF_LIMIT_MSEC:
229 case SR_CONF_LIMIT_SAMPLES:
230 return sr_sw_limits_config_get(&devc->sw_limits, key, data);
0acdd793
BV
231 default:
232 return SR_ERR_NA;
233 }
234
6dcb9723 235 return SR_OK;
0acdd793
BV
236}
237
584560f1 238static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
0acdd793
BV
239 const struct sr_channel_group *cg)
240{
91b77e6b 241 struct dev_context *devc = sdi->priv;
0acdd793 242
0acdd793
BV
243 (void)cg;
244
245 if (sdi->status != SR_ST_ACTIVE)
246 return SR_ERR_DEV_CLOSED;
247
91b77e6b 248 return sr_sw_limits_config_set(&devc->sw_limits, key, data);
0acdd793
BV
249}
250
584560f1 251static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
0acdd793
BV
252 const struct sr_channel_group *cg)
253{
0acdd793 254 (void)sdi;
0acdd793
BV
255 (void)cg;
256
0acdd793 257 switch (key) {
6dcb9723 258 case SR_CONF_SCAN_OPTIONS:
584560f1
BV
259 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
260 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
6dcb9723
BV
261 break;
262 case SR_CONF_DEVICE_OPTIONS:
584560f1
BV
263 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
264 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
6dcb9723 265 break;
0acdd793
BV
266 default:
267 return SR_ERR_NA;
268 }
269
6dcb9723 270 return SR_OK;
0acdd793
BV
271}
272
6dcb9723 273static void receive_data(struct sr_dev_inst *sdi, unsigned char *data, int len)
0acdd793 274{
6dcb9723
BV
275 struct dev_context *devc;
276 int packet_size;
87895640 277 uint16_t crc;
6dcb9723
BV
278
279 devc = sdi->priv;
280
281 if (devc->reply_size + len > MAX_REPLY_SIZE) {
282 /* Something went very wrong. */
283 sr_dbg("Receive buffer overrun.");
284 devc->reply_size = 0;
285 return;
286 }
287
288 memcpy(devc->reply + devc->reply_size, data, len);
289 devc->reply_size += len;
290 /* Sixth byte contains the length of the packet. */
87895640
BV
291 if (devc->reply_size < 7)
292 return;
293
294 packet_size = 7 + devc->reply[6] * 7 + 2;
295 if (devc->reply_size < packet_size)
296 return;
297
298 if (!testo_check_packet_prefix(devc->reply, devc->reply_size))
299 return;
300
301 crc = crc16_mcrf4xx(0xffff, devc->reply, devc->reply_size - 2);
88b1d4e5 302 if (crc == RL16(&devc->reply[devc->reply_size - 2])) {
87895640 303 testo_receive_packet(sdi);
91b77e6b 304 sr_sw_limits_update_samples_read(&devc->sw_limits, 1);
87895640
BV
305 } else {
306 sr_dbg("Packet has invalid CRC.");
6dcb9723
BV
307 }
308
87895640 309 devc->reply_size = 0;
91b77e6b 310 if (sr_sw_limits_check(&devc->sw_limits))
695dc859 311 dev_acquisition_stop(sdi);
87895640
BV
312 else
313 testo_request_packet(sdi);
314
6dcb9723
BV
315}
316
55462b8b 317SR_PRIV void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
6dcb9723
BV
318{
319 struct dev_context *devc;
320 struct sr_dev_inst *sdi;
321 int ret;
322
323 sdi = transfer->user_data;
324 devc = sdi->priv;
325 if (transfer == devc->out_transfer)
326 /* Just the command acknowledgement. */
327 return;
328
329 if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
330 /* USB device was unplugged. */
695dc859 331 dev_acquisition_stop(sdi);
6dcb9723
BV
332 } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
333 /* First two bytes in any transfer are FTDI status bytes. */
334 if (transfer->actual_length > 2)
335 receive_data(sdi, transfer->buffer + 2, transfer->actual_length - 2);
336 }
337 /* Anything else is either an error or a timeout, which is fine:
338 * we were just going to send another transfer request anyway. */
339
340 if (sdi->status == SR_ST_ACTIVE) {
341 if ((ret = libusb_submit_transfer(transfer) != 0)) {
342 sr_err("Unable to resubmit transfer: %s.",
343 libusb_error_name(ret));
344 g_free(transfer->buffer);
345 libusb_free_transfer(transfer);
695dc859 346 dev_acquisition_stop(sdi);
6dcb9723
BV
347 }
348 } else {
349 /* This was the last transfer we're going to receive, so
350 * clean up now. */
351 g_free(transfer->buffer);
352 libusb_free_transfer(transfer);
353 }
354}
355
356static int handle_events(int fd, int revents, void *cb_data)
357{
4f840ce9 358 struct sr_dev_driver *di;
6dcb9723 359 struct dev_context *devc;
4f840ce9 360 struct drv_context *drvc;
6dcb9723
BV
361 struct sr_dev_inst *sdi;
362 struct timeval tv;
6dcb9723
BV
363
364 (void)fd;
365 (void)revents;
366
367 sdi = cb_data;
368 devc = sdi->priv;
4f840ce9 369 di = sdi->driver;
41812aca 370 drvc = di->context;
6dcb9723 371
91b77e6b
LPC
372 if (sr_sw_limits_check(&devc->sw_limits))
373 dev_acquisition_stop(sdi);
6dcb9723
BV
374
375 if (sdi->status == SR_ST_STOPPING) {
102f1239 376 usb_source_remove(sdi->session, drvc->sr_ctx);
6dcb9723 377 dev_close(sdi);
3be42bc2 378 std_session_send_df_end(sdi, LOG_PREFIX);
6dcb9723
BV
379 }
380
381 memset(&tv, 0, sizeof(struct timeval));
382 libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
383 NULL);
384
385 return TRUE;
386}
387
695dc859 388static int dev_acquisition_start(const struct sr_dev_inst *sdi)
6dcb9723 389{
4f840ce9 390 struct sr_dev_driver *di = sdi->driver;
6dcb9723
BV
391 struct drv_context *drvc;
392 struct dev_context *devc;
393 struct sr_usb_dev_inst *usb;
394 struct libusb_transfer *transfer;
395 int ret;
396 unsigned char *buf;
0acdd793 397
41812aca 398 drvc = di->context;
0acdd793
BV
399 if (sdi->status != SR_ST_ACTIVE)
400 return SR_ERR_DEV_CLOSED;
401
6dcb9723
BV
402
403 devc = sdi->priv;
404 usb = sdi->conn;
6dcb9723
BV
405 devc->reply_size = 0;
406
695dc859 407 std_session_send_df_header(sdi, LOG_PREFIX);
6dcb9723 408
102f1239
BV
409 usb_source_add(sdi->session, drvc->sr_ctx, 100,
410 handle_events, (void *)sdi);
6dcb9723
BV
411
412 if (testo_set_serial_params(usb) != SR_OK)
413 return SR_ERR;
414
415 devc->out_transfer = libusb_alloc_transfer(0);
416 if (testo_request_packet(sdi) != SR_OK)
417 return SR_ERR;
418
a95f142e 419 buf = g_malloc(MAX_REPLY_SIZE);
6dcb9723
BV
420 transfer = libusb_alloc_transfer(0);
421 libusb_fill_bulk_transfer(transfer, usb->devhdl, EP_IN, buf,
422 MAX_REPLY_SIZE, receive_transfer, (void *)sdi, 100);
423 if ((ret = libusb_submit_transfer(transfer) != 0)) {
424 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
425 libusb_free_transfer(transfer);
426 g_free(buf);
427 return SR_ERR;
428 }
429 devc->reply_size = 0;
0acdd793 430
91b77e6b
LPC
431 sr_sw_limits_acquisition_start(&devc->sw_limits);
432
0acdd793
BV
433 return SR_OK;
434}
435
695dc859 436static int dev_acquisition_stop(struct sr_dev_inst *sdi)
0acdd793 437{
0acdd793
BV
438 if (sdi->status != SR_ST_ACTIVE)
439 return SR_ERR_DEV_CLOSED;
440
6dcb9723 441 sdi->status = SR_ST_STOPPING;
0acdd793
BV
442
443 return SR_OK;
444}
445
446SR_PRIV struct sr_dev_driver testo_driver_info = {
447 .name = "testo",
448 .longname = "Testo",
449 .api_version = 1,
450 .init = init,
700d6b64 451 .cleanup = std_cleanup,
0acdd793 452 .scan = scan,
c01bf34c 453 .dev_list = std_dev_list,
0acdd793
BV
454 .config_get = config_get,
455 .config_set = config_set,
456 .config_list = config_list,
457 .dev_open = dev_open,
458 .dev_close = dev_close,
459 .dev_acquisition_start = dev_acquisition_start,
460 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 461 .context = NULL,
0acdd793 462};