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