]> sigrok.org Git - libsigrok.git/blame - src/hardware/saleae-logic-pro/api.c
session_driver: Use std_cleanup().
[libsigrok.git] / src / hardware / saleae-logic-pro / api.c
CommitLineData
a8e913c4
JL
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2017 Jan Luebbe <jluebbe@lasnet.de>
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>
ca7d19b5
JL
21#include <glib.h>
22#include <string.h>
a8e913c4
JL
23#include "protocol.h"
24
bb0c5271
UH
25#define BUF_COUNT 8
26#define BUF_SIZE (16 * 1024)
27#define BUF_TIMEOUT (1000 * 1000)
ca7d19b5 28
b6189f7c 29SR_PRIV struct sr_dev_driver saleae_logic_pro_driver_info;
a8e913c4 30
ca7d19b5
JL
31static const uint32_t drvopts[] = {
32 SR_CONF_LOGIC_ANALYZER,
33};
34
35static const uint32_t scanopts[] = {
36 SR_CONF_CONN,
37};
38
39static const uint32_t devopts[] = {
40 SR_CONF_CONTINUOUS,
41 SR_CONF_CONN | SR_CONF_GET,
42 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
43};
44
45static const char *channel_names[] = {
46 "0", "1", "2", "3", "4", "5", "6", "7",
47 "8", "9", "10", "11", "12", "13", "14", "15",
48};
49
50static const uint64_t samplerates[] = {
51 SR_MHZ(1),
52 SR_MHZ(2),
53 SR_KHZ(2500),
54 SR_MHZ(10),
55 SR_MHZ(25),
56 SR_MHZ(50),
57};
58
59static gboolean scan_firmware(libusb_device *dev)
60{
61 struct libusb_device_descriptor des;
62 struct libusb_device_handle *hdl;
63 gboolean ret;
64 unsigned char strdesc[64];
65
66 hdl = NULL;
67 ret = FALSE;
68
69 libusb_get_device_descriptor(dev, &des);
70
71 if (libusb_open(dev, &hdl) != 0)
72 goto out;
73
74 if (libusb_get_string_descriptor_ascii(hdl,
75 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
76 goto out;
77 if (strcmp((const char *)strdesc, "Saleae"))
78 goto out;
79
80 if (libusb_get_string_descriptor_ascii(hdl,
81 des.iProduct, strdesc, sizeof(strdesc)) < 0)
82 goto out;
83 if (strcmp((const char *)strdesc, "Logic Pro"))
84 goto out;
85
86 ret = TRUE;
87
88out:
89 if (hdl)
90 libusb_close(hdl);
91
92 return ret;
93}
94
a8e913c4
JL
95static GSList *scan(struct sr_dev_driver *di, GSList *options)
96{
97 struct drv_context *drvc;
ca7d19b5
JL
98 struct dev_context *devc;
99 struct sr_dev_inst *sdi;
100 GSList *devices, *conn_devices;
101 libusb_device **devlist;
102 struct libusb_device_descriptor des;
103 const char *conn;
104 char connection_id[64];
a8e913c4
JL
105
106 devices = NULL;
107 drvc = di->context;
108 drvc->instances = NULL;
109
ca7d19b5
JL
110 conn = NULL;
111 for (GSList *l = options; l; l = l->next) {
112 struct sr_config *src = l->data;
113
114 switch (src->key) {
115 case SR_CONF_CONN:
116 conn = g_variant_get_string(src->data, NULL);
117 break;
118 }
119 }
120
121 if (conn)
122 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
123 else
124 conn_devices = NULL;
125
126 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
127 for (unsigned int i = 0; devlist[i]; i++) {
128 if (conn) {
129 struct sr_usb_dev_inst *usb = NULL;
130 GSList *l;
131
132 for (l = conn_devices; l; l = l->next) {
133 usb = l->data;
134 if (usb->bus == libusb_get_bus_number(devlist[i])
135 && usb->address == libusb_get_device_address(devlist[i]))
136 break;
137 }
138 if (!l)
139 /* This device matched none of the ones that
140 * matched the conn specification. */
141 continue;
142 }
143
144 libusb_get_device_descriptor(devlist[i], &des);
145
146 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
147
148 if (des.idVendor != 0x21a9 || des.idProduct != 0x1006)
149 continue;
150
151 if (!scan_firmware(devlist[i])) {
152 sr_err("Found a Logic Pro device, but firmware is not loaded (use Saleae application).");
153 continue;
154 }
155
156 sdi = g_malloc0(sizeof(struct sr_dev_inst));
157 sdi->status = SR_ST_INITIALIZING;
158 sdi->vendor = g_strdup("Saleae");
159 sdi->model = g_strdup("Logic Pro 16");
160 sdi->connection_id = g_strdup(connection_id);
161
162 for (unsigned int j = 0; j < ARRAY_SIZE(channel_names); j++)
163 sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
164 channel_names[j]);
165
166 sr_dbg("Found a Logic Pro 16 device.");
167 sdi->status = SR_ST_INACTIVE;
168 sdi->inst_type = SR_INST_USB;
169 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
170 libusb_get_device_address(devlist[i]), NULL);
171
172 devc = g_malloc0(sizeof(struct dev_context));
173 sdi->priv = devc;
174 devices = g_slist_append(devices, sdi);
175
176 }
177 libusb_free_device_list(devlist, 1);
178 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
a8e913c4 179
ca7d19b5 180 return std_scan_complete(di, devices);
a8e913c4
JL
181}
182
a8e913c4
JL
183static int dev_open(struct sr_dev_inst *sdi)
184{
ca7d19b5
JL
185 struct sr_dev_driver *di = sdi->driver;
186 struct drv_context *drvc = di->context;
187 struct dev_context *devc = sdi->priv;
188 struct sr_usb_dev_inst *usb = sdi->conn;
189 int ret;
a8e913c4 190
ca7d19b5
JL
191 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
192 return SR_ERR;
193
194 if ((ret = libusb_claim_interface(usb->devhdl, 0))) {
195 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
196 return SR_ERR;
197 }
198
bb0c5271 199 /* Configure default samplerate. */
ca7d19b5
JL
200 if (devc->dig_samplerate == 0)
201 devc->dig_samplerate = samplerates[3];
a8e913c4 202
a8e913c4
JL
203 return SR_OK;
204}
205
206static int dev_close(struct sr_dev_inst *sdi)
207{
f1ba6b4b 208 sr_usb_close(sdi->conn);
a8e913c4
JL
209
210 return SR_OK;
211}
212
213static int config_get(uint32_t key, GVariant **data,
ca7d19b5 214 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
a8e913c4 215{
ca7d19b5
JL
216 struct sr_usb_dev_inst *usb;
217 struct dev_context *devc;
a8e913c4
JL
218 int ret;
219
a8e913c4
JL
220 (void)cg;
221
222 ret = SR_OK;
223 switch (key) {
ca7d19b5
JL
224 case SR_CONF_CONN:
225 if (!sdi || !sdi->conn)
226 return SR_ERR_ARG;
227 usb = sdi->conn;
228 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
229 break;
230 case SR_CONF_SAMPLERATE:
231 if (!sdi)
232 return SR_ERR;
233 devc = sdi->priv;
234 *data = g_variant_new_uint64(devc->dig_samplerate);
235 break;
a8e913c4
JL
236 default:
237 return SR_ERR_NA;
238 }
239
240 return ret;
241}
242
243static int config_set(uint32_t key, GVariant *data,
ca7d19b5 244 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
a8e913c4 245{
ca7d19b5 246 struct dev_context *devc;
a8e913c4
JL
247 int ret;
248
a8e913c4
JL
249 (void)cg;
250
ca7d19b5 251 devc = sdi->priv;
a8e913c4
JL
252
253 ret = SR_OK;
254 switch (key) {
ca7d19b5
JL
255 case SR_CONF_SAMPLERATE:
256 devc->dig_samplerate = g_variant_get_uint64(data);
257 break;
a8e913c4
JL
258 default:
259 ret = SR_ERR_NA;
260 }
261
262 return ret;
263}
264
265static int config_list(uint32_t key, GVariant **data,
ca7d19b5 266 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
a8e913c4 267{
ca7d19b5
JL
268 GVariant *gvar;
269 GVariantBuilder gvb;
a8e913c4
JL
270 int ret;
271
272 (void)sdi;
a8e913c4
JL
273 (void)cg;
274
275 ret = SR_OK;
276 switch (key) {
ca7d19b5
JL
277 case SR_CONF_SCAN_OPTIONS:
278 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
bb0c5271 279 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
ca7d19b5
JL
280 break;
281 case SR_CONF_DEVICE_OPTIONS:
282 if (!sdi) {
283 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
bb0c5271 284 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
ca7d19b5
JL
285 } else {
286 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
bb0c5271 287 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
ca7d19b5
JL
288 }
289 break;
290 case SR_CONF_SAMPLERATE:
291 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
292 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
293 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
294 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
295 *data = g_variant_builder_end(&gvb);
296 break;
a8e913c4
JL
297 default:
298 return SR_ERR_NA;
299 }
300
301 return ret;
302}
303
ca7d19b5
JL
304static void dev_acquisition_abort(const struct sr_dev_inst *sdi)
305{
306 struct dev_context *devc = sdi->priv;
307 unsigned int i;
308
309 for (i = 0; i < devc->num_transfers; i++) {
310 if (devc->transfers[i])
311 libusb_cancel_transfer(devc->transfers[i]);
312 }
313}
314
315static int dev_acquisition_handle(int fd, int revents, void *cb_data)
316{
317 struct sr_dev_inst *sdi = cb_data;
318 struct drv_context *drvc = sdi->driver->context;
fbbafc69 319 struct timeval tv = ALL_ZERO;
ca7d19b5
JL
320
321 (void)fd;
322 (void)revents;
323
324 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
325
326 return TRUE;
327}
328
a8e913c4
JL
329static int dev_acquisition_start(const struct sr_dev_inst *sdi)
330{
ca7d19b5
JL
331 struct dev_context *devc = sdi->priv;
332 struct drv_context *drvc = sdi->driver->context;
333 struct libusb_transfer *transfer;
334 struct sr_usb_dev_inst *usb;
335 uint8_t *buf;
336 unsigned int i, ret;
337
b6189f7c 338 ret = saleae_logic_pro_init(sdi);
ca7d19b5
JL
339 if (ret != SR_OK)
340 return ret;
341
b6189f7c 342 ret = saleae_logic_pro_prepare(sdi);
ca7d19b5
JL
343 if (ret != SR_OK)
344 return ret;
345
346 usb = sdi->conn;
347
348 devc->conv_buffer = g_malloc(CONV_BUFFER_SIZE);
349
350 devc->num_transfers = BUF_COUNT;
351 devc->transfers = g_malloc0(sizeof(*devc->transfers) * BUF_COUNT);
352 for (i = 0; i < devc->num_transfers; i++) {
353 buf = g_malloc(BUF_SIZE);
354 transfer = libusb_alloc_transfer(0);
355 libusb_fill_bulk_transfer(transfer, usb->devhdl,
bb0c5271
UH
356 2 | LIBUSB_ENDPOINT_IN, buf, BUF_SIZE,
357 saleae_logic_pro_receive_data, (void *)sdi, BUF_TIMEOUT);
ca7d19b5
JL
358 if ((ret = libusb_submit_transfer(transfer)) != 0) {
359 sr_err("Failed to submit transfer: %s.",
360 libusb_error_name(ret));
361 libusb_free_transfer(transfer);
362 g_free(buf);
363 dev_acquisition_abort(sdi);
364 return SR_ERR;
365 }
366 devc->transfers[i] = transfer;
367 devc->submitted_transfers++;
368 }
369
370 usb_source_add(sdi->session, drvc->sr_ctx, BUF_TIMEOUT, dev_acquisition_handle, (void *)sdi);
371
372 std_session_send_df_header(sdi);
373
b6189f7c 374 saleae_logic_pro_start(sdi);
ca7d19b5
JL
375 if (ret != SR_OK)
376 return ret;
a8e913c4
JL
377
378 return SR_OK;
379}
380
381static int dev_acquisition_stop(struct sr_dev_inst *sdi)
382{
ca7d19b5
JL
383 struct dev_context *devc = sdi->priv;
384 struct drv_context *drvc = sdi->driver->context;
385
b6189f7c 386 saleae_logic_pro_stop(sdi);
ca7d19b5
JL
387
388 std_session_send_df_end(sdi);
389
390 usb_source_remove(sdi->session, drvc->sr_ctx);
391
392 g_free(devc->conv_buffer);
a8e913c4
JL
393
394 return SR_OK;
395}
396
b6189f7c
UH
397SR_PRIV struct sr_dev_driver saleae_logic_pro_driver_info = {
398 .name = "saleae-logic-pro",
399 .longname = "Saleae Logic Pro",
a8e913c4
JL
400 .api_version = 1,
401 .init = std_init,
402 .cleanup = std_cleanup,
403 .scan = scan,
404 .dev_list = std_dev_list,
f778bf02 405 .dev_clear = std_dev_clear,
a8e913c4
JL
406 .config_get = config_get,
407 .config_set = config_set,
408 .config_list = config_list,
409 .dev_open = dev_open,
410 .dev_close = dev_close,
411 .dev_acquisition_start = dev_acquisition_start,
412 .dev_acquisition_stop = dev_acquisition_stop,
413 .context = NULL,
414};
415
b6189f7c 416SR_REGISTER_DEV_DRIVER(saleae_logic_pro_driver_info);