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