hwdriver.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   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 3 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 #include <stdlib.h>
  21 #include <stdio.h>
  22 #include <sys/types.h>
  23 #include <dirent.h>
  24 #include <string.h>
  25 #include <glib.h>
  26 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
  27 #include "libsigrok.h"
  28 #include "libsigrok-internal.h"
  29
  30 /** @cond PRIVATE */
  31 #define LOG_PREFIX "hwdriver"
  32 /** @endcond */
  33
  34 extern SR_PRIV struct sr_dev_driver *drivers_list[];
  35
  36 /**
  37  * @file
  38  *
  39  * Hardware driver handling in libsigrok.
  40  */
  41
  42 /**
  43  * @defgroup grp_driver Hardware drivers
  44  *
  45  * Hardware driver handling in libsigrok.
  46  *
  47  * @{
  48  */
  49
  50 static struct sr_config_info sr_config_info_data[] = {
  51         {SR_CONF_CONN, SR_T_STRING, "conn",
  52                 "Connection", NULL},
  53         {SR_CONF_SERIALCOMM, SR_T_STRING, "serialcomm",
  54                 "Serial communication", NULL},
  55         {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
  56                 "Sample rate", NULL},
  57         {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
  58                 "Pre-trigger capture ratio", NULL},
  59         {SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern",
  60                 "Pattern", NULL},
  61         {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch",
  62                 "Trigger matches", NULL},
  63         {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
  64                 "External clock mode", NULL},
  65         {SR_CONF_SWAP, SR_T_BOOL, "swap",
  66                 "Swap channel order", NULL},
  67         {SR_CONF_RLE, SR_T_BOOL, "rle",
  68                 "Run Length Encoding", NULL},
  69         {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope",
  70                 "Trigger slope", NULL},
  71         {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource",
  72                 "Trigger source", NULL},
  73         {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
  74                 "Horizontal trigger position", NULL},
  75         {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
  76                 "Buffer size", NULL},
  77         {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
  78                 "Time base", NULL},
  79         {SR_CONF_FILTER, SR_T_STRING, "filter",
  80                 "Filter targets", NULL},
  81         {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
  82                 "Volts/div", NULL},
  83         {SR_CONF_COUPLING, SR_T_STRING, "coupling",
  84                 "Coupling", NULL},
  85         {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
  86                 "Datalog", NULL},
  87         {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq",
  88                 "Sound pressure level frequency weighting", NULL},
  89         {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time",
  90                 "Sound pressure level time weighting", NULL},
  91         {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
  92                 "Hold max", NULL},
  93         {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
  94                 "Hold min", NULL},
  95         {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
  96                 "Sound pressure level measurement range", NULL},
  97         {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
  98                 "Voltage threshold", NULL },
  99         {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
 100                 "Power off", NULL},
 101         {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source",
 102                 "Data source", NULL},
 103         {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels",
 104                 "Number of logic channels", NULL},
 105         {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels",
 106                 "Number of analog channels", NULL},
 107         {SR_CONF_OUTPUT_VOLTAGE, SR_T_FLOAT, "output_voltage",
 108                 "Current output voltage", NULL},
 109         {SR_CONF_OUTPUT_VOLTAGE_MAX, SR_T_FLOAT, "output_voltage_max",
 110                 "Maximum output voltage", NULL},
 111         {SR_CONF_OUTPUT_CURRENT, SR_T_FLOAT, "output_current",
 112                 "Current output current", NULL},
 113         {SR_CONF_OUTPUT_CURRENT_MAX, SR_T_FLOAT, "output_current_max",
 114                 "Maximum output current", NULL},
 115         {SR_CONF_OUTPUT_ENABLED, SR_T_BOOL, "output_enabled",
 116                 "Output enabled", NULL},
 117         {SR_CONF_OUTPUT_CHANNEL, SR_T_STRING, "output_channel",
 118                 "Output channel modes", NULL},
 119         {SR_CONF_OVER_VOLTAGE_PROTECTION, SR_T_BOOL, "ovp",
 120                 "Over-voltage protection", NULL},
 121         {SR_CONF_OVER_CURRENT_PROTECTION, SR_T_BOOL, "ocp",
 122                 "Over-current protection", NULL},
 123         {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
 124                 "Sample limit", NULL},
 125         {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge",
 126                 "Clock edge", NULL},
 127         {0, 0, NULL, NULL, NULL},
 128 };
 129
 130 extern struct sr_session *sr_current_session;
 131
 132 /**
 133  * Return the list of supported hardware drivers.
 134  *
 135  * @return Pointer to the NULL-terminated list of hardware driver pointers.
 136  *
 137  * @since 0.1.0
 138  */
 139 SR_API struct sr_dev_driver **sr_driver_list(void)
 140 {
 141
 142         return drivers_list;
 143 }
 144
 145 /**
 146  * Initialize a hardware driver.
 147  *
 148  * This usually involves memory allocations and variable initializations
 149  * within the driver, but _not_ scanning for attached devices.
 150  * The API call sr_driver_scan() is used for that.
 151  *
 152  * @param ctx A libsigrok context object allocated by a previous call to
 153  *            sr_init(). Must not be NULL.
 154  * @param driver The driver to initialize. This must be a pointer to one of
 155  *               the entries returned by sr_driver_list(). Must not be NULL.
 156  *
 157  * @retval SR_OK Success
 158  * @retval SR_ERR_ARG Invalid parameter(s).
 159  * @retval SR_ERR_BUG Internal errors.
 160  * @retval other Another negative error code upon other errors.
 161  *
 162  * @since 0.2.0
 163  */
 164 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 165 {
 166         int ret;
 167
 168         if (!ctx) {
 169                 sr_err("Invalid libsigrok context, can't initialize.");
 170                 return SR_ERR_ARG;
 171         }
 172
 173         if (!driver) {
 174                 sr_err("Invalid driver, can't initialize.");
 175                 return SR_ERR_ARG;
 176         }
 177
 178         sr_spew("Initializing driver '%s'.", driver->name);
 179         if ((ret = driver->init(ctx)) < 0)
 180                 sr_err("Failed to initialize the driver: %d.", ret);
 181
 182         return ret;
 183 }
 184
 185 /**
 186  * Tell a hardware driver to scan for devices.
 187  *
 188  * In addition to the detection, the devices that are found are also
 189  * initialized automatically. On some devices, this involves a firmware upload,
 190  * or other such measures.
 191  *
 192  * The order in which the system is scanned for devices is not specified. The
 193  * caller should not assume or rely on any specific order.
 194  *
 195  * Before calling sr_driver_scan(), the user must have previously initialized
 196  * the driver by calling sr_driver_init().
 197  *
 198  * @param driver The driver that should scan. This must be a pointer to one of
 199  *               the entries returned by sr_driver_list(). Must not be NULL.
 200  * @param options A list of 'struct sr_hwopt' options to pass to the driver's
 201  *                scanner. Can be NULL/empty.
 202  *
 203  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
 204  *         found (or errors were encountered). This list must be freed by the
 205  *         caller using g_slist_free(), but without freeing the data pointed
 206  *         to in the list.
 207  *
 208  * @since 0.2.0
 209  */
 210 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 211 {
 212         GSList *l;
 213
 214         if (!driver) {
 215                 sr_err("Invalid driver, can't scan for devices.");
 216                 return NULL;
 217         }
 218
 219         if (!driver->priv) {
 220                 sr_err("Driver not initialized, can't scan for devices.");
 221                 return NULL;
 222         }
 223
 224         l = driver->scan(options);
 225
 226         sr_spew("Scan of '%s' found %d devices.", driver->name,
 227                 g_slist_length(l));
 228
 229         return l;
 230 }
 231
 232 /** Call driver cleanup function for all drivers.
 233  *  @private */
 234 SR_PRIV void sr_hw_cleanup_all(void)
 235 {
 236         int i;
 237         struct sr_dev_driver **drivers;
 238
 239         drivers = sr_driver_list();
 240         for (i = 0; drivers[i]; i++) {
 241                 if (drivers[i]->cleanup)
 242                         drivers[i]->cleanup();
 243         }
 244 }
 245
 246 /** Allocate struct sr_config.
 247  *  A floating reference can be passed in for data.
 248  *  @private
 249  */
 250 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
 251 {
 252         struct sr_config *src;
 253
 254         if (!(src = g_try_malloc(sizeof(struct sr_config))))
 255                 return NULL;
 256         src->key = key;
 257         src->data = g_variant_ref_sink(data);
 258
 259         return src;
 260 }
 261
 262 /** Free struct sr_config.
 263  *  @private
 264  */
 265 SR_PRIV void sr_config_free(struct sr_config *src)
 266 {
 267
 268         if (!src || !src->data) {
 269                 sr_err("%s: invalid data!", __func__);
 270                 return;
 271         }
 272
 273         g_variant_unref(src->data);
 274         g_free(src);
 275
 276 }
 277
 278 /**
 279  * Query value of a configuration key at the given driver or device instance.
 280  *
 281  * @param[in] driver The sr_dev_driver struct to query.
 282  * @param[in] sdi (optional) If the key is specific to a device, this must
 283  *            contain a pointer to the struct sr_dev_inst to be checked.
 284  *            Otherwise it must be NULL.
 285  * @param[in] cg The channel group on the device for which to list the
 286  *                    values, or NULL.
 287  * @param[in] key The configuration key (SR_CONF_*).
 288  * @param[in,out] data Pointer to a GVariant where the value will be stored.
 289  *             Must not be NULL. The caller is given ownership of the GVariant
 290  *             and must thus decrease the refcount after use. However if
 291  *             this function returns an error code, the field should be
 292  *             considered unused, and should not be unreferenced.
 293  *
 294  * @retval SR_OK Success.
 295  * @retval SR_ERR Error.
 296  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 297  *          interpreted as an error by the caller; merely as an indication
 298  *          that it's not applicable.
 299  *
 300  * @since 0.3.0
 301  */
 302 SR_API int sr_config_get(const struct sr_dev_driver *driver,
 303                 const struct sr_dev_inst *sdi,
 304                 const struct sr_channel_group *cg,
 305                 int key, GVariant **data)
 306 {
 307         int ret;
 308
 309         if (!driver || !data)
 310                 return SR_ERR;
 311
 312         if (!driver->config_get)
 313                 return SR_ERR_ARG;
 314
 315         if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
 316                 /* Got a floating reference from the driver. Sink it here,
 317                  * caller will need to unref when done with it. */
 318                 g_variant_ref_sink(*data);
 319         }
 320
 321         return ret;
 322 }
 323
 324 /**
 325  * Set value of a configuration key in a device instance.
 326  *
 327  * @param[in] sdi The device instance.
 328  * @param[in] cg The channel group on the device for which to list the
 329  *                    values, or NULL.
 330  * @param[in] key The configuration key (SR_CONF_*).
 331  * @param data The new value for the key, as a GVariant with GVariantType
 332  *        appropriate to that key. A floating reference can be passed
 333  *        in; its refcount will be sunk and unreferenced after use.
 334  *
 335  * @retval SR_OK Success.
 336  * @retval SR_ERR Error.
 337  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 338  *          interpreted as an error by the caller; merely as an indication
 339  *          that it's not applicable.
 340  *
 341  * @since 0.3.0
 342  */
 343 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
 344                 const struct sr_channel_group *cg,
 345                 int key, GVariant *data)
 346 {
 347         int ret;
 348
 349         g_variant_ref_sink(data);
 350
 351         if (!sdi || !sdi->driver || !data)
 352                 ret = SR_ERR;
 353         else if (!sdi->driver->config_set)
 354                 ret = SR_ERR_ARG;
 355         else
 356                 ret = sdi->driver->config_set(key, data, sdi, cg);
 357
 358         g_variant_unref(data);
 359
 360         return ret;
 361 }
 362
 363 /**
 364  * Apply configuration settings to the device hardware.
 365  *
 366  * @param sdi The device instance.
 367  *
 368  * @return SR_OK upon success or SR_ERR in case of error.
 369  *
 370  * @since 0.3.0
 371  */
 372 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
 373 {
 374         int ret;
 375
 376         if (!sdi || !sdi->driver)
 377                 ret = SR_ERR;
 378         else if (!sdi->driver->config_commit)
 379                 ret = SR_OK;
 380         else
 381                 ret = sdi->driver->config_commit(sdi);
 382
 383         return ret;
 384 }
 385
 386 /**
 387  * List all possible values for a configuration key.
 388  *
 389  * @param[in] driver The sr_dev_driver struct to query.
 390  * @param[in] sdi (optional) If the key is specific to a device, this must
 391  *            contain a pointer to the struct sr_dev_inst to be checked.
 392  * @param[in] cg The channel group on the device for which to list the
 393  *                    values, or NULL.
 394  * @param[in] key The configuration key (SR_CONF_*).
 395  * @param[in,out] data A pointer to a GVariant where the list will be stored.
 396  *             The caller is given ownership of the GVariant and must thus
 397  *             unref the GVariant after use. However if this function
 398  *             returns an error code, the field should be considered
 399  *             unused, and should not be unreferenced.
 400  *
 401  * @retval SR_OK Success.
 402  * @retval SR_ERR Error.
 403  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 404  *          interpreted as an error by the caller; merely as an indication
 405  *          that it's not applicable.
 406  *
 407  * @since 0.3.0
 408  */
 409 SR_API int sr_config_list(const struct sr_dev_driver *driver,
 410                 const struct sr_dev_inst *sdi,
 411                 const struct sr_channel_group *cg,
 412                 int key, GVariant **data)
 413 {
 414         int ret;
 415
 416         if (!driver || !data)
 417                 ret = SR_ERR;
 418         else if (!driver->config_list)
 419                 ret = SR_ERR_ARG;
 420         else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK)
 421                 g_variant_ref_sink(*data);
 422
 423         return ret;
 424 }
 425
 426 /**
 427  * Get information about a configuration key, by key.
 428  *
 429  * @param[in] key The configuration key.
 430  *
 431  * @return A pointer to a struct sr_config_info, or NULL if the key
 432  *         was not found.
 433  *
 434  * @since 0.2.0
 435  */
 436 SR_API const struct sr_config_info *sr_config_info_get(int key)
 437 {
 438         int i;
 439
 440         for (i = 0; sr_config_info_data[i].key; i++) {
 441                 if (sr_config_info_data[i].key == key)
 442                         return &sr_config_info_data[i];
 443         }
 444
 445         return NULL;
 446 }
 447
 448 /**
 449  * Get information about a configuration key, by name.
 450  *
 451  * @param[in] optname The configuration key.
 452  *
 453  * @return A pointer to a struct sr_config_info, or NULL if the key
 454  *         was not found.
 455  *
 456  * @since 0.2.0
 457  */
 458 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
 459 {
 460         int i;
 461
 462         for (i = 0; sr_config_info_data[i].key; i++) {
 463                 if (!strcmp(sr_config_info_data[i].id, optname))
 464                         return &sr_config_info_data[i];
 465         }
 466
 467         return NULL;
 468 }
 469
 470 /* Unnecessary level of indirection follows. */
 471
 472 /** @private
 473  *  @see sr_session_source_remove()
 474  */
 475 SR_PRIV int sr_source_remove(int fd)
 476 {
 477         return sr_session_source_remove(sr_current_session, fd);
 478 }
 479
 480 /** @private
 481  *  @see sr_session_source_remove_pollfd()
 482  */
 483 SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd)
 484 {
 485         return sr_session_source_remove_pollfd(sr_current_session, pollfd);
 486 }
 487
 488 /** @private
 489  *  @see sr_session_source_remove_channel()
 490  */
 491 SR_PRIV int sr_source_remove_channel(GIOChannel *channel)
 492 {
 493         return sr_session_source_remove_channel(sr_current_session, channel);
 494 }
 495
 496 /** @private
 497  *  @see sr_session_source_add()
 498  */
 499 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 500                           sr_receive_data_callback cb, void *cb_data)
 501 {
 502         return sr_session_source_add(sr_current_session,
 503                         fd, events, timeout, cb, cb_data);
 504 }
 505
 506 /** @private
 507  *  @see sr_session_source_add_pollfd()
 508  */
 509 SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
 510                           sr_receive_data_callback cb, void *cb_data)
 511 {
 512         return sr_session_source_add_pollfd(sr_current_session,
 513                         pollfd, timeout, cb, cb_data);
 514 }
 515
 516 /** @private
 517  *  @see sr_session_source_add_channel()
 518  */
 519 SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events,
 520                           int timeout, sr_receive_data_callback cb, void *cb_data)
 521 {
 522         return sr_session_source_add_channel(sr_current_session,
 523                         channel, events, timeout, cb, cb_data);
 524 }
 525
 526 /** @} */