2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
23 #include "sigrok-internal.h"
25 static GSList *devices = NULL;
28 * Scan the system for attached logic analyzers / devices.
30 * This will try to autodetect all supported logic analyzer devices:
32 * - Those attached via USB (can be reliably detected via USB VID/PID).
34 * - Those using a (real or virtual) serial port (detected by sending
35 * device-specific commands to all OS-specific serial port devices such
36 * as /dev/ttyS*, /dev/ttyUSB*, /dev/ttyACM*, and others).
37 * The autodetection for this kind of devices can potentially be unreliable.
39 * Also, sending various bytes/commands to (all!) devices which happen to
40 * be attached to the system via a (real or virtual) serial port can be
41 * problematic. There is no way for libsigrok to know how unknown devices
42 * react to the bytes libsigrok sends. Potentially they could lead to the
43 * device getting into invalid/error states, losing/overwriting data, or...
45 * In addition to the detection, the devices that are found are also
46 * initialized automatically. On some devices, this involves a firmware upload,
47 * or other such measures.
49 * The order in which the system is scanned for devices is not specified. The
50 * caller should not assume or rely on any specific order.
52 * After the system has been scanned for devices, the list of detected (and
53 * supported) devices can be acquired via sr_device_list().
56 * TODO: Option to only scan for specific devices or device classes.
58 * @return SR_OK upon success, SR_ERR upon errors.
60 int sr_device_scan(void)
63 struct sr_device_plugin *plugin;
65 if (!(plugins = sr_list_hwplugins())) {
66 sr_err("dev: %s: no supported devices/hwplugins", __func__);
67 return SR_ERR; /* TODO: More specific error? */
71 * Initialize all plugins first. Since the init() call may involve
72 * a firmware upload and associated delay, we may as well get all
73 * of these out of the way first.
75 for (l = plugins; l; l = l->next) {
77 /* TODO: Handle 'plugin' being NULL. */
78 sr_init_hwplugins(plugin);
85 * Return the list of logic analyzer devices libsigrok has detected.
87 * If the libsigrok-internal device list is empty, a scan for attached
88 * devices -- via a call to sr_device_scan() -- is performed first.
90 * TODO: Error handling?
92 * @return The list (GSList) of detected devices, or NULL if none were found.
94 GSList *sr_device_list(void)
103 * Create a new device.
105 * The device is added to the (libsigrok-internal) list of devices, but
106 * additionally a pointer to the newly created device is also returned.
108 * The device has no probes attached to it yet after this call. You can
109 * use sr_device_probe_add() to add one or more probes.
111 * TODO: Should return int, so that we can return SR_OK, SR_ERR_* etc.
113 * It is the caller's responsibility to g_free() the allocated memory when
114 * no longer needed. TODO: Using which API function?
116 * @param plugin TODO.
117 * If 'plugin' is NULL, the created device is a "virtual" one.
118 * @param plugin_index TODO
120 * @return Pointer to the newly allocated device, or NULL upon errors.
122 struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
125 struct sr_device *device;
127 /* TODO: Check if plugin_index valid? */
129 if (!(device = g_try_malloc0(sizeof(struct sr_device)))) {
130 sr_err("dev: %s: device malloc failed", __func__);
134 device->plugin = (struct sr_device_plugin *)plugin;
135 device->plugin_index = plugin_index;
136 devices = g_slist_append(devices, device);
142 * Clear all probes of the specified device.
144 * This removes/clears the 'name' and 'trigger' fields of all probes of
147 * The order in which the probes are cleared is not specified. The caller
148 * should not assume or rely on a specific order.
150 * TODO: Rename to sr_device_clear_probes() or sr_device_probe_clear_all().
152 * @param device The device whose probes to clear. Must not be NULL.
153 * Note: device->probes is allowed to be NULL (in that case,
154 * there are no probes, thus none have to be cleared).
156 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
157 * If something other than SR_OK is returned, 'device' is unchanged.
159 int sr_device_clear(struct sr_device *device)
164 sr_err("dev: %s: device was NULL", __func__);
168 /* Note: device->probes can be NULL, this is handled correctly. */
170 for (pnum = 1; pnum <= g_slist_length(device->probes); pnum++)
171 sr_device_probe_clear(device, pnum);
177 * Clear the specified probe in the specified device.
179 * The probe itself still exists afterwards, but its 'name' and 'trigger'
180 * fields are g_free()'d and set to NULL.
182 * @param device The device in which the specified (to be cleared) probe
183 * resides. Must not be NULL.
184 * @param probenum The number of the probe to clear.
185 * Note that the probe numbers start at 1 (not 0!).
187 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
189 * If something other than SR_OK is returned, 'device' is unchanged.
191 int sr_device_probe_clear(struct sr_device *device, int probenum)
196 sr_err("dev: %s: device was NULL", __func__);
200 /* TODO: Sanity check on 'probenum'. */
202 if (!(p = sr_device_probe_find(device, probenum))) {
203 sr_err("dev: %s: probe %d not found", __func__, probenum);
204 return SR_ERR; /* TODO: More specific error? */
207 /* If the probe has a name, remove it. */
211 /* If the probe has a trigger, remove it. */
219 * Add a probe with the specified name to the specified device.
221 * The added probe is automatically enabled (the 'enabled' field is TRUE).
223 * The 'trigger' field of the added probe is set to NULL. A trigger can be
224 * added via sr_device_trigger_set().
226 * TODO: Are duplicate names allowed?
227 * TODO: Do we enforce a maximum probe number for a device?
228 * TODO: Error if the max. probe number for the specific LA is reached, e.g.
229 * if the caller tries to add more probes than the device actually has.
231 * @param device The device to which to add a probe with the specified name.
233 * @param name The name of the probe to add to this device. Must not be NULL.
234 * TODO: Maximum length, allowed characters, etc.
236 * @return SR_OK upon success, SR_ERR_MALLOC upon memory allocation errors,
237 * or SR_ERR_ARG upon invalid arguments.
238 * If something other than SR_OK is returned, 'device' is unchanged.
240 int sr_device_probe_add(struct sr_device *device, const char *name)
246 sr_err("dev: %s: device was NULL", __func__);
251 sr_err("dev: %s: name was NULL", __func__);
255 /* TODO: Further checks to ensure name is valid. */
257 probenum = g_slist_length(device->probes) + 1;
259 if (!(p = g_try_malloc0(sizeof(struct sr_probe)))) {
260 sr_err("dev: %s: p malloc failed", __func__);
261 return SR_ERR_MALLOC;
266 p->name = g_strdup(name);
268 device->probes = g_slist_append(device->probes, p);
274 * Find the probe with the specified number in the specified device.
278 * @param device TODO. Must not be NULL.
279 * @param probenum The number of the probe whose 'struct sr_probe' we want.
280 * Note that the probe numbers start at 1 (not 0!).
282 * TODO: Should return int.
283 * TODO: probenum should be unsigned.
285 * @return A pointer to the requested probe's 'struct sr_probe', or NULL
286 * if the probe could not be found.
288 struct sr_probe *sr_device_probe_find(const struct sr_device *device,
292 struct sr_probe *p, *found_probe;
295 sr_err("dev: %s: device was NULL", __func__);
296 return NULL; /* TODO: SR_ERR_ARG */
299 /* TODO: Sanity check on probenum. */
302 for (l = device->probes; l; l = l->next) {
304 /* TODO: Check for p != NULL. */
305 if (p->index == probenum) {
315 * Set the name of the specified probe in the specified device.
317 * If the probe already has a different name assigned to it, it will be
318 * removed, and the new name will be saved instead.
320 * TODO: Rename to sr_device_set_probe_name().
323 * @param probenum The number of the probe whose name to set.
324 * Note that the probe numbers start at 1 (not 0!).
325 * @param name The new name that the specified probe should get.
327 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
329 * If something other than SR_OK is returned, 'device' is unchanged.
331 int sr_device_probe_name(struct sr_device *device, int probenum,
337 sr_err("dev: %s: device was NULL", __func__);
341 p = sr_device_probe_find(device, probenum);
343 sr_err("dev: %s: probe %d not found", __func__, probenum);
344 return SR_ERR; /* TODO: More specific error? */
347 /* TODO: Sanity check on 'name'. */
349 /* If the probe already has a name, kill it first. */
352 p->name = g_strdup(name);
358 * Remove all triggers set up for the specified device.
360 * TODO: Better description.
364 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
365 * If something other than SR_OK is returned, 'device' is unchanged.
367 int sr_device_trigger_clear(struct sr_device *device)
370 unsigned int pnum; /* TODO: uint16_t? */
373 sr_err("dev: %s: device was NULL", __func__);
377 if (!device->probes) {
378 sr_err("dev: %s: device->probes was NULL", __func__);
382 for (pnum = 1; pnum <= g_slist_length(device->probes); pnum++) {
383 p = sr_device_probe_find(device, pnum);
384 /* TODO: Silently ignore probes which cannot be found? */
395 * Add a trigger to the specified device.
397 * TODO: Better description.
398 * TODO: Describe valid format of the 'trigger' string.
400 * @param device TODO. Must not be NULL.
401 * @param probenum The number of the probe. TODO.
402 * Note that the probe numbers start at 1 (not 0!).
403 * @param trigger TODO.
404 * TODO: Is NULL allowed?
406 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
408 * If something other than SR_OK is returned, 'device' is unchanged.
410 int sr_device_trigger_set(struct sr_device *device, int probenum,
416 sr_err("dev: %s: device was NULL", __func__);
420 /* TODO: Sanity check on 'probenum'. */
422 /* TODO: Sanity check on 'trigger'. */
424 p = sr_device_probe_find(device, probenum);
426 sr_err("dev: %s: probe %d not found", __func__, probenum);
427 return SR_ERR; /* TODO: More specific error? */
430 /* If the probe already has a trigger, kill it first. */
433 p->trigger = g_strdup(trigger);
439 * Determine whether the specified device has the specified capability.
441 * TODO: Should return int?
443 * @param device Pointer to the device to be checked. Must not be NULL.
444 * The device's 'plugin' field must not be NULL either.
445 * @param hwcap The capability that should be checked (whether it's supported
446 * by the specified device).
448 * @return TRUE, if the device has the specified capability, FALSE otherwise.
449 * FALSE is also returned upon invalid input parameters or other
452 gboolean sr_device_has_hwcap(const struct sr_device *device, int hwcap)
454 int *capabilities, i;
457 sr_err("dev: %s: device was NULL", __func__);
458 return FALSE; /* TODO: SR_ERR_ARG. */
461 if (!device->plugin) {
462 sr_err("dev: %s: device->plugin was NULL", __func__);
463 return FALSE; /* TODO: SR_ERR_ARG. */
466 /* TODO: Sanity check on 'hwcap'. */
468 if (!(capabilities = device->plugin->get_capabilities())) {
469 sr_err("dev: %s: device has no capabilities", __func__);
470 return FALSE; /* TODO: SR_ERR*. */
473 for (i = 0; capabilities[i]; i++) {
474 if (capabilities[i] != hwcap)
476 sr_spew("dev: %s: found hwcap %d", __func__, hwcap);
480 sr_spew("dev: %s: hwcap %d not found", __func__, hwcap);