X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=device.c;h=19fd6a14afba39af557889256e4b7182cae2bd8b;hb=c32cc2504b471deab0f511037f843234c726c461;hp=815e8066d549dc19b829aab78892b03a53150202;hpb=94799bc4dc6ab1ba64cdb7f0fb350d63d4fcee66;p=libsigrok.git diff --git a/device.c b/device.c index 815e8066..19fd6a14 100644 --- a/device.c +++ b/device.c @@ -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 *devices = NULL; /** * Scan the system for attached logic analyzers / devices. @@ -54,18 +52,19 @@ GSList *devices = NULL; * After the system has been scanned for devices, the list of detected (and * supported) devices can be acquired via sr_device_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_device_scan(void) { GSList *plugins, *l; struct sr_device_plugin *plugin; if (!(plugins = sr_list_hwplugins())) { sr_err("dev: %s: no supported devices/hwplugins", __func__); - return; /* TODO? */ + return SR_ERR; /* TODO: More specific error? */ } /* @@ -78,6 +77,8 @@ void sr_device_scan(void) /* TODO: Handle 'plugin' being NULL. */ sr_init_hwplugins(plugin); } + + return SR_OK; } /** @@ -90,7 +91,7 @@ void sr_device_scan(void) * * @return The list (GSList) of detected devices, or NULL if none were found. */ -GSList *sr_device_list(void) +SR_API GSList *sr_device_list(void) { if (!devices) sr_device_scan(); @@ -101,8 +102,12 @@ GSList *sr_device_list(void) /** * 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_device_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,38 +116,25 @@ 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_device *sr_device_new(const struct sr_device_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 */ - } /* 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__); return NULL; } - device->plugin = plugin; + device->plugin = (struct sr_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. */ - return device; } @@ -155,20 +147,22 @@ struct sr_device *sr_device_new(struct sr_device_plugin *plugin, int plugin_inde * 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). + * + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. + * If something other than SR_OK is returned, 'device' is unchanged. */ -void sr_device_clear(struct sr_device *device) +SR_API int 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. */ + return SR_ERR_ARG; } /* Note: device->probes can be NULL, this is handled correctly. */ @@ -176,7 +170,7 @@ void sr_device_clear(struct sr_device *device) for (pnum = 1; pnum <= g_slist_length(device->probes); pnum++) sr_device_probe_clear(device, pnum); - /* TODO: return SR_OK; */ + return SR_OK; } /** @@ -185,42 +179,40 @@ void sr_device_clear(struct sr_device *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!). + * + * @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, 'device' is unchanged. */ -void sr_device_probe_clear(struct sr_device *device, int probenum) +SR_API int 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. */ + return 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*. */ + return SR_ERR; /* TODO: More specific error? */ } /* If the probe has a name, remove it. */ - if (p->name) { - g_free(p->name); - p->name = NULL; - } + 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; - } + g_free(p->trigger); + p->trigger = NULL; - /* TODO: return SR_OK; */ + return SR_OK; } /** @@ -231,7 +223,6 @@ void sr_device_probe_clear(struct sr_device *device, int probenum) * The 'trigger' field of the added probe is set to NULL. A trigger can be * added via sr_device_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. @@ -246,20 +237,19 @@ void sr_device_probe_clear(struct sr_device *device, int probenum) * or SR_ERR_ARG upon invalid arguments. * If something other than SR_OK is returned, 'device' is unchanged. */ -void sr_device_probe_add(struct sr_device *device, const char *name) +SR_API int sr_device_probe_add(struct sr_device *device, 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; */ + 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. */ @@ -268,17 +258,12 @@ void sr_device_probe_add(struct sr_device *device, const char *name) 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); @@ -295,13 +280,13 @@ void sr_device_probe_add(struct sr_device *device, const char *name) * 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_device_probe_find(const struct sr_device *device, + int probenum) { GSList *l; struct sr_probe *p, *found_probe; @@ -332,38 +317,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(). * * @param device 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, 'device' is unchanged. */ -void sr_device_probe_name(struct sr_device *device, int probenum, - const char *name) +SR_API int sr_device_probe_name(struct sr_device *device, int probenum, + const char *name) { struct sr_probe *p; if (!device) { sr_err("dev: %s: device was NULL", __func__); - return; /* TODO: SR_ERR_ARG */ + return SR_ERR_ARG; } p = sr_device_probe_find(device, 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 +359,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 device TODO + * + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. + * If something other than SR_OK is returned, 'device' is unchanged. */ -void sr_device_trigger_clear(struct sr_device *device) +SR_API int sr_device_trigger_clear(struct sr_device *device) { 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 */ + return SR_ERR_ARG; } if (!device->probes) { sr_err("dev: %s: device->probes was NULL", __func__); - return; /* TODO: SR_ERR*. */ + return SR_ERR_ARG; } for (pnum = 1; pnum <= g_slist_length(device->probes); pnum++) { p = sr_device_probe_find(device, 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,23 +397,24 @@ 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 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, 'device' is unchanged. */ -void sr_device_trigger_set(struct sr_device *device, int probenum, - const char *trigger) +SR_API int sr_device_trigger_set(struct sr_device *device, int probenum, + const char *trigger) { struct sr_probe *p; if (!device) { sr_err("dev: %s: device was NULL", __func__); - return; /* TODO: SR_ERR_ARG */ + return SR_ERR_ARG; } /* TODO: Sanity check on 'probenum'. */ @@ -433,21 +424,21 @@ void sr_device_trigger_set(struct sr_device *device, int probenum, p = sr_device_probe_find(device, 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. @@ -458,7 +449,7 @@ 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_device_has_hwcap(const struct sr_device *device, int hwcap) { int *capabilities, i; @@ -490,3 +481,32 @@ gboolean sr_device_has_hwcap(struct sr_device *device, int hwcap) return FALSE; } + +/** + * Returns information about the given device. + * + * @param device 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. + */ +int sr_device_get_info(const struct sr_device *device, int id, + const void **data) +{ + if ((device == NULL) || (device->plugin == NULL)) + return SR_ERR_ARG; + + if (data == NULL) + return SR_ERR_ARG; + + *data = device->plugin->get_device_info(device->plugin_index, id); + + if (*data == NULL) + return SR_ERR; + + return SR_OK; +} +