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