]> sigrok.org Git - libsigrok.git/blame - hardware/testo/api.c
testo: More robust probing and packet checking.
[libsigrok.git] / 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
6dcb9723
BV
20#include <string.h>
21#include <libserialport.h>
0acdd793
BV
22#include "protocol.h"
23
6dcb9723
BV
24#define SERIALCOMM "115200/8n1"
25
0acdd793
BV
26SR_PRIV struct sr_dev_driver testo_driver_info;
27static struct sr_dev_driver *di = &testo_driver_info;
6dcb9723
BV
28static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
29
30static const int32_t scanopts[] = {
31 SR_CONF_CONN,
32};
33
34static const int32_t devopts[] = {
35 SR_CONF_MULTIMETER,
36 SR_CONF_LIMIT_MSEC,
37 SR_CONF_LIMIT_SAMPLES,
38 SR_CONF_CONTINUOUS,
39};
40
41unsigned char TESTO_x35_REQUEST[] = { 0x12, 0, 0, 0, 1, 1, 0x55, 0xd1, 0xb7 };
42struct testo_model models[] = {
43 { "435", 9, TESTO_x35_REQUEST },
44};
0acdd793
BV
45
46static int init(struct sr_context *sr_ctx)
47{
48 return std_init(sr_ctx, di, LOG_PREFIX);
49}
50
51static GSList *scan(GSList *options)
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;
62 int devcnt, ret, i;
63 const char *str;
64 char manufacturer[64], product[64];
0acdd793
BV
65
66 devices = NULL;
67 drvc = di->priv;
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
95 if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
96 sr_warn("Failed to get device descriptor: %s.",
97 libusb_error_name(ret));
98 continue;
99 }
100
101 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
102 continue;
103
104 manufacturer[0] = product[0] = '\0';
105 if (des.iManufacturer && (ret = libusb_get_string_descriptor_ascii(
106 hdl, des.iManufacturer, (unsigned char *) manufacturer,
107 sizeof(manufacturer))) < 0) {
108 sr_warn("Failed to get manufacturer string descriptor: %s.",
109 libusb_error_name(ret));
110 }
111 if (des.iProduct && (ret = libusb_get_string_descriptor_ascii(
112 hdl, des.iProduct, (unsigned char *) product,
113 sizeof(product))) < 0) {
114 sr_warn("Failed to get product string descriptor: %s.",
115 libusb_error_name(ret));
116 }
117 libusb_close(hdl);
118
119 if (strncmp(manufacturer, "testo", 5))
120 continue;
121
122 /* Hardcode the 435 for now.*/
123 if (strcmp(product, "testo 435/635/735"))
124 continue;
125
126 devcnt = g_slist_length(drvc->instances);
127 sdi = sr_dev_inst_new(devcnt, SR_ST_INACTIVE, "Testo",
128 "435/635/735", NULL);
129 sdi->driver = di;
130 sdi->inst_type = SR_INST_USB;
131 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
132 libusb_get_device_address(devlist[i]), NULL);
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
149static GSList *dev_list(void)
150{
151 return ((struct drv_context *)(di->priv))->instances;
152}
153
154static int dev_clear(void)
155{
156 return std_dev_clear(di, NULL);
157}
158
159static int dev_open(struct sr_dev_inst *sdi)
160{
6dcb9723
BV
161 struct drv_context *drvc = di->priv;
162 struct sr_usb_dev_inst *usb;
163 libusb_device **devlist;
164 int ret, i;
165
166 if (!di->priv) {
167 sr_err("Driver was not initialized.");
168 return SR_ERR;
169 }
0acdd793 170
6dcb9723
BV
171 usb = sdi->conn;
172 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
173 for (i = 0; devlist[i]; i++) {
174 if (libusb_get_bus_number(devlist[i]) != usb->bus
175 || libusb_get_device_address(devlist[i]) != usb->address)
176 continue;
177 if ((ret = libusb_open(devlist[i], &usb->devhdl))) {
178 sr_err("Failed to open device: %s.", libusb_error_name(ret));
179 return SR_ERR;
180 }
181 break;
182 }
183 libusb_free_device_list(devlist, 1);
184 if (!devlist[i]) {
185 sr_err("Device not found.");
186 return SR_ERR;
187 }
0acdd793 188
6dcb9723
BV
189 if ((ret = libusb_claim_interface(usb->devhdl, 0))) {
190 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
191 return SR_ERR;
192 }
0acdd793
BV
193 sdi->status = SR_ST_ACTIVE;
194
195 return SR_OK;
196}
197
198static int dev_close(struct sr_dev_inst *sdi)
199{
6dcb9723
BV
200 struct sr_usb_dev_inst *usb;
201
202 if (!di->priv) {
203 sr_err("Driver was not initialized.");
204 return SR_ERR;
205 }
0acdd793 206
6dcb9723
BV
207 usb = sdi->conn;
208 if (!usb->devhdl)
209 /* Nothing to do. */
210 return SR_OK;
0acdd793 211
6dcb9723
BV
212 libusb_release_interface(usb->devhdl, 0);
213 libusb_close(usb->devhdl);
214 usb->devhdl = NULL;
0acdd793
BV
215 sdi->status = SR_ST_INACTIVE;
216
217 return SR_OK;
218}
219
220static int cleanup(void)
221{
6dcb9723
BV
222 int ret;
223 struct drv_context *drvc;
0acdd793 224
6dcb9723
BV
225 if (!(drvc = di->priv))
226 return SR_OK;
0acdd793 227
6dcb9723
BV
228 ret = dev_clear();
229 g_free(drvc);
230 di->priv = NULL;
231
232 return ret;
0acdd793
BV
233}
234
235static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
236 const struct sr_channel_group *cg)
237{
6dcb9723
BV
238 struct sr_usb_dev_inst *usb;
239 char str[128];
0acdd793 240
0acdd793
BV
241 (void)cg;
242
0acdd793 243 switch (key) {
6dcb9723
BV
244 case SR_CONF_CONN:
245 if (!sdi || !sdi->conn)
246 return SR_ERR_ARG;
247 usb = sdi->conn;
248 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
249 *data = g_variant_new_string(str);
250 break;
0acdd793
BV
251 default:
252 return SR_ERR_NA;
253 }
254
6dcb9723 255 return SR_OK;
0acdd793
BV
256}
257
258static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
259 const struct sr_channel_group *cg)
260{
6dcb9723
BV
261 struct dev_context *devc;
262 gint64 now;
0acdd793
BV
263 int ret;
264
0acdd793
BV
265 (void)cg;
266
267 if (sdi->status != SR_ST_ACTIVE)
268 return SR_ERR_DEV_CLOSED;
269
6dcb9723
BV
270 if (!di->priv) {
271 sr_err("Driver was not initialized.");
272 return SR_ERR;
273 }
274
275 devc = sdi->priv;
0acdd793
BV
276 ret = SR_OK;
277 switch (key) {
6dcb9723
BV
278 case SR_CONF_LIMIT_MSEC:
279 devc->limit_msec = g_variant_get_uint64(data);
280 now = g_get_monotonic_time() / 1000;
281 devc->end_time = now + devc->limit_msec;
282 sr_dbg("Setting time limit to %" PRIu64 "ms.",
283 devc->limit_msec);
284 break;
285 case SR_CONF_LIMIT_SAMPLES:
286 devc->limit_samples = g_variant_get_uint64(data);
287 sr_dbg("Setting sample limit to %" PRIu64 ".",
288 devc->limit_samples);
289 break;
0acdd793
BV
290 default:
291 ret = SR_ERR_NA;
292 }
293
294 return ret;
295}
296
297static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
298 const struct sr_channel_group *cg)
299{
0acdd793 300 (void)sdi;
0acdd793
BV
301 (void)cg;
302
0acdd793 303 switch (key) {
6dcb9723
BV
304 case SR_CONF_SCAN_OPTIONS:
305 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
306 scanopts, ARRAY_SIZE(scanopts), sizeof(int32_t));
307 break;
308 case SR_CONF_DEVICE_OPTIONS:
309 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
310 devopts, ARRAY_SIZE(devopts), sizeof(int32_t));
311 break;
0acdd793
BV
312 default:
313 return SR_ERR_NA;
314 }
315
6dcb9723 316 return SR_OK;
0acdd793
BV
317}
318
6dcb9723 319static void receive_data(struct sr_dev_inst *sdi, unsigned char *data, int len)
0acdd793 320{
6dcb9723
BV
321 struct dev_context *devc;
322 int packet_size;
87895640 323 uint16_t crc;
6dcb9723
BV
324
325 devc = sdi->priv;
326
327 if (devc->reply_size + len > MAX_REPLY_SIZE) {
328 /* Something went very wrong. */
329 sr_dbg("Receive buffer overrun.");
330 devc->reply_size = 0;
331 return;
332 }
333
334 memcpy(devc->reply + devc->reply_size, data, len);
335 devc->reply_size += len;
336 /* Sixth byte contains the length of the packet. */
87895640
BV
337 if (devc->reply_size < 7)
338 return;
339
340 packet_size = 7 + devc->reply[6] * 7 + 2;
341 if (devc->reply_size < packet_size)
342 return;
343
344 if (!testo_check_packet_prefix(devc->reply, devc->reply_size))
345 return;
346
347 crc = crc16_mcrf4xx(0xffff, devc->reply, devc->reply_size - 2);
348 if ((crc & 0xff) == devc->reply[devc->reply_size - 2]
349 && (crc >> 8) == devc->reply[devc->reply_size - 1]) {
350 testo_receive_packet(sdi);
351 devc->num_samples++;
352 } else {
353 sr_dbg("Packet has invalid CRC.");
6dcb9723
BV
354 }
355
87895640
BV
356 devc->reply_size = 0;
357 if (devc->limit_samples && devc->num_samples >= devc->limit_samples)
358 dev_acquisition_stop(sdi, devc->cb_data);
359 else
360 testo_request_packet(sdi);
361
6dcb9723
BV
362}
363
364SR_PRIV void receive_transfer(struct libusb_transfer *transfer)
365{
366 struct dev_context *devc;
367 struct sr_dev_inst *sdi;
368 int ret;
369
370 sdi = transfer->user_data;
371 devc = sdi->priv;
372 if (transfer == devc->out_transfer)
373 /* Just the command acknowledgement. */
374 return;
375
376 if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
377 /* USB device was unplugged. */
378 dev_acquisition_stop(sdi, devc->cb_data);
379 } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
380 /* First two bytes in any transfer are FTDI status bytes. */
381 if (transfer->actual_length > 2)
382 receive_data(sdi, transfer->buffer + 2, transfer->actual_length - 2);
383 }
384 /* Anything else is either an error or a timeout, which is fine:
385 * we were just going to send another transfer request anyway. */
386
387 if (sdi->status == SR_ST_ACTIVE) {
388 if ((ret = libusb_submit_transfer(transfer) != 0)) {
389 sr_err("Unable to resubmit transfer: %s.",
390 libusb_error_name(ret));
391 g_free(transfer->buffer);
392 libusb_free_transfer(transfer);
393 dev_acquisition_stop(sdi, devc->cb_data);
394 }
395 } else {
396 /* This was the last transfer we're going to receive, so
397 * clean up now. */
398 g_free(transfer->buffer);
399 libusb_free_transfer(transfer);
400 }
401}
402
403static int handle_events(int fd, int revents, void *cb_data)
404{
405 struct dev_context *devc;
406 struct drv_context *drvc = di->priv;
407 struct sr_datafeed_packet packet;
408 struct sr_dev_inst *sdi;
409 struct timeval tv;
410 gint64 now;
411
412 (void)fd;
413 (void)revents;
414
415 sdi = cb_data;
416 devc = sdi->priv;
417
418 if (devc->limit_msec) {
419 now = g_get_monotonic_time() / 1000;
420 if (now > devc->end_time)
421 dev_acquisition_stop(sdi, devc->cb_data);
422 }
423
424 if (sdi->status == SR_ST_STOPPING) {
425 usb_source_remove(drvc->sr_ctx);
426
427 dev_close(sdi);
428
429 packet.type = SR_DF_END;
430 sr_session_send(sdi, &packet);
431 }
432
433 memset(&tv, 0, sizeof(struct timeval));
434 libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
435 NULL);
436
437 return TRUE;
438}
439
440static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
441{
442 struct drv_context *drvc;
443 struct dev_context *devc;
444 struct sr_usb_dev_inst *usb;
445 struct libusb_transfer *transfer;
446 int ret;
447 unsigned char *buf;
0acdd793 448
6dcb9723 449 drvc = di->priv;
0acdd793
BV
450 if (sdi->status != SR_ST_ACTIVE)
451 return SR_ERR_DEV_CLOSED;
452
6dcb9723
BV
453 if (!di->priv) {
454 sr_err("Driver was not initialized.");
455 return SR_ERR;
456 }
457
458 devc = sdi->priv;
459 usb = sdi->conn;
460 devc->cb_data = cb_data;
461 devc->end_time = 0;
462 devc->num_samples = 0;
463 devc->reply_size = 0;
464
465 /* Send header packet to the session bus. */
466 std_session_send_df_header(cb_data, LOG_PREFIX);
467
468 usb_source_add(drvc->sr_ctx, 100, handle_events, (void *)sdi);
469
470 if (testo_set_serial_params(usb) != SR_OK)
471 return SR_ERR;
472
473 devc->out_transfer = libusb_alloc_transfer(0);
474 if (testo_request_packet(sdi) != SR_OK)
475 return SR_ERR;
476
477 buf = g_try_malloc(MAX_REPLY_SIZE);
478 transfer = libusb_alloc_transfer(0);
479 libusb_fill_bulk_transfer(transfer, usb->devhdl, EP_IN, buf,
480 MAX_REPLY_SIZE, receive_transfer, (void *)sdi, 100);
481 if ((ret = libusb_submit_transfer(transfer) != 0)) {
482 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
483 libusb_free_transfer(transfer);
484 g_free(buf);
485 return SR_ERR;
486 }
487 devc->reply_size = 0;
0acdd793
BV
488
489 return SR_OK;
490}
491
492static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
493{
494 (void)cb_data;
495
6dcb9723
BV
496 if (!di->priv) {
497 sr_err("Driver was not initialized.");
498 return SR_ERR;
499 }
500
0acdd793
BV
501 if (sdi->status != SR_ST_ACTIVE)
502 return SR_ERR_DEV_CLOSED;
503
6dcb9723 504 sdi->status = SR_ST_STOPPING;
0acdd793
BV
505
506 return SR_OK;
507}
508
509SR_PRIV struct sr_dev_driver testo_driver_info = {
510 .name = "testo",
511 .longname = "Testo",
512 .api_version = 1,
513 .init = init,
514 .cleanup = cleanup,
515 .scan = scan,
516 .dev_list = dev_list,
517 .dev_clear = dev_clear,
518 .config_get = config_get,
519 .config_set = config_set,
520 .config_list = config_list,
521 .dev_open = dev_open,
522 .dev_close = dev_close,
523 .dev_acquisition_start = dev_acquisition_start,
524 .dev_acquisition_stop = dev_acquisition_stop,
525 .priv = NULL,
526};