std.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <glib.h>
  22 #include "libsigrok.h"
  23 #include "libsigrok-internal.h"
  24
  25 /**
  26  * Standard sr_driver_init() API helper.
  27  *
  28  * This function can be used to simplify most driver's hw_init() API callback.
  29  *
  30  * It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and
  31  * then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed.
  32  *
  33  * @param sr_ctx The libsigrok context to assign.
  34  * @param di The driver instance to use.
  35  * @param prefix A driver-specific prefix string used for log messages.
  36  *
  37  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
  38  *         SR_ERR_MALLOC upon memory allocation errors.
  39  */
  40 SR_PRIV int std_hw_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
  41                         const char *prefix)
  42 {
  43         struct drv_context *drvc;
  44
  45         if (!di) {
  46                 sr_err("%sInvalid driver, cannot initialize.", prefix);
  47                 return SR_ERR_ARG;
  48         }
  49
  50         if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
  51                 sr_err("%sDriver context malloc failed.", prefix);
  52                 return SR_ERR_MALLOC;
  53         }
  54
  55         drvc->sr_ctx = sr_ctx;
  56         di->priv = drvc;
  57
  58         return SR_OK;
  59 }
  60
  61 /**
  62  * Standard API helper for sending an SR_DF_HEADER packet.
  63  *
  64  * This function can be used to simplify most driver's
  65  * hw_dev_acquisition_start() API callback.
  66  *
  67  * @param sdi The device instance to use.
  68  * @param prefix A driver-specific prefix string used for log messages.
  69  *               Must not be NULL. An empty string is allowed.
  70  *
  71  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
  72  *         SR_ERR upon other errors.
  73  */
  74 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
  75                                        const char *prefix)
  76 {
  77         int ret;
  78         struct sr_datafeed_packet packet;
  79         struct sr_datafeed_header header;
  80
  81         if (!prefix) {
  82                 sr_err("Invalid prefix.");
  83                 return SR_ERR_ARG;
  84         }
  85
  86         sr_dbg("%sStarting acquisition.", prefix);
  87
  88         /* Send header packet to the session bus. */
  89         sr_dbg("%sSending SR_DF_HEADER packet.", prefix);
  90         packet.type = SR_DF_HEADER;
  91         packet.payload = (uint8_t *)&header;
  92         header.feed_version = 1;
  93         gettimeofday(&header.starttime, NULL);
  94
  95         if ((ret = sr_session_send(sdi, &packet)) < 0) {
  96                 sr_err("%sFailed to send header packet: %d.", prefix, ret);
  97                 return ret;
  98         }
  99
 100         return SR_OK;
 101 }
 102
 103 /*
 104  * Standard sr_session_stop() API helper.
 105  *
 106  * This function can be used to simplify most (serial port based) driver's
 107  * hw_dev_acquisition_stop() API callback.
 108  *
 109  * @param sdi The device instance for which acquisition should stop.
 110  *            Must not be NULL.
 111  * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
 112  * @param hw_dev_close_fn Function pointer to the driver's hw_dev_close().
 113  *                        Must not be NULL.
 114  * @param serial The serial device instance (struct serial_dev_inst *).
 115  *               Must not be NULL.
 116  * @param prefix A driver-specific prefix string used for log messages.
 117  *               Must not be NULL. An empty string is allowed.
 118  *
 119  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 120  *         SR_ERR upon other errors.
 121  */
 122 SR_PRIV int std_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
 123                         void *cb_data, dev_close_t hw_dev_close_fn,
 124                         struct sr_serial_dev_inst *serial, const char *prefix)
 125 {
 126         int ret;
 127         struct sr_datafeed_packet packet;
 128
 129         if (!prefix) {
 130                 sr_err("Invalid prefix.");
 131                 return SR_ERR_ARG;
 132         }
 133
 134         if (sdi->status != SR_ST_ACTIVE) {
 135                 sr_err("%sDevice inactive, can't stop acquisition.", prefix);
 136                 return SR_ERR;
 137         }
 138
 139         sr_dbg("%sStopping acquisition.", prefix);
 140
 141         if ((ret = sr_source_remove(serial->fd)) < 0) {
 142                 sr_err("%sFailed to remove source: %d.", prefix, ret);
 143                 return ret;
 144         }
 145
 146         if ((ret = hw_dev_close_fn(sdi)) < 0) {
 147                 sr_err("%sFailed to close device: %d.", prefix, ret);
 148                 return ret;
 149         }
 150
 151         /* Send SR_DF_END packet to the session bus. */
 152         sr_dbg("%sSending SR_DF_END packet.", prefix);
 153         packet.type = SR_DF_END;
 154         packet.payload = NULL;
 155         if ((ret = sr_session_send(cb_data, &packet)) < 0) {
 156                 sr_err("%sFailed to send SR_DF_END packet: %d.", prefix, ret);
 157                 return ret;
 158         }
 159
 160         return SR_OK;
 161 }
 162
 163 /*
 164  * Standard driver dev_clear() helper.
 165  *
 166  * This function can be used to implement the dev_clear() driver API
 167  * callback. dev_close() is called before every sr_dev_inst is cleared.
 168  *
 169  * The only limitation is driver-specific device contexts (sdi->priv).
 170  * These are freed, but any dynamic allocation within structs stored
 171  * there cannot be freed.
 172  *
 173  * @param driver The driver which will have its instances released.
 174  *
 175  * @return SR_OK on success.
 176  */
 177 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 178                 std_dev_clear_t clear_private)
 179 {
 180         struct sr_dev_inst *sdi;
 181         struct drv_context *drvc;
 182         struct dev_context *devc;
 183         GSList *l;
 184         int ret;
 185
 186         drvc = driver->priv;
 187         ret = SR_OK;
 188         for (l = drvc->instances; l; l = l->next) {
 189                 /* Log errors, but continue cleaning up the rest. */
 190                 if (!(sdi = l->data)) {
 191                         ret = SR_ERR_BUG;
 192                         continue;
 193                 }
 194                 if (!(devc = sdi->priv)) {
 195                         ret = SR_ERR_BUG;
 196                         continue;
 197                 }
 198                 if (driver->dev_close)
 199                         driver->dev_close(sdi);
 200
 201                 if (sdi->conn) {
 202                         if (sdi->inst_type == SR_INST_USB)
 203                                 sr_usb_dev_inst_free(sdi->conn);
 204                         else if (sdi->inst_type == SR_INST_SERIAL)
 205                                 sr_serial_dev_inst_free(sdi->conn);
 206                 }
 207                 if (clear_private)
 208                         clear_private(sdi->priv);
 209                 sdi = l->data;
 210                 sr_dev_inst_free(sdi);
 211         }
 212
 213         g_slist_free(drvc->instances);
 214         drvc->instances = NULL;
 215
 216         return ret;
 217 }