drivers: return SR_ERR_NA on unsupported config key

[libsigrok.git] / libsigrok.h

diff --git a/libsigrok.h b/libsigrok.h
index 3d577cccac2f93f0d14d9dcae795162170536e0b..294bb15d7d3ba0a5fd7827ddf89b9640dfaead1a 100644 (file)
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -1,7 +1,7 @@
 /*
  * This file is part of the sigrok project.
  *
- * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
  *
  * 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
@@ -36,7 +36,7 @@ extern "C" {
  * The public libsigrok header file to be used by frontends.
  *
  * This is the only file that libsigrok users (frontends) are supposed to
- * use and #include. There are other header files which get installed with
+ * use and \#include. There are other header files which get installed with
  * libsigrok, but those are not meant to be used directly by frontends.
  *
  * The correct way to get/use the libsigrok API functions is:
@@ -70,6 +70,7 @@ enum {
        SR_ERR_ARG        = -3, /**< Function argument error. */
        SR_ERR_BUG        = -4, /**< Errors hinting at internal bugs. */
        SR_ERR_SAMPLERATE = -5, /**< Incorrect samplerate. */
+       SR_ERR_NA         = -6, /**< Not applicable. */
 };
 
 #define SR_MAX_NUM_PROBES    64 /* Limited by uint64_t. */
@@ -522,7 +523,7 @@ struct sr_probe {
 
 struct sr_config {
        int key;
-       const void *value;
+       GVariant *data;
 };
 
 struct sr_config_info {
@@ -636,6 +637,12 @@ enum {
        /** The device supports setting its sample interval, in ms. */
        SR_CONF_SAMPLE_INTERVAL,
 
+       /** Number of timebases, as related to SR_CONF_TIMEBASE.  */
+       SR_CONF_NUM_TIMEBASE,
+
+       /** Number of vertical divisions, as related to SR_CONF_VDIV.  */
+       SR_CONF_NUM_VDIV,
+
        /*--- Special stuff -------------------------------------------------*/
 
        /** Scan options supported by the driver. */
@@ -722,18 +729,6 @@ enum {
        SR_ST_STOPPING,
 };
 
-/*
- * A device supports either a range of samplerates with steps of a given
- * granularity, or is limited to a set of defined samplerates. Use either
- * step or list, but not both.
- */
-struct sr_samplerates {
-       uint64_t low;
-       uint64_t high;
-       uint64_t step;
-       const uint64_t *list;
-};
-
 struct sr_dev_driver {
        /* Driver-specific */
        char *name;
@@ -744,11 +739,11 @@ struct sr_dev_driver {
        GSList *(*scan) (GSList *options);
        GSList *(*dev_list) (void);
        int (*dev_clear) (void);
-       int (*config_get) (int id, const void **value,
+       int (*config_get) (int id, GVariant **data,
                        const struct sr_dev_inst *sdi);
-       int (*config_set) (int id, const void *value,
+       int (*config_set) (int id, GVariant *data,
                        const struct sr_dev_inst *sdi);
-       int (*config_list) (int info_id, const void **data,
+       int (*config_list) (int info_id, GVariant **data,
                        const struct sr_dev_inst *sdi);
 
        /* Device-specific */
@@ -781,6 +776,14 @@ struct sr_session {
        struct source *sources;
        GPollFD *pollfds;
        int source_timeout;
+
+       /*
+        * These are our synchronization primitives for stopping the session in
+        * an async fashion. We need to make sure the session is stopped from
+        * within the session thread itself.
+        */
+       GMutex stop_mutex;
+       gboolean abort_session;
 };
 
 #include "proto.h"