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