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