]> sigrok.org Git - libsigrok.git/blame - src/hardware/testo/api.c
Introduce standard cleanup helper
[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,
5827f61b
BV
36 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
37 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
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];
135 devc->limit_msec = 0;
136 devc->limit_samples = 0;
137 sdi->priv = devc;
138 if (testo_probe_channels(sdi) != SR_OK)
139 continue;
140 drvc->instances = g_slist_append(drvc->instances, sdi);
141 devices = g_slist_append(devices, sdi);
142 }
143 libusb_free_device_list(devlist, 1);
144 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
0acdd793
BV
145
146 return devices;
147}
148
4f840ce9 149static GSList *dev_list(const struct sr_dev_driver *di)
0acdd793 150{
41812aca 151 return ((struct drv_context *)(di->context))->instances;
0acdd793
BV
152}
153
4f840ce9 154static int dev_clear(const struct sr_dev_driver *di)
0acdd793
BV
155{
156 return std_dev_clear(di, NULL);
157}
158
159static int dev_open(struct sr_dev_inst *sdi)
160{
4f840ce9 161 struct sr_dev_driver *di = sdi->driver;
41812aca 162 struct drv_context *drvc = di->context;
6dcb9723
BV
163 struct sr_usb_dev_inst *usb;
164 libusb_device **devlist;
165 int ret, i;
bde9fbd1 166 char connection_id[64];
6dcb9723 167
41812aca 168 if (!di->context) {
6dcb9723
BV
169 sr_err("Driver was not initialized.");
170 return SR_ERR;
171 }
0acdd793 172
6dcb9723
BV
173 usb = sdi->conn;
174 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
175 for (i = 0; devlist[i]; i++) {
bde9fbd1
SA
176 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
177 if (strcmp(sdi->connection_id, connection_id))
6dcb9723
BV
178 continue;
179 if ((ret = libusb_open(devlist[i], &usb->devhdl))) {
180 sr_err("Failed to open device: %s.", libusb_error_name(ret));
181 return SR_ERR;
182 }
183 break;
184 }
185 libusb_free_device_list(devlist, 1);
186 if (!devlist[i]) {
187 sr_err("Device not found.");
188 return SR_ERR;
189 }
0acdd793 190
88b1d4e5
BV
191 if (libusb_has_capability(LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER)) {
192 if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
193 if ((ret = libusb_detach_kernel_driver(usb->devhdl, 0)) < 0) {
194 sr_err("Failed to detach kernel driver: %s.",
195 libusb_error_name(ret));
196 return SR_ERR;
197 }
198 }
199 }
200
6dcb9723
BV
201 if ((ret = libusb_claim_interface(usb->devhdl, 0))) {
202 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
203 return SR_ERR;
204 }
0acdd793
BV
205 sdi->status = SR_ST_ACTIVE;
206
207 return SR_OK;
208}
209
210static int dev_close(struct sr_dev_inst *sdi)
211{
4f840ce9 212 struct sr_dev_driver *di = sdi->driver;
6dcb9723
BV
213 struct sr_usb_dev_inst *usb;
214
41812aca 215 if (!di->context) {
6dcb9723
BV
216 sr_err("Driver was not initialized.");
217 return SR_ERR;
218 }
0acdd793 219
6dcb9723
BV
220 usb = sdi->conn;
221 if (!usb->devhdl)
222 /* Nothing to do. */
223 return SR_OK;
0acdd793 224
6dcb9723
BV
225 libusb_release_interface(usb->devhdl, 0);
226 libusb_close(usb->devhdl);
227 usb->devhdl = NULL;
0acdd793
BV
228 sdi->status = SR_ST_INACTIVE;
229
230 return SR_OK;
231}
232
584560f1 233static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
0acdd793
BV
234 const struct sr_channel_group *cg)
235{
6dcb9723
BV
236 struct sr_usb_dev_inst *usb;
237 char str[128];
0acdd793 238
0acdd793
BV
239 (void)cg;
240
0acdd793 241 switch (key) {
6dcb9723
BV
242 case SR_CONF_CONN:
243 if (!sdi || !sdi->conn)
244 return SR_ERR_ARG;
245 usb = sdi->conn;
246 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
247 *data = g_variant_new_string(str);
248 break;
0acdd793
BV
249 default:
250 return SR_ERR_NA;
251 }
252
6dcb9723 253 return SR_OK;
0acdd793
BV
254}
255
584560f1 256static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
0acdd793
BV
257 const struct sr_channel_group *cg)
258{
4f840ce9 259 struct sr_dev_driver *di = sdi->driver;
6dcb9723
BV
260 struct dev_context *devc;
261 gint64 now;
0acdd793
BV
262 int ret;
263
0acdd793
BV
264 (void)cg;
265
266 if (sdi->status != SR_ST_ACTIVE)
267 return SR_ERR_DEV_CLOSED;
268
41812aca 269 if (!di->context) {
6dcb9723
BV
270 sr_err("Driver was not initialized.");
271 return SR_ERR;
272 }
273
274 devc = sdi->priv;
0acdd793
BV
275 ret = SR_OK;
276 switch (key) {
6dcb9723
BV
277 case SR_CONF_LIMIT_MSEC:
278 devc->limit_msec = g_variant_get_uint64(data);
279 now = g_get_monotonic_time() / 1000;
280 devc->end_time = now + devc->limit_msec;
6dcb9723
BV
281 break;
282 case SR_CONF_LIMIT_SAMPLES:
283 devc->limit_samples = g_variant_get_uint64(data);
6dcb9723 284 break;
0acdd793
BV
285 default:
286 ret = SR_ERR_NA;
287 }
288
289 return ret;
290}
291
584560f1 292static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
0acdd793
BV
293 const struct sr_channel_group *cg)
294{
0acdd793 295 (void)sdi;
0acdd793
BV
296 (void)cg;
297
0acdd793 298 switch (key) {
6dcb9723 299 case SR_CONF_SCAN_OPTIONS:
584560f1
BV
300 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
301 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
6dcb9723
BV
302 break;
303 case SR_CONF_DEVICE_OPTIONS:
584560f1
BV
304 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
305 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
6dcb9723 306 break;
0acdd793
BV
307 default:
308 return SR_ERR_NA;
309 }
310
6dcb9723 311 return SR_OK;
0acdd793
BV
312}
313
6dcb9723 314static void receive_data(struct sr_dev_inst *sdi, unsigned char *data, int len)
0acdd793 315{
6dcb9723
BV
316 struct dev_context *devc;
317 int packet_size;
87895640 318 uint16_t crc;
6dcb9723
BV
319
320 devc = sdi->priv;
321
322 if (devc->reply_size + len > MAX_REPLY_SIZE) {
323 /* Something went very wrong. */
324 sr_dbg("Receive buffer overrun.");
325 devc->reply_size = 0;
326 return;
327 }
328
329 memcpy(devc->reply + devc->reply_size, data, len);
330 devc->reply_size += len;
331 /* Sixth byte contains the length of the packet. */
87895640
BV
332 if (devc->reply_size < 7)
333 return;
334
335 packet_size = 7 + devc->reply[6] * 7 + 2;
336 if (devc->reply_size < packet_size)
337 return;
338
339 if (!testo_check_packet_prefix(devc->reply, devc->reply_size))
340 return;
341
342 crc = crc16_mcrf4xx(0xffff, devc->reply, devc->reply_size - 2);
88b1d4e5 343 if (crc == RL16(&devc->reply[devc->reply_size - 2])) {
87895640
BV
344 testo_receive_packet(sdi);
345 devc->num_samples++;
346 } else {
347 sr_dbg("Packet has invalid CRC.");
6dcb9723
BV
348 }
349
87895640
BV
350 devc->reply_size = 0;
351 if (devc->limit_samples && devc->num_samples >= devc->limit_samples)
695dc859 352 dev_acquisition_stop(sdi);
87895640
BV
353 else
354 testo_request_packet(sdi);
355
6dcb9723
BV
356}
357
55462b8b 358SR_PRIV void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
6dcb9723
BV
359{
360 struct dev_context *devc;
361 struct sr_dev_inst *sdi;
362 int ret;
363
364 sdi = transfer->user_data;
365 devc = sdi->priv;
366 if (transfer == devc->out_transfer)
367 /* Just the command acknowledgement. */
368 return;
369
370 if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
371 /* USB device was unplugged. */
695dc859 372 dev_acquisition_stop(sdi);
6dcb9723
BV
373 } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
374 /* First two bytes in any transfer are FTDI status bytes. */
375 if (transfer->actual_length > 2)
376 receive_data(sdi, transfer->buffer + 2, transfer->actual_length - 2);
377 }
378 /* Anything else is either an error or a timeout, which is fine:
379 * we were just going to send another transfer request anyway. */
380
381 if (sdi->status == SR_ST_ACTIVE) {
382 if ((ret = libusb_submit_transfer(transfer) != 0)) {
383 sr_err("Unable to resubmit transfer: %s.",
384 libusb_error_name(ret));
385 g_free(transfer->buffer);
386 libusb_free_transfer(transfer);
695dc859 387 dev_acquisition_stop(sdi);
6dcb9723
BV
388 }
389 } else {
390 /* This was the last transfer we're going to receive, so
391 * clean up now. */
392 g_free(transfer->buffer);
393 libusb_free_transfer(transfer);
394 }
395}
396
397static int handle_events(int fd, int revents, void *cb_data)
398{
4f840ce9 399 struct sr_dev_driver *di;
6dcb9723 400 struct dev_context *devc;
4f840ce9 401 struct drv_context *drvc;
6dcb9723
BV
402 struct sr_dev_inst *sdi;
403 struct timeval tv;
404 gint64 now;
405
406 (void)fd;
407 (void)revents;
408
409 sdi = cb_data;
410 devc = sdi->priv;
4f840ce9 411 di = sdi->driver;
41812aca 412 drvc = di->context;
6dcb9723
BV
413
414 if (devc->limit_msec) {
415 now = g_get_monotonic_time() / 1000;
416 if (now > devc->end_time)
695dc859 417 dev_acquisition_stop(sdi);
6dcb9723
BV
418 }
419
420 if (sdi->status == SR_ST_STOPPING) {
102f1239 421 usb_source_remove(sdi->session, drvc->sr_ctx);
6dcb9723 422 dev_close(sdi);
3be42bc2 423 std_session_send_df_end(sdi, LOG_PREFIX);
6dcb9723
BV
424 }
425
426 memset(&tv, 0, sizeof(struct timeval));
427 libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
428 NULL);
429
430 return TRUE;
431}
432
695dc859 433static int dev_acquisition_start(const struct sr_dev_inst *sdi)
6dcb9723 434{
4f840ce9 435 struct sr_dev_driver *di = sdi->driver;
6dcb9723
BV
436 struct drv_context *drvc;
437 struct dev_context *devc;
438 struct sr_usb_dev_inst *usb;
439 struct libusb_transfer *transfer;
440 int ret;
441 unsigned char *buf;
0acdd793 442
41812aca 443 drvc = di->context;
0acdd793
BV
444 if (sdi->status != SR_ST_ACTIVE)
445 return SR_ERR_DEV_CLOSED;
446
41812aca 447 if (!di->context) {
6dcb9723
BV
448 sr_err("Driver was not initialized.");
449 return SR_ERR;
450 }
451
452 devc = sdi->priv;
453 usb = sdi->conn;
6dcb9723
BV
454 devc->end_time = 0;
455 devc->num_samples = 0;
456 devc->reply_size = 0;
457
695dc859 458 std_session_send_df_header(sdi, LOG_PREFIX);
6dcb9723 459
102f1239
BV
460 usb_source_add(sdi->session, drvc->sr_ctx, 100,
461 handle_events, (void *)sdi);
6dcb9723
BV
462
463 if (testo_set_serial_params(usb) != SR_OK)
464 return SR_ERR;
465
466 devc->out_transfer = libusb_alloc_transfer(0);
467 if (testo_request_packet(sdi) != SR_OK)
468 return SR_ERR;
469
a95f142e 470 buf = g_malloc(MAX_REPLY_SIZE);
6dcb9723
BV
471 transfer = libusb_alloc_transfer(0);
472 libusb_fill_bulk_transfer(transfer, usb->devhdl, EP_IN, buf,
473 MAX_REPLY_SIZE, receive_transfer, (void *)sdi, 100);
474 if ((ret = libusb_submit_transfer(transfer) != 0)) {
475 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
476 libusb_free_transfer(transfer);
477 g_free(buf);
478 return SR_ERR;
479 }
480 devc->reply_size = 0;
0acdd793
BV
481
482 return SR_OK;
483}
484
695dc859 485static int dev_acquisition_stop(struct sr_dev_inst *sdi)
0acdd793 486{
4f840ce9 487 struct sr_dev_driver *di = sdi->driver;
0acdd793 488
41812aca 489 if (!di->context) {
6dcb9723
BV
490 sr_err("Driver was not initialized.");
491 return SR_ERR;
492 }
493
0acdd793
BV
494 if (sdi->status != SR_ST_ACTIVE)
495 return SR_ERR_DEV_CLOSED;
496
6dcb9723 497 sdi->status = SR_ST_STOPPING;
0acdd793
BV
498
499 return SR_OK;
500}
501
502SR_PRIV struct sr_dev_driver testo_driver_info = {
503 .name = "testo",
504 .longname = "Testo",
505 .api_version = 1,
506 .init = init,
700d6b64 507 .cleanup = std_cleanup,
0acdd793
BV
508 .scan = scan,
509 .dev_list = dev_list,
510 .dev_clear = dev_clear,
511 .config_get = config_get,
512 .config_set = config_set,
513 .config_list = config_list,
514 .dev_open = dev_open,
515 .dev_close = dev_close,
516 .dev_acquisition_start = dev_acquisition_start,
517 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 518 .context = NULL,
0acdd793 519};