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