X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=device.c;h=327ddc73df50b723ee7a314970046dfb764b4eda;hb=576ff5b0ba72cf9d682cf62736b4b9dc2048647d;hp=6e9a30086b610a590ac9c3190ff5698751758166;hpb=b08024a8363c7a019bebc05a25e2689e774326e8;p=libsigrok.git diff --git a/device.c b/device.c index 6e9a3008..327ddc73 100644 --- a/device.c +++ b/device.c @@ -1,7 +1,7 @@ /* - * This file is part of the sigrok project. + * This file is part of the libsigrok project. * - * Copyright (C) 2010 Bert Vermeulen + * Copyright (C) 2013 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,232 +19,406 @@ #include #include -#include -#include - -extern struct sr_global *global; +#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */ +#include "libsigrok.h" +#include "libsigrok-internal.h" + +/* Message logging helpers with subsystem-specific prefix string. */ +#define LOG_PREFIX "device: " +#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args) +#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args) +#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args) +#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args) +#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args) +#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args) + +/** + * @file + * + * Device handling in libsigrok. + */ -GSList *devices = NULL; +/** + * @defgroup grp_devices Devices + * + * Device handling in libsigrok. + * + * @{ + */ -void sr_device_scan(void) +/** @private */ +SR_PRIV struct sr_probe *sr_probe_new(int index, int type, + gboolean enabled, const char *name) { - GSList *plugins, *l; - struct sr_device_plugin *plugin; - - plugins = sr_list_hwplugins(); - - /* - * Initialize all plugins 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; - sr_device_plugin_init(plugin); + struct sr_probe *probe; + + if (!(probe = g_try_malloc0(sizeof(struct sr_probe)))) { + sr_err("Probe malloc failed."); + return NULL; } + probe->index = index; + probe->type = type; + probe->enabled = enabled; + if (name) + probe->name = g_strdup(name); + + return probe; } -int sr_device_plugin_init(struct sr_device_plugin *plugin) +/** + * Set the name of the specified probe in the specified device. + * + * If the probe already has a different name assigned to it, it will be + * removed, and the new name will be saved instead. + * + * @param sdi The device instance the probe is connected to. + * @param probenum The number of the probe whose name to set. + * Note that the probe numbers start at 0. + * @param name The new name that the specified probe should get. A copy + * of the string is made. + * + * @return SR_OK on success, or SR_ERR_ARG on invalid arguments. + * + * @since 0.1.0 (but the API changed in 0.2.0) + */ +SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi, + int probenum, const char *name) { - int num_devices, num_probes, i; + GSList *l; + struct sr_probe *probe; + int ret; + + if (!sdi) { + sr_err("%s: sdi was NULL", __func__); + return SR_ERR_ARG; + } - sr_info("initializing %s plugin", plugin->name); - num_devices = plugin->init(NULL); - for (i = 0; i < num_devices; i++) { - num_probes = (int)plugin->get_device_info(i, SR_DI_NUM_PROBES); - sr_device_new(plugin, i, num_probes); + ret = SR_ERR_ARG; + for (l = sdi->probes; l; l = l->next) { + probe = l->data; + if (probe->index == probenum) { + g_free(probe->name); + probe->name = g_strdup(name); + ret = SR_OK; + break; + } } - return num_devices; + return ret; } -void sr_device_close_all(void) +/** + * 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. + * + * @since 0.2.0 + */ +SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum, + gboolean state) { - struct sr_device *device; - - while (devices) { - device = devices->data; - if (device->plugin && device->plugin->close) - device->plugin->close(device->plugin_index); - sr_device_destroy(device); + 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; } -GSList *sr_device_list(void) +/** + * 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. + * + * @param sdi Must not be NULL. + * @param probenum The probe number, starting from 0. + * @param trigger Trigger string, in the format used by sigrok-cli + * + * @return SR_OK on success, or SR_ERR_ARG on invalid arguments. + * + * @since 0.1.0 (but the API changed in 0.2.0) + */ +SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, + const char *trigger) { + 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) { + /* If the probe already has a trigger, kill it first. */ + g_free(probe->trigger); + probe->trigger = g_strdup(trigger); + ret = SR_OK; + break; + } + } - if (!devices) - sr_device_scan(); - - return devices; + return ret; } -struct sr_device *sr_device_new(struct sr_device_plugin *plugin, int plugin_index, - int num_probes) +/** + * Determine whether the specified device instance has the specified + * capability. + * + * @param sdi Pointer to the device instance 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 key The option that should be checked for support on the + * specified device. + * + * @return TRUE if the device has the specified option, FALSE otherwise. + * FALSE is also returned on invalid input parameters or other + * error conditions. + * + * @since 0.1.0 (but the API changed in 0.2.0) + */ +SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key) { - struct sr_device *device; - int i; + GVariant *gvar; + const int *devopts; + gsize num_opts, i; + int ret; - device = g_malloc0(sizeof(struct sr_device)); - device->plugin = plugin; - device->plugin_index = plugin_index; - devices = g_slist_append(devices, device); + if (!sdi || !sdi->driver || !sdi->driver->config_list) + return FALSE; - for (i = 0; i < num_probes; i++) - sr_device_probe_add(device, NULL); + if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS, &gvar, NULL) != SR_OK) + return FALSE; + + ret = FALSE; + devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t)); + for (i = 0; i < num_opts; i++) { + if (devopts[i] == key) { + ret = TRUE; + break; + } + } + g_variant_unref(gvar); - return device; + return ret; } -void sr_device_clear(struct sr_device *device) +/** @private */ +SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status, + const char *vendor, const char *model, const char *version) { - unsigned int pnum; + struct sr_dev_inst *sdi; - /* TODO: Plugin-specific clear call? */ - - if (!device->probes) - return; + if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) { + sr_err("Device instance malloc failed."); + return NULL; + } - for (pnum = 1; pnum <= g_slist_length(device->probes); pnum++) - sr_device_probe_clear(device, pnum); + sdi->driver = NULL; + sdi->index = index; + sdi->status = status; + sdi->inst_type = -1; + sdi->vendor = vendor ? g_strdup(vendor) : NULL; + sdi->model = model ? g_strdup(model) : NULL; + sdi->version = version ? g_strdup(version) : NULL; + sdi->probes = NULL; + sdi->conn = NULL; + sdi->priv = NULL; + + return sdi; } -void sr_device_destroy(struct sr_device *device) +/** @private */ +SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi) { - unsigned int pnum; - - /* - * TODO: Plugin-specific destroy call, need to decrease refcount - * in plugin. - */ - - devices = g_slist_remove(devices, device); - if (device->probes) { - for (pnum = 1; pnum <= g_slist_length(device->probes); pnum++) - sr_device_probe_clear(device, pnum); - g_slist_free(device->probes); + struct sr_probe *probe; + GSList *l; + + for (l = sdi->probes; l; l = l->next) { + probe = l->data; + g_free(probe->name); + g_free(probe->trigger); + g_free(probe); } - g_free(device); + g_slist_free(sdi->probes); + + g_free(sdi->vendor); + g_free(sdi->model); + g_free(sdi->version); + g_free(sdi); } -void sr_device_probe_clear(struct sr_device *device, int probenum) -{ - struct sr_probe *p; +#ifdef HAVE_LIBUSB_1_0 - p = sr_device_probe_find(device, probenum); - if (!p) - return; +/** @private */ +SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, + uint8_t address, struct libusb_device_handle *hdl) +{ + struct sr_usb_dev_inst *udi; - if (p->name) { - g_free(p->name); - p->name = NULL; + if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) { + sr_err("USB device instance malloc failed."); + return NULL; } - if (p->trigger) { - g_free(p->trigger); - p->trigger = NULL; - } + udi->bus = bus; + udi->address = address; + udi->devhdl = hdl; + + return udi; } -void sr_device_probe_add(struct sr_device *device, const char *name) +/** @private */ +SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb) { - struct sr_probe *p; - char probename[16]; - int probenum; - - probenum = g_slist_length(device->probes) + 1; - p = g_malloc0(sizeof(struct sr_probe)); - 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->trigger = NULL; - device->probes = g_slist_append(device->probes, p); + g_free(usb); } -struct sr_probe *sr_device_probe_find(struct sr_device *device, int probenum) +#endif + +/** + * @private + * + * Both parameters are copied to newly allocated strings, and freed + * automatically by sr_serial_dev_inst_free(). + * + * @param pathname OS-specific serial port specification. Examples: + * "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1". + * @param serialcomm A serial communication parameters string, in the form + * of /, for example + * "9600/8n1" or "600/7o2". This is an optional parameter; + * it may be filled in later. + * + * @return A pointer to a newly initialized struct sr_serial_dev_inst, + * or NULL on error. + */ +SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, + const char *serialcomm) { - GSList *l; - struct sr_probe *p, *found_probe; + struct sr_serial_dev_inst *serial; - found_probe = NULL; - for (l = device->probes; l; l = l->next) { - p = l->data; - if (p->index == probenum) { - found_probe = p; - break; - } + if (!port) { + sr_err("Serial port required."); + return NULL; } - return found_probe; -} - -/* TODO: return SIGROK_ERR if probenum not found */ -void sr_device_probe_name(struct sr_device *device, int probenum, - const char *name) -{ - struct sr_probe *p; + if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) { + sr_err("Serial device instance malloc failed."); + return NULL; + } - p = sr_device_probe_find(device, probenum); - if (!p) - return; + serial->port = g_strdup(port); + if (serialcomm) + serial->serialcomm = g_strdup(serialcomm); + serial->fd = -1; - if (p->name) - g_free(p->name); - p->name = g_strdup(name); + return serial; } -/* TODO: return SIGROK_ERR if probenum not found */ -void sr_device_trigger_clear(struct sr_device *device) +/** @private */ +SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial) { - struct sr_probe *p; - unsigned int pnum; - - if (!device->probes) - return; + g_free(serial->port); + g_free(serial->serialcomm); + g_free(serial); +} - for (pnum = 1; pnum <= g_slist_length(device->probes); pnum++) { - p = sr_device_probe_find(device, pnum); - if (p && p->trigger) { - g_free(p->trigger); - p->trigger = NULL; - } - } +/** + * Get the list of devices/instances of the specified driver. + * + * @param driver The driver to use. Must not be NULL. + * + * @return The list of devices/instances of this driver, or NULL upon errors + * or if the list is empty. + * + * @since 0.1.0 (but the API changed in 0.2.0) + */ +SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver) +{ + if (driver && driver->dev_list) + return driver->dev_list(); + else + return NULL; } -/* TODO: return SIGROK_ERR if probenum not found */ -void sr_device_trigger_set(struct sr_device *device, int probenum, - const char *trigger) +/** + * Clear all devices/instances of the specified driver. + * + * @param driver The driver to use. Must not be NULL. + * + * @return SR_OK upon success, a negative error code upon errors. + * + * @since 0.2.0 + */ +SR_API int sr_dev_clear(const struct sr_dev_driver *driver) { - struct sr_probe *p; + if (driver && driver->dev_clear) + return driver->dev_clear(); + else + return SR_OK; +} - p = sr_device_probe_find(device, probenum); - if (!p) - return; +/** + * Open the specified device. + * + * @param sdi Device instance to use. Must not be NULL. + * + * @return SR_OK upon success, a negative error code upon errors. + * + * @since 0.2.0 + */ +SR_API int sr_dev_open(struct sr_dev_inst *sdi) +{ + int ret; - if (p->trigger) - g_free(p->trigger); + if (!sdi || !sdi->driver || !sdi->driver->dev_open) + return SR_ERR; - p->trigger = g_strdup(trigger); + ret = sdi->driver->dev_open(sdi); + return ret; } -gboolean sr_device_has_hwcap(struct sr_device *device, int hwcap) +/** + * Close the specified device. + * + * @param sdi Device instance to use. Must not be NULL. + * + * @return SR_OK upon success, a negative error code upon errors. + * + * @since 0.2.0 + */ +SR_API int sr_dev_close(struct sr_dev_inst *sdi) { - int *capabilities, i; + int ret; - if (!device || !device->plugin) - return FALSE; + if (!sdi || !sdi->driver || !sdi->driver->dev_close) + return SR_ERR; - if ((capabilities = device->plugin->get_capabilities())) - for (i = 0; capabilities[i]; i++) - if (capabilities[i] == hwcap) - return TRUE; + ret = sdi->driver->dev_close(sdi); - return FALSE; + return ret; } + +/** @} */