X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=device.c;h=b261d6a741b2e93b6a54b958abb532e71361c6a9;hb=53f05fa80f1f9d7657f1173f24d9d1e2b740a312;hp=d305710c1bc1f98c1655d1f4fb8fbba774aa294e;hpb=7b870c38e3040fec1165a623ae3986e4fb342218;p=libsigrok.git diff --git a/device.c b/device.c index d305710c..b261d6a7 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-2012 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,9 +19,25 @@ #include #include +#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. + */ + /** * @defgroup grp_devices Devices * @@ -37,7 +53,7 @@ SR_PRIV struct sr_probe *sr_probe_new(int index, int type, struct sr_probe *probe; if (!(probe = g_try_malloc0(sizeof(struct sr_probe)))) { - sr_err("hwdriver: probe malloc failed"); + sr_err("Probe malloc failed."); return NULL; } @@ -63,6 +79,8 @@ SR_PRIV struct sr_probe *sr_probe_new(int index, int type, * of the string is made. * * @return SR_OK on success, or SR_ERR_ARG on invalid arguments. + * + * @since 0.2.0 */ SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi, int probenum, const char *name) @@ -98,6 +116,8 @@ SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi, * @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) @@ -133,6 +153,8 @@ SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum, * @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.2.0 */ SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, const char *trigger) @@ -160,37 +182,46 @@ SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, } /** - * Determine whether the specified device has the specified capability. + * Determine whether the specified device instance has the specified + * capability. * - * @param dev Pointer to the device instance to be checked. Must not be NULL. + * @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). + * @param key The option that should be checked for support on the + * specified device. * - * @return TRUE if the device has the specified capability, FALSE otherwise. - * FALSE is also returned upon invalid input parameters or other + * @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.2.0 */ -SR_API gboolean sr_dev_has_hwcap(const struct sr_dev_inst *sdi, int hwcap) +SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key) { - const int *hwcaps; - int i; + GVariant *gvar; + const int *devopts; + gsize num_opts, i; + int ret; - if (!sdi || !sdi->driver) + if (!sdi || !sdi->driver || !sdi->driver->config_list) return FALSE; - if (sdi->driver->info_get(SR_DI_HWCAPS, - (const void **)&hwcaps, NULL) != SR_OK) + if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS, &gvar, NULL) != SR_OK) return FALSE; - for (i = 0; hwcaps[i]; i++) { - if (hwcaps[i] == hwcap) - return TRUE; + 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 FALSE; + return ret; } /** @private */ @@ -200,7 +231,7 @@ SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status, struct sr_dev_inst *sdi; if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) { - sr_err("hwdriver: %s: sdi malloc failed", __func__); + sr_err("Device instance malloc failed."); return NULL; } @@ -212,6 +243,7 @@ SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status, 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; @@ -226,15 +258,15 @@ SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi) for (l = sdi->probes; l; l = l->next) { probe = l->data; g_free(probe->name); + g_free(probe->trigger); g_free(probe); } + g_slist_free(sdi->probes); - g_free(sdi->priv); g_free(sdi->vendor); g_free(sdi->model); g_free(sdi->version); g_free(sdi); - } #ifdef HAVE_LIBUSB_1_0 @@ -246,7 +278,7 @@ SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, struct sr_usb_dev_inst *udi; if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) { - sr_err("hwdriver: %s: udi malloc failed", __func__); + sr_err("USB device instance malloc failed."); return NULL; } @@ -260,27 +292,46 @@ SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, /** @private */ SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb) { - /* Avoid compiler warnings. */ - (void)usb; - - /* Nothing to do for this device instance type. */ + g_free(usb); } #endif -/** @private */ +/** + * @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, - int fd) + const char *serialcomm) { struct sr_serial_dev_inst *serial; - if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) { - sr_err("hwdriver: %s: serial malloc failed", __func__); + if (!port) { + sr_err("Serial port required."); + return NULL; + } + + if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) { + sr_err("Serial device instance malloc failed."); return NULL; } serial->port = g_strdup(port); - serial->fd = fd; + if (serialcomm) + serial->serialcomm = g_strdup(serialcomm); + serial->fd = -1; return serial; } @@ -289,39 +340,85 @@ SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial) { g_free(serial->port); + g_free(serial->serialcomm); + g_free(serial); } -SR_API int sr_dev_config_set(const struct sr_dev_inst *sdi, int hwcap, - const void *value) +/** + * 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.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; +} + +/** + * 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) +{ + if (driver && driver->dev_clear) + return driver->dev_clear(); + else + return SR_OK; +} + +/** + * 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 (!sdi || !sdi->driver || !sdi->driver->dev_config_set) { - sr_err("hwdriver: unable to set config option"); + if (!sdi || !sdi->driver || !sdi->driver->dev_open) return SR_ERR; - } - ret = sdi->driver->dev_config_set(sdi, hwcap, value); + ret = sdi->driver->dev_open(sdi); return ret; } -SR_API GSList *sr_dev_inst_list(const struct sr_dev_driver *driver) +/** + * 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 ret; - if (driver && driver->dev_list) - return driver->dev_list(); - else - return NULL; -} + if (!sdi || !sdi->driver || !sdi->driver->dev_close) + return SR_ERR; -SR_API int sr_dev_inst_clear(const struct sr_dev_driver *driver) -{ + ret = sdi->driver->dev_close(sdi); - if (driver && driver->dev_clear) - return driver->dev_clear(); - else - return SR_OK; + return ret; } /** @} */