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