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