X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=device.c;h=d504f8b5cc883253e447a0e75b47758ce7f991c5;hb=c532476aa7b9a4afb1f32d5b634348d3e825d6bb;hp=866dadf5677fe1ac6ea3d6025fe0a9d7a3f5520c;hpb=08d4cc1d146478aa9f6032fc65142293df822726;p=libsigrok.git diff --git a/device.c b/device.c index 866dadf5..d504f8b5 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 *devices = NULL; /** * Scan the system for attached logic analyzers / devices. @@ -52,19 +50,19 @@ 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: Error checks? * TODO: Option to only scan for specific devices or device classes. * * @return SR_OK upon success, SR_ERR upon errors. */ -int sr_device_scan(void) +SR_API int sr_dev_scan(void) { GSList *plugins, *l; struct sr_device_plugin *plugin; - if (!(plugins = sr_list_hwplugins())) { + if (!(plugins = sr_hwplugins_list())) { sr_err("dev: %s: no supported devices/hwplugins", __func__); return SR_ERR; /* TODO: More specific error? */ } @@ -77,7 +75,7 @@ int sr_device_scan(void) for (l = plugins; l; l = l->next) { plugin = l->data; /* TODO: Handle 'plugin' being NULL. */ - sr_init_hwplugins(plugin); + sr_hwplugin_init(plugin); } return SR_OK; @@ -87,16 +85,16 @@ int sr_device_scan(void) * 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(); + sr_dev_scan(); return devices; } @@ -104,7 +102,12 @@ GSList *sr_device_list(void) /** * Create a new device. * - * 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 @@ -113,26 +116,16 @@ 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(const struct sr_device_plugin *plugin, - int plugin_index, int num_probes) +SR_API struct sr_device *sr_dev_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; @@ -142,100 +135,16 @@ struct sr_device *sr_device_new(const 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; } -/** - * 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: 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. - */ -int sr_device_clear(struct sr_device *device) -{ - unsigned int pnum; - - if (!device) { - sr_err("dev: %s: device was NULL", __func__); - return 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); - - 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. - * - * @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. - */ -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 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 SR_ERR; /* TODO: More specific error? */ - } - - /* 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; - } - - return SR_OK; -} - /** * Add a probe with the specified name to the specified device. * * 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: Are duplicate names allowed? * TODO: Do we enforce a maximum probe number for a device? @@ -251,10 +160,9 @@ int 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. */ -int sr_device_probe_add(struct sr_device *device, const char *name) +SR_API int sr_dev_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) { @@ -278,12 +186,7 @@ int sr_device_probe_add(struct sr_device *device, const char *name) 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); @@ -305,8 +208,8 @@ int sr_device_probe_add(struct sr_device *device, const char *name) * @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(const struct sr_device *device, - int probenum) +SR_API struct sr_probe *sr_dev_probe_find(const struct sr_device *device, + int probenum) { GSList *l; struct sr_probe *p, *found_probe; @@ -348,8 +251,8 @@ struct sr_probe *sr_device_probe_find(const struct sr_device *device, * upon other errors. * If something other than SR_OK is returned, 'device' is unchanged. */ -int sr_device_probe_name(struct sr_device *device, int probenum, - const char *name) +SR_API int sr_dev_probe_name(struct sr_device *device, int probenum, + const char *name) { struct sr_probe *p; @@ -358,7 +261,7 @@ int sr_device_probe_name(struct sr_device *device, int probenum, return SR_ERR_ARG; } - p = sr_device_probe_find(device, probenum); + p = sr_dev_probe_find(device, probenum); if (!p) { sr_err("dev: %s: probe %d not found", __func__, probenum); return SR_ERR; /* TODO: More specific error? */ @@ -367,8 +270,7 @@ int sr_device_probe_name(struct sr_device *device, int probenum, /* 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); @@ -385,7 +287,7 @@ int sr_device_probe_name(struct sr_device *device, int probenum, * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. * If something other than SR_OK is returned, 'device' is unchanged. */ -int sr_device_trigger_clear(struct sr_device *device) +SR_API int sr_dev_trigger_clear(struct sr_device *device) { struct sr_probe *p; unsigned int pnum; /* TODO: uint16_t? */ @@ -401,9 +303,9 @@ int sr_device_trigger_clear(struct sr_device *device) } for (pnum = 1; pnum <= g_slist_length(device->probes); pnum++) { - p = sr_device_probe_find(device, pnum); + p = sr_dev_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; } @@ -428,8 +330,8 @@ int sr_device_trigger_clear(struct sr_device *device) * upon other errors. * If something other than SR_OK is returned, 'device' is unchanged. */ -int sr_device_trigger_set(struct sr_device *device, int probenum, - const char *trigger) +SR_API int sr_dev_trigger_set(struct sr_device *device, int probenum, + const char *trigger) { struct sr_probe *p; @@ -442,15 +344,14 @@ int sr_device_trigger_set(struct sr_device *device, int probenum, /* TODO: Sanity check on 'trigger'. */ - p = sr_device_probe_find(device, probenum); + p = sr_dev_probe_find(device, probenum); if (!p) { sr_err("dev: %s: probe %d not found", __func__, probenum); 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); @@ -471,7 +372,7 @@ int 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(const struct sr_device *device, int hwcap) +SR_API gboolean sr_dev_has_hwcap(const struct sr_device *device, int hwcap) { int *capabilities, i; @@ -503,3 +404,32 @@ gboolean sr_device_has_hwcap(const 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_dev_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; +} +