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 serial driver dev_open() helper.
 108  *
 109  * This function can be used to implement the dev_open() driver API
 110  * callback in drivers that use a serial port. The port is opened
 111  * with the SERIAL_RDWR and SERIAL_NONBLOCK flags.
 112  *
 113  * If the open succeeded, the status field of the given sdi is set
 114  * to SR_ST_ACTIVE.
 115  *
 116  * @retval SR_OK Success.
 117  * @retval SR_ERR Serial port open failed.
 118  */
 119 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
 120 {
 121         struct sr_serial_dev_inst *serial;
 122
 123         serial = sdi->conn;
 124         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
 125                 return SR_ERR;
 126
 127         sdi->status = SR_ST_ACTIVE;
 128
 129         return SR_OK;
 130 }
 131
 132 /*
 133  * Standard sr_session_stop() API helper.
 134  *
 135  * This function can be used to simplify most (serial port based) driver's
 136  * dev_acquisition_stop() API callback.
 137  *
 138  * @param sdi The device instance for which acquisition should stop.
 139  *            Must not be NULL.
 140  * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
 141  * @param dev_close_fn Function pointer to the driver's dev_close().
 142  *                        Must not be NULL.
 143  * @param serial The serial device instance (struct serial_dev_inst *).
 144  *               Must not be NULL.
 145  * @param prefix A driver-specific prefix string used for log messages.
 146  *               Must not be NULL. An empty string is allowed.
 147  *
 148  * @retval SR_OK Success.
 149  * @retval SR_ERR_ARG Invalid arguments.
 150  * @retval SR_ERR_DEV_CLOSED Device is closed.
 151  * @retval SR_ERR Other errors.
 152  */
 153 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
 154                         void *cb_data, dev_close_t dev_close_fn,
 155                         struct sr_serial_dev_inst *serial, const char *prefix)
 156 {
 157         int ret;
 158         struct sr_datafeed_packet packet;
 159
 160         if (!prefix) {
 161                 sr_err("Invalid prefix.");
 162                 return SR_ERR_ARG;
 163         }
 164
 165         if (sdi->status != SR_ST_ACTIVE) {
 166                 sr_err("%sDevice inactive, can't stop acquisition.", prefix);
 167                 return SR_ERR_DEV_CLOSED;
 168         }
 169
 170         sr_dbg("%sStopping acquisition.", prefix);
 171
 172         if ((ret = serial_source_remove(serial)) < 0) {
 173                 sr_err("%sFailed to remove source: %d.", prefix, ret);
 174                 return ret;
 175         }
 176
 177         if ((ret = dev_close_fn(sdi)) < 0) {
 178                 sr_err("%sFailed to close device: %d.", prefix, ret);
 179                 return ret;
 180         }
 181
 182         /* Send SR_DF_END packet to the session bus. */
 183         sr_dbg("%sSending SR_DF_END packet.", prefix);
 184         packet.type = SR_DF_END;
 185         packet.payload = NULL;
 186         if ((ret = sr_session_send(cb_data, &packet)) < 0) {
 187                 sr_err("%sFailed to send SR_DF_END packet: %d.", prefix, ret);
 188                 return ret;
 189         }
 190
 191         return SR_OK;
 192 }
 193
 194 #endif
 195
 196 /*
 197  * Standard driver dev_clear() helper.
 198  *
 199  * This function can be used to implement the dev_clear() driver API
 200  * callback. dev_close() is called before every sr_dev_inst is cleared.
 201  *
 202  * The only limitation is driver-specific device contexts (sdi->priv).
 203  * These are freed, but any dynamic allocation within structs stored
 204  * there cannot be freed.
 205  *
 206  * @param driver The driver which will have its instances released.
 207  * @param clear_private If not NULL, this points to a function called
 208  * with sdi->priv as argument. The function can then clear any device
 209  * instance-specific resources kept there. It must also clear the struct
 210  * pointed to by sdi->priv.
 211  *
 212  * @return SR_OK on success.
 213  */
 214 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 215                 std_dev_clear_t clear_private)
 216 {
 217         struct drv_context *drvc;
 218         struct sr_dev_inst *sdi;
 219         GSList *l;
 220         int ret;
 221
 222         if (!(drvc = driver->priv))
 223                 /* Driver was never initialized, nothing to do. */
 224                 return SR_OK;
 225
 226         ret = SR_OK;
 227         for (l = drvc->instances; l; l = l->next) {
 228                 if (!(sdi = l->data)) {
 229                         ret = SR_ERR_BUG;
 230                         continue;
 231                 }
 232                 if (driver->dev_close)
 233                         driver->dev_close(sdi);
 234
 235                 if (sdi->conn) {
 236 #if HAVE_LIBSERIALPORT
 237                         if (sdi->inst_type == SR_INST_SERIAL)
 238                                 sr_serial_dev_inst_free(sdi->conn);
 239 #endif
 240 #if HAVE_LIBUSB_1_0
 241                         if (sdi->inst_type == SR_INST_USB)
 242                                 sr_usb_dev_inst_free(sdi->conn);
 243 #endif
 244                         if (sdi->inst_type == SR_INST_SCPI)
 245                                 sr_scpi_free(sdi->conn);
 246                 }
 247                 if (clear_private)
 248                         clear_private(sdi->priv);
 249                 else
 250                         g_free(sdi->priv);
 251                 sr_dev_inst_free(sdi);
 252         }
 253
 254         g_slist_free(drvc->instances);
 255         drvc->instances = NULL;
 256
 257         return ret;
 258 }
 259
 260 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
 261 {
 262         struct sr_serial_dev_inst *serial;
 263
 264         serial = sdi->conn;
 265         if (serial && sdi->status == SR_ST_ACTIVE) {
 266                 serial_close(serial);
 267                 sdi->status = SR_ST_INACTIVE;
 268         }
 269
 270         return SR_OK;
 271 }