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