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