]>
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_driver lascar_el_usb_driver_info; | |
27 | static struct sr_dev_driver *di = &lascar_el_usb_driver_info; | |
28 | ||
29 | static const int32_t hwopts[] = { | |
30 | SR_CONF_CONN, | |
31 | }; | |
32 | ||
33 | static const int32_t hwcaps[] = { | |
34 | SR_CONF_THERMOMETER, | |
35 | SR_CONF_HYGROMETER, | |
36 | SR_CONF_DATALOG, | |
37 | SR_CONF_LIMIT_SAMPLES, | |
38 | }; | |
39 | ||
40 | static int init(struct sr_context *sr_ctx) | |
41 | { | |
42 | return std_init(sr_ctx, di, LOG_PREFIX); | |
43 | } | |
44 | ||
45 | static GSList *scan(GSList *options) | |
46 | { | |
47 | struct drv_context *drvc; | |
48 | struct sr_dev_inst *sdi; | |
49 | struct sr_usb_dev_inst *usb; | |
50 | struct sr_config *src; | |
51 | GSList *usb_devices, *devices, *l; | |
52 | const char *conn; | |
53 | ||
54 | drvc = di->priv; | |
55 | ||
56 | conn = NULL; | |
57 | for (l = options; l; l = l->next) { | |
58 | src = l->data; | |
59 | switch (src->key) { | |
60 | case SR_CONF_CONN: | |
61 | conn = g_variant_get_string(src->data, NULL); | |
62 | break; | |
63 | } | |
64 | } | |
65 | if (!conn) | |
66 | return NULL; | |
67 | ||
68 | devices = NULL; | |
69 | if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) { | |
70 | /* We have a list of sr_usb_dev_inst matching the connection | |
71 | * string. Wrap them in sr_dev_inst and we're done. */ | |
72 | for (l = usb_devices; l; l = l->next) { | |
73 | usb = l->data; | |
74 | if (!(sdi = lascar_scan(usb->bus, usb->address))) { | |
75 | /* Not a Lascar EL-USB. */ | |
76 | g_free(usb); | |
77 | continue; | |
78 | } | |
79 | sdi->inst_type = SR_INST_USB; | |
80 | sdi->conn = usb; | |
81 | drvc->instances = g_slist_append(drvc->instances, sdi); | |
82 | devices = g_slist_append(devices, sdi); | |
83 | } | |
84 | g_slist_free(usb_devices); | |
85 | } else | |
86 | g_slist_free_full(usb_devices, g_free); | |
87 | ||
88 | return devices; | |
89 | } | |
90 | ||
91 | static GSList *dev_list(void) | |
92 | { | |
93 | return ((struct drv_context *)(di->priv))->instances; | |
94 | } | |
95 | ||
96 | static int dev_open(struct sr_dev_inst *sdi) | |
97 | { | |
98 | struct drv_context *drvc; | |
99 | struct sr_usb_dev_inst *usb; | |
100 | int ret; | |
101 | ||
102 | if (!(drvc = di->priv)) { | |
103 | sr_err("Driver was not initialized."); | |
104 | return SR_ERR; | |
105 | } | |
106 | ||
107 | usb = sdi->conn; | |
108 | ||
109 | if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK) | |
110 | return SR_ERR; | |
111 | ||
112 | if ((ret = libusb_claim_interface(usb->devhdl, LASCAR_INTERFACE))) { | |
113 | sr_err("Failed to claim interface: %s.", libusb_error_name(ret)); | |
114 | return SR_ERR; | |
115 | } | |
116 | sdi->status = SR_ST_ACTIVE; | |
117 | ||
118 | return ret; | |
119 | } | |
120 | ||
121 | static int dev_close(struct sr_dev_inst *sdi) | |
122 | { | |
123 | struct sr_usb_dev_inst *usb; | |
124 | ||
125 | if (!di->priv) { | |
126 | sr_err("Driver was not initialized."); | |
127 | return SR_ERR; | |
128 | } | |
129 | ||
130 | usb = sdi->conn; | |
131 | ||
132 | if (!usb->devhdl) | |
133 | /* Nothing to do. */ | |
134 | return SR_OK; | |
135 | ||
136 | libusb_release_interface(usb->devhdl, LASCAR_INTERFACE); | |
137 | libusb_close(usb->devhdl); | |
138 | usb->devhdl = NULL; | |
139 | sdi->status = SR_ST_INACTIVE; | |
140 | ||
141 | return SR_OK; | |
142 | } | |
143 | ||
144 | static int cleanup(void) | |
145 | { | |
146 | int ret; | |
147 | struct drv_context *drvc; | |
148 | ||
149 | if (!(drvc = di->priv)) | |
150 | /* Can get called on an unused driver, doesn't matter. */ | |
151 | return SR_OK; | |
152 | ||
153 | ||
154 | ret = std_dev_clear(di, NULL); | |
155 | g_free(drvc); | |
156 | di->priv = NULL; | |
157 | ||
158 | return ret; | |
159 | } | |
160 | ||
161 | static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi, | |
162 | const struct sr_channel_group *cg) | |
163 | { | |
164 | struct dev_context *devc; | |
165 | struct sr_usb_dev_inst *usb; | |
166 | int ret; | |
167 | char str[128]; | |
168 | ||
169 | (void)cg; | |
170 | ||
171 | devc = sdi->priv; | |
172 | switch (id) { | |
173 | case SR_CONF_CONN: | |
174 | if (!sdi || !sdi->conn) | |
175 | return SR_ERR_ARG; | |
176 | usb = sdi->conn; | |
177 | snprintf(str, 128, "%d.%d", usb->bus, usb->address); | |
178 | *data = g_variant_new_string(str); | |
179 | break; | |
180 | case SR_CONF_DATALOG: | |
181 | if (!sdi) | |
182 | return SR_ERR_ARG; | |
183 | if ((ret = lascar_is_logging(sdi)) == -1) | |
184 | return SR_ERR; | |
185 | *data = g_variant_new_boolean(ret ? TRUE : FALSE); | |
186 | break; | |
187 | case SR_CONF_LIMIT_SAMPLES: | |
188 | *data = g_variant_new_uint64(devc->limit_samples); | |
189 | break; | |
190 | default: | |
191 | return SR_ERR_NA; | |
192 | } | |
193 | ||
194 | return SR_OK; | |
195 | } | |
196 | ||
197 | static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi, | |
198 | const struct sr_channel_group *cg) | |
199 | { | |
200 | struct dev_context *devc; | |
201 | int ret; | |
202 | ||
203 | (void)cg; | |
204 | ||
205 | if (sdi->status != SR_ST_ACTIVE) | |
206 | return SR_ERR_DEV_CLOSED; | |
207 | ||
208 | if (!di->priv) { | |
209 | sr_err("Driver was not initialized."); | |
210 | return SR_ERR; | |
211 | } | |
212 | ||
213 | devc = sdi->priv; | |
214 | ret = SR_OK; | |
215 | switch (id) { | |
216 | case SR_CONF_DATALOG: | |
217 | if (g_variant_get_boolean(data)) { | |
218 | /* Start logging. */ | |
219 | ret = lascar_start_logging(sdi); | |
220 | } else { | |
221 | /* Stop logging. */ | |
222 | ret = lascar_stop_logging(sdi); | |
223 | } | |
224 | break; | |
225 | case SR_CONF_LIMIT_SAMPLES: | |
226 | devc->limit_samples = g_variant_get_uint64(data); | |
227 | sr_dbg("Setting sample limit to %" PRIu64 ".", | |
228 | devc->limit_samples); | |
229 | break; | |
230 | default: | |
231 | ret = SR_ERR_NA; | |
232 | } | |
233 | ||
234 | return ret; | |
235 | } | |
236 | ||
237 | static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi, | |
238 | const struct sr_channel_group *cg) | |
239 | { | |
240 | (void)sdi; | |
241 | (void)cg; | |
242 | ||
243 | switch (key) { | |
244 | case SR_CONF_SCAN_OPTIONS: | |
245 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, | |
246 | hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t)); | |
247 | break; | |
248 | case SR_CONF_DEVICE_OPTIONS: | |
249 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, | |
250 | hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t)); | |
251 | break; | |
252 | default: | |
253 | return SR_ERR_NA; | |
254 | } | |
255 | ||
256 | return SR_OK; | |
257 | } | |
258 | ||
259 | static void mark_xfer(struct libusb_transfer *xfer) | |
260 | { | |
261 | ||
262 | if (xfer->status == LIBUSB_TRANSFER_COMPLETED) | |
263 | xfer->user_data = GINT_TO_POINTER(1); | |
264 | else | |
265 | xfer->user_data = GINT_TO_POINTER(-1); | |
266 | ||
267 | } | |
268 | ||
269 | /* The Lascar software, in its infinite ignorance, reads a set of four | |
270 | * bytes from the device config struct and interprets it as a float. | |
271 | * That only works because they only use windows, and only on x86. However | |
272 | * we may be running on any architecture, any operating system. So we have | |
273 | * to convert these four bytes as the Lascar software would on windows/x86, | |
274 | * to the local representation of a float. | |
275 | * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */ | |
276 | static float binary32_le_to_float(unsigned char *buf) | |
277 | { | |
278 | GFloatIEEE754 f; | |
279 | ||
280 | f.v_float = 0; | |
281 | f.mpn.sign = (buf[3] & 0x80) ? 1 : 0; | |
282 | f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7); | |
283 | f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16); | |
284 | ||
285 | return f.v_float; | |
286 | } | |
287 | ||
288 | static int lascar_proc_config(const struct sr_dev_inst *sdi) | |
289 | { | |
290 | struct dev_context *devc; | |
291 | struct sr_usb_dev_inst *usb; | |
292 | int dummy, ret; | |
293 | ||
294 | devc = sdi->priv; | |
295 | usb = sdi->conn; | |
296 | ||
297 | if (lascar_get_config(usb->devhdl, devc->config, &dummy) != SR_OK) | |
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 dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data) | |
330 | { | |
331 | struct sr_datafeed_packet packet; | |
332 | struct sr_datafeed_meta meta; | |
333 | struct sr_config *src; | |
334 | struct dev_context *devc; | |
335 | struct drv_context *drvc; | |
336 | struct sr_usb_dev_inst *usb; | |
337 | struct libusb_transfer *xfer_in, *xfer_out; | |
338 | struct timeval tv; | |
339 | uint64_t interval; | |
340 | int ret; | |
341 | unsigned char cmd[3], resp[4], *buf; | |
342 | ||
343 | if (sdi->status != SR_ST_ACTIVE) | |
344 | return SR_ERR_DEV_CLOSED; | |
345 | ||
346 | if (!di->priv) { | |
347 | sr_err("Driver was not initialized."); | |
348 | return SR_ERR; | |
349 | } | |
350 | ||
351 | drvc = di->priv; | |
352 | devc = sdi->priv; | |
353 | usb = sdi->conn; | |
354 | devc->cb_data = cb_data; | |
355 | ||
356 | if (lascar_proc_config(sdi) != SR_OK) | |
357 | return SR_ERR; | |
358 | ||
359 | sr_dbg("Starting log retrieval."); | |
360 | ||
361 | /* Send header packet to the session bus. */ | |
362 | std_session_send_df_header(cb_data, LOG_PREFIX); | |
363 | ||
364 | interval = (devc->config[0x1c] | (devc->config[0x1d] << 8)) * 1000; | |
365 | packet.type = SR_DF_META; | |
366 | packet.payload = &meta; | |
367 | src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, g_variant_new_uint64(interval)); | |
368 | meta.config = g_slist_append(NULL, src); | |
369 | sr_session_send(devc->cb_data, &packet); | |
370 | g_free(src); | |
371 | ||
372 | if (devc->logged_samples == 0) { | |
373 | /* This ensures the frontend knows the session is done. */ | |
374 | packet.type = SR_DF_END; | |
375 | sr_session_send(devc->cb_data, &packet); | |
376 | return SR_OK; | |
377 | } | |
378 | ||
379 | if (!(xfer_in = libusb_alloc_transfer(0)) || | |
380 | !(xfer_out = libusb_alloc_transfer(0))) | |
381 | return SR_ERR; | |
382 | ||
383 | libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR, | |
384 | 0x00, 0xffff, 0x00, NULL, 0, 50); | |
385 | libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR, | |
386 | 0x02, 0x0002, 0x00, NULL, 0, 50); | |
387 | libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR, | |
388 | 0x02, 0x0001, 0x00, NULL, 0, 50); | |
389 | ||
390 | ||
391 | /* Flush input. The F321 requires this. */ | |
392 | while (libusb_bulk_transfer(usb->devhdl, LASCAR_EP_IN, resp, | |
393 | 256, &ret, 5) == 0 && ret > 0) | |
394 | ; | |
395 | ||
396 | libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN, | |
397 | resp, sizeof(resp), mark_xfer, 0, 10000); | |
398 | if (libusb_submit_transfer(xfer_in) != 0) { | |
399 | libusb_free_transfer(xfer_in); | |
400 | libusb_free_transfer(xfer_out); | |
401 | return SR_ERR; | |
402 | } | |
403 | ||
404 | cmd[0] = 0x03; | |
405 | cmd[1] = 0xff; | |
406 | cmd[2] = 0xff; | |
407 | libusb_fill_bulk_transfer(xfer_out, usb->devhdl, LASCAR_EP_OUT, | |
408 | cmd, 3, mark_xfer, 0, 100); | |
409 | if (libusb_submit_transfer(xfer_out) != 0) { | |
410 | libusb_free_transfer(xfer_in); | |
411 | libusb_free_transfer(xfer_out); | |
412 | return SR_ERR; | |
413 | } | |
414 | ||
415 | tv.tv_sec = 0; | |
416 | tv.tv_usec = 0; | |
417 | while (!xfer_in->user_data || !xfer_out->user_data) { | |
418 | g_usleep(5000); | |
419 | libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv); | |
420 | } | |
421 | if (xfer_in->user_data != GINT_TO_POINTER(1) || | |
422 | xfer_in->user_data != GINT_TO_POINTER(1)) { | |
423 | sr_dbg("no response to log transfer request"); | |
424 | libusb_free_transfer(xfer_in); | |
425 | libusb_free_transfer(xfer_out); | |
426 | return SR_ERR; | |
427 | } | |
428 | if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) { | |
429 | sr_dbg("invalid response to log transfer request"); | |
430 | libusb_free_transfer(xfer_in); | |
431 | libusb_free_transfer(xfer_out); | |
432 | return SR_ERR; | |
433 | } | |
434 | devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8); | |
435 | libusb_free_transfer(xfer_out); | |
436 | ||
437 | usb_source_add(drvc->sr_ctx, 100, lascar_el_usb_handle_events, (void *)sdi); | |
438 | ||
439 | buf = g_try_malloc(4096); | |
440 | libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN, | |
441 | buf, 4096, lascar_el_usb_receive_transfer, cb_data, 100); | |
442 | if ((ret = libusb_submit_transfer(xfer_in) != 0)) { | |
443 | sr_err("Unable to submit transfer: %s.", libusb_error_name(ret)); | |
444 | libusb_free_transfer(xfer_in); | |
445 | g_free(buf); | |
446 | return SR_ERR; | |
447 | } | |
448 | ||
449 | return SR_OK; | |
450 | } | |
451 | ||
452 | SR_PRIV int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data) | |
453 | { | |
454 | (void)cb_data; | |
455 | ||
456 | if (!di->priv) { | |
457 | sr_err("Driver was not initialized."); | |
458 | return SR_ERR; | |
459 | } | |
460 | ||
461 | if (sdi->status != SR_ST_ACTIVE) { | |
462 | sr_err("Device inactive, can't stop acquisition."); | |
463 | return SR_ERR; | |
464 | } | |
465 | ||
466 | sdi->status = SR_ST_STOPPING; | |
467 | /* TODO: free ongoing transfers? */ | |
468 | ||
469 | return SR_OK; | |
470 | } | |
471 | ||
472 | SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = { | |
473 | .name = "lascar-el-usb", | |
474 | .longname = "Lascar EL-USB", | |
475 | .api_version = 1, | |
476 | .init = init, | |
477 | .cleanup = cleanup, | |
478 | .scan = scan, | |
479 | .dev_list = dev_list, | |
480 | .dev_clear = NULL, | |
481 | .config_get = config_get, | |
482 | .config_set = config_set, | |
483 | .config_list = config_list, | |
484 | .dev_open = dev_open, | |
485 | .dev_close = dev_close, | |
486 | .dev_acquisition_start = dev_acquisition_start, | |
487 | .dev_acquisition_stop = dev_acquisition_stop, | |
488 | .priv = NULL, | |
489 | }; |