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