X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=device.c;h=b261d6a741b2e93b6a54b958abb532e71361c6a9;hb=53f05fa80f1f9d7657f1173f24d9d1e2b740a312;hp=3214a078e7824d337879a4544abb0ad5db4c43b6;hpb=cbadb856d6d833f2822cf63e4884abb409da6172;p=libsigrok.git diff --git a/device.c b/device.c index 3214a078..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 @@ -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) @@ -183,31 +189,39 @@ SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, * 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 option The option that should be checked for support on the + * @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.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) + if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS, &gvar, 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 */ @@ -217,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("%s: sdi malloc failed", __func__); + sr_err("Device instance malloc failed."); return NULL; } @@ -229,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; @@ -243,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 @@ -263,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("%s: udi malloc failed", __func__); + sr_err("USB device instance malloc failed."); return NULL; } @@ -277,24 +292,26 @@ 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. +/** + * @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) @@ -302,12 +319,12 @@ SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, struct sr_serial_dev_inst *serial; if (!port) { - sr_err("hwdriver: serial port required"); + sr_err("Serial port required."); return NULL; } if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) { - sr_err("hwdriver: serial malloc failed"); + sr_err("Serial device instance malloc failed."); return NULL; } @@ -322,29 +339,86 @@ SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, /** @private */ 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 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(); else 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(); 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_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; +} + /** @} */