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