* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
*/
-/** @file
- * Standard API helper functions.
- * @internal
- */
+/**
+ * @file
+ *
+ * Standard API helper functions.
+ */
+/* Needed for gettimeofday(), at least on FreeBSD. */
+#define _XOPEN_SOURCE 700
+
+#include <config.h>
+#include <string.h>
+#include <math.h>
+#include <sys/time.h>
#include <glib.h>
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
+#include "scpi.h"
#define LOG_PREFIX "std"
+SR_PRIV const uint32_t NO_OPTS[1] = {};
+
/**
- * Standard sr_driver_init() API helper.
+ * Standard driver init() callback API helper.
*
* This function can be used to simplify most driver's init() API callback.
*
- * It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and
- * then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed.
+ * Create a new 'struct drv_context' (drvc), assign sr_ctx to it, and
+ * then assign 'drvc' to the 'struct sr_dev_driver' (di) that is passed.
*
- * @param sr_ctx The libsigrok context to assign.
- * @param di The driver instance to use.
- * @param[in] prefix A driver-specific prefix string used for log messages.
+ * @param[in] di The driver instance to use. Must not be NULL.
+ * @param[in] sr_ctx The libsigrok context to assign. May be NULL.
*
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
- * SR_ERR_MALLOC upon memory allocation errors.
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
*/
-SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
- const char *prefix)
+SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
{
struct drv_context *drvc;
if (!di) {
- sr_err("%s: Invalid driver, cannot initialize.", prefix);
+ sr_err("%s: Invalid argument.", __func__);
return SR_ERR_ARG;
}
- if (!(drvc = g_try_malloc(sizeof(struct drv_context)))) {
- sr_err("%s: Driver context malloc failed.", prefix);
- return SR_ERR_MALLOC;
- }
-
+ drvc = g_malloc0(sizeof(struct drv_context));
drvc->sr_ctx = sr_ctx;
drvc->instances = NULL;
- di->priv = drvc;
+ di->context = drvc;
+
+ return SR_OK;
+}
+
+/**
+ * Standard driver cleanup() callback API helper.
+ *
+ * This function can be used to simplify most driver's cleanup() API callback.
+ *
+ * Free all device instances by calling sr_dev_clear() and then release any
+ * resources allocated by std_init().
+ *
+ * @param[in] di The driver instance to use. Must not be NULL.
+ *
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Other error.
+ */
+SR_PRIV int std_cleanup(const struct sr_dev_driver *di)
+{
+ int ret;
+
+ if (!di) {
+ sr_err("%s: Invalid argument.", __func__);
+ return SR_ERR_ARG;
+ }
+
+ ret = sr_dev_clear(di);
+ g_free(di->context);
+
+ return ret;
+}
+
+/**
+ * Dummmy driver dev_open() callback API helper.
+ *
+ * @param[in] sdi The device instance to use. May be NULL (unused).
+ *
+ * @retval SR_OK Success.
+ */
+SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi)
+{
+ (void)sdi;
+
+ return SR_OK;
+}
+
+/**
+ * Dummmy driver dev_close() callback API helper.
+ *
+ * @param[in] sdi The device instance to use. May be NULL (unused).
+ *
+ * @retval SR_OK Success.
+ */
+SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi)
+{
+ (void)sdi;
+
+ return SR_OK;
+}
+
+/**
+ * Dummmy driver dev_acquisition_start() callback API helper.
+ *
+ * @param[in] sdi The device instance to use. May be NULL (unused).
+ *
+ * @retval SR_OK Success.
+ */
+SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi)
+{
+ (void)sdi;
+
+ return SR_OK;
+}
+
+/**
+ * Dummmy driver dev_acquisition_stop() callback API helper.
+ *
+ * @param[in] sdi The device instance to use. May be NULL (unused).
+ *
+ * @retval SR_OK Success.
+ */
+SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi)
+{
+ (void)sdi;
return SR_OK;
}
/**
* Standard API helper for sending an SR_DF_HEADER packet.
*
- * This function can be used to simplify most driver's
+ * This function can be used to simplify most drivers'
* dev_acquisition_start() API callback.
*
- * @param sdi The device instance to use.
- * @param prefix A driver-specific prefix string used for log messages.
- * Must not be NULL. An empty string is allowed.
+ * @param[in] sdi The device instance to use. Must not be NULL.
*
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
- * SR_ERR upon other errors.
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Other error.
*/
-SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
- const char *prefix)
+SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi)
{
+ const char *prefix;
int ret;
struct sr_datafeed_packet packet;
struct sr_datafeed_header header;
- if (!prefix) {
- sr_err("Invalid prefix.");
+ if (!sdi) {
+ sr_err("%s: Invalid argument.", __func__);
return SR_ERR_ARG;
}
- sr_dbg("%s: Starting acquisition.", prefix);
+ prefix = (sdi->driver) ? sdi->driver->name : "unknown";
/* Send header packet to the session bus. */
- sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix);
packet.type = SR_DF_HEADER;
packet.payload = (uint8_t *)&header;
header.feed_version = 1;
gettimeofday(&header.starttime, NULL);
if ((ret = sr_session_send(sdi, &packet)) < 0) {
- sr_err("%s: Failed to send header packet: %d.", prefix, ret);
+ sr_err("%s: Failed to send SR_DF_HEADER packet: %d.", prefix, ret);
+ return ret;
+ }
+
+ return SR_OK;
+}
+
+static int send_df_without_payload(const struct sr_dev_inst *sdi, uint16_t packet_type)
+{
+ const char *prefix;
+ int ret;
+ struct sr_datafeed_packet packet;
+
+ if (!sdi) {
+ sr_err("%s: Invalid argument.", __func__);
+ return SR_ERR_ARG;
+ }
+
+ prefix = (sdi->driver) ? sdi->driver->name : "unknown";
+
+ packet.type = packet_type;
+ packet.payload = NULL;
+
+ if ((ret = sr_session_send(sdi, &packet)) < 0) {
+ sr_err("%s: Failed to send packet of type %d: %d.", prefix, packet_type, ret);
return ret;
}
return SR_OK;
}
-#ifdef HAVE_LIBSERIALPORT
+/**
+ * Standard API helper for sending an SR_DF_END packet.
+ *
+ * This function can be used to simplify most drivers'
+ * dev_acquisition_stop() API callback.
+ *
+ * @param[in] sdi The device instance to use. Must not be NULL.
+ *
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Other error.
+ */
+SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi)
+{
+ return send_df_without_payload(sdi, SR_DF_END);
+}
+
+/**
+ * Standard API helper for sending an SR_DF_TRIGGER packet.
+ *
+ * This function can be used to simplify most drivers' trigger handling.
+ *
+ * @param[in] sdi The device instance to use. Must not be NULL.
+ *
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Other error.
+ */
+SR_PRIV int std_session_send_df_trigger(const struct sr_dev_inst *sdi)
+{
+ return send_df_without_payload(sdi, SR_DF_TRIGGER);
+}
+
+/**
+ * Standard API helper for sending an SR_DF_FRAME_BEGIN packet.
+ *
+ * This function can be used to simplify most drivers' frame handling.
+ *
+ * @param[in] sdi The device instance to use. Must not be NULL.
+ *
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Other error.
+ */
+SR_PRIV int std_session_send_df_frame_begin(const struct sr_dev_inst *sdi)
+{
+ return send_df_without_payload(sdi, SR_DF_FRAME_BEGIN);
+}
/**
- * Standard serial driver dev_open() helper.
+ * Standard API helper for sending an SR_DF_FRAME_END packet.
+ *
+ * This function can be used to simplify most drivers' frame handling.
+ *
+ * @param[in] sdi The device instance to use. Must not be NULL.
+ *
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Other error.
+ */
+SR_PRIV int std_session_send_df_frame_end(const struct sr_dev_inst *sdi)
+{
+ return send_df_without_payload(sdi, SR_DF_FRAME_END);
+}
+
+#ifdef HAVE_SERIAL_COMM
+
+/**
+ * Standard serial driver dev_open() callback API helper.
*
* This function can be used to implement the dev_open() driver API
* callback in drivers that use a serial port. The port is opened
- * with the SERIAL_RDWR and SERIAL_NONBLOCK flags.
+ * with the SERIAL_RDWR flag.
*
- * If the open succeeded, the status field of the given sdi is set
- * to SR_ST_ACTIVE.
+ * @param[in] sdi The device instance to use. Must not be NULL.
*
* @retval SR_OK Success.
- * @retval SR_ERR Serial port open failed.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Serial port open failed.
*/
SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
{
struct sr_serial_dev_inst *serial;
- serial = sdi->conn;
- if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
- return SR_ERR;
+ if (!sdi) {
+ sr_err("%s: Invalid argument.", __func__);
+ return SR_ERR_ARG;
+ }
- sdi->status = SR_ST_ACTIVE;
+ serial = sdi->conn;
- return SR_OK;
+ return serial_open(serial, SERIAL_RDWR);
}
/**
- * Standard serial driver dev_close() helper.
+ * Standard serial driver dev_close() callback API helper.
*
* This function can be used to implement the dev_close() driver API
* callback in drivers that use a serial port.
*
- * After closing the port, the status field of the given sdi is set
- * to SR_ST_INACTIVE.
+ * @param[in] sdi The device instance to use. Must not be NULL.
*
* @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Serial port close failed.
*/
SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
{
struct sr_serial_dev_inst *serial;
- serial = sdi->conn;
- if (serial && sdi->status == SR_ST_ACTIVE) {
- serial_close(serial);
- sdi->status = SR_ST_INACTIVE;
+ if (!sdi) {
+ sr_err("%s: Invalid argument.", __func__);
+ return SR_ERR_ARG;
}
- return SR_OK;
+ serial = sdi->conn;
+
+ return serial_close(serial);
}
/**
- * Standard sr_session_stop() API helper.
+ * Standard serial driver dev_acquisition_stop() callback API helper.
*
- * This function can be used to simplify most (serial port based) driver's
+ * This function can be used to simplify most (serial port based) drivers'
* dev_acquisition_stop() API callback.
*
- * @param sdi The device instance for which acquisition should stop.
- * Must not be NULL.
- * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
- * @param dev_close_fn Function pointer to the driver's dev_close().
- * Must not be NULL.
- * @param serial The serial device instance (struct serial_dev_inst *).
- * Must not be NULL.
- * @param[in] prefix A driver-specific prefix string used for log messages.
- * Must not be NULL. An empty string is allowed.
+ * @param[in] sdi The device instance for which acquisition should stop.
+ * Must not be NULL.
*
* @retval SR_OK Success.
- * @retval SR_ERR_ARG Invalid arguments.
- * @retval SR_ERR_DEV_CLOSED Device is closed.
- * @retval SR_ERR Other errors.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Other error.
*/
-SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
- void *cb_data, dev_close_callback dev_close_fn,
- struct sr_serial_dev_inst *serial, const char *prefix)
+SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi)
{
+ struct sr_serial_dev_inst *serial;
+ const char *prefix;
int ret;
- struct sr_datafeed_packet packet;
- if (!prefix) {
- sr_err("Invalid prefix.");
+ if (!sdi) {
+ sr_err("%s: Invalid argument.", __func__);
return SR_ERR_ARG;
}
- if (sdi->status != SR_ST_ACTIVE) {
- sr_err("%s: Device inactive, can't stop acquisition.", prefix);
- return SR_ERR_DEV_CLOSED;
- }
-
- sr_dbg("%s: Stopping acquisition.", prefix);
+ serial = sdi->conn;
+ prefix = sdi->driver->name;
if ((ret = serial_source_remove(sdi->session, serial)) < 0) {
sr_err("%s: Failed to remove source: %d.", prefix, ret);
return ret;
}
- if ((ret = dev_close_fn(sdi)) < 0) {
- sr_err("%s: Failed to close device: %d.", prefix, ret);
- return ret;
- }
-
- /* Send SR_DF_END packet to the session bus. */
- sr_dbg("%s: Sending SR_DF_END packet.", prefix);
- packet.type = SR_DF_END;
- packet.payload = NULL;
- if ((ret = sr_session_send(cb_data, &packet)) < 0) {
- sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
- return ret;
- }
-
- return SR_OK;
+ return std_session_send_df_end(sdi);
}
#endif
/**
- * Standard driver dev_clear() helper.
+ * Standard driver dev_clear() callback API helper.
*
* Clear driver, this means, close all instances.
*
* This function can be used to implement the dev_clear() driver API
* callback. dev_close() is called before every sr_dev_inst is cleared.
*
- * The only limitation is driver-specific device contexts (sdi->priv).
+ * The only limitation is driver-specific device contexts (sdi->priv / devc).
* These are freed, but any dynamic allocation within structs stored
* there cannot be freed.
*
- * @param driver The driver which will have its instances released.
- * @param clear_private If not NULL, this points to a function called
- * with sdi->priv as argument. The function can then clear any device
- * instance-specific resources kept there. It must also clear the struct
- * pointed to by sdi->priv.
+ * @param[in] driver The driver which will have its instances released.
+ * Must not be NULL.
+ * @param[in] clear_private If not NULL, this points to a function called
+ * with sdi->priv (devc) as argument. The function can then clear
+ * any device instance-specific resources kept there.
+ * It must NOT clear the struct pointed to by sdi->priv (devc),
+ * since this function will always free it after clear_private()
+ * has run.
*
- * @return SR_OK on success.
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval SR_ERR_BUG Implementation bug.
+ * @retval other Other error.
*/
-SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
+SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
std_dev_clear_callback clear_private)
{
struct drv_context *drvc;
struct sr_dev_inst *sdi;
- struct sr_channel_group *cg;
- GSList *l, *lcg;
+ GSList *l;
int ret;
- if (!(drvc = driver->priv))
- /* Driver was never initialized, nothing to do. */
- return SR_OK;
+ if (!driver) {
+ sr_err("%s: Invalid argument.", __func__);
+ return SR_ERR_ARG;
+ }
+
+ drvc = driver->context; /* Caller checked for context != NULL. */
ret = SR_OK;
for (l = drvc->instances; l; l = l->next) {
if (!(sdi = l->data)) {
+ sr_err("%s: Invalid device instance.", __func__);
ret = SR_ERR_BUG;
continue;
}
- if (driver->dev_close)
+ if (driver->dev_close && sdi->status == SR_ST_ACTIVE)
driver->dev_close(sdi);
if (sdi->conn) {
-#ifdef HAVE_LIBSERIALPORT
+#ifdef HAVE_SERIAL_COMM
if (sdi->inst_type == SR_INST_SERIAL)
sr_serial_dev_inst_free(sdi->conn);
#endif
#endif
if (sdi->inst_type == SR_INST_SCPI)
sr_scpi_free(sdi->conn);
+ if (sdi->inst_type == SR_INST_MODBUS)
+ sr_modbus_free(sdi->conn);
}
+
+ /* Clear driver-specific stuff, if any. */
if (clear_private)
- /* The helper function is responsible for freeing
- * its own sdi->priv! */
clear_private(sdi->priv);
- else
- g_free(sdi->priv);
-
- /* Channel groups */
- for (lcg = sdi->channel_groups; lcg; lcg = lcg->next) {
- cg = lcg->data;
- g_free(cg->name);
- g_slist_free(cg->channels);
- g_free(cg);
- }
+
+ /* Clear sdi->priv (devc). */
+ g_free(sdi->priv);
+
sr_dev_inst_free(sdi);
}
return ret;
}
+
+SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver)
+{
+ return std_dev_clear_with_callback(driver, NULL);
+}
+
+/**
+ * Standard driver dev_list() callback API helper.
+ *
+ * This function can be used as the dev_list() callback by most drivers.
+ *
+ * Return the devices contained in the driver context instances list.
+ *
+ * @param[in] di The driver instance to use. Must not be NULL.
+ *
+ * @retval NULL Error, or the list is empty.
+ * @retval other The list of device instances of this driver.
+ */
+SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di)
+{
+ struct drv_context *drvc;
+
+ if (!di) {
+ sr_err("%s: Invalid argument.", __func__);
+ return NULL;
+ }
+
+ drvc = di->context;
+
+ return drvc->instances;
+}
+
+/**
+ * Standard driver scan() callback API helper.
+ *
+ * This function can be used to perform common tasks required by a driver's
+ * scan() callback. It will initialize the driver for each device on the list
+ * and add the devices on the list to the driver's device instance list.
+ * Usually it should be used as the last step in the scan() callback, right
+ * before returning.
+ *
+ * Note: This function can only be used if std_init() has been called
+ * previously by the driver.
+ *
+ * Example:
+ * @code{c}
+ * static GSList *scan(struct sr_dev_driver *di, GSList *options)
+ * {
+ * struct GSList *device;
+ * struct sr_dev_inst *sdi;
+ *
+ * sdi = g_new0(sr_dev_inst, 1);
+ * sdi->vendor = ...;
+ * ...
+ * devices = g_slist_append(devices, sdi);
+ * ...
+ * return std_scan_complete(di, devices);
+ * }
+ * @endcode
+ *
+ * @param[in] di The driver instance to use. Must not be NULL.
+ * @param[in] devices List of newly discovered devices (struct sr_dev_inst).
+ * May be NULL.
+ *
+ * @return The @p devices list.
+ */
+SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices)
+{
+ struct drv_context *drvc;
+ GSList *l;
+
+ if (!di) {
+ sr_err("Invalid driver instance (di), cannot complete scan.");
+ return NULL;
+ }
+
+ drvc = di->context;
+
+ for (l = devices; l; l = l->next) {
+ struct sr_dev_inst *sdi = l->data;
+ if (!sdi) {
+ sr_err("Invalid device instance, cannot complete scan.");
+ return NULL;
+ }
+ sdi->driver = di;
+ }
+
+ drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
+
+ return devices;
+}
+
+SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data,
+ const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
+ const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[],
+ size_t drvsize, const uint32_t devopts[], size_t devsize)
+{
+ switch (key) {
+ case SR_CONF_SCAN_OPTIONS:
+ /* Always return scanopts, regardless of sdi or cg. */
+ if (!scanopts || scanopts == NO_OPTS)
+ return SR_ERR_ARG;
+ *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+ scanopts, scansize, sizeof(uint32_t));
+ break;
+ case SR_CONF_DEVICE_OPTIONS:
+ if (!sdi) {
+ /* sdi == NULL: return drvopts. */
+ if (!drvopts || drvopts == NO_OPTS)
+ return SR_ERR_ARG;
+ *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+ drvopts, drvsize, sizeof(uint32_t));
+ } else if (sdi && !cg) {
+ /* sdi != NULL, cg == NULL: return devopts. */
+ if (!devopts || devopts == NO_OPTS)
+ return SR_ERR_ARG;
+ *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+ devopts, devsize, sizeof(uint32_t));
+ } else {
+ /*
+ * Note: sdi != NULL, cg != NULL is not handled by
+ * this function since it's very driver-specific.
+ */
+ sr_err("%s: %s: sdi/cg != NULL: not handling.",
+ sdi->driver->name, __func__);
+ return SR_ERR_ARG;
+ }
+ break;
+ default:
+ return SR_ERR_NA;
+ }
+
+ return SR_OK;
+}
+
+SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n)
+{
+ unsigned int i;
+ GVariant *rational[2];
+ GVariantBuilder gvb;
+
+ g_variant_builder_init(&gvb, G_VARIANT_TYPE_TUPLE);
+
+ for (i = 0; i < n; i++) {
+ rational[0] = g_variant_new_uint64(a[i][0]);
+ rational[1] = g_variant_new_uint64(a[i][1]);
+
+ /* FIXME: Valgrind reports a memory leak here. */
+ g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational,
+ ARRAY_SIZE(rational)));
+ }
+
+ return g_variant_builder_end(&gvb);
+}
+
+SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n)
+{
+ unsigned int i;
+ GVariant *rational[2];
+ GVariantBuilder gvb;
+
+ g_variant_builder_init(&gvb, G_VARIANT_TYPE_TUPLE);
+
+ for (i = 0; i < n; i++) {
+ rational[0] = g_variant_new_uint64(r[i].p);
+ rational[1] = g_variant_new_uint64(r[i].q);
+
+ /* FIXME: Valgrind reports a memory leak here. */
+ g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational,
+ ARRAY_SIZE(rational)));
+ }
+
+ return g_variant_builder_end(&gvb);
+}
+
+static GVariant *samplerate_helper(const uint64_t samplerates[], unsigned int n, const char *str)
+{
+ GVariant *gvar;
+ GVariantBuilder gvb;
+
+ g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
+ gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
+ n, sizeof(uint64_t));
+ g_variant_builder_add(&gvb, "{sv}", str, gvar);
+
+ return g_variant_builder_end(&gvb);
+}
+
+SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n)
+{
+ return samplerate_helper(samplerates, n, "samplerates");
+}
+
+SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n)
+{
+ return samplerate_helper(samplerates, n, "samplerate-steps");
+}
+
+SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step)
+{
+ GVariantBuilder gvb;
+
+ g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
+
+ g_variant_builder_add_value(&gvb, g_variant_new_double(min));
+ g_variant_builder_add_value(&gvb, g_variant_new_double(max));
+ g_variant_builder_add_value(&gvb, g_variant_new_double(step));
+
+ return g_variant_builder_end(&gvb);
+}
+
+SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3])
+{
+ unsigned int i;
+ GVariantBuilder gvb;
+
+ g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
+
+ for (i = 0; i < 3; i++)
+ g_variant_builder_add_value(&gvb, g_variant_new_double(a[i]));
+
+ return g_variant_builder_end(&gvb);
+}
+
+SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double min, const double max, const double step)
+{
+ double d, v;
+ GVariant *gvar, *range[2];
+ GVariantBuilder gvb;
+
+ g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
+
+ for (d = min; d <= max + step / 2.0; d += step) {
+ /*
+ * We will never see exactly 0.0 because of the error we're
+ * accumulating, so catch the "zero" value and force it to be 0.
+ */
+ v = ((d > (-step / 2.0)) && (d < (step / 2.0))) ? 0 : d;
+
+ range[0] = g_variant_new_double(v);
+ range[1] = g_variant_new_double(v);
+
+ gvar = g_variant_new_tuple(range, ARRAY_SIZE(range));
+ g_variant_builder_add_value(&gvb, gvar);
+ }
+
+ return g_variant_builder_end(&gvb);
+}
+
+SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high)
+{
+ GVariant *range[2];
+
+ range[0] = g_variant_new_uint64(low);
+ range[1] = g_variant_new_uint64(high);
+
+ return g_variant_new_tuple(range, ARRAY_SIZE(range));
+}
+
+SR_PRIV GVariant *std_gvar_tuple_double(double low, double high)
+{
+ GVariant *range[2];
+
+ range[0] = g_variant_new_double(low);
+ range[1] = g_variant_new_double(high);
+
+ return g_variant_new_tuple(range, ARRAY_SIZE(range));
+}
+
+SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n)
+{
+ return g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+ a, n, sizeof(int32_t));
+}
+
+SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n)
+{
+ return g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+ a, n, sizeof(uint32_t));
+}
+
+SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n)
+{
+ return g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64,
+ a, n, sizeof(uint64_t));
+}
+
+SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n)
+{
+ GVariant *gvar;
+ GVariantBuilder *builder;
+ unsigned int i;
+
+ builder = g_variant_builder_new(G_VARIANT_TYPE ("as"));
+
+ for (i = 0; i < n; i++)
+ g_variant_builder_add(builder, "s", a[i]);
+
+ gvar = g_variant_new("as", builder);
+ g_variant_builder_unref(builder);
+
+ return gvar;
+}
+
+SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n)
+{
+ unsigned int i;
+ GVariant *gvar, *range[2];
+ GVariantBuilder gvb;
+
+ g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
+
+ for (i = 0; i < n; i++) {
+ range[0] = g_variant_new_double(a[i][0]);
+ range[1] = g_variant_new_double(a[i][1]);
+ gvar = g_variant_new_tuple(range, ARRAY_SIZE(range));
+ g_variant_builder_add_value(&gvb, gvar);
+ }
+
+ return g_variant_builder_end(&gvb);
+}
+
+/* Return the index of 'data' in the array 'arr' (or -1). */
+static int find_in_array(GVariant *data, const GVariantType *type,
+ const void *arr, unsigned int n)
+{
+ const char * const *sarr;
+ const char *s;
+ const uint64_t *u64arr;
+ const uint8_t *u8arr;
+ uint64_t u64;
+ uint8_t u8;
+ unsigned int i;
+
+ if (!g_variant_is_of_type(data, type))
+ return -1;
+
+ switch (g_variant_classify(data)) {
+ case G_VARIANT_CLASS_STRING:
+ s = g_variant_get_string(data, NULL);
+ sarr = arr;
+
+ for (i = 0; i < n; i++)
+ if (!strcmp(s, sarr[i]))
+ return i;
+ break;
+ case G_VARIANT_CLASS_UINT64:
+ u64 = g_variant_get_uint64(data);
+ u64arr = arr;
+
+ for (i = 0; i < n; i++)
+ if (u64 == u64arr[i])
+ return i;
+ break;
+ case G_VARIANT_CLASS_BYTE:
+ u8 = g_variant_get_byte(data);
+ u8arr = arr;
+
+ for (i = 0; i < n; i++)
+ if (u8 == u8arr[i])
+ return i;
+ default:
+ break;
+ }
+
+ return -1;
+}
+
+SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n)
+{
+ return find_in_array(data, G_VARIANT_TYPE_STRING, a, n);
+}
+
+SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n)
+{
+ return find_in_array(data, G_VARIANT_TYPE_UINT64, a, n);
+}
+
+SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n)
+{
+ return find_in_array(data, G_VARIANT_TYPE_BYTE, a, n);
+}
+
+SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n)
+{
+ int idx;
+ GVariant *data;
+
+ data = g_variant_new_string(s);
+ idx = find_in_array(data, G_VARIANT_TYPE_STRING, a, n);
+ g_variant_unref(data);
+
+ return idx;
+}
+
+SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n)
+{
+ int idx;
+ GVariant *data;
+
+ data = g_variant_new_byte(b);
+ idx = find_in_array(data, G_VARIANT_TYPE_BYTE, a, n);
+ g_variant_unref(data);
+
+ return idx;
+}
+
+SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n)
+{
+ unsigned int i;
+ uint64_t low, high;
+
+ g_variant_get(data, "(tt)", &low, &high);
+
+ for (i = 0; i < n; i++)
+ if (a[i][0] == low && a[i][1] == high)
+ return i;
+
+ return -1;
+}
+
+SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n)
+{
+ unsigned int i;
+ double low, high;
+
+ g_variant_get(data, "(dd)", &low, &high);
+
+ for (i = 0; i < n; i++)
+ if ((fabs(a[i][0] - low) < 0.1) && ((fabs(a[i][1] - high) < 0.1)))
+ return i;
+
+ return -1;
+}
+
+SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n)
+{
+ unsigned int i;
+
+ for (i = 0; i < n; i++)
+ if (d == a[i][0])
+ return i;
+
+ return -1;
+}
+
+SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n)
+{
+ unsigned int i;
+
+ for (i = 0; i < n; i++)
+ if (cg == a[i])
+ return i;
+
+ return -1;
+}
+
+SR_PRIV int std_dummy_set_params(struct sr_serial_dev_inst *serial,
+ int baudrate, int bits, int parity, int stopbits,
+ int flowcontrol, int rts, int dtr)
+{
+ (void)serial;
+ (void)baudrate;
+ (void)bits;
+ (void)parity;
+ (void)stopbits;
+ (void)flowcontrol;
+ (void)rts;
+ (void)dtr;
+
+ return SR_OK;
+}
+
+SR_PRIV int std_dummy_set_handshake(struct sr_serial_dev_inst *serial,
+ int rts, int dtr)
+{
+ (void)serial;
+ (void)rts;
+ (void)dtr;
+
+ return SR_OK;
+}
projects / libsigrok.git / blobdiff