src/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 /** @file
  22   * Standard API helper functions.
  23   * @internal
  24   */
  25
  26 #include <config.h>
  27 #include <glib.h>
  28 #include <libsigrok/libsigrok.h>
  29 #include "libsigrok-internal.h"
  30 #include "scpi.h"
  31
  32 #define LOG_PREFIX "std"
  33
  34 /**
  35  * Standard sr_driver_init() API helper.
  36  *
  37  * This function can be used to simplify most driver's init() API callback.
  38  *
  39  * It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and
  40  * then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed.
  41  *
  42  * @param sr_ctx The libsigrok context to assign.
  43  * @param di The driver instance to use.
  44  * @param[in] prefix A driver-specific prefix string used for log messages.
  45  *
  46  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
  47  */
  48 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
  49                      const char *prefix)
  50 {
  51         struct drv_context *drvc;
  52
  53         if (!di) {
  54                 sr_err("%s: Invalid driver, cannot initialize.", prefix);
  55                 return SR_ERR_ARG;
  56         }
  57
  58         drvc = g_malloc0(sizeof(struct drv_context));
  59         drvc->sr_ctx = sr_ctx;
  60         drvc->instances = NULL;
  61         di->context = drvc;
  62
  63         return SR_OK;
  64 }
  65
  66 /**
  67  * Standard API helper for sending an SR_DF_HEADER packet.
  68  *
  69  * This function can be used to simplify most driver's
  70  * dev_acquisition_start() API callback.
  71  *
  72  * @param sdi The device instance to use.
  73  * @param prefix A driver-specific prefix string used for log messages.
  74  *               Must not be NULL. An empty string is allowed.
  75  *
  76  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
  77  *         SR_ERR upon other errors.
  78  */
  79 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
  80                                        const char *prefix)
  81 {
  82         int ret;
  83         struct sr_datafeed_packet packet;
  84         struct sr_datafeed_header header;
  85
  86         if (!prefix) {
  87                 sr_err("Invalid prefix.");
  88                 return SR_ERR_ARG;
  89         }
  90
  91         sr_dbg("%s: Starting acquisition.", prefix);
  92
  93         /* Send header packet to the session bus. */
  94         sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix);
  95         packet.type = SR_DF_HEADER;
  96         packet.payload = (uint8_t *)&header;
  97         header.feed_version = 1;
  98         gettimeofday(&header.starttime, NULL);
  99
 100         if ((ret = sr_session_send(sdi, &packet)) < 0) {
 101                 sr_err("%s: Failed to send header packet: %d.", prefix, ret);
 102                 return ret;
 103         }
 104
 105         return SR_OK;
 106 }
 107
 108 #ifdef HAVE_LIBSERIALPORT
 109
 110 /**
 111  * Standard serial driver dev_open() helper.
 112  *
 113  * This function can be used to implement the dev_open() driver API
 114  * callback in drivers that use a serial port. The port is opened
 115  * with the SERIAL_RDWR flag.
 116  *
 117  * If the open succeeded, the status field of the given sdi is set
 118  * to SR_ST_ACTIVE.
 119  *
 120  * @retval SR_OK Success.
 121  * @retval SR_ERR Serial port open failed.
 122  */
 123 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
 124 {
 125         struct sr_serial_dev_inst *serial;
 126
 127         serial = sdi->conn;
 128         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 129                 return SR_ERR;
 130
 131         sdi->status = SR_ST_ACTIVE;
 132
 133         return SR_OK;
 134 }
 135
 136 /**
 137  * Standard serial driver dev_close() helper.
 138  *
 139  * This function can be used to implement the dev_close() driver API
 140  * callback in drivers that use a serial port.
 141  *
 142  * After closing the port, the status field of the given sdi is set
 143  * to SR_ST_INACTIVE.
 144  *
 145  * @retval SR_OK Success.
 146  */
 147 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
 148 {
 149         struct sr_serial_dev_inst *serial;
 150
 151         serial = sdi->conn;
 152         if (serial && sdi->status == SR_ST_ACTIVE) {
 153                 serial_close(serial);
 154                 sdi->status = SR_ST_INACTIVE;
 155         }
 156
 157         return SR_OK;
 158 }
 159
 160 /**
 161  * Standard sr_session_stop() API helper.
 162  *
 163  * This function can be used to simplify most (serial port based) driver's
 164  * dev_acquisition_stop() API callback.
 165  *
 166  * @param sdi The device instance for which acquisition should stop.
 167  *            Must not be NULL.
 168  * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
 169  * @param dev_close_fn Function pointer to the driver's dev_close().
 170  *                        Must not be NULL.
 171  * @param serial The serial device instance (struct serial_dev_inst *).
 172  *               Must not be NULL.
 173  * @param[in] prefix A driver-specific prefix string used for log messages.
 174  *               Must not be NULL. An empty string is allowed.
 175  *
 176  * @retval SR_OK Success.
 177  * @retval SR_ERR_ARG Invalid arguments.
 178  * @retval SR_ERR_DEV_CLOSED Device is closed.
 179  * @retval SR_ERR Other errors.
 180  */
 181 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
 182                         void *cb_data, dev_close_callback dev_close_fn,
 183                         struct sr_serial_dev_inst *serial, const char *prefix)
 184 {
 185         int ret;
 186         struct sr_datafeed_packet packet;
 187
 188         if (!prefix) {
 189                 sr_err("Invalid prefix.");
 190                 return SR_ERR_ARG;
 191         }
 192
 193         if (sdi->status != SR_ST_ACTIVE) {
 194                 sr_err("%s: Device inactive, can't stop acquisition.", prefix);
 195                 return SR_ERR_DEV_CLOSED;
 196         }
 197
 198         sr_dbg("%s: Stopping acquisition.", prefix);
 199
 200         if ((ret = serial_source_remove(sdi->session, serial)) < 0) {
 201                 sr_err("%s: Failed to remove source: %d.", prefix, ret);
 202                 return ret;
 203         }
 204
 205         if ((ret = dev_close_fn(sdi)) < 0) {
 206                 sr_err("%s: Failed to close device: %d.", prefix, ret);
 207                 return ret;
 208         }
 209
 210         /* Send SR_DF_END packet to the session bus. */
 211         sr_dbg("%s: Sending SR_DF_END packet.", prefix);
 212         packet.type = SR_DF_END;
 213         packet.payload = NULL;
 214         if ((ret = sr_session_send(cb_data, &packet)) < 0) {
 215                 sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
 216                 return ret;
 217         }
 218
 219         return SR_OK;
 220 }
 221
 222 #endif
 223
 224 /**
 225  * Standard driver dev_clear() helper.
 226  *
 227  * Clear driver, this means, close all instances.
 228  *
 229  * This function can be used to implement the dev_clear() driver API
 230  * callback. dev_close() is called before every sr_dev_inst is cleared.
 231  *
 232  * The only limitation is driver-specific device contexts (sdi->priv).
 233  * These are freed, but any dynamic allocation within structs stored
 234  * there cannot be freed.
 235  *
 236  * @param driver The driver which will have its instances released.
 237  * @param clear_private If not NULL, this points to a function called
 238  * with sdi->priv as argument. The function can then clear any device
 239  * instance-specific resources kept there. It must also clear the struct
 240  * pointed to by sdi->priv.
 241  *
 242  * @return SR_OK on success.
 243  */
 244 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 245                 std_dev_clear_callback clear_private)
 246 {
 247         struct drv_context *drvc;
 248         struct sr_dev_inst *sdi;
 249         GSList *l;
 250         int ret;
 251
 252         if (!(drvc = driver->context))
 253                 /* Driver was never initialized, nothing to do. */
 254                 return SR_OK;
 255
 256         ret = SR_OK;
 257         for (l = drvc->instances; l; l = l->next) {
 258                 if (!(sdi = l->data)) {
 259                         ret = SR_ERR_BUG;
 260                         continue;
 261                 }
 262                 if (driver->dev_close)
 263                         driver->dev_close(sdi);
 264
 265                 if (sdi->conn) {
 266 #ifdef HAVE_LIBSERIALPORT
 267                         if (sdi->inst_type == SR_INST_SERIAL)
 268                                 sr_serial_dev_inst_free(sdi->conn);
 269 #endif
 270 #ifdef HAVE_LIBUSB_1_0
 271                         if (sdi->inst_type == SR_INST_USB)
 272                                 sr_usb_dev_inst_free(sdi->conn);
 273 #endif
 274                         if (sdi->inst_type == SR_INST_SCPI)
 275                                 sr_scpi_free(sdi->conn);
 276                         if (sdi->inst_type == SR_INST_MODBUS)
 277                                 sr_modbus_free(sdi->conn);
 278                 }
 279                 if (clear_private)
 280                         /* The helper function is responsible for freeing
 281                          * its own sdi->priv! */
 282                         clear_private(sdi->priv);
 283                 else
 284                         g_free(sdi->priv);
 285
 286                 sr_dev_inst_free(sdi);
 287         }
 288
 289         g_slist_free(drvc->instances);
 290         drvc->instances = NULL;
 291
 292         return ret;
 293 }