X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=device.c;h=2509c542ba4566816998f58e74de4bd4a6e7c881;hb=393fb9cb18c5746d8567c9cf74b872804043345a;hp=3166ea8e0c087d72431ab7269d80e0308109c2cf;hpb=0abee5076fd7751bd77d0fee940d617a1a40ea34;p=libsigrok.git diff --git a/device.c b/device.c index 3166ea8e..2509c542 100644 --- a/device.c +++ b/device.c @@ -19,411 +19,316 @@ #include #include -#include "sigrok.h" -#include "sigrok-internal.h" - -static GSList *devs = NULL; +#include "libsigrok.h" +#include "libsigrok-internal.h" /** - * Scan the system for attached logic analyzers / devices. - * - * This will try to autodetect all supported logic analyzer devices: - * - * - Those attached via USB (can be reliably detected via USB VID/PID). - * - * - Those using a (real or virtual) serial port (detected by sending - * device-specific commands to all OS-specific serial port devices such - * as /dev/ttyS*, /dev/ttyUSB*, /dev/ttyACM*, and others). - * The autodetection for this kind of devices can potentially be unreliable. - * - * Also, sending various bytes/commands to (all!) devices which happen to - * be attached to the system via a (real or virtual) serial port can be - * problematic. There is no way for libsigrok to know how unknown devices - * react to the bytes libsigrok sends. Potentially they could lead to the - * device getting into invalid/error states, losing/overwriting data, or... - * - * In addition to the detection, the devices that are found are also - * initialized automatically. On some devices, this involves a firmware upload, - * or other such measures. - * - * The order in which the system is scanned for devices is not specified. The - * 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_dev_list(). + * @file * - * TODO: Error checks? - * TODO: Option to only scan for specific devices or device classes. - * - * @return SR_OK upon success, SR_ERR_BUG upon internal errors. + * Device handling in libsigrok. */ -SR_API int sr_dev_scan(void) -{ - int i; - struct sr_dev_driver **drivers; - - drivers = sr_driver_list(); - if (!drivers[0]) { - sr_err("dev: %s: no supported hardware drivers", __func__); - return SR_ERR_BUG; - } - - /* - * 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 (i = 0; drivers[i]; i++) - sr_driver_init(drivers[i]); - - return SR_OK; -} /** - * Return the list of logic analyzer devices libsigrok has detected. + * @defgroup grp_devices Devices * - * If the libsigrok-internal device list is empty, a scan for attached - * devices -- via a call to sr_dev_scan() -- is performed first. + * Device handling in libsigrok. * - * TODO: Error handling? - * - * @return The list (GSList) of detected devices, or NULL if none were found. + * @{ */ -SR_API GSList *sr_dev_list(void) -{ - if (!devs) - sr_dev_scan(); - - return devs; -} -/** - * Create a new device. - * - * 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 - * no longer needed. TODO: Using which API function? - * - * @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_dev *sr_dev_new(const struct sr_dev_driver *driver, - int driver_index) +/** @private */ +SR_PRIV struct sr_probe *sr_probe_new(int index, int type, + gboolean enabled, const char *name) { - struct sr_dev *dev; + struct sr_probe *probe; - /* TODO: Check if driver_index valid? */ - - if (!(dev = g_try_malloc0(sizeof(struct sr_dev)))) { - sr_err("dev: %s: dev malloc failed", __func__); + if (!(probe = g_try_malloc0(sizeof(struct sr_probe)))) { + sr_err("hwdriver: probe malloc failed"); return NULL; } - dev->driver = (struct sr_dev_driver *)driver; - dev->driver_index = driver_index; - devs = g_slist_append(devs, dev); + probe->index = index; + probe->type = type; + probe->enabled = enabled; + if (name) + probe->name = g_strdup(name); - return dev; + return probe; } /** - * 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_dev_trigger_set(). + * Set the name of the specified probe in the specified device. * - * 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. - * if the caller tries to add more probes than the device actually has. + * If the probe already has a different name assigned to it, it will be + * removed, and the new name will be saved instead. * - * @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. + * @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 upon success, SR_ERR_MALLOC upon memory allocation errors, - * or SR_ERR_ARG upon invalid arguments. - * If something other than SR_OK is returned, 'dev' is unchanged. + * @return SR_OK on success, or SR_ERR_ARG on invalid arguments. */ -SR_API int sr_dev_probe_add(struct sr_dev *dev, const char *name) +SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi, + int probenum, const char *name) { - struct sr_probe *p; - int probenum; - - if (!dev) { - sr_err("dev: %s: dev was NULL", __func__); - return SR_ERR_ARG; - } + GSList *l; + struct sr_probe *probe; + int ret; - if (!name) { - sr_err("dev: %s: name was NULL", __func__); + if (!sdi) { + sr_err("%s: sdi was NULL", __func__); return SR_ERR_ARG; } - /* TODO: Further checks to ensure name is valid. */ - - probenum = g_slist_length(dev->probes) + 1; - - if (!(p = g_try_malloc0(sizeof(struct sr_probe)))) { - sr_err("dev: %s: p malloc failed", __func__); - return SR_ERR_MALLOC; + 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; + } } - p->index = probenum; - p->enabled = TRUE; - p->name = g_strdup(name); - p->trigger = NULL; - dev->probes = g_slist_append(dev->probes, p); - - return SR_OK; + return ret; } /** - * Find the probe with the specified number in the specified device. + * Enable or disable a probe on the specified device. * - * TODO + * @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. * - * @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!). - * - * TODO: Should return int. - * 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. + * @return SR_OK on success, or SR_ERR_ARG on invalid arguments. */ -SR_API struct sr_probe *sr_dev_probe_find(const struct sr_dev *dev, - int probenum) +SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum, + gboolean state) { GSList *l; - struct sr_probe *p, *found_probe; - - if (!dev) { - sr_err("dev: %s: dev was NULL", __func__); - return NULL; /* TODO: SR_ERR_ARG */ - } + struct sr_probe *probe; + int ret; - /* TODO: Sanity check on probenum. */ + if (!sdi) + return SR_ERR_ARG; - found_probe = NULL; - for (l = dev->probes; l; l = l->next) { - p = l->data; - /* TODO: Check for p != NULL. */ - if (p->index == probenum) { - found_probe = p; + 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 found_probe; + return ret; } /** - * Set the name of the specified probe in the specified device. + * Add a trigger to the specified device (and the specified probe). * - * If the probe already has a different name assigned to it, it will be - * removed, and the new name will be saved instead. + * If the specified probe of this device already has a trigger, it will + * be silently replaced. * - * @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. + * @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 upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR - * upon other errors. - * If something other than SR_OK is returned, 'dev' is unchanged. + * @return SR_OK on success, or SR_ERR_ARG on invalid arguments. */ -SR_API int sr_dev_probe_name_set(struct sr_dev *dev, int probenum, - const char *name) +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 (!dev) { - sr_err("dev: %s: dev was NULL", __func__); + if (!sdi) return SR_ERR_ARG; - } - 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? */ + 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; + } } - /* TODO: Sanity check on 'name'. */ - - /* If the probe already has a name, kill it first. */ - g_free(p->name); - - p->name = g_strdup(name); - - return SR_OK; + return ret; } /** - * Remove all triggers set up for the specified device. + * Determine whether the specified device instance has the specified + * capability. * - * TODO: Better description. - * - * @param dev TODO + * @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 SR_OK upon success, SR_ERR_ARG upon invalid arguments. - * If something other than SR_OK is returned, 'dev' is unchanged. + * @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 int sr_dev_trigger_clear(struct sr_dev *dev) +SR_API gboolean sr_dev_has_hwcap(const struct sr_dev_inst *sdi, int hwcap) { - struct sr_probe *p; - unsigned int pnum; /* TODO: uint16_t? */ + const int *hwcaps; + int i; - if (!dev) { - sr_err("dev: %s: dev was NULL", __func__); - return SR_ERR_ARG; - } + if (!sdi || !sdi->driver) + return FALSE; - if (!dev->probes) { - sr_err("dev: %s: dev->probes was NULL", __func__); - return SR_ERR_ARG; + 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; } - 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); - p->trigger = NULL; - } + return FALSE; +} + +/** @private */ +SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status, + const char *vendor, const char *model, const char *version) +{ + struct sr_dev_inst *sdi; + + if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) { + sr_err("hwdriver: %s: sdi malloc failed", __func__); + return NULL; } - return SR_OK; + 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; } -/** - * Add a trigger to the specified device. - * - * TODO: Better description. - * TODO: Describe valid format of the 'trigger' string. - * - * @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. - * 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, 'dev' is unchanged. - */ -SR_API int sr_dev_trigger_set(struct sr_dev *dev, int probenum, - const char *trigger) +/** @private */ +SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi) { - struct sr_probe *p; + struct sr_probe *probe; + GSList *l; - if (!dev) { - sr_err("dev: %s: dev was NULL", __func__); - return SR_ERR_ARG; + for (l = sdi->probes; l; l = l->next) { + probe = l->data; + g_free(probe->name); + g_free(probe); } - /* TODO: Sanity check on 'probenum'. */ + g_free(sdi->priv); + g_free(sdi->vendor); + g_free(sdi->model); + g_free(sdi->version); + g_free(sdi); + +} + +#ifdef HAVE_LIBUSB_1_0 - /* TODO: Sanity check on 'trigger'. */ +/** @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; - 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? */ + if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) { + sr_err("hwdriver: %s: udi malloc failed", __func__); + return NULL; } - /* If the probe already has a trigger, kill it first. */ - g_free(p->trigger); + udi->bus = bus; + udi->address = address; + udi->devhdl = hdl; + + return udi; +} - p->trigger = g_strdup(trigger); +/** @private */ +SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb) +{ + /* Avoid compiler warnings. */ + (void)usb; - return SR_OK; + /* Nothing to do for this device instance type. */ } -/** - * Determine whether the specified device has the specified capability. - * - * TODO: Should return int? - * - * @param dev Pointer to the device to be checked. Must not be NULL. - * The device's 'driver' field must not be NULL either. - * @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 *dev, int hwcap) +#endif + +/** @private */ +SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, + int fd) { - int *hwcaps, i; + struct sr_serial_dev_inst *serial; - if (!dev) { - sr_err("dev: %s: dev was NULL", __func__); - return FALSE; /* TODO: SR_ERR_ARG. */ + if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) { + sr_err("hwdriver: %s: serial malloc failed", __func__); + return NULL; } - if (!dev->driver) { - sr_err("dev: %s: dev->driver was NULL", __func__); - return FALSE; /* TODO: SR_ERR_ARG. */ - } + serial->port = g_strdup(port); + serial->fd = fd; - /* TODO: Sanity check on 'hwcap'. */ + return serial; +} - if (!(hwcaps = dev->driver->hwcap_get_all())) { - sr_err("dev: %s: dev has no capabilities", __func__); - return FALSE; /* TODO: SR_ERR*. */ - } +/** @private */ +SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial) +{ + g_free(serial->port); +} - for (i = 0; hwcaps[i]; i++) { - if (hwcaps[i] != hwcap) - continue; - sr_spew("dev: %s: found hwcap %d", __func__, hwcap); - return TRUE; +SR_API int sr_dev_config_set(const struct sr_dev_inst *sdi, int hwcap, + const void *value) +{ + int ret; + + if (!sdi || !sdi->driver || !sdi->driver->dev_config_set) { + sr_err("hwdriver: unable to set config option"); + return SR_ERR; } - sr_spew("dev: %s: hwcap %d not found", __func__, hwcap); + ret = sdi->driver->dev_config_set(sdi, hwcap, value); - return FALSE; + return ret; } -/** - * Returns information about the given device. - * - * @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. - */ -SR_API int sr_dev_info_get(const struct sr_dev *dev, int id, const void **data) +SR_API GSList *sr_dev_inst_list(const struct sr_dev_driver *driver) { - if ((dev == NULL) || (dev->driver == NULL)) - return SR_ERR_ARG; - if (data == NULL) - return SR_ERR_ARG; - - *data = dev->driver->dev_info_get(dev->driver_index, id); + if (driver && driver->dev_list) + return driver->dev_list(); + else + return NULL; +} - if (*data == NULL) - return SR_ERR; +SR_API int sr_dev_inst_clear(const struct sr_dev_driver *driver) +{ - return SR_OK; + if (driver && driver->dev_clear) + return driver->dev_clear(); + else + return SR_OK; } + +/** @} */