X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=device.c;h=9cc3b6800691b4debd76555b8b572bb1d20486b7;hb=5097b0d0912165429aceddb5febbf68467b623f5;hp=815e8066d549dc19b829aab78892b03a53150202;hpb=94799bc4dc6ab1ba64cdb7f0fb350d63d4fcee66;p=libsigrok.git diff --git a/device.c b/device.c index 815e8066..9cc3b680 100644 --- a/device.c +++ b/device.c @@ -1,7 +1,7 @@ /* * This file is part of the sigrok project. * - * Copyright (C) 2010 Bert Vermeulen + * Copyright (C) 2010-2012 Bert Vermeulen * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -19,12 +19,10 @@ #include #include -#include -#include +#include "sigrok.h" +#include "sigrok-internal.h" -extern struct sr_global *global; - -GSList *devices = NULL; +static GSList *devs = NULL; /** * Scan the system for attached logic analyzers / devices. @@ -52,20 +50,21 @@ GSList *devices = NULL; * caller should not assume or rely on any specific order. * * After the system has been scanned for devices, the list of detected (and - * supported) devices can be acquired via sr_device_list(). + * supported) devices can be acquired via sr_dev_list(). * - * TODO: Should return int. * TODO: Error checks? * TODO: Option to only scan for specific devices or device classes. + * + * @return SR_OK upon success, SR_ERR upon errors. */ -void sr_device_scan(void) +SR_API int sr_dev_scan(void) { GSList *plugins, *l; - struct sr_device_plugin *plugin; + struct sr_dev_plugin *plugin; - if (!(plugins = sr_list_hwplugins())) { + if (!(plugins = sr_hw_list())) { sr_err("dev: %s: no supported devices/hwplugins", __func__); - return; /* TODO? */ + return SR_ERR; /* TODO: More specific error? */ } /* @@ -76,33 +75,39 @@ void sr_device_scan(void) for (l = plugins; l; l = l->next) { plugin = l->data; /* TODO: Handle 'plugin' being NULL. */ - sr_init_hwplugins(plugin); + sr_hw_init(plugin); } + + return SR_OK; } /** * Return the list of logic analyzer devices libsigrok has detected. * * If the libsigrok-internal device list is empty, a scan for attached - * devices -- via a call to sr_device_scan() -- is performed first. + * devices -- via a call to sr_dev_scan() -- is performed first. * * TODO: Error handling? * * @return The list (GSList) of detected devices, or NULL if none were found. */ -GSList *sr_device_list(void) +SR_API GSList *sr_dev_list(void) { - if (!devices) - sr_device_scan(); + if (!devs) + sr_dev_scan(); - return devices; + return devs; } /** * Create a new device. * - * TODO: 'plugin' can be const. - * TODO: num_probes should be uint16_t. + * The device is added to the (libsigrok-internal) list of devices, but + * additionally a pointer to the newly created device is also returned. + * + * The device has no probes attached to it yet after this call. You can + * use sr_dev_probe_add() to add one or more probes. + * * TODO: Should return int, so that we can return SR_OK, SR_ERR_* etc. * * It is the caller's responsibility to g_free() the allocated memory when @@ -111,116 +116,26 @@ GSList *sr_device_list(void) * @param plugin TODO. * If 'plugin' is NULL, the created device is a "virtual" one. * @param plugin_index TODO - * @param num_probes The number of probes (>= 1) this device has. - * TODO: 0 allowed? * * @return Pointer to the newly allocated device, or NULL upon errors. */ -struct sr_device *sr_device_new(struct sr_device_plugin *plugin, int plugin_index, - int num_probes) +SR_API struct sr_dev *sr_dev_new(const struct sr_dev_plugin *plugin, + int plugin_index) { - struct sr_device *device; - int i; - - if (!plugin) { - sr_err("dev: %s: plugin was NULL", __func__); - return NULL; /* TODO: SR_ERR_ARG */ - } + struct sr_dev *dev; /* TODO: Check if plugin_index valid? */ - /* TODO: Check if num_probes valid? */ - - if (!(device = g_try_malloc0(sizeof(struct sr_device)))) { - sr_err("dev: %s: device malloc failed", __func__); + if (!(dev = g_try_malloc0(sizeof(struct sr_dev)))) { + sr_err("dev: %s: dev malloc failed", __func__); return NULL; } - device->plugin = plugin; - device->plugin_index = plugin_index; - devices = g_slist_append(devices, device); - - for (i = 0; i < num_probes; i++) - sr_device_probe_add(device, NULL); /* TODO: Check return value. */ + dev->plugin = (struct sr_dev_plugin *)plugin; + dev->plugin_index = plugin_index; + devs = g_slist_append(devs, dev); - return device; -} - -/** - * Clear all probes of the specified device. - * - * This removes/clears the 'name' and 'trigger' fields of all probes of - * the device. - * - * The order in which the probes are cleared is not specified. The caller - * should not assume or rely on a specific order. - * - * TODO: Should return int. - * TODO: Rename to sr_device_clear_probes() or sr_device_probe_clear_all(). - * - * @param device The device whose probes to clear. Must not be NULL. - * Note: device->probes is allowed to be NULL (in that case, - * there are no probes, thus none have to be cleared). - */ -void sr_device_clear(struct sr_device *device) -{ - unsigned int pnum; - - if (!device) { - sr_err("dev: %s: device was NULL", __func__); - return; /* TODO: SR_ERR_ARG. */ - } - - /* Note: device->probes can be NULL, this is handled correctly. */ - - for (pnum = 1; pnum <= g_slist_length(device->probes); pnum++) - sr_device_probe_clear(device, pnum); - - /* TODO: return SR_OK; */ -} - -/** - * Clear the specified probe in the specified device. - * - * The probe itself still exists afterwards, but its 'name' and 'trigger' - * fields are g_free()'d and set to NULL. - * - * TODO: Should return int. - * - * @param device The device in which the specified (to be cleared) probe - * resides. Must not be NULL. - * @param probenum The number of the probe to clear. - * Note that the probe numbers start at 1 (not 0!). - */ -void sr_device_probe_clear(struct sr_device *device, int probenum) -{ - struct sr_probe *p; - - if (!device) { - sr_err("dev: %s: device was NULL", __func__); - return; /* TODO: SR_ERR_ARG. */ - } - - /* TODO: Sanity check on 'probenum'. */ - - if (!(p = sr_device_probe_find(device, probenum))) { - sr_err("dev: %s: probe %d not found", __func__, probenum); - return; /* TODO: SR_ERR*. */ - } - - /* If the probe has a name, remove it. */ - if (p->name) { - g_free(p->name); - p->name = NULL; - } - - /* If the probe has a trigger, remove it. */ - if (p->trigger) { - g_free(p->trigger); - p->trigger = NULL; - } - - /* TODO: return SR_OK; */ + return dev; } /** @@ -229,58 +144,51 @@ void sr_device_probe_clear(struct sr_device *device, int probenum) * The added probe is automatically enabled (the 'enabled' field is TRUE). * * The 'trigger' field of the added probe is set to NULL. A trigger can be - * added via sr_device_trigger_set(). + * added via sr_dev_trigger_set(). * - * TODO: Should return int. * TODO: Are duplicate names allowed? * TODO: Do we enforce a maximum probe number for a device? * TODO: Error if the max. probe number for the specific LA is reached, e.g. * if the caller tries to add more probes than the device actually has. * - * @param device The device to which to add a probe with the specified name. - * Must not be NULL. + * @param dev The device to which to add a probe with the specified name. + * Must not be NULL. * @param name The name of the probe to add to this device. Must not be NULL. * TODO: Maximum length, allowed characters, etc. * * @return SR_OK upon success, SR_ERR_MALLOC upon memory allocation errors, * or SR_ERR_ARG upon invalid arguments. - * If something other than SR_OK is returned, 'device' is unchanged. + * If something other than SR_OK is returned, 'dev' is unchanged. */ -void sr_device_probe_add(struct sr_device *device, const char *name) +SR_API int sr_dev_probe_add(struct sr_dev *dev, const char *name) { struct sr_probe *p; - char probename[16]; /* FIXME: Don't hardcode 16? #define? */ int probenum; - if (!device) { - sr_err("dev: %s: device was NULL", __func__); - return; /* SR_ERR_ARG; */ + if (!dev) { + sr_err("dev: %s: dev was NULL", __func__); + return SR_ERR_ARG; } if (!name) { sr_err("dev: %s: name was NULL", __func__); - return; /* SR_ERR_ARG; */ + return SR_ERR_ARG; } /* TODO: Further checks to ensure name is valid. */ - probenum = g_slist_length(device->probes) + 1; + probenum = g_slist_length(dev->probes) + 1; if (!(p = g_try_malloc0(sizeof(struct sr_probe)))) { sr_err("dev: %s: p malloc failed", __func__); - return; /* SR_ERR_MALLOC; */ + return SR_ERR_MALLOC; } p->index = probenum; p->enabled = TRUE; - if (name) { - p->name = g_strdup(name); - } else { - snprintf(probename, 16, "%d", probenum); - p->name = g_strdup(probename); - } + p->name = g_strdup(name); p->trigger = NULL; - device->probes = g_slist_append(device->probes, p); + dev->probes = g_slist_append(dev->probes, p); return SR_OK; } @@ -290,31 +198,31 @@ void sr_device_probe_add(struct sr_device *device, const char *name) * * TODO * - * @param device TODO. Must not be NULL. + * @param dev TODO. Must not be NULL. * @param probenum The number of the probe whose 'struct sr_probe' we want. * Note that the probe numbers start at 1 (not 0!). * * TODO: Should return int. - * TODO: device can be const. * TODO: probenum should be unsigned. * * @return A pointer to the requested probe's 'struct sr_probe', or NULL * if the probe could not be found. */ -struct sr_probe *sr_device_probe_find(struct sr_device *device, int probenum) +SR_API struct sr_probe *sr_dev_probe_find(const struct sr_dev *dev, + int probenum) { GSList *l; struct sr_probe *p, *found_probe; - if (!device) { - sr_err("dev: %s: device was NULL", __func__); + if (!dev) { + sr_err("dev: %s: dev was NULL", __func__); return NULL; /* TODO: SR_ERR_ARG */ } /* TODO: Sanity check on probenum. */ found_probe = NULL; - for (l = device->probes; l; l = l->next) { + for (l = dev->probes; l; l = l->next) { p = l->data; /* TODO: Check for p != NULL. */ if (p->index == probenum) { @@ -332,38 +240,41 @@ struct sr_probe *sr_device_probe_find(struct sr_device *device, int probenum) * If the probe already has a different name assigned to it, it will be * removed, and the new name will be saved instead. * - * TODO: Should return int. - * TODO: device can be const? - * TODO: Rename to sr_device_set_probe_name(). + * TODO: Rename to sr_dev_probe_name_set(). * - * @param device TODO + * @param dev TODO * @param probenum The number of the probe whose name to set. * Note that the probe numbers start at 1 (not 0!). * @param name The new name that the specified probe should get. + * + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR + * upon other errors. + * If something other than SR_OK is returned, 'dev' is unchanged. */ -void sr_device_probe_name(struct sr_device *device, int probenum, - const char *name) +SR_API int sr_dev_probe_name(struct sr_dev *dev, int probenum, + const char *name) { struct sr_probe *p; - if (!device) { - sr_err("dev: %s: device was NULL", __func__); - return; /* TODO: SR_ERR_ARG */ + if (!dev) { + sr_err("dev: %s: dev was NULL", __func__); + return SR_ERR_ARG; } - p = sr_device_probe_find(device, probenum); + p = sr_dev_probe_find(dev, probenum); if (!p) { sr_err("dev: %s: probe %d not found", __func__, probenum); - return; /* TODO: SR_ERR*. */ + return SR_ERR; /* TODO: More specific error? */ } /* TODO: Sanity check on 'name'. */ /* If the probe already has a name, kill it first. */ - if (p->name) - g_free(p->name); + g_free(p->name); p->name = g_strdup(name); + + return SR_OK; } /** @@ -371,34 +282,36 @@ void sr_device_probe_name(struct sr_device *device, int probenum, * * TODO: Better description. * - * TODO: Should return int. - * TODO: device can be const? + * @param dev TODO * - * @param device TODO + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. + * If something other than SR_OK is returned, 'dev' is unchanged. */ -void sr_device_trigger_clear(struct sr_device *device) +SR_API int sr_dev_trigger_clear(struct sr_dev *dev) { struct sr_probe *p; - unsigned int pnum; /* TODO: uint6_t? */ + unsigned int pnum; /* TODO: uint16_t? */ - if (!device) { - sr_err("dev: %s: device was NULL", __func__); - return; /* TODO: SR_ERR_ARG */ + if (!dev) { + sr_err("dev: %s: dev was NULL", __func__); + return SR_ERR_ARG; } - if (!device->probes) { - sr_err("dev: %s: device->probes was NULL", __func__); - return; /* TODO: SR_ERR*. */ + if (!dev->probes) { + sr_err("dev: %s: dev->probes was NULL", __func__); + return SR_ERR_ARG; } - for (pnum = 1; pnum <= g_slist_length(device->probes); pnum++) { - p = sr_device_probe_find(device, pnum); + for (pnum = 1; pnum <= g_slist_length(dev->probes); pnum++) { + p = sr_dev_probe_find(dev, pnum); /* TODO: Silently ignore probes which cannot be found? */ - if (p && p->trigger) { + if (p) { g_free(p->trigger); p->trigger = NULL; } } + + return SR_OK; } /** @@ -407,50 +320,51 @@ void sr_device_trigger_clear(struct sr_device *device) * TODO: Better description. * TODO: Describe valid format of the 'trigger' string. * - * TODO: Should return int. - * TODO: device can be const? - * - * @param device TODO. Must not be NULL. + * @param dev TODO. Must not be NULL. * @param probenum The number of the probe. TODO. * Note that the probe numbers start at 1 (not 0!). * @param trigger TODO. * TODO: Is NULL allowed? + * + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR + * upon other errors. + * If something other than SR_OK is returned, 'dev' is unchanged. */ -void sr_device_trigger_set(struct sr_device *device, int probenum, - const char *trigger) +SR_API int sr_dev_trigger_set(struct sr_dev *dev, int probenum, + const char *trigger) { struct sr_probe *p; - if (!device) { - sr_err("dev: %s: device was NULL", __func__); - return; /* TODO: SR_ERR_ARG */ + if (!dev) { + sr_err("dev: %s: dev was NULL", __func__); + return SR_ERR_ARG; } /* TODO: Sanity check on 'probenum'. */ /* TODO: Sanity check on 'trigger'. */ - p = sr_device_probe_find(device, probenum); + p = sr_dev_probe_find(dev, probenum); if (!p) { sr_err("dev: %s: probe %d not found", __func__, probenum); - return; /* TODO: SR_ERR*. */ + return SR_ERR; /* TODO: More specific error? */ } /* If the probe already has a trigger, kill it first. */ - if (p->trigger) - g_free(p->trigger); + g_free(p->trigger); p->trigger = g_strdup(trigger); + + return SR_OK; } /** * Determine whether the specified device has the specified capability. * * TODO: Should return int? - * TODO: device can be const. * - * @param device Pointer to the device to be checked. Must not be NULL. - * The device's 'plugin' field must not be NULL either. + * @param dev Pointer to the device to be checked. Must not be NULL. + * The device's 'plugin' field must not be NULL either. * @param hwcap The capability that should be checked (whether it's supported * by the specified device). * @@ -458,29 +372,29 @@ void sr_device_trigger_set(struct sr_device *device, int probenum, * FALSE is also returned upon invalid input parameters or other * error conditions. */ -gboolean sr_device_has_hwcap(struct sr_device *device, int hwcap) +SR_API gboolean sr_dev_has_hwcap(const struct sr_dev *dev, int hwcap) { - int *capabilities, i; + int *hwcaps, i; - if (!device) { - sr_err("dev: %s: device was NULL", __func__); + if (!dev) { + sr_err("dev: %s: dev was NULL", __func__); return FALSE; /* TODO: SR_ERR_ARG. */ } - if (!device->plugin) { - sr_err("dev: %s: device->plugin was NULL", __func__); + if (!dev->plugin) { + sr_err("dev: %s: dev->plugin was NULL", __func__); return FALSE; /* TODO: SR_ERR_ARG. */ } /* TODO: Sanity check on 'hwcap'. */ - if (!(capabilities = device->plugin->get_capabilities())) { - sr_err("dev: %s: device has no capabilities", __func__); + if (!(hwcaps = dev->plugin->hwcap_get_all())) { + sr_err("dev: %s: dev has no capabilities", __func__); return FALSE; /* TODO: SR_ERR*. */ } - for (i = 0; capabilities[i]; i++) { - if (capabilities[i] != hwcap) + for (i = 0; hwcaps[i]; i++) { + if (hwcaps[i] != hwcap) continue; sr_spew("dev: %s: found hwcap %d", __func__, hwcap); return TRUE; @@ -490,3 +404,30 @@ gboolean sr_device_has_hwcap(struct sr_device *device, int hwcap) return FALSE; } + +/** + * Returns information about the given device. + * + * @param dev Pointer to the device to be checked. Must not be NULL. + * The device's 'plugin' field must not be NULL either. + * @param id The type of information. + * @param data The return value. Must not be NULL. + * + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR + * upon other errors. + */ +SR_API int sr_dev_info_get(const struct sr_dev *dev, int id, const void **data) +{ + if ((dev == NULL) || (dev->plugin == NULL)) + return SR_ERR_ARG; + + if (data == NULL) + return SR_ERR_ARG; + + *data = dev->plugin->dev_info_get(dev->plugin_index, id); + + if (*data == NULL) + return SR_ERR; + + return SR_OK; +}