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