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