sr: initial support for Hantek 2xxx/5200 USB oscilloscopes

[libsigrok.git] / session.c

diff --git a/session.c b/session.c
index 151d96b171d45145391fa4c003632476f65b8dd9..4bf96b8ccfe20f21f0ce486670e1aa5f0c1a625e 100644 (file)
--- a/session.c
+++ b/session.c
@@ -97,7 +97,7 @@ SR_API int sr_session_destroy(void)
  *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
-SR_API int sr_session_dev_clear(void)
+SR_API int sr_session_dev_remove_all(void)
 {
        if (!session) {
                sr_err("session: %s: session was NULL", __func__);
@@ -127,20 +127,25 @@ SR_API int sr_session_dev_add(struct sr_dev *dev)
                return SR_ERR_ARG;
        }
 
+       if (!session) {
+               sr_err("session: %s: session was NULL", __func__);
+               return SR_ERR_BUG;
+       }
+
+       /* If dev->driver is NULL, this is a virtual device. */
        if (!dev->driver) {
-               sr_err("session: %s: dev->driver was NULL", __func__);
-               return SR_ERR_ARG;
+               sr_dbg("session: %s: dev->driver was NULL, this seems to be "
+                      "a virtual device; continuing", __func__);
+               /* Just add the device, don't run dev_open(). */
+               session->devs = g_slist_append(session->devs, dev);
+               return SR_OK;
        }
 
+       /* dev->driver is non-NULL (i.e. we have a real device). */
        if (!dev->driver->dev_open) {
                sr_err("session: %s: dev->driver->dev_open was NULL",
                       __func__);
-               return SR_ERR_ARG;
-       }
-
-       if (!session) {
-               sr_err("session: %s: session was NULL", __func__);
-               return SR_ERR; /* TODO: SR_ERR_BUG? */
+               return SR_ERR_BUG;
        }
 
        if ((ret = dev->driver->dev_open(dev->driver_index)) != SR_OK) {
@@ -154,11 +159,11 @@ SR_API int sr_session_dev_add(struct sr_dev *dev)
 }
 
 /**
- * Clear all datafeed callbacks in the current session.
+ * Remove all datafeed callbacks in the current session.
  *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
-SR_API int sr_session_datafeed_callback_clear(void)
+SR_API int sr_session_datafeed_callback_remove_all(void)
 {
        if (!session) {
                sr_err("session: %s: session was NULL", __func__);
@@ -175,6 +180,7 @@ SR_API int sr_session_datafeed_callback_clear(void)
  * Add a datafeed callback to the current session.
  *
  * @param cb Function to call when a chunk of data is received.
+ *           Must not be NULL.
  *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
@@ -185,7 +191,10 @@ SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb)
                return SR_ERR_BUG;
        }
 
-       /* TODO: Is 'cb' allowed to be NULL? */
+       if (!cb) {
+               sr_err("session: %s: cb was NULL", __func__);
+               return SR_ERR_ARG;
+       }
 
        session->datafeed_callbacks =
            g_slist_append(session->datafeed_callbacks, cb);
@@ -259,14 +268,14 @@ SR_API int sr_session_start(void)
        if (!session) {
                sr_err("session: %s: session was NULL; a session must be "
                       "created first, before starting it.", __func__);
-               return SR_ERR; /* TODO: SR_ERR_BUG? */
+               return SR_ERR_BUG;
        }
 
        if (!session->devs) {
                /* TODO: Actually the case? */
                sr_err("session: %s: session->devs was NULL; a session "
                       "cannot be started without devices.", __func__);
-               return SR_ERR; /* TODO: SR_ERR_BUG? */
+               return SR_ERR_BUG;
        }
 
        /* TODO: Check driver_index validity? */
@@ -391,6 +400,7 @@ SR_API int sr_session_stop(void)
 static void datafeed_dump(struct sr_datafeed_packet *packet)
 {
        struct sr_datafeed_logic *logic;
+       struct sr_datafeed_analog *analog;
 
        switch (packet->type) {
        case SR_DF_HEADER:
@@ -399,11 +409,22 @@ static void datafeed_dump(struct sr_datafeed_packet *packet)
        case SR_DF_TRIGGER:
                sr_dbg("bus: received SR_DF_TRIGGER");
                break;
+       case SR_DF_META_LOGIC:
+               sr_dbg("bus: received SR_DF_META_LOGIC");
+               break;
        case SR_DF_LOGIC:
                logic = packet->payload;
                /* TODO: Check for logic != NULL. */
                sr_dbg("bus: received SR_DF_LOGIC %" PRIu64 " bytes", logic->length);
                break;
+       case SR_DF_META_ANALOG:
+               sr_dbg("bus: received SR_DF_META_LOGIC");
+               break;
+       case SR_DF_ANALOG:
+               analog = packet->payload;
+               /* TODO: Check for analog != NULL. */
+               sr_dbg("bus: received SR_DF_ANALOG %d samples", analog->num_samples);
+               break;
        case SR_DF_END:
                sr_dbg("bus: received SR_DF_END");
                break;
@@ -434,11 +455,6 @@ SR_PRIV int sr_session_send(struct sr_dev *dev,
                return SR_ERR_ARG;
        }
 
-       if (!dev->driver) {
-               sr_err("session: %s: dev->driver was NULL", __func__);
-               return SR_ERR_ARG;
-       }
-
        if (!packet) {
                sr_err("session: %s: packet was NULL", __func__);
                return SR_ERR_ARG;
@@ -463,8 +479,8 @@ SR_PRIV int sr_session_send(struct sr_dev *dev,
  * @param fd TODO.
  * @param events TODO.
  * @param timeout TODO.
- * @param cb TODO.
- * @param cb_data TODO.
+ * @param cb Callback function to add. Must not be NULL.
+ * @param cb_data Data for the callback function. Can be NULL.
  *
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
  *         SR_ERR_MALLOC upon memory allocation errors.
@@ -526,7 +542,7 @@ SR_API int sr_session_source_remove(int fd)
 
        if (!sources) {
                sr_err("session: %s: sources was NULL", __func__);
-               return SR_ERR_BUG; /* TODO: Other? */
+               return SR_ERR_BUG;
        }
 
        /* TODO: Check if 'fd' valid. */