]>
Commit | Line | Data |
---|---|---|
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 | ||
20 | #include <glib.h> | |
851d5b22 | 21 | #include <libusb.h> |
46697e38 BV |
22 | #include "libsigrok.h" |
23 | #include "libsigrok-internal.h" | |
24 | #include "protocol.h" | |
25 | ||
851d5b22 | 26 | SR_PRIV struct sr_dev_inst *lascar_scan(int bus, int address); |
46697e38 BV |
27 | SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info; |
28 | static struct sr_dev_driver *di = &lascar_el_usb_driver_info; | |
851d5b22 | 29 | static int hw_dev_close(struct sr_dev_inst *sdi); |
851d5b22 BV |
30 | |
31 | static const int hwopts[] = { | |
1953564a | 32 | SR_CONF_CONN, |
851d5b22 BV |
33 | 0, |
34 | }; | |
35 | ||
36 | static const int hwcaps[] = { | |
1953564a BV |
37 | SR_CONF_THERMOMETER, |
38 | SR_CONF_HYGROMETER, | |
361d1511 | 39 | SR_CONF_DATALOG, |
1953564a | 40 | SR_CONF_LIMIT_SAMPLES, |
851d5b22 BV |
41 | 0 |
42 | }; | |
43 | ||
361d1511 BV |
44 | /* Terrible hack */ |
45 | static int BOOL_TRUE = TRUE; | |
46 | static int BOOL_FALSE = FALSE; | |
47 | ||
46697e38 BV |
48 | /* Properly close and free all devices. */ |
49 | static int clear_instances(void) | |
50 | { | |
51 | struct sr_dev_inst *sdi; | |
52 | struct drv_context *drvc; | |
53 | struct dev_context *devc; | |
54 | GSList *l; | |
55 | ||
56 | if (!(drvc = di->priv)) | |
57 | return SR_OK; | |
58 | ||
59 | for (l = drvc->instances; l; l = l->next) { | |
60 | if (!(sdi = l->data)) | |
61 | continue; | |
62 | if (!(devc = sdi->priv)) | |
63 | continue; | |
64 | ||
851d5b22 BV |
65 | hw_dev_close(sdi); |
66 | sr_usb_dev_inst_free(devc->usb); | |
46697e38 BV |
67 | sr_dev_inst_free(sdi); |
68 | } | |
69 | ||
70 | g_slist_free(drvc->instances); | |
71 | drvc->instances = NULL; | |
72 | ||
73 | return SR_OK; | |
74 | } | |
75 | ||
851d5b22 | 76 | static int hw_init(struct sr_context *sr_ctx) |
46697e38 | 77 | { |
063e7aef | 78 | return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN); |
46697e38 BV |
79 | } |
80 | ||
81 | static GSList *hw_scan(GSList *options) | |
82 | { | |
83 | struct drv_context *drvc; | |
851d5b22 BV |
84 | struct dev_context *devc; |
85 | struct sr_dev_inst *sdi; | |
86 | struct sr_usb_dev_inst *usb; | |
1987b8d6 | 87 | struct sr_config *src; |
851d5b22 BV |
88 | GSList *usb_devices, *devices, *l; |
89 | const char *conn; | |
46697e38 BV |
90 | |
91 | (void)options; | |
92 | ||
4b97c74e | 93 | drvc = di->priv; |
46697e38 | 94 | |
851d5b22 BV |
95 | /* USB scan is always authoritative. */ |
96 | clear_instances(); | |
97 | ||
98 | conn = NULL; | |
99 | for (l = options; l; l = l->next) { | |
1987b8d6 BV |
100 | src = l->data; |
101 | switch (src->key) { | |
1953564a | 102 | case SR_CONF_CONN: |
1987b8d6 | 103 | conn = src->value; |
851d5b22 BV |
104 | break; |
105 | } | |
106 | } | |
107 | if (!conn) | |
108 | return NULL; | |
109 | ||
110 | devices = NULL; | |
111 | if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) { | |
112 | /* We have a list of sr_usb_dev_inst matching the connection | |
113 | * string. Wrap them in sr_dev_inst and we're done. */ | |
114 | for (l = usb_devices; l; l = l->next) { | |
115 | usb = l->data; | |
116 | if (!(sdi = lascar_scan(usb->bus, usb->address))) { | |
117 | /* Not a Lascar EL-USB. */ | |
118 | g_free(usb); | |
119 | continue; | |
120 | } | |
6aa1eb4e | 121 | devc = sdi->priv; |
851d5b22 | 122 | devc->usb = usb; |
851d5b22 BV |
123 | drvc->instances = g_slist_append(drvc->instances, sdi); |
124 | devices = g_slist_append(devices, sdi); | |
125 | } | |
126 | g_slist_free(usb_devices); | |
127 | } else | |
128 | g_slist_free_full(usb_devices, g_free); | |
46697e38 BV |
129 | |
130 | return devices; | |
131 | } | |
132 | ||
133 | static GSList *hw_dev_list(void) | |
134 | { | |
0e94d524 | 135 | return ((struct drv_context *)(di->priv))->instances; |
46697e38 BV |
136 | } |
137 | ||
138 | static int hw_dev_open(struct sr_dev_inst *sdi) | |
139 | { | |
6aa1eb4e BV |
140 | struct drv_context *drvc; |
141 | struct dev_context *devc; | |
142 | int ret; | |
46697e38 | 143 | |
6aa1eb4e BV |
144 | if (!(drvc = di->priv)) { |
145 | sr_err("Driver was not initialized."); | |
146 | return SR_ERR; | |
147 | } | |
148 | ||
149 | devc = sdi->priv; | |
150 | if (sr_usb_open(drvc->sr_ctx->libusb_ctx, devc->usb) != SR_OK) | |
151 | return SR_ERR; | |
152 | ||
153 | if ((ret = libusb_claim_interface(devc->usb->devhdl, LASCAR_INTERFACE))) { | |
154 | sr_err("Failed to claim interface: %s.", libusb_error_name(ret)); | |
155 | return SR_ERR; | |
156 | } | |
157 | sdi->status = SR_ST_ACTIVE; | |
158 | ||
159 | return ret; | |
46697e38 BV |
160 | } |
161 | ||
162 | static int hw_dev_close(struct sr_dev_inst *sdi) | |
163 | { | |
6aa1eb4e BV |
164 | struct dev_context *devc; |
165 | ||
166 | if (!di->priv) { | |
167 | sr_err("Driver was not initialized."); | |
168 | return SR_ERR; | |
169 | } | |
170 | ||
171 | devc = sdi->priv; | |
172 | if (!devc->usb->devhdl) | |
173 | /* Nothing to do. */ | |
174 | return SR_OK; | |
175 | ||
176 | libusb_release_interface(devc->usb->devhdl, LASCAR_INTERFACE); | |
177 | libusb_close(devc->usb->devhdl); | |
178 | devc->usb->devhdl = NULL; | |
6aa1eb4e BV |
179 | sdi->status = SR_ST_INACTIVE; |
180 | ||
46697e38 BV |
181 | |
182 | return SR_OK; | |
183 | } | |
184 | ||
185 | static int hw_cleanup(void) | |
186 | { | |
6aa1eb4e | 187 | struct drv_context *drvc; |
46697e38 | 188 | |
6aa1eb4e BV |
189 | if (!(drvc = di->priv)) |
190 | /* Can get called on an unused driver, doesn't matter. */ | |
191 | return SR_OK; | |
192 | ||
193 | clear_instances(); | |
194 | g_free(drvc); | |
195 | di->priv = NULL; | |
46697e38 BV |
196 | |
197 | return SR_OK; | |
198 | } | |
199 | ||
361d1511 BV |
200 | static int config_get(int id, const void **data, const struct sr_dev_inst *sdi) |
201 | { | |
202 | struct dev_context *devc; | |
203 | int ret; | |
204 | ||
205 | devc = sdi->priv; | |
206 | switch (id) { | |
207 | case SR_CONF_DATALOG: | |
208 | if (!sdi) | |
209 | return SR_ERR_ARG; | |
210 | if ((ret = lascar_is_logging(sdi)) == -1) | |
211 | return SR_ERR; | |
212 | *data = ret ? &BOOL_TRUE : &BOOL_FALSE; | |
213 | break; | |
214 | case SR_CONF_LIMIT_SAMPLES: | |
215 | *data = &devc->limit_samples; | |
216 | break; | |
217 | default: | |
218 | return SR_ERR_ARG; | |
219 | } | |
220 | ||
221 | return SR_OK; | |
222 | } | |
223 | ||
035a1078 | 224 | static int config_set(int id, const void *value, const struct sr_dev_inst *sdi) |
46697e38 | 225 | { |
6aa1eb4e | 226 | struct dev_context *devc; |
46697e38 BV |
227 | int ret; |
228 | ||
6aa1eb4e BV |
229 | if (!di->priv) { |
230 | sr_err("Driver was not initialized."); | |
231 | return SR_ERR; | |
232 | } | |
46697e38 BV |
233 | if (sdi->status != SR_ST_ACTIVE) { |
234 | sr_err("Device inactive, can't set config options."); | |
235 | return SR_ERR; | |
236 | } | |
237 | ||
6aa1eb4e | 238 | devc = sdi->priv; |
46697e38 | 239 | ret = SR_OK; |
035a1078 | 240 | switch (id) { |
361d1511 BV |
241 | case SR_CONF_DATALOG: |
242 | if (*(int *)value) { | |
243 | /* Start logging. */ | |
244 | ret = lascar_start_logging(sdi); | |
245 | } else { | |
246 | /* Stop logging. */ | |
247 | ret = lascar_stop_logging(sdi); | |
248 | } | |
249 | break; | |
1953564a | 250 | case SR_CONF_LIMIT_SAMPLES: |
6aa1eb4e BV |
251 | devc->limit_samples = *(const uint64_t *)value; |
252 | sr_dbg("Setting sample limit to %" PRIu64 ".", | |
253 | devc->limit_samples); | |
254 | break; | |
46697e38 | 255 | default: |
035a1078 | 256 | sr_err("Unknown hardware capability: %d.", id); |
46697e38 BV |
257 | ret = SR_ERR_ARG; |
258 | } | |
259 | ||
260 | return ret; | |
261 | } | |
262 | ||
a1c743fc BV |
263 | static int config_list(int key, const void **data, const struct sr_dev_inst *sdi) |
264 | { | |
265 | ||
266 | (void)sdi; | |
267 | ||
268 | switch (key) { | |
0d485e30 BV |
269 | case SR_CONF_SCAN_OPTIONS: |
270 | *data = hwopts; | |
271 | break; | |
9a6517d1 BV |
272 | case SR_CONF_DEVICE_OPTIONS: |
273 | *data = hwcaps; | |
274 | break; | |
a1c743fc BV |
275 | default: |
276 | return SR_ERR_ARG; | |
277 | } | |
278 | ||
279 | return SR_OK; | |
280 | } | |
281 | ||
6aa1eb4e BV |
282 | static void mark_xfer(struct libusb_transfer *xfer) |
283 | { | |
284 | ||
285 | if (xfer->status == LIBUSB_TRANSFER_COMPLETED) | |
286 | xfer->user_data = GINT_TO_POINTER(1); | |
287 | else | |
288 | xfer->user_data = GINT_TO_POINTER(-1); | |
289 | ||
290 | } | |
291 | ||
292 | /* The Lascar software, in its infinite ignorance, reads a set of four | |
293 | * bytes from the device config struct and interprets it as a float. | |
294 | * That only works because they only use windows, and only on x86. However | |
295 | * we may be running on any architecture, any operating system. So we have | |
296 | * to convert these four bytes as the Lascar software would on windows/x86, | |
297 | * to the local representation of a float. | |
298 | * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */ | |
299 | static float binary32_le_to_float(unsigned char *buf) | |
300 | { | |
301 | GFloatIEEE754 f; | |
302 | ||
303 | f.v_float = 0; | |
304 | f.mpn.sign = (buf[3] & 0x80) ? 1 : 0; | |
305 | f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7); | |
306 | f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16); | |
307 | ||
308 | return f.v_float; | |
309 | } | |
310 | ||
311 | static int lascar_proc_config(const struct sr_dev_inst *sdi) | |
312 | { | |
313 | struct dev_context *devc; | |
361d1511 | 314 | int dummy, ret; |
6aa1eb4e BV |
315 | |
316 | devc = sdi->priv; | |
361d1511 | 317 | if (lascar_get_config(devc->usb->devhdl, devc->config, &dummy) != SR_OK) |
6aa1eb4e BV |
318 | return SR_ERR; |
319 | ||
320 | ret = SR_OK; | |
321 | switch (devc->profile->logformat) { | |
322 | case LOG_TEMP_RH: | |
6787f404 BV |
323 | devc->sample_size = 2; |
324 | devc->temp_unit = devc->config[0x2e] | (devc->config[0x2f] << 8); | |
325 | if (devc->temp_unit != 0 && devc->temp_unit != 1) { | |
326 | sr_dbg("invalid temperature unit %d", devc->temp_unit); | |
327 | /* Default to Celcius, we're all adults here. */ | |
328 | devc->temp_unit = 0; | |
329 | } else | |
330 | sr_dbg("temperature unit is %s", devc->temp_unit | |
331 | ? "Fahrenheit" : "Celcius"); | |
6aa1eb4e BV |
332 | break; |
333 | case LOG_CO: | |
334 | devc->sample_size = 2; | |
6787f404 BV |
335 | devc->co_high = binary32_le_to_float(devc->config + 0x24); |
336 | devc->co_low = binary32_le_to_float(devc->config + 0x28); | |
6aa1eb4e BV |
337 | sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high, |
338 | devc->co_low); | |
339 | break; | |
340 | default: | |
341 | ret = SR_ERR_ARG; | |
342 | } | |
343 | devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8); | |
344 | sr_dbg("device log contains %d samples.", devc->logged_samples); | |
345 | ||
346 | return ret; | |
347 | } | |
348 | ||
46697e38 | 349 | static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi, |
851d5b22 | 350 | void *cb_data) |
46697e38 | 351 | { |
6aa1eb4e | 352 | struct sr_datafeed_packet packet; |
8e77bc20 BV |
353 | struct sr_datafeed_meta meta; |
354 | struct sr_config *src; | |
6aa1eb4e | 355 | struct dev_context *devc; |
8e77bc20 | 356 | struct drv_context *drvc; |
6aa1eb4e BV |
357 | struct libusb_transfer *xfer_in, *xfer_out; |
358 | const struct libusb_pollfd **pfd; | |
359 | struct timeval tv; | |
8e77bc20 | 360 | uint64_t interval; |
6aa1eb4e BV |
361 | int ret, i; |
362 | unsigned char cmd[3], resp[4], *buf; | |
363 | ||
364 | if (!di->priv) { | |
365 | sr_err("Driver was not initialized."); | |
366 | return SR_ERR; | |
367 | } | |
368 | ||
8e77bc20 | 369 | drvc = di->priv; |
6aa1eb4e BV |
370 | devc = sdi->priv; |
371 | devc->cb_data = cb_data; | |
372 | ||
373 | if (lascar_proc_config(sdi) != SR_OK) | |
374 | return SR_ERR; | |
375 | ||
376 | sr_dbg("Starting log retrieval."); | |
377 | ||
378 | /* Send header packet to the session bus. */ | |
4afdfd46 | 379 | std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN); |
6aa1eb4e | 380 | |
8e77bc20 BV |
381 | interval = (devc->config[0x1c] | (devc->config[0x1d] << 8)) * 1000; |
382 | packet.type = SR_DF_META; | |
383 | packet.payload = &meta; | |
384 | src = sr_config_make(SR_CONF_SAMPLE_INTERVAL, (const void *)&interval); | |
385 | meta.config = g_slist_append(NULL, src); | |
386 | sr_session_send(devc->cb_data, &packet); | |
387 | g_free(src); | |
388 | ||
6aa1eb4e BV |
389 | if (devc->logged_samples == 0) { |
390 | /* This ensures the frontend knows the session is done. */ | |
391 | packet.type = SR_DF_END; | |
392 | sr_session_send(devc->cb_data, &packet); | |
393 | return SR_OK; | |
394 | } | |
395 | ||
396 | if (!(xfer_in = libusb_alloc_transfer(0)) || | |
397 | !(xfer_out = libusb_alloc_transfer(0))) | |
398 | return SR_ERR; | |
399 | ||
400 | libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR, | |
401 | 0x00, 0xffff, 0x00, NULL, 0, 50); | |
402 | libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR, | |
403 | 0x02, 0x0002, 0x00, NULL, 0, 50); | |
404 | libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR, | |
405 | 0x02, 0x0001, 0x00, NULL, 0, 50); | |
406 | ||
407 | ||
408 | /* Flush input. The F321 requires this. */ | |
409 | while (libusb_bulk_transfer(devc->usb->devhdl, LASCAR_EP_IN, resp, | |
410 | 256, &ret, 5) == 0 && ret > 0) | |
411 | ; | |
412 | ||
413 | libusb_fill_bulk_transfer(xfer_in, devc->usb->devhdl, LASCAR_EP_IN, | |
414 | resp, sizeof(resp), mark_xfer, 0, 10000); | |
415 | if (libusb_submit_transfer(xfer_in) != 0) { | |
416 | libusb_free_transfer(xfer_in); | |
417 | libusb_free_transfer(xfer_out); | |
418 | return SR_ERR; | |
419 | } | |
420 | ||
421 | cmd[0] = 0x03; | |
422 | cmd[1] = 0xff; | |
423 | cmd[2] = 0xff; | |
424 | libusb_fill_bulk_transfer(xfer_out, devc->usb->devhdl, LASCAR_EP_OUT, | |
425 | cmd, 3, mark_xfer, 0, 100); | |
426 | if (libusb_submit_transfer(xfer_out) != 0) { | |
427 | libusb_free_transfer(xfer_in); | |
428 | libusb_free_transfer(xfer_out); | |
429 | return SR_ERR; | |
430 | } | |
431 | ||
432 | tv.tv_sec = 0; | |
433 | tv.tv_usec = 0; | |
434 | while (!xfer_in->user_data || !xfer_out->user_data) { | |
435 | g_usleep(5000); | |
436 | libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv); | |
437 | } | |
438 | if (xfer_in->user_data != GINT_TO_POINTER(1) || | |
439 | xfer_in->user_data != GINT_TO_POINTER(1)) { | |
440 | sr_dbg("no response to log transfer request"); | |
441 | libusb_free_transfer(xfer_in); | |
442 | libusb_free_transfer(xfer_out); | |
443 | return SR_ERR; | |
444 | } | |
445 | if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) { | |
446 | sr_dbg("invalid response to log transfer request"); | |
447 | libusb_free_transfer(xfer_in); | |
448 | libusb_free_transfer(xfer_out); | |
449 | return SR_ERR; | |
450 | } | |
451 | devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8); | |
452 | libusb_free_transfer(xfer_out); | |
453 | ||
6aa1eb4e BV |
454 | pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx); |
455 | for (i = 0; pfd[i]; i++) { | |
456 | /* Handle USB events every 100ms, for decent latency. */ | |
457 | sr_source_add(pfd[i]->fd, pfd[i]->events, 100, | |
458 | lascar_el_usb_handle_events, (void *)sdi); | |
459 | /* We'll need to remove this fd later. */ | |
460 | devc->usbfd[i] = pfd[i]->fd; | |
461 | } | |
462 | devc->usbfd[i] = -1; | |
463 | ||
464 | buf = g_try_malloc(4096); | |
465 | libusb_fill_bulk_transfer(xfer_in, devc->usb->devhdl, LASCAR_EP_IN, | |
466 | buf, 4096, lascar_el_usb_receive_transfer, cb_data, 100); | |
467 | if ((ret = libusb_submit_transfer(xfer_in) != 0)) { | |
468 | sr_err("Unable to submit transfer: %s.", libusb_error_name(ret)); | |
469 | libusb_free_transfer(xfer_in); | |
470 | g_free(buf); | |
471 | return SR_ERR; | |
472 | } | |
46697e38 BV |
473 | |
474 | return SR_OK; | |
475 | } | |
476 | ||
6aa1eb4e | 477 | SR_PRIV int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data) |
46697e38 BV |
478 | { |
479 | (void)cb_data; | |
480 | ||
6aa1eb4e BV |
481 | if (!di->priv) { |
482 | sr_err("Driver was not initialized."); | |
483 | return SR_ERR; | |
484 | } | |
485 | ||
46697e38 BV |
486 | if (sdi->status != SR_ST_ACTIVE) { |
487 | sr_err("Device inactive, can't stop acquisition."); | |
488 | return SR_ERR; | |
489 | } | |
490 | ||
6aa1eb4e BV |
491 | sdi->status = SR_ST_STOPPING; |
492 | /* TODO: free ongoing transfers? */ | |
46697e38 BV |
493 | |
494 | return SR_OK; | |
495 | } | |
496 | ||
497 | SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = { | |
498 | .name = "lascar-el-usb", | |
499 | .longname = "Lascar EL-USB", | |
500 | .api_version = 1, | |
501 | .init = hw_init, | |
502 | .cleanup = hw_cleanup, | |
503 | .scan = hw_scan, | |
504 | .dev_list = hw_dev_list, | |
505 | .dev_clear = clear_instances, | |
361d1511 | 506 | .config_get = config_get, |
035a1078 | 507 | .config_set = config_set, |
a1c743fc | 508 | .config_list = config_list, |
46697e38 BV |
509 | .dev_open = hw_dev_open, |
510 | .dev_close = hw_dev_close, | |
46697e38 BV |
511 | .dev_acquisition_start = hw_dev_acquisition_start, |
512 | .dev_acquisition_stop = hw_dev_acquisition_stop, | |
513 | .priv = NULL, | |
514 | }; |