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