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