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