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