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