]> sigrok.org Git - libsigrok.git/blame - hardware/lascar-el-usb/api.c
sr_driver_init(): Improve checks.
[libsigrok.git] / hardware / lascar-el-usb / api.c
CommitLineData
46697e38
BV
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2012 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
20#include <glib.h>
851d5b22 21#include <libusb.h>
46697e38
BV
22#include "libsigrok.h"
23#include "libsigrok-internal.h"
24#include "protocol.h"
25
851d5b22 26SR_PRIV struct sr_dev_inst *lascar_scan(int bus, int address);
46697e38
BV
27SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
28static struct sr_dev_driver *di = &lascar_el_usb_driver_info;
851d5b22 29static int hw_dev_close(struct sr_dev_inst *sdi);
851d5b22
BV
30
31static const int hwopts[] = {
1953564a 32 SR_CONF_CONN,
851d5b22
BV
33 0,
34};
35
36static const int hwcaps[] = {
1953564a
BV
37 SR_CONF_THERMOMETER,
38 SR_CONF_HYGROMETER,
39 SR_CONF_LIMIT_SAMPLES,
851d5b22
BV
40 0
41};
42
46697e38
BV
43/* Properly close and free all devices. */
44static int clear_instances(void)
45{
46 struct sr_dev_inst *sdi;
47 struct drv_context *drvc;
48 struct dev_context *devc;
49 GSList *l;
50
51 if (!(drvc = di->priv))
52 return SR_OK;
53
54 for (l = drvc->instances; l; l = l->next) {
55 if (!(sdi = l->data))
56 continue;
57 if (!(devc = sdi->priv))
58 continue;
59
851d5b22
BV
60 hw_dev_close(sdi);
61 sr_usb_dev_inst_free(devc->usb);
46697e38
BV
62 sr_dev_inst_free(sdi);
63 }
64
65 g_slist_free(drvc->instances);
66 drvc->instances = NULL;
67
68 return SR_OK;
69}
70
851d5b22 71static int hw_init(struct sr_context *sr_ctx)
46697e38
BV
72{
73 struct drv_context *drvc;
74
75 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
76 sr_err("Driver context malloc failed.");
77 return SR_ERR_MALLOC;
78 }
79
851d5b22 80 drvc->sr_ctx = sr_ctx;
46697e38
BV
81 di->priv = drvc;
82
83 return SR_OK;
84}
85
86static GSList *hw_scan(GSList *options)
87{
88 struct drv_context *drvc;
851d5b22
BV
89 struct dev_context *devc;
90 struct sr_dev_inst *sdi;
91 struct sr_usb_dev_inst *usb;
1987b8d6 92 struct sr_config *src;
851d5b22
BV
93 GSList *usb_devices, *devices, *l;
94 const char *conn;
46697e38
BV
95
96 (void)options;
97
851d5b22
BV
98 if (!(drvc = di->priv)) {
99 sr_err("Driver was not initialized.");
100 return NULL;
101 }
46697e38 102
851d5b22
BV
103 /* USB scan is always authoritative. */
104 clear_instances();
105
106 conn = NULL;
107 for (l = options; l; l = l->next) {
1987b8d6
BV
108 src = l->data;
109 switch (src->key) {
1953564a 110 case SR_CONF_CONN:
1987b8d6 111 conn = src->value;
851d5b22
BV
112 break;
113 }
114 }
115 if (!conn)
116 return NULL;
117
118 devices = NULL;
119 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
120 /* We have a list of sr_usb_dev_inst matching the connection
121 * string. Wrap them in sr_dev_inst and we're done. */
122 for (l = usb_devices; l; l = l->next) {
123 usb = l->data;
124 if (!(sdi = lascar_scan(usb->bus, usb->address))) {
125 /* Not a Lascar EL-USB. */
126 g_free(usb);
127 continue;
128 }
6aa1eb4e 129 devc = sdi->priv;
851d5b22 130 devc->usb = usb;
851d5b22
BV
131 drvc->instances = g_slist_append(drvc->instances, sdi);
132 devices = g_slist_append(devices, sdi);
133 }
134 g_slist_free(usb_devices);
135 } else
136 g_slist_free_full(usb_devices, g_free);
46697e38
BV
137
138 return devices;
139}
140
141static GSList *hw_dev_list(void)
142{
143 struct drv_context *drvc;
144
6aa1eb4e
BV
145 if (!(drvc = di->priv)) {
146 sr_err("Driver was not initialized.");
147 return NULL;
148 }
46697e38
BV
149
150 return drvc->instances;
151}
152
153static int hw_dev_open(struct sr_dev_inst *sdi)
154{
6aa1eb4e
BV
155 struct drv_context *drvc;
156 struct dev_context *devc;
157 int ret;
46697e38 158
6aa1eb4e
BV
159 if (!(drvc = di->priv)) {
160 sr_err("Driver was not initialized.");
161 return SR_ERR;
162 }
163
164 devc = sdi->priv;
165 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, devc->usb) != SR_OK)
166 return SR_ERR;
167
168 if ((ret = libusb_claim_interface(devc->usb->devhdl, LASCAR_INTERFACE))) {
169 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
170 return SR_ERR;
171 }
172 sdi->status = SR_ST_ACTIVE;
173
174 return ret;
46697e38
BV
175}
176
177static int hw_dev_close(struct sr_dev_inst *sdi)
178{
6aa1eb4e
BV
179 struct dev_context *devc;
180
181 if (!di->priv) {
182 sr_err("Driver was not initialized.");
183 return SR_ERR;
184 }
185
186 devc = sdi->priv;
187 if (!devc->usb->devhdl)
188 /* Nothing to do. */
189 return SR_OK;
190
191 libusb_release_interface(devc->usb->devhdl, LASCAR_INTERFACE);
192 libusb_close(devc->usb->devhdl);
193 devc->usb->devhdl = NULL;
194 g_free(devc->config);
195 sdi->status = SR_ST_INACTIVE;
196
46697e38
BV
197
198 return SR_OK;
199}
200
201static int hw_cleanup(void)
202{
6aa1eb4e 203 struct drv_context *drvc;
46697e38 204
6aa1eb4e
BV
205 if (!(drvc = di->priv))
206 /* Can get called on an unused driver, doesn't matter. */
207 return SR_OK;
208
209 clear_instances();
210 g_free(drvc);
211 di->priv = NULL;
46697e38
BV
212
213 return SR_OK;
214}
215
035a1078 216static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
46697e38 217{
6aa1eb4e 218 struct dev_context *devc;
46697e38
BV
219 int ret;
220
6aa1eb4e
BV
221 if (!di->priv) {
222 sr_err("Driver was not initialized.");
223 return SR_ERR;
224 }
46697e38
BV
225 if (sdi->status != SR_ST_ACTIVE) {
226 sr_err("Device inactive, can't set config options.");
227 return SR_ERR;
228 }
229
6aa1eb4e 230 devc = sdi->priv;
46697e38 231 ret = SR_OK;
035a1078 232 switch (id) {
1953564a 233 case SR_CONF_LIMIT_SAMPLES:
6aa1eb4e
BV
234 devc->limit_samples = *(const uint64_t *)value;
235 sr_dbg("Setting sample limit to %" PRIu64 ".",
236 devc->limit_samples);
237 break;
46697e38 238 default:
035a1078 239 sr_err("Unknown hardware capability: %d.", id);
46697e38
BV
240 ret = SR_ERR_ARG;
241 }
242
243 return ret;
244}
245
a1c743fc
BV
246static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
247{
248
249 (void)sdi;
250
251 switch (key) {
0d485e30
BV
252 case SR_CONF_SCAN_OPTIONS:
253 *data = hwopts;
254 break;
9a6517d1
BV
255 case SR_CONF_DEVICE_OPTIONS:
256 *data = hwcaps;
257 break;
a1c743fc
BV
258 default:
259 return SR_ERR_ARG;
260 }
261
262 return SR_OK;
263}
264
6aa1eb4e
BV
265static void mark_xfer(struct libusb_transfer *xfer)
266{
267
268 if (xfer->status == LIBUSB_TRANSFER_COMPLETED)
269 xfer->user_data = GINT_TO_POINTER(1);
270 else
271 xfer->user_data = GINT_TO_POINTER(-1);
272
273}
274
275/* The Lascar software, in its infinite ignorance, reads a set of four
276 * bytes from the device config struct and interprets it as a float.
277 * That only works because they only use windows, and only on x86. However
278 * we may be running on any architecture, any operating system. So we have
279 * to convert these four bytes as the Lascar software would on windows/x86,
280 * to the local representation of a float.
281 * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */
282static float binary32_le_to_float(unsigned char *buf)
283{
284 GFloatIEEE754 f;
285
286 f.v_float = 0;
287 f.mpn.sign = (buf[3] & 0x80) ? 1 : 0;
288 f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7);
289 f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16);
290
291 return f.v_float;
292}
293
294static int lascar_proc_config(const struct sr_dev_inst *sdi)
295{
296 struct dev_context *devc;
297 int ret;
298
299 devc = sdi->priv;
300 if (!(devc->config = lascar_get_config(devc->usb->devhdl)))
301 return SR_ERR;
302
303 ret = SR_OK;
304 switch (devc->profile->logformat) {
305 case LOG_TEMP_RH:
6787f404
BV
306 devc->sample_size = 2;
307 devc->temp_unit = devc->config[0x2e] | (devc->config[0x2f] << 8);
308 if (devc->temp_unit != 0 && devc->temp_unit != 1) {
309 sr_dbg("invalid temperature unit %d", devc->temp_unit);
310 /* Default to Celcius, we're all adults here. */
311 devc->temp_unit = 0;
312 } else
313 sr_dbg("temperature unit is %s", devc->temp_unit
314 ? "Fahrenheit" : "Celcius");
6aa1eb4e
BV
315 break;
316 case LOG_CO:
317 devc->sample_size = 2;
6787f404
BV
318 devc->co_high = binary32_le_to_float(devc->config + 0x24);
319 devc->co_low = binary32_le_to_float(devc->config + 0x28);
6aa1eb4e
BV
320 sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
321 devc->co_low);
322 break;
323 default:
324 ret = SR_ERR_ARG;
325 }
326 devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8);
327 sr_dbg("device log contains %d samples.", devc->logged_samples);
328
329 return ret;
330}
331
46697e38 332static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
851d5b22 333 void *cb_data)
46697e38 334{
6aa1eb4e
BV
335 struct sr_datafeed_packet packet;
336 struct sr_datafeed_header header;
6aa1eb4e
BV
337 struct dev_context *devc;
338 struct drv_context *drvc = di->priv;
339 struct libusb_transfer *xfer_in, *xfer_out;
340 const struct libusb_pollfd **pfd;
341 struct timeval tv;
342 int ret, i;
343 unsigned char cmd[3], resp[4], *buf;
344
345 if (!di->priv) {
346 sr_err("Driver was not initialized.");
347 return SR_ERR;
348 }
349
350 devc = sdi->priv;
351 devc->cb_data = cb_data;
352
353 if (lascar_proc_config(sdi) != SR_OK)
354 return SR_ERR;
355
356 sr_dbg("Starting log retrieval.");
357
358 /* Send header packet to the session bus. */
359 sr_dbg("Sending SR_DF_HEADER.");
360 packet.type = SR_DF_HEADER;
361 packet.payload = (uint8_t *)&header;
362 header.feed_version = 1;
363 sr_session_send(devc->cb_data, &packet);
364
365 if (devc->logged_samples == 0) {
366 /* This ensures the frontend knows the session is done. */
367 packet.type = SR_DF_END;
368 sr_session_send(devc->cb_data, &packet);
369 return SR_OK;
370 }
371
372 if (!(xfer_in = libusb_alloc_transfer(0)) ||
373 !(xfer_out = libusb_alloc_transfer(0)))
374 return SR_ERR;
375
376 libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
377 0x00, 0xffff, 0x00, NULL, 0, 50);
378 libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
379 0x02, 0x0002, 0x00, NULL, 0, 50);
380 libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
381 0x02, 0x0001, 0x00, NULL, 0, 50);
382
383
384 /* Flush input. The F321 requires this. */
385 while (libusb_bulk_transfer(devc->usb->devhdl, LASCAR_EP_IN, resp,
386 256, &ret, 5) == 0 && ret > 0)
387 ;
388
389 libusb_fill_bulk_transfer(xfer_in, devc->usb->devhdl, LASCAR_EP_IN,
390 resp, sizeof(resp), mark_xfer, 0, 10000);
391 if (libusb_submit_transfer(xfer_in) != 0) {
392 libusb_free_transfer(xfer_in);
393 libusb_free_transfer(xfer_out);
394 return SR_ERR;
395 }
396
397 cmd[0] = 0x03;
398 cmd[1] = 0xff;
399 cmd[2] = 0xff;
400 libusb_fill_bulk_transfer(xfer_out, devc->usb->devhdl, LASCAR_EP_OUT,
401 cmd, 3, mark_xfer, 0, 100);
402 if (libusb_submit_transfer(xfer_out) != 0) {
403 libusb_free_transfer(xfer_in);
404 libusb_free_transfer(xfer_out);
405 return SR_ERR;
406 }
407
408 tv.tv_sec = 0;
409 tv.tv_usec = 0;
410 while (!xfer_in->user_data || !xfer_out->user_data) {
411 g_usleep(5000);
412 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
413 }
414 if (xfer_in->user_data != GINT_TO_POINTER(1) ||
415 xfer_in->user_data != GINT_TO_POINTER(1)) {
416 sr_dbg("no response to log transfer request");
417 libusb_free_transfer(xfer_in);
418 libusb_free_transfer(xfer_out);
419 return SR_ERR;
420 }
421 if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) {
422 sr_dbg("invalid response to log transfer request");
423 libusb_free_transfer(xfer_in);
424 libusb_free_transfer(xfer_out);
425 return SR_ERR;
426 }
427 devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8);
428 libusb_free_transfer(xfer_out);
429
6aa1eb4e
BV
430 pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
431 for (i = 0; pfd[i]; i++) {
432 /* Handle USB events every 100ms, for decent latency. */
433 sr_source_add(pfd[i]->fd, pfd[i]->events, 100,
434 lascar_el_usb_handle_events, (void *)sdi);
435 /* We'll need to remove this fd later. */
436 devc->usbfd[i] = pfd[i]->fd;
437 }
438 devc->usbfd[i] = -1;
439
440 buf = g_try_malloc(4096);
441 libusb_fill_bulk_transfer(xfer_in, devc->usb->devhdl, LASCAR_EP_IN,
442 buf, 4096, lascar_el_usb_receive_transfer, cb_data, 100);
443 if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
444 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
445 libusb_free_transfer(xfer_in);
446 g_free(buf);
447 return SR_ERR;
448 }
46697e38
BV
449
450 return SR_OK;
451}
452
6aa1eb4e 453SR_PRIV int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
46697e38
BV
454{
455 (void)cb_data;
456
6aa1eb4e
BV
457 if (!di->priv) {
458 sr_err("Driver was not initialized.");
459 return SR_ERR;
460 }
461
46697e38
BV
462 if (sdi->status != SR_ST_ACTIVE) {
463 sr_err("Device inactive, can't stop acquisition.");
464 return SR_ERR;
465 }
466
6aa1eb4e
BV
467 sdi->status = SR_ST_STOPPING;
468 /* TODO: free ongoing transfers? */
46697e38
BV
469
470 return SR_OK;
471}
472
473SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
474 .name = "lascar-el-usb",
475 .longname = "Lascar EL-USB",
476 .api_version = 1,
477 .init = hw_init,
478 .cleanup = hw_cleanup,
479 .scan = hw_scan,
480 .dev_list = hw_dev_list,
481 .dev_clear = clear_instances,
035a1078 482 .config_set = config_set,
a1c743fc 483 .config_list = config_list,
46697e38
BV
484 .dev_open = hw_dev_open,
485 .dev_close = hw_dev_close,
46697e38
BV
486 .dev_acquisition_start = hw_dev_acquisition_start,
487 .dev_acquisition_stop = hw_dev_acquisition_stop,
488 .priv = NULL,
489};