X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=device.c;h=be647fb248e7be173810a439fe543d41fb10d59a;hb=be5bf44d281cc0a85992666803afdd7dafcefaf9;hp=491317a55d8ad1905de48a56dc15aeaf88349295;hpb=031685005b022b98b5b1604cc6226c0cc2b959f8;p=libsigrok.git diff --git a/device.c b/device.c index 491317a5..be647fb2 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,10 +19,10 @@ #include #include -#include "sigrok.h" -#include "sigrok-internal.h" +#include "libsigrok.h" +#include "libsigrok-internal.h" -static GSList *devices = NULL; +static GSList *devs = NULL; /** * Scan the system for attached logic analyzers / devices. @@ -55,28 +55,26 @@ static GSList *devices = NULL; * TODO: Error checks? * TODO: Option to only scan for specific devices or device classes. * - * @return SR_OK upon success, SR_ERR upon errors. + * @return SR_OK upon success, SR_ERR_BUG upon internal errors. */ SR_API int sr_dev_scan(void) { - GSList *plugins, *l; - struct sr_device_plugin *plugin; + int i; + struct sr_dev_driver **drivers; - if (!(plugins = sr_list_hwplugins())) { - sr_err("dev: %s: no supported devices/hwplugins", __func__); - return SR_ERR; /* TODO: More specific error? */ + drivers = sr_driver_list(); + if (!drivers[0]) { + sr_err("dev: %s: no supported hardware drivers", __func__); + return SR_ERR_BUG; } /* - * Initialize all plugins first. Since the init() call may involve + * Initialize all drivers first. Since the init() call may involve * a firmware upload and associated delay, we may as well get all * of these out of the way first. */ - for (l = plugins; l; l = l->next) { - plugin = l->data; - /* TODO: Handle 'plugin' being NULL. */ - sr_init_hwplugin(plugin); - } + for (i = 0; drivers[i]; i++) + sr_driver_init(drivers[i]); return SR_OK; } @@ -93,10 +91,10 @@ SR_API int sr_dev_scan(void) */ SR_API GSList *sr_dev_list(void) { - if (!devices) + if (!devs) sr_dev_scan(); - return devices; + return devs; } /** @@ -113,29 +111,29 @@ SR_API GSList *sr_dev_list(void) * It is the caller's responsibility to g_free() the allocated memory when * no longer needed. TODO: Using which API function? * - * @param plugin TODO. - * If 'plugin' is NULL, the created device is a "virtual" one. - * @param plugin_index TODO + * @param driver TODO. + * If 'driver' is NULL, the created device is a "virtual" one. + * @param driver_index TODO * * @return Pointer to the newly allocated device, or NULL upon errors. */ -SR_API struct sr_device *sr_dev_new(const struct sr_device_plugin *plugin, - int plugin_index) +SR_API struct sr_dev *sr_dev_new(const struct sr_dev_driver *driver, + int driver_index) { - struct sr_device *device; + struct sr_dev *dev; - /* TODO: Check if plugin_index valid? */ + /* TODO: Check if driver_index 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 = (struct sr_device_plugin *)plugin; - device->plugin_index = plugin_index; - devices = g_slist_append(devices, device); + dev->driver = (struct sr_dev_driver *)driver; + dev->driver_index = driver_index; + devs = g_slist_append(devs, dev); - return device; + return dev; } /** @@ -151,22 +149,22 @@ SR_API struct sr_device *sr_dev_new(const struct sr_device_plugin *plugin, * 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. */ -SR_API int sr_dev_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; int probenum; - if (!device) { - sr_err("dev: %s: device was NULL", __func__); + if (!dev) { + sr_err("dev: %s: dev was NULL", __func__); return SR_ERR_ARG; } @@ -177,7 +175,7 @@ SR_API int sr_dev_probe_add(struct sr_device *device, const char *name) /* 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__); @@ -188,7 +186,7 @@ SR_API int sr_dev_probe_add(struct sr_device *device, const char *name) p->enabled = TRUE; 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; } @@ -198,7 +196,7 @@ SR_API int sr_dev_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!). * @@ -208,21 +206,21 @@ SR_API int sr_dev_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. */ -SR_API struct sr_probe *sr_dev_probe_find(const 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) { @@ -240,28 +238,26 @@ SR_API struct sr_probe *sr_dev_probe_find(const struct sr_device *device, * If the probe already has a different name assigned to it, it will be * removed, and the new name will be saved instead. * - * TODO: Rename to sr_device_set_probe_name(). - * - * @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, 'device' is unchanged. + * If something other than SR_OK is returned, 'dev' is unchanged. */ -SR_API int sr_dev_probe_name(struct sr_device *device, int probenum, - const char *name) +SR_API int sr_dev_probe_name_set(struct sr_dev *dev, int probenum, + const char *name) { struct sr_probe *p; - if (!device) { - sr_err("dev: %s: device was NULL", __func__); + if (!dev) { + sr_err("dev: %s: dev was NULL", __func__); return SR_ERR_ARG; } - p = sr_dev_probe_find(device, probenum); + p = sr_dev_probe_find(dev, probenum); if (!p) { sr_err("dev: %s: probe %d not found", __func__, probenum); return SR_ERR; /* TODO: More specific error? */ @@ -277,33 +273,65 @@ SR_API int sr_dev_probe_name(struct sr_device *device, int probenum, return SR_OK; } +/** + * Enable or disable a probe on the specified device. + * + * @param sdi The device instance the probe is connected to. + * @param probenum The probe number, starting from 0. + * @param state TRUE to enable the probe, FALSE to disable. + * + * @return SR_OK on success, or SR_ERR_ARG on invalid arguments. + */ +SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum, + gboolean state) +{ + GSList *l; + struct sr_probe *probe; + int ret; + + if (!sdi) + return SR_ERR_ARG; + + ret = SR_ERR_ARG; + for (l = sdi->probes; l; l = l->next) { + probe = l->data; + if (probe->index == probenum) { + probe->enabled = state; + ret = SR_OK; + break; + } + } + + return ret; +} + /** * Remove all triggers set up for the specified device. * * TODO: Better description. * - * @param device TODO + * @param dev TODO * * @return SR_OK upon success, 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. */ -SR_API int sr_dev_trigger_clear(struct sr_device *device) +SR_API int sr_dev_trigger_remove_all(struct sr_dev *dev) { struct sr_probe *p; unsigned int pnum; /* TODO: uint16_t? */ - if (!device) { - sr_err("dev: %s: device was NULL", __func__); + 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__); + 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_dev_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) { g_free(p->trigger); @@ -315,12 +343,15 @@ SR_API int sr_dev_trigger_clear(struct sr_device *device) } /** - * Add a trigger to the specified device. + * Add a trigger to the specified device (and the specified probe). + * + * If the specified probe of this device already has a trigger, it will + * be silently replaced. * * TODO: Better description. * TODO: Describe valid format of the 'trigger' string. * - * @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. @@ -328,43 +359,40 @@ SR_API int sr_dev_trigger_clear(struct sr_device *device) * * @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. + * If something other than SR_OK is returned, 'dev' is unchanged. */ -SR_API int sr_dev_trigger_set(struct sr_device *device, int probenum, - const char *trigger) +SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, + const char *trigger) { - struct sr_probe *p; + GSList *l; + struct sr_probe *probe; + int ret; - if (!device) { - sr_err("dev: %s: device was NULL", __func__); + if (!sdi) return SR_ERR_ARG; - } - - /* TODO: Sanity check on 'probenum'. */ - - /* TODO: Sanity check on 'trigger'. */ - 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? */ + ret = SR_ERR_ARG; + for (l = sdi->probes; l; l = l->next) { + probe = l->data; + if (probe->index == probenum) { + /* If the probe already has a trigger, kill it first. */ + g_free(probe->trigger); + probe->trigger = g_strdup(trigger); + ret = SR_OK; + break; + } } - /* If the probe already has a trigger, kill it first. */ - g_free(p->trigger); - - p->trigger = g_strdup(trigger); - - return SR_OK; + return ret; } /** * Determine whether the specified device has the specified capability. * - * TODO: Should return int? - * - * @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. + * If the device's 'driver' field is NULL (virtual device), this + * function will always return FALSE (virtual devices don't have + * a hardware capabilities list). * @param hwcap The capability that should be checked (whether it's supported * by the specified device). * @@ -372,29 +400,38 @@ SR_API int sr_dev_trigger_set(struct sr_device *device, int probenum, * FALSE is also returned upon invalid input parameters or other * error conditions. */ -SR_API gboolean sr_dev_has_hwcap(const struct sr_device *device, int hwcap) +SR_API gboolean sr_dev_has_hwcap(const struct sr_dev *dev, int hwcap) { - int *capabilities, i; + const int *hwcaps; + int i; - if (!device) { - sr_err("dev: %s: device was NULL", __func__); - return FALSE; /* TODO: SR_ERR_ARG. */ + sr_spew("dev: %s: requesting hwcap %d", __func__, hwcap); + + if (!dev) { + sr_err("dev: %s: dev was NULL", __func__); + return FALSE; } - if (!device->plugin) { - sr_err("dev: %s: device->plugin was NULL", __func__); - return FALSE; /* TODO: SR_ERR_ARG. */ + /* + * Virtual devices (which have dev->driver set to NULL) always say that + * they don't have the capability (they can't call hwcap_get_all()). + */ + if (!dev->driver) { + sr_dbg("dev: %s: dev->driver was NULL, this seems to be " + "a virtual device without capabilities", __func__); + return FALSE; } /* TODO: Sanity check on 'hwcap'. */ - if (!(capabilities = device->plugin->get_capabilities())) { - sr_err("dev: %s: device has no capabilities", __func__); - return FALSE; /* TODO: SR_ERR*. */ + if (dev->driver->info_get(SR_DI_HWCAPS, + (const void **)&hwcaps, NULL) != SR_OK) { + sr_err("dev: %s: dev has no capabilities", __func__); + return FALSE; } - 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; @@ -408,28 +445,26 @@ SR_API gboolean sr_dev_has_hwcap(const struct sr_device *device, int hwcap) /** * 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. + * @param dev Pointer to the device to be checked. Must not be NULL. + * The device's 'driver' 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) +SR_API int sr_dev_info_get(const struct sr_dev *dev, int id, const void **data) { - if ((device == NULL) || (device->plugin == NULL)) + if ((dev == NULL) || (dev->driver == NULL)) return SR_ERR_ARG; if (data == NULL) return SR_ERR_ARG; - *data = device->plugin->get_device_info(device->plugin_index, id); + *data = dev->driver->dev_info_get(dev->driver_index, id); if (*data == NULL) return SR_ERR; return SR_OK; } -