std.c

   1 /*
   2  * This file is part of the libsigrok 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 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_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_malloc(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         drvc->instances = NULL;
  57         di->priv = drvc;
  58
  59         return SR_OK;
  60 }
  61
  62 /**
  63  * Standard API helper for sending an SR_DF_HEADER packet.
  64  *
  65  * This function can be used to simplify most driver's
  66  * dev_acquisition_start() API callback.
  67  *
  68  * @param sdi The device instance to use.
  69  * @param prefix A driver-specific prefix string used for log messages.
  70  *               Must not be NULL. An empty string is allowed.
  71  *
  72  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
  73  *         SR_ERR upon other errors.
  74  */
  75 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
  76                                        const char *prefix)
  77 {
  78         int ret;
  79         struct sr_datafeed_packet packet;
  80         struct sr_datafeed_header header;
  81
  82         if (!prefix) {
  83                 sr_err("Invalid prefix.");
  84                 return SR_ERR_ARG;
  85         }
  86
  87         sr_dbg("%sStarting acquisition.", prefix);
  88
  89         /* Send header packet to the session bus. */
  90         sr_dbg("%sSending SR_DF_HEADER packet.", prefix);
  91         packet.type = SR_DF_HEADER;
  92         packet.payload = (uint8_t *)&header;
  93         header.feed_version = 1;
  94         gettimeofday(&header.starttime, NULL);
  95
  96         if ((ret = sr_session_send(sdi, &packet)) < 0) {
  97                 sr_err("%sFailed to send header packet: %d.", prefix, ret);
  98                 return ret;
  99         }
 100
 101         return SR_OK;
 102 }
 103
 104 #ifdef HAVE_LIBSERIALPORT
 105
 106 /*
 107  * Standard sr_session_stop() API helper.
 108  *
 109  * This function can be used to simplify most (serial port based) driver's
 110  * dev_acquisition_stop() API callback.
 111  *
 112  * @param sdi The device instance for which acquisition should stop.
 113  *            Must not be NULL.
 114  * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
 115  * @param dev_close_fn Function pointer to the driver's dev_close().
 116  *                        Must not be NULL.
 117  * @param serial The serial device instance (struct serial_dev_inst *).
 118  *               Must not be NULL.
 119  * @param prefix A driver-specific prefix string used for log messages.
 120  *               Must not be NULL. An empty string is allowed.
 121  *
 122  * @retval SR_OK Success.
 123  * @retval SR_ERR_ARG Invalid arguments.
 124  * @retval SR_ERR_DEV_CLOSED Device is closed.
 125  * @retval SR_ERR Other errors.
 126  */
 127 SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
 128                         void *cb_data, dev_close_t dev_close_fn,
 129                         struct sr_serial_dev_inst *serial, const char *prefix)
 130 {
 131         int ret;
 132         struct sr_datafeed_packet packet;
 133
 134         if (!prefix) {
 135                 sr_err("Invalid prefix.");
 136                 return SR_ERR_ARG;
 137         }
 138
 139         if (sdi->status != SR_ST_ACTIVE) {
 140                 sr_err("%sDevice inactive, can't stop acquisition.", prefix);
 141                 return SR_ERR_DEV_CLOSED;
 142         }
 143
 144         sr_dbg("%sStopping acquisition.", prefix);
 145
 146         if ((ret = sr_source_remove(serial->fd)) < 0) {
 147                 sr_err("%sFailed to remove source: %d.", prefix, ret);
 148                 return ret;
 149         }
 150
 151         if ((ret = dev_close_fn(sdi)) < 0) {
 152                 sr_err("%sFailed to close device: %d.", prefix, ret);
 153                 return ret;
 154         }
 155
 156         /* Send SR_DF_END packet to the session bus. */
 157         sr_dbg("%sSending SR_DF_END packet.", prefix);
 158         packet.type = SR_DF_END;
 159         packet.payload = NULL;
 160         if ((ret = sr_session_send(cb_data, &packet)) < 0) {
 161                 sr_err("%sFailed to send SR_DF_END packet: %d.", prefix, ret);
 162                 return ret;
 163         }
 164
 165         return SR_OK;
 166 }
 167
 168 #endif
 169
 170 /*
 171  * Standard driver dev_clear() helper.
 172  *
 173  * This function can be used to implement the dev_clear() driver API
 174  * callback. dev_close() is called before every sr_dev_inst is cleared.
 175  *
 176  * The only limitation is driver-specific device contexts (sdi->priv).
 177  * These are freed, but any dynamic allocation within structs stored
 178  * there cannot be freed.
 179  *
 180  * @param driver The driver which will have its instances released.
 181  * @param clear_private If not NULL, this points to a function called
 182  * with sdi->priv as argument. The function can then clear any device
 183  * instance-specific resources kept there. It must also clear the struct
 184  * pointed to by sdi->priv.
 185  *
 186  * @return SR_OK on success.
 187  */
 188 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 189                 std_dev_clear_t clear_private)
 190 {
 191         struct drv_context *drvc;
 192         struct sr_dev_inst *sdi;
 193         GSList *l;
 194         int ret;
 195
 196         if (!(drvc = driver->priv))
 197                 /* Driver was never initialized, nothing to do. */
 198                 return SR_OK;
 199
 200         ret = SR_OK;
 201         for (l = drvc->instances; l; l = l->next) {
 202                 if (!(sdi = l->data)) {
 203                         ret = SR_ERR_BUG;
 204                         continue;
 205                 }
 206                 if (driver->dev_close)
 207                         driver->dev_close(sdi);
 208
 209                 if (sdi->conn) {
 210 #if HAVE_LIBSERIALPORT
 211                         if (sdi->inst_type == SR_INST_SERIAL)
 212                                 sr_serial_dev_inst_free(sdi->conn);
 213 #endif
 214 #if HAVE_LIBUSB_1_0
 215                         if (sdi->inst_type == SR_INST_USB)
 216                                 sr_usb_dev_inst_free(sdi->conn);
 217 #endif
 218                         if (sdi->inst_type == SR_INST_USBTMC)
 219                                 sr_usbtmc_dev_inst_free(sdi->conn);
 220                         if (sdi->inst_type == SR_INST_SCPI)
 221                                 sr_scpi_free(sdi->conn);
 222                 }
 223                 if (clear_private)
 224                         clear_private(sdi->priv);
 225                 else
 226                         g_free(sdi->priv);
 227                 sr_dev_inst_free(sdi);
 228         }
 229
 230         g_slist_free(drvc->instances);
 231         drvc->instances = NULL;
 232
 233         return ret;
 234 }