]> sigrok.org Git - libsigrok.git/blame - src/hardware/testo/api.c
Don't reset instance list in scan() 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 24#define SERIALCOMM "115200/8n1"
695dc859 25static int dev_acquisition_stop(struct sr_dev_inst *sdi);
6dcb9723 26
584560f1 27static const uint32_t scanopts[] = {
6dcb9723
BV
28 SR_CONF_CONN,
29};
30
584560f1 31static const uint32_t devopts[] = {
6dcb9723 32 SR_CONF_MULTIMETER,
6dcb9723 33 SR_CONF_CONTINUOUS,
91b77e6b
LPC
34 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_GET,
35 SR_CONF_LIMIT_MSEC | SR_CONF_SET | SR_CONF_GET,
6dcb9723
BV
36};
37
329733d9
UH
38static const uint8_t TESTO_x35_REQUEST[] = { 0x12, 0, 0, 0, 1, 1, 0x55, 0xd1, 0xb7 };
39
40static const struct testo_model models[] = {
6dcb9723
BV
41 { "435", 9, TESTO_x35_REQUEST },
42};
0acdd793 43
4f840ce9 44static GSList *scan(struct sr_dev_driver *di, GSList *options)
0acdd793
BV
45{
46 struct drv_context *drvc;
6dcb9723
BV
47 struct dev_context *devc;
48 struct sr_config *src;
49 struct sr_dev_inst *sdi;
50 struct sr_usb_dev_inst *usb;
51 struct libusb_device_descriptor des;
52 libusb_device **devlist;
53 struct libusb_device_handle *hdl;
54 GSList *conn_devices, *devices, *l;
bde9fbd1 55 int ret, i;
6dcb9723 56 const char *str;
bde9fbd1 57 char manufacturer[64], product[64], connection_id[64];
0acdd793
BV
58
59 devices = NULL;
41812aca 60 drvc = di->context;
0acdd793 61
6dcb9723
BV
62 conn_devices = NULL;
63 for (l = options; l; l = l->next) {
64 src = l->data;
65 if (src->key != SR_CONF_CONN)
66 continue;
67 str = g_variant_get_string(src->data, NULL);
68 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, str);
69 }
70
71 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
72 for (i = 0; devlist[i]; i++) {
73 if (conn_devices) {
74 usb = NULL;
75 for (l = conn_devices; l; l = l->next) {
76 usb = l->data;
77 if (usb->bus == libusb_get_bus_number(devlist[i])
78 && usb->address == libusb_get_device_address(devlist[i]))
79 break;
80 }
81 if (!l)
82 /* This device matched none of the ones that
83 * matched the conn specification. */
84 continue;
85 }
86
2a8f2d41 87 libusb_get_device_descriptor(devlist[i], &des);
6dcb9723
BV
88
89 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
90 continue;
91
92 manufacturer[0] = product[0] = '\0';
93 if (des.iManufacturer && (ret = libusb_get_string_descriptor_ascii(
94 hdl, des.iManufacturer, (unsigned char *) manufacturer,
95 sizeof(manufacturer))) < 0) {
96 sr_warn("Failed to get manufacturer string descriptor: %s.",
97 libusb_error_name(ret));
98 }
99 if (des.iProduct && (ret = libusb_get_string_descriptor_ascii(
100 hdl, des.iProduct, (unsigned char *) product,
101 sizeof(product))) < 0) {
102 sr_warn("Failed to get product string descriptor: %s.",
103 libusb_error_name(ret));
104 }
105 libusb_close(hdl);
106
107 if (strncmp(manufacturer, "testo", 5))
108 continue;
109
bde9fbd1
SA
110 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
111
6dcb9723
BV
112 /* Hardcode the 435 for now.*/
113 if (strcmp(product, "testo 435/635/735"))
114 continue;
115
aac29cc1 116 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be
UH
117 sdi->status = SR_ST_INACTIVE;
118 sdi->vendor = g_strdup("Testo");
119 sdi->model = g_strdup("435/635/735");
6dcb9723
BV
120 sdi->driver = di;
121 sdi->inst_type = SR_INST_USB;
122 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
123 libusb_get_device_address(devlist[i]), NULL);
bde9fbd1 124 sdi->connection_id = g_strdup(connection_id);
6dcb9723
BV
125 devc = g_malloc(sizeof(struct dev_context));
126 devc->model = &models[0];
91b77e6b 127 sr_sw_limits_init(&devc->sw_limits);
6dcb9723
BV
128 sdi->priv = devc;
129 if (testo_probe_channels(sdi) != SR_OK)
130 continue;
131 drvc->instances = g_slist_append(drvc->instances, sdi);
132 devices = g_slist_append(devices, sdi);
133 }
134 libusb_free_device_list(devlist, 1);
135 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
0acdd793
BV
136
137 return devices;
138}
139
0acdd793
BV
140static int dev_open(struct sr_dev_inst *sdi)
141{
4f840ce9 142 struct sr_dev_driver *di = sdi->driver;
41812aca 143 struct drv_context *drvc = di->context;
6dcb9723 144 struct sr_usb_dev_inst *usb;
b75dc14a 145 int ret;
6dcb9723 146
6dcb9723 147 usb = sdi->conn;
b75dc14a
LPC
148
149 ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
150 if (ret != SR_OK)
151 return ret;
0acdd793 152
88b1d4e5
BV
153 if (libusb_has_capability(LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER)) {
154 if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
155 if ((ret = libusb_detach_kernel_driver(usb->devhdl, 0)) < 0) {
156 sr_err("Failed to detach kernel driver: %s.",
157 libusb_error_name(ret));
158 return SR_ERR;
159 }
160 }
161 }
162
6dcb9723
BV
163 if ((ret = libusb_claim_interface(usb->devhdl, 0))) {
164 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
165 return SR_ERR;
166 }
0acdd793
BV
167 sdi->status = SR_ST_ACTIVE;
168
169 return SR_OK;
170}
171
172static int dev_close(struct sr_dev_inst *sdi)
173{
6dcb9723
BV
174 struct sr_usb_dev_inst *usb;
175
6dcb9723
BV
176 usb = sdi->conn;
177 if (!usb->devhdl)
178 /* Nothing to do. */
179 return SR_OK;
0acdd793 180
6dcb9723
BV
181 libusb_release_interface(usb->devhdl, 0);
182 libusb_close(usb->devhdl);
183 usb->devhdl = NULL;
0acdd793
BV
184 sdi->status = SR_ST_INACTIVE;
185
186 return SR_OK;
187}
188
584560f1 189static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
0acdd793
BV
190 const struct sr_channel_group *cg)
191{
91b77e6b 192 struct dev_context *devc = sdi->priv;
6dcb9723
BV
193 struct sr_usb_dev_inst *usb;
194 char str[128];
0acdd793 195
0acdd793
BV
196 (void)cg;
197
0acdd793 198 switch (key) {
6dcb9723
BV
199 case SR_CONF_CONN:
200 if (!sdi || !sdi->conn)
201 return SR_ERR_ARG;
202 usb = sdi->conn;
203 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
204 *data = g_variant_new_string(str);
205 break;
91b77e6b
LPC
206 case SR_CONF_LIMIT_MSEC:
207 case SR_CONF_LIMIT_SAMPLES:
208 return sr_sw_limits_config_get(&devc->sw_limits, key, data);
0acdd793
BV
209 default:
210 return SR_ERR_NA;
211 }
212
6dcb9723 213 return SR_OK;
0acdd793
BV
214}
215
584560f1 216static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
0acdd793
BV
217 const struct sr_channel_group *cg)
218{
91b77e6b 219 struct dev_context *devc = sdi->priv;
0acdd793 220
0acdd793
BV
221 (void)cg;
222
223 if (sdi->status != SR_ST_ACTIVE)
224 return SR_ERR_DEV_CLOSED;
225
91b77e6b 226 return sr_sw_limits_config_set(&devc->sw_limits, key, data);
0acdd793
BV
227}
228
584560f1 229static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
0acdd793
BV
230 const struct sr_channel_group *cg)
231{
0acdd793 232 (void)sdi;
0acdd793
BV
233 (void)cg;
234
0acdd793 235 switch (key) {
6dcb9723 236 case SR_CONF_SCAN_OPTIONS:
584560f1
BV
237 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
238 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
6dcb9723
BV
239 break;
240 case SR_CONF_DEVICE_OPTIONS:
584560f1
BV
241 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
242 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
6dcb9723 243 break;
0acdd793
BV
244 default:
245 return SR_ERR_NA;
246 }
247
6dcb9723 248 return SR_OK;
0acdd793
BV
249}
250
6dcb9723 251static void receive_data(struct sr_dev_inst *sdi, unsigned char *data, int len)
0acdd793 252{
6dcb9723
BV
253 struct dev_context *devc;
254 int packet_size;
87895640 255 uint16_t crc;
6dcb9723
BV
256
257 devc = sdi->priv;
258
259 if (devc->reply_size + len > MAX_REPLY_SIZE) {
260 /* Something went very wrong. */
261 sr_dbg("Receive buffer overrun.");
262 devc->reply_size = 0;
263 return;
264 }
265
266 memcpy(devc->reply + devc->reply_size, data, len);
267 devc->reply_size += len;
268 /* Sixth byte contains the length of the packet. */
87895640
BV
269 if (devc->reply_size < 7)
270 return;
271
272 packet_size = 7 + devc->reply[6] * 7 + 2;
273 if (devc->reply_size < packet_size)
274 return;
275
276 if (!testo_check_packet_prefix(devc->reply, devc->reply_size))
277 return;
278
279 crc = crc16_mcrf4xx(0xffff, devc->reply, devc->reply_size - 2);
88b1d4e5 280 if (crc == RL16(&devc->reply[devc->reply_size - 2])) {
87895640 281 testo_receive_packet(sdi);
91b77e6b 282 sr_sw_limits_update_samples_read(&devc->sw_limits, 1);
87895640
BV
283 } else {
284 sr_dbg("Packet has invalid CRC.");
6dcb9723
BV
285 }
286
87895640 287 devc->reply_size = 0;
91b77e6b 288 if (sr_sw_limits_check(&devc->sw_limits))
695dc859 289 dev_acquisition_stop(sdi);
87895640
BV
290 else
291 testo_request_packet(sdi);
292
6dcb9723
BV
293}
294
55462b8b 295SR_PRIV void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
6dcb9723
BV
296{
297 struct dev_context *devc;
298 struct sr_dev_inst *sdi;
299 int ret;
300
301 sdi = transfer->user_data;
302 devc = sdi->priv;
303 if (transfer == devc->out_transfer)
304 /* Just the command acknowledgement. */
305 return;
306
307 if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
308 /* USB device was unplugged. */
695dc859 309 dev_acquisition_stop(sdi);
6dcb9723
BV
310 } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
311 /* First two bytes in any transfer are FTDI status bytes. */
312 if (transfer->actual_length > 2)
313 receive_data(sdi, transfer->buffer + 2, transfer->actual_length - 2);
314 }
315 /* Anything else is either an error or a timeout, which is fine:
316 * we were just going to send another transfer request anyway. */
317
318 if (sdi->status == SR_ST_ACTIVE) {
319 if ((ret = libusb_submit_transfer(transfer) != 0)) {
320 sr_err("Unable to resubmit transfer: %s.",
321 libusb_error_name(ret));
322 g_free(transfer->buffer);
323 libusb_free_transfer(transfer);
695dc859 324 dev_acquisition_stop(sdi);
6dcb9723
BV
325 }
326 } else {
327 /* This was the last transfer we're going to receive, so
328 * clean up now. */
329 g_free(transfer->buffer);
330 libusb_free_transfer(transfer);
331 }
332}
333
334static int handle_events(int fd, int revents, void *cb_data)
335{
4f840ce9 336 struct sr_dev_driver *di;
6dcb9723 337 struct dev_context *devc;
4f840ce9 338 struct drv_context *drvc;
6dcb9723
BV
339 struct sr_dev_inst *sdi;
340 struct timeval tv;
6dcb9723
BV
341
342 (void)fd;
343 (void)revents;
344
345 sdi = cb_data;
346 devc = sdi->priv;
4f840ce9 347 di = sdi->driver;
41812aca 348 drvc = di->context;
6dcb9723 349
91b77e6b
LPC
350 if (sr_sw_limits_check(&devc->sw_limits))
351 dev_acquisition_stop(sdi);
6dcb9723
BV
352
353 if (sdi->status == SR_ST_STOPPING) {
102f1239 354 usb_source_remove(sdi->session, drvc->sr_ctx);
6dcb9723 355 dev_close(sdi);
3be42bc2 356 std_session_send_df_end(sdi, LOG_PREFIX);
6dcb9723
BV
357 }
358
359 memset(&tv, 0, sizeof(struct timeval));
360 libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
361 NULL);
362
363 return TRUE;
364}
365
695dc859 366static int dev_acquisition_start(const struct sr_dev_inst *sdi)
6dcb9723 367{
4f840ce9 368 struct sr_dev_driver *di = sdi->driver;
6dcb9723
BV
369 struct drv_context *drvc;
370 struct dev_context *devc;
371 struct sr_usb_dev_inst *usb;
372 struct libusb_transfer *transfer;
373 int ret;
374 unsigned char *buf;
0acdd793 375
41812aca 376 drvc = di->context;
0acdd793
BV
377 if (sdi->status != SR_ST_ACTIVE)
378 return SR_ERR_DEV_CLOSED;
379
6dcb9723
BV
380
381 devc = sdi->priv;
382 usb = sdi->conn;
6dcb9723
BV
383 devc->reply_size = 0;
384
695dc859 385 std_session_send_df_header(sdi, LOG_PREFIX);
6dcb9723 386
102f1239
BV
387 usb_source_add(sdi->session, drvc->sr_ctx, 100,
388 handle_events, (void *)sdi);
6dcb9723
BV
389
390 if (testo_set_serial_params(usb) != SR_OK)
391 return SR_ERR;
392
393 devc->out_transfer = libusb_alloc_transfer(0);
394 if (testo_request_packet(sdi) != SR_OK)
395 return SR_ERR;
396
a95f142e 397 buf = g_malloc(MAX_REPLY_SIZE);
6dcb9723
BV
398 transfer = libusb_alloc_transfer(0);
399 libusb_fill_bulk_transfer(transfer, usb->devhdl, EP_IN, buf,
400 MAX_REPLY_SIZE, receive_transfer, (void *)sdi, 100);
401 if ((ret = libusb_submit_transfer(transfer) != 0)) {
402 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
403 libusb_free_transfer(transfer);
404 g_free(buf);
405 return SR_ERR;
406 }
407 devc->reply_size = 0;
0acdd793 408
91b77e6b
LPC
409 sr_sw_limits_acquisition_start(&devc->sw_limits);
410
0acdd793
BV
411 return SR_OK;
412}
413
695dc859 414static int dev_acquisition_stop(struct sr_dev_inst *sdi)
0acdd793 415{
0acdd793
BV
416 if (sdi->status != SR_ST_ACTIVE)
417 return SR_ERR_DEV_CLOSED;
418
6dcb9723 419 sdi->status = SR_ST_STOPPING;
0acdd793
BV
420
421 return SR_OK;
422}
423
dd5c48a6 424static struct sr_dev_driver testo_driver_info = {
0acdd793
BV
425 .name = "testo",
426 .longname = "Testo",
427 .api_version = 1,
c2fdcc25 428 .init = std_init,
700d6b64 429 .cleanup = std_cleanup,
0acdd793 430 .scan = scan,
c01bf34c 431 .dev_list = std_dev_list,
0acdd793
BV
432 .config_get = config_get,
433 .config_set = config_set,
434 .config_list = config_list,
435 .dev_open = dev_open,
436 .dev_close = dev_close,
437 .dev_acquisition_start = dev_acquisition_start,
438 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 439 .context = NULL,
0acdd793 440};
dd5c48a6 441SR_REGISTER_DEV_DRIVER(testo_driver_info);