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