X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=device.c;h=0167a220cc390b289bbfd121e650c5a32f4cb74a;hb=ae67644fe5340d9c6e450fb0443178af356e0647;hp=d489ef3f8cff7d6e1e65d2443e801aaa7cebe069;hpb=13d8e03c4f9fb6fe9c5f682ab957173effe42d43;p=libsigrok.git diff --git a/device.c b/device.c index d489ef3f..0167a220 100644 --- a/device.c +++ b/device.c @@ -1,5 +1,5 @@ /* - * This file is part of the sigrok project. + * This file is part of the libsigrok project. * * Copyright (C) 2013 Bert Vermeulen * @@ -23,14 +23,14 @@ #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) +/* 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 @@ -79,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) @@ -114,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) @@ -149,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) @@ -189,25 +195,34 @@ SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, * @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_option(const struct sr_dev_inst *sdi, int key) { + GVariant *gvar; const int *devopts; - int i; + gsize num_opts, i; + int ret; - if (!sdi || !sdi->driver) + if (!sdi || !sdi->driver || !sdi->driver->config_list) return FALSE; if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS, - (const void **)&devopts, NULL) != SR_OK) + &gvar, NULL, NULL) != SR_OK) return FALSE; - for (i = 0; devopts[i]; i++) { - if (devopts[i] == key) - 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 */ @@ -229,6 +244,8 @@ 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->probe_groups = NULL; + sdi->conn = NULL; sdi->priv = NULL; return sdi; @@ -243,15 +260,18 @@ 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); + + if (sdi->probe_groups) + g_slist_free(sdi->probe_groups); - g_free(sdi->priv); g_free(sdi->vendor); g_free(sdi->model); g_free(sdi->version); g_free(sdi); - } #ifdef HAVE_LIBUSB_1_0 @@ -277,24 +297,28 @@ 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) { - (void)usb; - - /* Nothing to do for this device instance type. */ + g_free(usb); } #endif -/** @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. +#ifdef HAVE_LIBSERIALPORT + +/** + * @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) @@ -326,8 +350,45 @@ SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial) g_free(serial->serialcomm); g_free(serial); } +#endif + +SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device) +{ + struct sr_usbtmc_dev_inst *usbtmc; + + if (!device) { + sr_err("Device name required."); + return NULL; + } + + if (!(usbtmc = g_try_malloc0(sizeof(struct sr_usbtmc_dev_inst)))) { + sr_err("USBTMC device instance malloc failed."); + return NULL; + } + + usbtmc->device = g_strdup(device); + usbtmc->fd = -1; + + return usbtmc; +} + +SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc) +{ + g_free(usbtmc->device); + g_free(usbtmc); +} -SR_API GSList *sr_dev_inst_list(const struct sr_dev_driver *driver) +/** + * 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(); @@ -335,7 +396,16 @@ SR_API GSList *sr_dev_inst_list(const struct sr_dev_driver *driver) return NULL; } -SR_API int sr_dev_inst_clear(const struct sr_dev_driver *driver) +/** + * 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(); @@ -343,4 +413,46 @@ SR_API int sr_dev_inst_clear(const struct sr_dev_driver *driver) 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_open) + return SR_ERR; + + ret = sdi->driver->dev_open(sdi); + + return ret; +} + +/** + * 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 (!sdi || !sdi->driver || !sdi->driver->dev_close) + return SR_ERR; + + ret = sdi->driver->dev_close(sdi); + + return ret; +} + /** @} */