Fix incorrect doxygen comment for srd_decoder_list().
[libsigrokdecode.git] / session.c
index 109ede10516251c8079d40ce67575532013867f4..6963a233b5617f3bf7a69635031d370d118f74a4 100644 (file)
--- a/session.c
+++ b/session.c
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "libsigrokdecode-internal.h"
+#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode.h"
 #include "config.h"
+#include <inttypes.h>
 #include <glib.h>
 
 /**
@@ -40,7 +41,7 @@
 /** @cond PRIVATE */
 
 SRD_PRIV GSList *sessions = NULL;
-int max_session_id = -1;
+SRD_PRIV int max_session_id = -1;
 
 /** @endcond */
 
@@ -124,8 +125,7 @@ SRD_API int srd_session_start(struct srd_session *sess)
        return ret;
 }
 
-/** @private */
-SRD_PRIV int srd_inst_send_meta(struct srd_decoder_inst *di, int key,
+static int srd_inst_send_meta(struct srd_decoder_inst *di, int key,
                GVariant *data)
 {
        PyObject *py_ret;
@@ -170,10 +170,27 @@ SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
                return SRD_ERR_ARG;
        }
 
+       if (!key) {
+               srd_err("Invalid key.");
+               return SRD_ERR_ARG;
+       }
+
+       if (!data) {
+               srd_err("Invalid value.");
+               return SRD_ERR_ARG;
+       }
+
+       /* Hardcoded to samplerate/uint64 for now. */
+
        if (key != SRD_CONF_SAMPLERATE) {
                srd_err("Unknown config key %d.", key);
                return SRD_ERR_ARG;
        }
+       if (!g_variant_is_of_type(data, G_VARIANT_TYPE_UINT64)) {
+               srd_err("Invalid value type: expected uint64, got %s",
+                               g_variant_get_type_string(data));
+               return SRD_ERR_ARG;
+       }
 
        srd_dbg("Setting session %d samplerate to %"PRIu64".",
                        sess->session_id, g_variant_get_uint64(data));
@@ -192,12 +209,13 @@ SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
 /**
  * Send a chunk of logic sample data to a running decoder session.
  *
- * The logic samples must be arranged in probe order, in the least
- * amount of space possible. If no probes were configured, the default
- * probe set consists of all required probes + all optional probes.
+ * If no channel map has been set up, the logic samples must be arranged
+ * in channel order, in the least amount of space possible. The default
+ * channel set consists of all required channels + all optional channels.
  *
- * The size of a sample in inbuf is the minimum number of bytes needed
- * to store the configured (or default) probes.
+ * The size of a sample in inbuf is the unit size passed to
+ * srd_inst_channel_set_all(). If no channel map has been configured, it is
+ * the minimum number of bytes needed to store the default channels.
  *
  * @param sess The session to use.
  * @param start_samplenum The sample number of the first sample in this chunk.
@@ -283,7 +301,7 @@ SRD_API int srd_session_destroy(struct srd_session *sess)
  * @since 0.3.0
  */
 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
-               int output_type, srd_pd_output_callback_t cb, void *cb_data)
+               int output_type, srd_pd_output_callback cb, void *cb_data)
 {
        struct srd_pd_callback *pd_cb;