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