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