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 di The driver instance to use.
  43  * @param sr_ctx The libsigrok context to assign.
  44  *
  45  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
  46  */
  47 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
  48 {
  49         struct drv_context *drvc;
  50
  51         drvc = g_malloc0(sizeof(struct drv_context));
  52         drvc->sr_ctx = sr_ctx;
  53         drvc->instances = NULL;
  54         di->context = drvc;
  55
  56         return SR_OK;
  57 }
  58
  59 /**
  60  * Standard driver cleanup() callback API helper
  61  *
  62  * @param di The driver instance to use.
  63  *
  64  * Frees all device instances by calling sr_dev_clear() and then releases any
  65  * resources allocated by std_init().
  66  *
  67  * @retval SR_OK Success
  68  * @retval SR_ERR_ARG Invalid driver
  69  *
  70 */
  71 SR_PRIV int std_cleanup(const struct sr_dev_driver *di)
  72 {
  73         int ret;
  74
  75         ret = sr_dev_clear(di);
  76         g_free(di->context);
  77
  78         return ret;
  79 }
  80
  81 /**
  82  * Standard API helper for sending an SR_DF_HEADER packet.
  83  *
  84  * This function can be used to simplify most driver's
  85  * dev_acquisition_start() API callback.
  86  *
  87  * @param sdi The device instance to use.
  88  *
  89  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
  90  *         SR_ERR upon other errors.
  91  */
  92 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi)
  93 {
  94         const char *prefix = sdi->driver->name;
  95         int ret;
  96         struct sr_datafeed_packet packet;
  97         struct sr_datafeed_header header;
  98
  99         sr_dbg("%s: Starting acquisition.", prefix);
 100
 101         /* Send header packet to the session bus. */
 102         sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix);
 103         packet.type = SR_DF_HEADER;
 104         packet.payload = (uint8_t *)&header;
 105         header.feed_version = 1;
 106         gettimeofday(&header.starttime, NULL);
 107
 108         if ((ret = sr_session_send(sdi, &packet)) < 0) {
 109                 sr_err("%s: Failed to send header packet: %d.", prefix, ret);
 110                 return ret;
 111         }
 112
 113         return SR_OK;
 114 }
 115
 116 /**
 117  * Standard API helper for sending an SR_DF_END packet.
 118  *
 119  * @param sdi The device instance to use. Must not be NULL.
 120  *
 121  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 122  *         SR_ERR upon other errors.
 123  */
 124 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi)
 125 {
 126         const char *prefix = sdi->driver->name;
 127         int ret;
 128         struct sr_datafeed_packet packet;
 129
 130         if (!sdi)
 131                 return SR_ERR_ARG;
 132
 133         sr_dbg("%s: Sending SR_DF_END packet.", prefix);
 134
 135         packet.type = SR_DF_END;
 136         packet.payload = NULL;
 137
 138         if ((ret = sr_session_send(sdi, &packet)) < 0) {
 139                 sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
 140                 return ret;
 141         }
 142
 143         return SR_OK;
 144 }
 145
 146 #ifdef HAVE_LIBSERIALPORT
 147
 148 /**
 149  * Standard serial driver dev_open() helper.
 150  *
 151  * This function can be used to implement the dev_open() driver API
 152  * callback in drivers that use a serial port. The port is opened
 153  * with the SERIAL_RDWR flag.
 154  *
 155  * If the open succeeded, the status field of the given sdi is set
 156  * to SR_ST_ACTIVE.
 157  *
 158  * @retval SR_OK Success.
 159  * @retval SR_ERR Serial port open failed.
 160  */
 161 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
 162 {
 163         struct sr_serial_dev_inst *serial;
 164
 165         serial = sdi->conn;
 166         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 167                 return SR_ERR;
 168
 169         sdi->status = SR_ST_ACTIVE;
 170
 171         return SR_OK;
 172 }
 173
 174 /**
 175  * Standard serial driver dev_close() helper.
 176  *
 177  * This function can be used to implement the dev_close() driver API
 178  * callback in drivers that use a serial port.
 179  *
 180  * After closing the port, the status field of the given sdi is set
 181  * to SR_ST_INACTIVE.
 182  *
 183  * @retval SR_OK Success.
 184  */
 185 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
 186 {
 187         struct sr_serial_dev_inst *serial;
 188
 189         serial = sdi->conn;
 190         if (serial && sdi->status == SR_ST_ACTIVE) {
 191                 serial_close(serial);
 192                 sdi->status = SR_ST_INACTIVE;
 193         }
 194
 195         return SR_OK;
 196 }
 197
 198 /**
 199  * Standard sr_session_stop() API helper.
 200  *
 201  * This function can be used to simplify most (serial port based) driver's
 202  * dev_acquisition_stop() API callback.
 203  *
 204  * @param sdi The device instance for which acquisition should stop.
 205  *            Must not be NULL.
 206  * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
 207  * @param dev_close_fn Function pointer to the driver's dev_close().
 208  *                        Must not be NULL.
 209  * @param serial The serial device instance (struct serial_dev_inst *).
 210  *               Must not be NULL.
 211  *
 212  * @retval SR_OK Success.
 213  * @retval SR_ERR_ARG Invalid arguments.
 214  * @retval SR_ERR_DEV_CLOSED Device is closed.
 215  * @retval SR_ERR Other errors.
 216  */
 217 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
 218                         dev_close_callback dev_close_fn,
 219                         struct sr_serial_dev_inst *serial)
 220 {
 221         const char *prefix = sdi->driver->name;
 222         int ret;
 223
 224         if (sdi->status != SR_ST_ACTIVE) {
 225                 sr_err("%s: Device inactive, can't stop acquisition.", prefix);
 226                 return SR_ERR_DEV_CLOSED;
 227         }
 228
 229         sr_dbg("%s: Stopping acquisition.", prefix);
 230
 231         if ((ret = serial_source_remove(sdi->session, serial)) < 0) {
 232                 sr_err("%s: Failed to remove source: %d.", prefix, ret);
 233                 return ret;
 234         }
 235
 236         if ((ret = dev_close_fn(sdi)) < 0) {
 237                 sr_err("%s: Failed to close device: %d.", prefix, ret);
 238                 return ret;
 239         }
 240
 241         std_session_send_df_end(sdi);
 242
 243         return SR_OK;
 244 }
 245
 246 #endif
 247
 248 /**
 249  * Standard driver dev_clear() helper.
 250  *
 251  * Clear driver, this means, close all instances.
 252  *
 253  * This function can be used to implement the dev_clear() driver API
 254  * callback. dev_close() is called before every sr_dev_inst is cleared.
 255  *
 256  * The only limitation is driver-specific device contexts (sdi->priv).
 257  * These are freed, but any dynamic allocation within structs stored
 258  * there cannot be freed.
 259  *
 260  * @param driver The driver which will have its instances released.
 261  * @param clear_private If not NULL, this points to a function called
 262  * with sdi->priv as argument. The function can then clear any device
 263  * instance-specific resources kept there. It must also clear the struct
 264  * pointed to by sdi->priv.
 265  *
 266  * @return SR_OK on success.
 267  */
 268 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 269                 std_dev_clear_callback clear_private)
 270 {
 271         struct drv_context *drvc;
 272         struct sr_dev_inst *sdi;
 273         GSList *l;
 274         int ret;
 275
 276         if (!(drvc = driver->context))
 277                 /* Driver was never initialized, nothing to do. */
 278                 return SR_OK;
 279
 280         ret = SR_OK;
 281         for (l = drvc->instances; l; l = l->next) {
 282                 if (!(sdi = l->data)) {
 283                         ret = SR_ERR_BUG;
 284                         continue;
 285                 }
 286                 if (driver->dev_close)
 287                         driver->dev_close(sdi);
 288
 289                 if (sdi->conn) {
 290 #ifdef HAVE_LIBSERIALPORT
 291                         if (sdi->inst_type == SR_INST_SERIAL)
 292                                 sr_serial_dev_inst_free(sdi->conn);
 293 #endif
 294 #ifdef HAVE_LIBUSB_1_0
 295                         if (sdi->inst_type == SR_INST_USB)
 296                                 sr_usb_dev_inst_free(sdi->conn);
 297 #endif
 298                         if (sdi->inst_type == SR_INST_SCPI)
 299                                 sr_scpi_free(sdi->conn);
 300                         if (sdi->inst_type == SR_INST_MODBUS)
 301                                 sr_modbus_free(sdi->conn);
 302                 }
 303                 if (clear_private)
 304                         /* The helper function is responsible for freeing
 305                          * its own sdi->priv! */
 306                         clear_private(sdi->priv);
 307                 else
 308                         g_free(sdi->priv);
 309
 310                 sr_dev_inst_free(sdi);
 311         }
 312
 313         g_slist_free(drvc->instances);
 314         drvc->instances = NULL;
 315
 316         return ret;
 317 }
 318
 319 /**
 320  * Standard implementation for the driver dev_list() callback
 321  *
 322  * This function can be used as the dev_list callback by most drivers that use
 323  * the standard helper functions. It returns the devices contained in the driver
 324  * context instances list.
 325  *
 326  * @param di The driver instance to use.
 327  *
 328  * @return The list of devices/instances of this driver, or NULL upon errors
 329  *         or if the list is empty.
 330  */
 331 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di)
 332 {
 333         struct drv_context *drvc = di->context;
 334
 335         return drvc->instances;
 336 }
 337
 338 /**
 339  * Standard scan() callback API helper.
 340  *
 341  * This function can be used to perform common tasks required by a driver's
 342  * scan() callback. It will initialize the driver for each device on the list
 343  * and add the devices on the list to the driver's device instance list.
 344  * Usually it should be used as the last step in the scan() callback, right
 345  * before returning.
 346  *
 347  * Note: This function can only be used if std_init() has been called
 348  * previously by the driver.
 349  *
 350  * Example:
 351  * @code{c}
 352  * static GSList *scan(struct sr_dev_driver *di, GSList *options)
 353  * {
 354  *     struct GSList *device;
 355  *     struct sr_dev_inst *sdi;
 356  *
 357  *     sdi = g_new0(sr_dev_inst, 1);
 358  *     sdi->vendor = ...;
 359  *     ...
 360  *     devices = g_slist_append(devices, sdi);
 361  *     ...
 362  *     return std_scan_complete(di, devices);
 363  * }
 364  * @endcode
 365  *
 366  * @param di The driver instance to use. Must not be NULL.
 367  * @param devices List of newly discovered devices (struct sr_dev_inst).
 368  *
 369  * @return The @p devices list.
 370  */
 371 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices)
 372 {
 373         struct drv_context *drvc;
 374         GSList *l;
 375
 376         if (!di) {
 377                 sr_err("Invalid driver instance (di), cannot complete scan.");
 378                 return NULL;
 379         }
 380
 381         drvc = di->context;
 382
 383         for (l = devices; l; l = l->next) {
 384                 struct sr_dev_inst *sdi = l->data;
 385                 if (!sdi) {
 386                         sr_err("Invalid driver instance, cannot complete scan.");
 387                         return NULL;
 388                 }
 389                 sdi->driver = di;
 390         }
 391
 392         drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
 393
 394         return devices;
 395 }