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 /**
 131  * Return the list of supported hardware drivers.
 132  *
 133  * @return Pointer to the NULL-terminated list of hardware driver pointers.
 134  *
 135  * @since 0.1.0
 136  */
 137 SR_API struct sr_dev_driver **sr_driver_list(void)
 138 {
 139
 140         return drivers_list;
 141 }
 142
 143 /**
 144  * Initialize a hardware driver.
 145  *
 146  * This usually involves memory allocations and variable initializations
 147  * within the driver, but _not_ scanning for attached devices.
 148  * The API call sr_driver_scan() is used for that.
 149  *
 150  * @param ctx A libsigrok context object allocated by a previous call to
 151  *            sr_init(). Must not be NULL.
 152  * @param driver The driver to initialize. This must be a pointer to one of
 153  *               the entries returned by sr_driver_list(). Must not be NULL.
 154  *
 155  * @retval SR_OK Success
 156  * @retval SR_ERR_ARG Invalid parameter(s).
 157  * @retval SR_ERR_BUG Internal errors.
 158  * @retval other Another negative error code upon other errors.
 159  *
 160  * @since 0.2.0
 161  */
 162 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 163 {
 164         int ret;
 165
 166         if (!ctx) {
 167                 sr_err("Invalid libsigrok context, can't initialize.");
 168                 return SR_ERR_ARG;
 169         }
 170
 171         if (!driver) {
 172                 sr_err("Invalid driver, can't initialize.");
 173                 return SR_ERR_ARG;
 174         }
 175
 176         sr_spew("Initializing driver '%s'.", driver->name);
 177         if ((ret = driver->init(ctx)) < 0)
 178                 sr_err("Failed to initialize the driver: %d.", ret);
 179
 180         return ret;
 181 }
 182
 183 /**
 184  * Tell a hardware driver to scan for devices.
 185  *
 186  * In addition to the detection, the devices that are found are also
 187  * initialized automatically. On some devices, this involves a firmware upload,
 188  * or other such measures.
 189  *
 190  * The order in which the system is scanned for devices is not specified. The
 191  * caller should not assume or rely on any specific order.
 192  *
 193  * Before calling sr_driver_scan(), the user must have previously initialized
 194  * the driver by calling sr_driver_init().
 195  *
 196  * @param driver The driver that should scan. This must be a pointer to one of
 197  *               the entries returned by sr_driver_list(). Must not be NULL.
 198  * @param options A list of 'struct sr_hwopt' options to pass to the driver's
 199  *                scanner. Can be NULL/empty.
 200  *
 201  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
 202  *         found (or errors were encountered). This list must be freed by the
 203  *         caller using g_slist_free(), but without freeing the data pointed
 204  *         to in the list.
 205  *
 206  * @since 0.2.0
 207  */
 208 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 209 {
 210         GSList *l;
 211
 212         if (!driver) {
 213                 sr_err("Invalid driver, can't scan for devices.");
 214                 return NULL;
 215         }
 216
 217         if (!driver->priv) {
 218                 sr_err("Driver not initialized, can't scan for devices.");
 219                 return NULL;
 220         }
 221
 222         l = driver->scan(options);
 223
 224         sr_spew("Scan of '%s' found %d devices.", driver->name,
 225                 g_slist_length(l));
 226
 227         return l;
 228 }
 229
 230 /** Call driver cleanup function for all drivers.
 231  *  @private */
 232 SR_PRIV void sr_hw_cleanup_all(void)
 233 {
 234         int i;
 235         struct sr_dev_driver **drivers;
 236
 237         drivers = sr_driver_list();
 238         for (i = 0; drivers[i]; i++) {
 239                 if (drivers[i]->cleanup)
 240                         drivers[i]->cleanup();
 241         }
 242 }
 243
 244 /** Allocate struct sr_config.
 245  *  A floating reference can be passed in for data.
 246  *  @private
 247  */
 248 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
 249 {
 250         struct sr_config *src;
 251
 252         if (!(src = g_try_malloc(sizeof(struct sr_config))))
 253                 return NULL;
 254         src->key = key;
 255         src->data = g_variant_ref_sink(data);
 256
 257         return src;
 258 }
 259
 260 /** Free struct sr_config.
 261  *  @private
 262  */
 263 SR_PRIV void sr_config_free(struct sr_config *src)
 264 {
 265
 266         if (!src || !src->data) {
 267                 sr_err("%s: invalid data!", __func__);
 268                 return;
 269         }
 270
 271         g_variant_unref(src->data);
 272         g_free(src);
 273
 274 }
 275
 276 /**
 277  * Query value of a configuration key at the given driver or device instance.
 278  *
 279  * @param[in] driver The sr_dev_driver struct to query.
 280  * @param[in] sdi (optional) If the key is specific to a device, this must
 281  *            contain a pointer to the struct sr_dev_inst to be checked.
 282  *            Otherwise it must be NULL.
 283  * @param[in] cg The channel group on the device for which to list the
 284  *                    values, or NULL.
 285  * @param[in] key The configuration key (SR_CONF_*).
 286  * @param[in,out] data Pointer to a GVariant where the value will be stored.
 287  *             Must not be NULL. The caller is given ownership of the GVariant
 288  *             and must thus decrease the refcount after use. However if
 289  *             this function returns an error code, the field should be
 290  *             considered unused, and should not be unreferenced.
 291  *
 292  * @retval SR_OK Success.
 293  * @retval SR_ERR Error.
 294  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 295  *          interpreted as an error by the caller; merely as an indication
 296  *          that it's not applicable.
 297  *
 298  * @since 0.3.0
 299  */
 300 SR_API int sr_config_get(const struct sr_dev_driver *driver,
 301                 const struct sr_dev_inst *sdi,
 302                 const struct sr_channel_group *cg,
 303                 int key, GVariant **data)
 304 {
 305         int ret;
 306
 307         if (!driver || !data)
 308                 return SR_ERR;
 309
 310         if (!driver->config_get)
 311                 return SR_ERR_ARG;
 312
 313         if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
 314                 /* Got a floating reference from the driver. Sink it here,
 315                  * caller will need to unref when done with it. */
 316                 g_variant_ref_sink(*data);
 317         }
 318
 319         return ret;
 320 }
 321
 322 /**
 323  * Set value of a configuration key in a device instance.
 324  *
 325  * @param[in] sdi The device instance.
 326  * @param[in] cg The channel group on the device for which to list the
 327  *                    values, or NULL.
 328  * @param[in] key The configuration key (SR_CONF_*).
 329  * @param data The new value for the key, as a GVariant with GVariantType
 330  *        appropriate to that key. A floating reference can be passed
 331  *        in; its refcount will be sunk and unreferenced after use.
 332  *
 333  * @retval SR_OK Success.
 334  * @retval SR_ERR Error.
 335  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 336  *          interpreted as an error by the caller; merely as an indication
 337  *          that it's not applicable.
 338  *
 339  * @since 0.3.0
 340  */
 341 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
 342                 const struct sr_channel_group *cg,
 343                 int key, GVariant *data)
 344 {
 345         int ret;
 346
 347         g_variant_ref_sink(data);
 348
 349         if (!sdi || !sdi->driver || !data)
 350                 ret = SR_ERR;
 351         else if (!sdi->driver->config_set)
 352                 ret = SR_ERR_ARG;
 353         else
 354                 ret = sdi->driver->config_set(key, data, sdi, cg);
 355
 356         g_variant_unref(data);
 357
 358         return ret;
 359 }
 360
 361 /**
 362  * Apply configuration settings to the device hardware.
 363  *
 364  * @param sdi The device instance.
 365  *
 366  * @return SR_OK upon success or SR_ERR in case of error.
 367  *
 368  * @since 0.3.0
 369  */
 370 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
 371 {
 372         int ret;
 373
 374         if (!sdi || !sdi->driver)
 375                 ret = SR_ERR;
 376         else if (!sdi->driver->config_commit)
 377                 ret = SR_OK;
 378         else
 379                 ret = sdi->driver->config_commit(sdi);
 380
 381         return ret;
 382 }
 383
 384 /**
 385  * List all possible values for a configuration key.
 386  *
 387  * @param[in] driver The sr_dev_driver struct to query.
 388  * @param[in] sdi (optional) If the key is specific to a device, this must
 389  *            contain a pointer to the struct sr_dev_inst to be checked.
 390  * @param[in] cg The channel group on the device for which to list the
 391  *                    values, or NULL.
 392  * @param[in] key The configuration key (SR_CONF_*).
 393  * @param[in,out] data A pointer to a GVariant where the list will be stored.
 394  *             The caller is given ownership of the GVariant and must thus
 395  *             unref the GVariant after use. However if this function
 396  *             returns an error code, the field should be considered
 397  *             unused, and should not be unreferenced.
 398  *
 399  * @retval SR_OK Success.
 400  * @retval SR_ERR Error.
 401  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 402  *          interpreted as an error by the caller; merely as an indication
 403  *          that it's not applicable.
 404  *
 405  * @since 0.3.0
 406  */
 407 SR_API int sr_config_list(const struct sr_dev_driver *driver,
 408                 const struct sr_dev_inst *sdi,
 409                 const struct sr_channel_group *cg,
 410                 int key, GVariant **data)
 411 {
 412         int ret;
 413
 414         if (!driver || !data)
 415                 ret = SR_ERR;
 416         else if (!driver->config_list)
 417                 ret = SR_ERR_ARG;
 418         else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK)
 419                 g_variant_ref_sink(*data);
 420
 421         return ret;
 422 }
 423
 424 /**
 425  * Get information about a configuration key, by key.
 426  *
 427  * @param[in] key The configuration key.
 428  *
 429  * @return A pointer to a struct sr_config_info, or NULL if the key
 430  *         was not found.
 431  *
 432  * @since 0.2.0
 433  */
 434 SR_API const struct sr_config_info *sr_config_info_get(int key)
 435 {
 436         int i;
 437
 438         for (i = 0; sr_config_info_data[i].key; i++) {
 439                 if (sr_config_info_data[i].key == key)
 440                         return &sr_config_info_data[i];
 441         }
 442
 443         return NULL;
 444 }
 445
 446 /**
 447  * Get information about a configuration key, by name.
 448  *
 449  * @param[in] optname The configuration key.
 450  *
 451  * @return A pointer to a struct sr_config_info, or NULL if the key
 452  *         was not found.
 453  *
 454  * @since 0.2.0
 455  */
 456 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
 457 {
 458         int i;
 459
 460         for (i = 0; sr_config_info_data[i].key; i++) {
 461                 if (!strcmp(sr_config_info_data[i].id, optname))
 462                         return &sr_config_info_data[i];
 463         }
 464
 465         return NULL;
 466 }
 467
 468 /** @} */