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