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