]>
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 | ||
26 | SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info; | |
27 | static struct sr_dev_driver *di = &lascar_el_usb_driver_info; | |
851d5b22 | 28 | |
7faf69da | 29 | static const int32_t hwopts[] = { |
1953564a | 30 | SR_CONF_CONN, |
851d5b22 BV |
31 | }; |
32 | ||
7faf69da | 33 | static const int32_t hwcaps[] = { |
1953564a BV |
34 | SR_CONF_THERMOMETER, |
35 | SR_CONF_HYGROMETER, | |
361d1511 | 36 | SR_CONF_DATALOG, |
1953564a | 37 | SR_CONF_LIMIT_SAMPLES, |
851d5b22 BV |
38 | }; |
39 | ||
6078d2c9 | 40 | static int init(struct sr_context *sr_ctx) |
46697e38 | 41 | { |
f6beaac5 | 42 | return std_init(sr_ctx, di, LOG_PREFIX); |
46697e38 BV |
43 | } |
44 | ||
6078d2c9 | 45 | static GSList *scan(GSList *options) |
46697e38 BV |
46 | { |
47 | struct drv_context *drvc; | |
851d5b22 BV |
48 | struct sr_dev_inst *sdi; |
49 | struct sr_usb_dev_inst *usb; | |
1987b8d6 | 50 | struct sr_config *src; |
851d5b22 BV |
51 | GSList *usb_devices, *devices, *l; |
52 | const char *conn; | |
46697e38 | 53 | |
4b97c74e | 54 | drvc = di->priv; |
46697e38 | 55 | |
851d5b22 BV |
56 | conn = NULL; |
57 | for (l = options; l; l = l->next) { | |
1987b8d6 BV |
58 | src = l->data; |
59 | switch (src->key) { | |
1953564a | 60 | case SR_CONF_CONN: |
7faf69da | 61 | conn = g_variant_get_string(src->data, NULL); |
851d5b22 BV |
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 | } | |
0f150649 BV |
79 | sdi->inst_type = SR_INST_USB; |
80 | sdi->conn = usb; | |
851d5b22 BV |
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); | |
46697e38 BV |
87 | |
88 | return devices; | |
89 | } | |
90 | ||
6078d2c9 | 91 | static GSList *dev_list(void) |
46697e38 | 92 | { |
0e94d524 | 93 | return ((struct drv_context *)(di->priv))->instances; |
46697e38 BV |
94 | } |
95 | ||
6078d2c9 | 96 | static int dev_open(struct sr_dev_inst *sdi) |
46697e38 | 97 | { |
6aa1eb4e | 98 | struct drv_context *drvc; |
0f150649 | 99 | struct sr_usb_dev_inst *usb; |
6aa1eb4e | 100 | int ret; |
46697e38 | 101 | |
6aa1eb4e BV |
102 | if (!(drvc = di->priv)) { |
103 | sr_err("Driver was not initialized."); | |
104 | return SR_ERR; | |
105 | } | |
106 | ||
0f150649 BV |
107 | usb = sdi->conn; |
108 | ||
109 | if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK) | |
6aa1eb4e BV |
110 | return SR_ERR; |
111 | ||
0f150649 | 112 | if ((ret = libusb_claim_interface(usb->devhdl, LASCAR_INTERFACE))) { |
6aa1eb4e BV |
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; | |
46697e38 BV |
119 | } |
120 | ||
6078d2c9 | 121 | static int dev_close(struct sr_dev_inst *sdi) |
46697e38 | 122 | { |
0f150649 | 123 | struct sr_usb_dev_inst *usb; |
6aa1eb4e BV |
124 | |
125 | if (!di->priv) { | |
126 | sr_err("Driver was not initialized."); | |
127 | return SR_ERR; | |
128 | } | |
129 | ||
0f150649 BV |
130 | usb = sdi->conn; |
131 | ||
132 | if (!usb->devhdl) | |
6aa1eb4e BV |
133 | /* Nothing to do. */ |
134 | return SR_OK; | |
135 | ||
0f150649 BV |
136 | libusb_release_interface(usb->devhdl, LASCAR_INTERFACE); |
137 | libusb_close(usb->devhdl); | |
138 | usb->devhdl = NULL; | |
6aa1eb4e BV |
139 | sdi->status = SR_ST_INACTIVE; |
140 | ||
46697e38 BV |
141 | return SR_OK; |
142 | } | |
143 | ||
6078d2c9 | 144 | static int cleanup(void) |
46697e38 | 145 | { |
c9d622a4 | 146 | int ret; |
6aa1eb4e | 147 | struct drv_context *drvc; |
46697e38 | 148 | |
6aa1eb4e BV |
149 | if (!(drvc = di->priv)) |
150 | /* Can get called on an unused driver, doesn't matter. */ | |
151 | return SR_OK; | |
152 | ||
a6630742 BV |
153 | |
154 | ret = std_dev_clear(di, NULL); | |
6aa1eb4e BV |
155 | g_free(drvc); |
156 | di->priv = NULL; | |
46697e38 | 157 | |
c9d622a4 | 158 | return ret; |
46697e38 BV |
159 | } |
160 | ||
8f996b89 | 161 | static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi, |
53b4680f | 162 | const struct sr_channel_group *cg) |
361d1511 BV |
163 | { |
164 | struct dev_context *devc; | |
0f150649 | 165 | struct sr_usb_dev_inst *usb; |
361d1511 | 166 | int ret; |
0f150649 | 167 | char str[128]; |
361d1511 | 168 | |
53b4680f | 169 | (void)cg; |
8f996b89 | 170 | |
361d1511 BV |
171 | devc = sdi->priv; |
172 | switch (id) { | |
0f150649 BV |
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; | |
361d1511 BV |
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; | |
7faf69da | 185 | *data = g_variant_new_boolean(ret ? TRUE : FALSE); |
361d1511 BV |
186 | break; |
187 | case SR_CONF_LIMIT_SAMPLES: | |
7faf69da | 188 | *data = g_variant_new_uint64(devc->limit_samples); |
361d1511 BV |
189 | break; |
190 | default: | |
bd6fbf62 | 191 | return SR_ERR_NA; |
361d1511 BV |
192 | } |
193 | ||
194 | return SR_OK; | |
195 | } | |
196 | ||
8f996b89 | 197 | static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi, |
53b4680f | 198 | const struct sr_channel_group *cg) |
46697e38 | 199 | { |
6aa1eb4e | 200 | struct dev_context *devc; |
46697e38 BV |
201 | int ret; |
202 | ||
53b4680f | 203 | (void)cg; |
8f996b89 | 204 | |
e73ffd42 BV |
205 | if (sdi->status != SR_ST_ACTIVE) |
206 | return SR_ERR_DEV_CLOSED; | |
207 | ||
6aa1eb4e BV |
208 | if (!di->priv) { |
209 | sr_err("Driver was not initialized."); | |
210 | return SR_ERR; | |
211 | } | |
46697e38 | 212 | |
6aa1eb4e | 213 | devc = sdi->priv; |
46697e38 | 214 | ret = SR_OK; |
035a1078 | 215 | switch (id) { |
361d1511 | 216 | case SR_CONF_DATALOG: |
7faf69da | 217 | if (g_variant_get_boolean(data)) { |
361d1511 BV |
218 | /* Start logging. */ |
219 | ret = lascar_start_logging(sdi); | |
220 | } else { | |
221 | /* Stop logging. */ | |
222 | ret = lascar_stop_logging(sdi); | |
223 | } | |
224 | break; | |
1953564a | 225 | case SR_CONF_LIMIT_SAMPLES: |
7faf69da | 226 | devc->limit_samples = g_variant_get_uint64(data); |
6aa1eb4e BV |
227 | sr_dbg("Setting sample limit to %" PRIu64 ".", |
228 | devc->limit_samples); | |
229 | break; | |
46697e38 | 230 | default: |
bd6fbf62 | 231 | ret = SR_ERR_NA; |
46697e38 BV |
232 | } |
233 | ||
234 | return ret; | |
235 | } | |
236 | ||
8f996b89 | 237 | static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi, |
53b4680f | 238 | const struct sr_channel_group *cg) |
a1c743fc | 239 | { |
a1c743fc | 240 | (void)sdi; |
53b4680f | 241 | (void)cg; |
a1c743fc BV |
242 | |
243 | switch (key) { | |
0d485e30 | 244 | case SR_CONF_SCAN_OPTIONS: |
7faf69da BV |
245 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, |
246 | hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t)); | |
0d485e30 | 247 | break; |
9a6517d1 | 248 | case SR_CONF_DEVICE_OPTIONS: |
7faf69da BV |
249 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, |
250 | hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t)); | |
9a6517d1 | 251 | break; |
a1c743fc | 252 | default: |
bd6fbf62 | 253 | return SR_ERR_NA; |
a1c743fc BV |
254 | } |
255 | ||
256 | return SR_OK; | |
257 | } | |
258 | ||
6aa1eb4e BV |
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; | |
0f150649 | 291 | struct sr_usb_dev_inst *usb; |
361d1511 | 292 | int dummy, ret; |
6aa1eb4e BV |
293 | |
294 | devc = sdi->priv; | |
0f150649 BV |
295 | usb = sdi->conn; |
296 | ||
297 | if (lascar_get_config(usb->devhdl, devc->config, &dummy) != SR_OK) | |
6aa1eb4e BV |
298 | return SR_ERR; |
299 | ||
300 | ret = SR_OK; | |
301 | switch (devc->profile->logformat) { | |
302 | case LOG_TEMP_RH: | |
6787f404 BV |
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"); | |
6aa1eb4e BV |
312 | break; |
313 | case LOG_CO: | |
314 | devc->sample_size = 2; | |
6787f404 BV |
315 | devc->co_high = binary32_le_to_float(devc->config + 0x24); |
316 | devc->co_low = binary32_le_to_float(devc->config + 0x28); | |
6aa1eb4e BV |
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 | ||
6078d2c9 | 329 | static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data) |
46697e38 | 330 | { |
6aa1eb4e | 331 | struct sr_datafeed_packet packet; |
8e77bc20 BV |
332 | struct sr_datafeed_meta meta; |
333 | struct sr_config *src; | |
6aa1eb4e | 334 | struct dev_context *devc; |
8e77bc20 | 335 | struct drv_context *drvc; |
0f150649 | 336 | struct sr_usb_dev_inst *usb; |
6aa1eb4e | 337 | struct libusb_transfer *xfer_in, *xfer_out; |
6aa1eb4e | 338 | struct timeval tv; |
8e77bc20 | 339 | uint64_t interval; |
6c60facc | 340 | int ret; |
6aa1eb4e BV |
341 | unsigned char cmd[3], resp[4], *buf; |
342 | ||
e73ffd42 BV |
343 | if (sdi->status != SR_ST_ACTIVE) |
344 | return SR_ERR_DEV_CLOSED; | |
345 | ||
6aa1eb4e BV |
346 | if (!di->priv) { |
347 | sr_err("Driver was not initialized."); | |
348 | return SR_ERR; | |
349 | } | |
350 | ||
8e77bc20 | 351 | drvc = di->priv; |
6aa1eb4e | 352 | devc = sdi->priv; |
0f150649 | 353 | usb = sdi->conn; |
6aa1eb4e BV |
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. */ | |
29a27196 | 362 | std_session_send_df_header(cb_data, LOG_PREFIX); |
6aa1eb4e | 363 | |
8e77bc20 BV |
364 | interval = (devc->config[0x1c] | (devc->config[0x1d] << 8)) * 1000; |
365 | packet.type = SR_DF_META; | |
366 | packet.payload = &meta; | |
7faf69da | 367 | src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, g_variant_new_uint64(interval)); |
8e77bc20 BV |
368 | meta.config = g_slist_append(NULL, src); |
369 | sr_session_send(devc->cb_data, &packet); | |
370 | g_free(src); | |
371 | ||
6aa1eb4e BV |
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 | ||
0f150649 | 383 | libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR, |
6aa1eb4e | 384 | 0x00, 0xffff, 0x00, NULL, 0, 50); |
0f150649 | 385 | libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR, |
6aa1eb4e | 386 | 0x02, 0x0002, 0x00, NULL, 0, 50); |
0f150649 | 387 | libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR, |
6aa1eb4e BV |
388 | 0x02, 0x0001, 0x00, NULL, 0, 50); |
389 | ||
390 | ||
391 | /* Flush input. The F321 requires this. */ | |
0f150649 | 392 | while (libusb_bulk_transfer(usb->devhdl, LASCAR_EP_IN, resp, |
6aa1eb4e BV |
393 | 256, &ret, 5) == 0 && ret > 0) |
394 | ; | |
395 | ||
0f150649 | 396 | libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN, |
6aa1eb4e BV |
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; | |
0f150649 | 407 | libusb_fill_bulk_transfer(xfer_out, usb->devhdl, LASCAR_EP_OUT, |
6aa1eb4e BV |
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 | ||
6c60facc | 437 | usb_source_add(drvc->sr_ctx, 100, lascar_el_usb_handle_events, (void *)sdi); |
6aa1eb4e BV |
438 | |
439 | buf = g_try_malloc(4096); | |
0f150649 | 440 | libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN, |
6aa1eb4e BV |
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 | } | |
46697e38 BV |
448 | |
449 | return SR_OK; | |
450 | } | |
451 | ||
6078d2c9 | 452 | SR_PRIV int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data) |
46697e38 BV |
453 | { |
454 | (void)cb_data; | |
455 | ||
6aa1eb4e BV |
456 | if (!di->priv) { |
457 | sr_err("Driver was not initialized."); | |
458 | return SR_ERR; | |
459 | } | |
460 | ||
46697e38 BV |
461 | if (sdi->status != SR_ST_ACTIVE) { |
462 | sr_err("Device inactive, can't stop acquisition."); | |
463 | return SR_ERR; | |
464 | } | |
465 | ||
6aa1eb4e BV |
466 | sdi->status = SR_ST_STOPPING; |
467 | /* TODO: free ongoing transfers? */ | |
46697e38 BV |
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, | |
6078d2c9 UH |
476 | .init = init, |
477 | .cleanup = cleanup, | |
478 | .scan = scan, | |
479 | .dev_list = dev_list, | |
a6630742 | 480 | .dev_clear = NULL, |
361d1511 | 481 | .config_get = config_get, |
035a1078 | 482 | .config_set = config_set, |
a1c743fc | 483 | .config_list = config_list, |
6078d2c9 UH |
484 | .dev_open = dev_open, |
485 | .dev_close = dev_close, | |
486 | .dev_acquisition_start = dev_acquisition_start, | |
487 | .dev_acquisition_stop = dev_acquisition_stop, | |
46697e38 BV |
488 | .priv = NULL, |
489 | }; |