X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=device.c;h=f437c18a5fdb88e544fc4cdc1821070f641083c5;hb=299bdb249ecaa9f42900a8f1a0fa0404d619c27a;hp=cef3aac3dd787db6bfc4c482dfb17347f951cd13;hpb=afc8e4deb68271ba7696e38cc02053b97cfc1a19;p=libsigrok.git diff --git a/device.c b/device.c index cef3aac3..f437c18a 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,217 +19,346 @@ #include #include -#include "sigrok.h" - -extern struct sigrok_global *global; - -GSList *devices = NULL; +#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */ +#include "libsigrok.h" +#include "libsigrok-internal.h" + +/* Message logging helpers with driver-specific prefix string. */ +#define DRIVER_LOG_DOMAIN "device: " +#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args) +#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args) +#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args) +#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args) +#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args) +#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args) + +/** + * @file + * + * Device handling in libsigrok. + */ +/** + * @defgroup grp_devices Devices + * + * Device handling in libsigrok. + * + * @{ + */ -void 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 device_plugin *plugin; - int num_devices, i; - - plugins = 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; - g_message("initializing %s plugin", plugin->name); - num_devices = plugin->init(NULL); - for(i = 0; i < num_devices; i++) - { - device_new(plugin, i); - } + 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; +} -void device_close_all(void) +/** + * 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. + */ +SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi, + int probenum, const char *name) { - struct device *device; + GSList *l; + struct sr_probe *probe; + int ret; - while(devices) - { - device = devices->data; - device->plugin->close(device->plugin_index); - device_destroy(device); + if (!sdi) { + sr_err("%s: sdi was NULL", __func__); + return SR_ERR_ARG; } -} + 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 ret; +} -GSList *device_list(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. + */ +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 devices; + return ret; } - -struct device *device_new(struct device_plugin *plugin, int plugin_index) +/** + * 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. + */ +SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, + const char *trigger) { - struct device *device; - int num_probes, i; - char probename[16]; - - device = g_malloc0(sizeof(struct device)); - device->plugin = plugin; - device->plugin_index = plugin_index; - devices = g_slist_append(devices, device); - - num_probes = (int) device->plugin->get_device_info(device->plugin_index, DI_NUM_PROBES); - for(i = 0; i < num_probes; i++) - { - snprintf(probename, 16, "%d", i+1); - device_probe_add(device, probename); + 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; + } } - return device; + return ret; } - -void device_clear(struct device *device) +/** + * 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 hwcap The capability that should be checked (whether it's supported + * by the specified device). + * + * @return TRUE if the device has the specified capability, FALSE otherwise. + * FALSE is also returned upon invalid input parameters or other + * error conditions. + */ +SR_API gboolean sr_dev_has_hwcap(const struct sr_dev_inst *sdi, int hwcap) { - unsigned int probenum; + const int *hwcaps; + int i; - /* TODO: plugin-specific clear call? */ + if (!sdi || !sdi->driver) + return FALSE; - if(device->probes) - for(probenum = 1; probenum <= g_slist_length(device->probes); probenum++) - device_probe_clear(device, probenum); + if (sdi->driver->info_get(SR_DI_HWCAPS, + (const void **)&hwcaps, NULL) != SR_OK) + return FALSE; -} + for (i = 0; hwcaps[i]; i++) { + if (hwcaps[i] == hwcap) + return TRUE; + } + return FALSE; +} -void device_destroy(struct 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 probenum; + struct sr_dev_inst *sdi; - /* TODO: plugin-specific destroy call, need to decrease refcount in plugin */ - - devices = g_slist_remove(devices, device); - if(device->probes) - { - for(probenum = 1; probenum <= g_slist_length(device->probes); probenum++) - device_probe_clear(device, probenum); - g_slist_free(device->probes); + if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) { + sr_err("%s: sdi malloc failed", __func__); + return NULL; } - g_free(device); + 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->priv = NULL; + + return sdi; } - -void device_probe_clear(struct device *device, int probenum) +/** @private */ +SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi) { - struct probe *p; - - p = probe_find(device, probenum); - if(!p) - return; + struct sr_probe *probe; + GSList *l; - if(p->name) - { - g_free(p->name); - p->name = NULL; + for (l = sdi->probes; l; l = l->next) { + probe = l->data; + g_free(probe->name); + g_free(probe); } - if(p->trigger) - { - g_free(p->trigger); - p->trigger = NULL; - } + g_free(sdi->priv); + g_free(sdi->vendor); + g_free(sdi->model); + g_free(sdi->version); + g_free(sdi); } +#ifdef HAVE_LIBUSB_1_0 -void device_probe_add(struct device *device, char *name) +/** @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 probe *p; + struct sr_usb_dev_inst *udi; - p = g_malloc0(sizeof(struct probe)); - p->index = g_slist_length(device->probes) + 1; - p->enabled = TRUE; - p->name = g_strdup(name); - p->trigger = NULL; - device->probes = g_slist_append(device->probes, p); + if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) { + sr_err("%s: udi malloc failed", __func__); + return NULL; + } -} + udi->bus = bus; + udi->address = address; + udi->devhdl = hdl; + return udi; +} -struct probe *probe_find(struct device *device, int probenum) +/** @private */ +SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb) { - GSList *l; - struct probe *p, *found_probe; - - found_probe = NULL; - for(l = device->probes; l; l = l->next) - { - p = l->data; - if(p->index == probenum) - { - found_probe = p; - break; - } - } + (void)usb; - return found_probe; + /* Nothing to do for this device instance type. */ } +#endif -void device_probe_name(struct device *device, int probenum, char *name) +/** @private + * @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. + * + * Both parameters are copied to newly allocated strings, and freed + * automatically by sr_serial_dev_inst_free(). + */ +SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, + const char *serialcomm) { - struct probe *p; + struct sr_serial_dev_inst *serial; - p = probe_find(device, probenum); - if(!p) - return; + if (!port) { + sr_err("hwdriver: serial port required"); + return NULL; + } - if(p->name) - g_free(p->name); - p->name = g_strdup(name); + if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) { + sr_err("hwdriver: serial malloc failed"); + return NULL; + } -} + serial->port = g_strdup(port); + if (serialcomm) + serial->serialcomm = g_strdup(serialcomm); + serial->fd = -1; + return serial; +} -void device_trigger_clear(struct device *device) +/** @private */ +SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial) { - struct probe *p; - unsigned int probenum; - - if(device->probes) - for(probenum = 1; probenum <= g_slist_length(device->probes); probenum++) - { - p = probe_find(device, probenum); - if(p && p->trigger) - { - g_free(p->trigger); - p->trigger = NULL; - } - } -} + g_free(serial->port); + g_free(serial->serialcomm); +} -void device_trigger_set(struct device *device, int probenum, char *trigger) +SR_API int sr_dev_config_set(const struct sr_dev_inst *sdi, int hwcap, + const void *value) { - struct probe *p; + int ret; + + if (!sdi || !sdi->driver || !sdi->driver->dev_config_set) { + sr_err("Unable to set config option."); + return SR_ERR; + } - p = probe_find(device, probenum); - if(!p) - return; + ret = sdi->driver->dev_config_set(sdi, hwcap, value); - if(p->trigger) - g_free(p->trigger); + return ret; +} - p->trigger = g_strdup(trigger); +SR_API GSList *sr_dev_inst_list(const struct sr_dev_driver *driver) +{ + if (driver && driver->dev_list) + return driver->dev_list(); + else + return NULL; } +SR_API int sr_dev_inst_clear(const struct sr_dev_driver *driver) +{ + + if (driver && driver->dev_clear) + return driver->dev_clear(); + else + return SR_OK; +} +/** @} */