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