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