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