]> sigrok.org Git - libsigrok.git/blobdiff - src/std.c
sr_dev_close(): Set status to SR_ST_INACTIVE.
[libsigrok.git] / src / std.c
index 4af3c6816266aa91ed097957f1583614c888a7a3..13f9b03195f549eafa40e02072605242dc6f7294 100644 (file)
--- a/src/std.c
+++ b/src/std.c
  * 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.
+ *
+ * @internal
+ */
 
 #include <config.h>
 #include <glib.h>
@@ -85,26 +87,17 @@ SR_PRIV int std_cleanup(const struct sr_dev_driver *di)
  * 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.
  *
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
  *         SR_ERR upon other errors.
  */
-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 = (sdi->driver) ? sdi->driver->name : "unknown";
        int ret;
        struct sr_datafeed_packet packet;
        struct sr_datafeed_header header;
 
-       if (!prefix) {
-               sr_err("Invalid prefix.");
-               return SR_ERR_ARG;
-       }
-
-       sr_dbg("%s: Starting acquisition.", prefix);
-
        /* Send header packet to the session bus. */
        sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix);
        packet.type = SR_DF_HEADER;
@@ -124,19 +117,17 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
  * Standard API helper for sending an SR_DF_END packet.
  *
  * @param sdi The device instance to use. Must not be NULL.
- * @param prefix A driver-specific prefix string used for log messages.
- *              Must not be NULL. An empty string is allowed.
  *
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
  *         SR_ERR upon other errors.
  */
-SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi,
-                                   const char *prefix)
+SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi)
 {
+       const char *prefix = (sdi->driver) ? sdi->driver->name : "unknown";
        int ret;
        struct sr_datafeed_packet packet;
 
-       if (!sdi || !prefix)
+       if (!sdi)
                return SR_ERR_ARG;
 
        sr_dbg("%s: Sending SR_DF_END packet.", prefix);
@@ -161,23 +152,20 @@ SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi,
  * callback in drivers that use a serial port. The port is opened
  * with the SERIAL_RDWR flag.
  *
- * If the open succeeded, the status field of the given sdi is set
- * to SR_ST_ACTIVE.
- *
  * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid arguments.
  * @retval SR_ERR 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) != SR_OK)
-               return SR_ERR;
+       if (!sdi || !sdi->conn)
+               return SR_ERR_ARG;
 
-       sdi->status = SR_ST_ACTIVE;
+       serial = sdi->conn;
 
-       return SR_OK;
+       return serial_open(serial, SERIAL_RDWR);
 }
 
 /**
@@ -186,22 +174,20 @@ SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
  * 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.
- *
  * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid arguments.
+ * @retval SR_ERR Serial port close failed.
  */
 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
 {
        struct sr_serial_dev_inst *serial;
 
+       if (!sdi || !sdi->conn)
+               return SR_ERR_ARG;
+
        serial = sdi->conn;
-       if (serial && sdi->status == SR_ST_ACTIVE) {
-               serial_close(serial);
-               sdi->status = SR_ST_INACTIVE;
-       }
 
-       return SR_OK;
+       return serial_close(serial);
 }
 
 /**
@@ -212,48 +198,29 @@ SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
  *
  * @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.
  *
  * @retval SR_OK Success.
  * @retval SR_ERR_ARG Invalid arguments.
  * @retval SR_ERR_DEV_CLOSED Device is closed.
  * @retval SR_ERR Other errors.
  */
-SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
-                       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 = sdi->conn;
+       const char *prefix = sdi->driver->name;
        int ret;
 
-       if (!prefix) {
-               sr_err("Invalid prefix.");
-               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);
-
        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) {
+       if ((ret = sr_dev_close(sdi)) < 0) {
                sr_err("%s: Failed to close device: %d.", prefix, ret);
                return ret;
        }
 
-       std_session_send_df_end(sdi, prefix);
+       std_session_send_df_end(sdi);
 
        return SR_OK;
 }
@@ -378,18 +345,29 @@ SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di)
  * }
  * @endcode
  *
- * @param di The driver instance to use.
+ * @param di The driver instance to use. Must not be NULL.
  * @param devices List of newly discovered devices (struct sr_dev_inst).
  *
  * @return The @p devices list.
  */
 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices)
 {
-       struct drv_context *drvc = di->context;
+       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 driver instance, cannot complete scan.");
+                       return NULL;
+               }
                sdi->driver = di;
        }