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         /* 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) ? sdi->driver->name : "unknown";
 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  *
 207  * @retval SR_OK Success.
 208  * @retval SR_ERR_ARG Invalid arguments.
 209  * @retval SR_ERR_DEV_CLOSED Device is closed.
 210  * @retval SR_ERR Other errors.
 211  */
 212 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi)
 213 {
 214         struct sr_serial_dev_inst *serial = sdi->conn;
 215         const char *prefix = sdi->driver->name;
 216         int ret;
 217
 218         if ((ret = serial_source_remove(sdi->session, serial)) < 0) {
 219                 sr_err("%s: Failed to remove source: %d.", prefix, ret);
 220                 return ret;
 221         }
 222
 223         if ((ret = sdi->driver->dev_close(sdi)) < 0) {
 224                 sr_err("%s: Failed to close device: %d.", prefix, ret);
 225                 return ret;
 226         }
 227
 228         std_session_send_df_end(sdi);
 229
 230         return SR_OK;
 231 }
 232
 233 #endif
 234
 235 /**
 236  * Standard driver dev_clear() helper.
 237  *
 238  * Clear driver, this means, close all instances.
 239  *
 240  * This function can be used to implement the dev_clear() driver API
 241  * callback. dev_close() is called before every sr_dev_inst is cleared.
 242  *
 243  * The only limitation is driver-specific device contexts (sdi->priv).
 244  * These are freed, but any dynamic allocation within structs stored
 245  * there cannot be freed.
 246  *
 247  * @param driver The driver which will have its instances released.
 248  * @param clear_private If not NULL, this points to a function called
 249  * with sdi->priv as argument. The function can then clear any device
 250  * instance-specific resources kept there. It must also clear the struct
 251  * pointed to by sdi->priv.
 252  *
 253  * @return SR_OK on success.
 254  */
 255 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 256                 std_dev_clear_callback clear_private)
 257 {
 258         struct drv_context *drvc;
 259         struct sr_dev_inst *sdi;
 260         GSList *l;
 261         int ret;
 262
 263         if (!(drvc = driver->context))
 264                 /* Driver was never initialized, nothing to do. */
 265                 return SR_OK;
 266
 267         ret = SR_OK;
 268         for (l = drvc->instances; l; l = l->next) {
 269                 if (!(sdi = l->data)) {
 270                         ret = SR_ERR_BUG;
 271                         continue;
 272                 }
 273                 if (driver->dev_close)
 274                         driver->dev_close(sdi);
 275
 276                 if (sdi->conn) {
 277 #ifdef HAVE_LIBSERIALPORT
 278                         if (sdi->inst_type == SR_INST_SERIAL)
 279                                 sr_serial_dev_inst_free(sdi->conn);
 280 #endif
 281 #ifdef HAVE_LIBUSB_1_0
 282                         if (sdi->inst_type == SR_INST_USB)
 283                                 sr_usb_dev_inst_free(sdi->conn);
 284 #endif
 285                         if (sdi->inst_type == SR_INST_SCPI)
 286                                 sr_scpi_free(sdi->conn);
 287                         if (sdi->inst_type == SR_INST_MODBUS)
 288                                 sr_modbus_free(sdi->conn);
 289                 }
 290                 if (clear_private)
 291                         /* The helper function is responsible for freeing
 292                          * its own sdi->priv! */
 293                         clear_private(sdi->priv);
 294                 else
 295                         g_free(sdi->priv);
 296
 297                 sr_dev_inst_free(sdi);
 298         }
 299
 300         g_slist_free(drvc->instances);
 301         drvc->instances = NULL;
 302
 303         return ret;
 304 }
 305
 306 /**
 307  * Standard implementation for the driver dev_list() callback
 308  *
 309  * This function can be used as the dev_list callback by most drivers that use
 310  * the standard helper functions. It returns the devices contained in the driver
 311  * context instances list.
 312  *
 313  * @param di The driver instance to use.
 314  *
 315  * @return The list of devices/instances of this driver, or NULL upon errors
 316  *         or if the list is empty.
 317  */
 318 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di)
 319 {
 320         struct drv_context *drvc = di->context;
 321
 322         return drvc->instances;
 323 }
 324
 325 /**
 326  * Standard scan() callback API helper.
 327  *
 328  * This function can be used to perform common tasks required by a driver's
 329  * scan() callback. It will initialize the driver for each device on the list
 330  * and add the devices on the list to the driver's device instance list.
 331  * Usually it should be used as the last step in the scan() callback, right
 332  * before returning.
 333  *
 334  * Note: This function can only be used if std_init() has been called
 335  * previously by the driver.
 336  *
 337  * Example:
 338  * @code{c}
 339  * static GSList *scan(struct sr_dev_driver *di, GSList *options)
 340  * {
 341  *     struct GSList *device;
 342  *     struct sr_dev_inst *sdi;
 343  *
 344  *     sdi = g_new0(sr_dev_inst, 1);
 345  *     sdi->vendor = ...;
 346  *     ...
 347  *     devices = g_slist_append(devices, sdi);
 348  *     ...
 349  *     return std_scan_complete(di, devices);
 350  * }
 351  * @endcode
 352  *
 353  * @param di The driver instance to use. Must not be NULL.
 354  * @param devices List of newly discovered devices (struct sr_dev_inst).
 355  *
 356  * @return The @p devices list.
 357  */
 358 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices)
 359 {
 360         struct drv_context *drvc;
 361         GSList *l;
 362
 363         if (!di) {
 364                 sr_err("Invalid driver instance (di), cannot complete scan.");
 365                 return NULL;
 366         }
 367
 368         drvc = di->context;
 369
 370         for (l = devices; l; l = l->next) {
 371                 struct sr_dev_inst *sdi = l->data;
 372                 if (!sdi) {
 373                         sr_err("Invalid driver instance, cannot complete scan.");
 374                         return NULL;
 375                 }
 376                 sdi->driver = di;
 377         }
 378
 379         drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
 380
 381         return devices;
 382 }