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