src/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_TARGET, SR_T_FLOAT, "output_voltage_target",
 110                 "Output voltage target", NULL},
 111         {SR_CONF_OUTPUT_CURRENT, SR_T_FLOAT, "output_current",
 112                 "Current output current", NULL},
 113         {SR_CONF_OUTPUT_CURRENT_LIMIT, SR_T_FLOAT, "output_current_limit",
 114                 "Output current limit", NULL},
 115         {SR_CONF_OUTPUT_ENABLED, SR_T_BOOL, "output_enabled",
 116                 "Output enabled", NULL},
 117         {SR_CONF_OUTPUT_CHANNEL_CONFIG, SR_T_STRING, "output_channel_config",
 118                 "Output channel modes", NULL},
 119         {SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, SR_T_BOOL, "ovp_enabled",
 120                 "Over-voltage protection enabled", NULL},
 121         {SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, SR_T_BOOL, "ovp_active",
 122                 "Over-voltage protection active", NULL},
 123         {SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD, SR_T_FLOAT, "ovp_threshold",
 124                 "Over-voltage protection threshold", NULL},
 125         {SR_CONF_OVER_CURRENT_PROTECTION_ENABLED, SR_T_BOOL, "ocp_enabled",
 126                 "Over-current protection enabled", NULL},
 127         {SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE, SR_T_BOOL, "ocp_active",
 128                 "Over-current protection active", NULL},
 129         {SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD, SR_T_FLOAT, "ocp_threshold",
 130                 "Over-current protection threshold", NULL},
 131         {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
 132                 "Sample limit", NULL},
 133         {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge",
 134                 "Clock edge", NULL},
 135         {SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude",
 136                 "Amplitude", NULL},
 137         {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp",
 138                 "Over-temperature protection", NULL},
 139         {SR_CONF_OUTPUT_REGULATION, SR_T_STRING, "output_regulation",
 140                 "Output channel regulation", NULL},
 141         {SR_CONF_OUTPUT_FREQUENCY, SR_T_UINT64, "output_frequency",
 142                 "Output frequency", NULL},
 143         {SR_CONF_MEASURED_QUANTITY, SR_T_STRING, "measured_quantity",
 144                 "Measured quantity", NULL},
 145         {SR_CONF_MEASURED_2ND_QUANTITY, SR_T_STRING, "measured_2nd_quantity",
 146                 "Measured secondary quantity", NULL},
 147         {SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model",
 148                 "Equivalent circuit model", NULL},
 149         {0, 0, NULL, NULL, NULL},
 150 };
 151
 152 SR_PRIV const GVariantType *sr_variant_type_get(int datatype)
 153 {
 154         switch (datatype) {
 155         case SR_T_INT32:
 156                 return G_VARIANT_TYPE_INT32;
 157         case SR_T_UINT64:
 158                 return G_VARIANT_TYPE_UINT64;
 159         case SR_T_STRING:
 160                 return G_VARIANT_TYPE_STRING;
 161         case SR_T_BOOL:
 162                 return G_VARIANT_TYPE_BOOLEAN;
 163         case SR_T_FLOAT:
 164                 return G_VARIANT_TYPE_DOUBLE;
 165         case SR_T_RATIONAL_PERIOD:
 166         case SR_T_RATIONAL_VOLT:
 167         case SR_T_UINT64_RANGE:
 168         case SR_T_DOUBLE_RANGE:
 169                 return G_VARIANT_TYPE_TUPLE;
 170         case SR_T_KEYVALUE:
 171                 return G_VARIANT_TYPE_DICTIONARY;
 172         default:
 173                 return NULL;
 174         }
 175 }
 176
 177 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value)
 178 {
 179         const struct sr_config_info *info;
 180         const GVariantType *type, *expected;
 181         char *expected_string, *type_string;
 182
 183         info = sr_config_info_get(key);
 184         if (!info)
 185                 return SR_OK;
 186
 187         expected = sr_variant_type_get(info->datatype);
 188         type = g_variant_get_type(value);
 189         if (!g_variant_type_equal(type, expected)
 190                         && !g_variant_type_is_subtype_of(type, expected)) {
 191                 expected_string = g_variant_type_dup_string(expected);
 192                 type_string = g_variant_type_dup_string(type);
 193                 sr_err("Wrong variant type for key '%s': expected '%s', got '%s'",
 194                         info->name, expected_string, type_string);
 195                 g_free(expected_string);
 196                 g_free(type_string);
 197                 return SR_ERR_ARG;
 198         }
 199
 200         return SR_OK;
 201 }
 202
 203 /**
 204  * Return the list of supported hardware drivers.
 205  *
 206  * @return Pointer to the NULL-terminated list of hardware driver pointers.
 207  *
 208  * @since 0.1.0
 209  */
 210 SR_API struct sr_dev_driver **sr_driver_list(void)
 211 {
 212
 213         return drivers_list;
 214 }
 215
 216 /**
 217  * Initialize a hardware driver.
 218  *
 219  * This usually involves memory allocations and variable initializations
 220  * within the driver, but _not_ scanning for attached devices.
 221  * The API call sr_driver_scan() is used for that.
 222  *
 223  * @param ctx A libsigrok context object allocated by a previous call to
 224  *            sr_init(). Must not be NULL.
 225  * @param driver The driver to initialize. This must be a pointer to one of
 226  *               the entries returned by sr_driver_list(). Must not be NULL.
 227  *
 228  * @retval SR_OK Success
 229  * @retval SR_ERR_ARG Invalid parameter(s).
 230  * @retval SR_ERR_BUG Internal errors.
 231  * @retval other Another negative error code upon other errors.
 232  *
 233  * @since 0.2.0
 234  */
 235 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 236 {
 237         int ret;
 238
 239         if (!ctx) {
 240                 sr_err("Invalid libsigrok context, can't initialize.");
 241                 return SR_ERR_ARG;
 242         }
 243
 244         if (!driver) {
 245                 sr_err("Invalid driver, can't initialize.");
 246                 return SR_ERR_ARG;
 247         }
 248
 249         sr_spew("Initializing driver '%s'.", driver->name);
 250         if ((ret = driver->init(ctx)) < 0)
 251                 sr_err("Failed to initialize the driver: %d.", ret);
 252
 253         return ret;
 254 }
 255
 256 /**
 257  * Tell a hardware driver to scan for devices.
 258  *
 259  * In addition to the detection, the devices that are found are also
 260  * initialized automatically. On some devices, this involves a firmware upload,
 261  * or other such measures.
 262  *
 263  * The order in which the system is scanned for devices is not specified. The
 264  * caller should not assume or rely on any specific order.
 265  *
 266  * Before calling sr_driver_scan(), the user must have previously initialized
 267  * the driver by calling sr_driver_init().
 268  *
 269  * @param driver The driver that should scan. This must be a pointer to one of
 270  *               the entries returned by sr_driver_list(). Must not be NULL.
 271  * @param options A list of 'struct sr_hwopt' options to pass to the driver's
 272  *                scanner. Can be NULL/empty.
 273  *
 274  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
 275  *         found (or errors were encountered). This list must be freed by the
 276  *         caller using g_slist_free(), but without freeing the data pointed
 277  *         to in the list.
 278  *
 279  * @since 0.2.0
 280  */
 281 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 282 {
 283         GSList *l;
 284         struct sr_config *src;
 285
 286         if (!driver) {
 287                 sr_err("Invalid driver, can't scan for devices.");
 288                 return NULL;
 289         }
 290
 291         if (!driver->priv) {
 292                 sr_err("Driver not initialized, can't scan for devices.");
 293                 return NULL;
 294         }
 295
 296         for (l = options; l; l = l->next) {
 297                 src = l->data;
 298                 if (sr_variant_type_check(src->key, src->data) != SR_OK)
 299                         return NULL;
 300         }
 301
 302         l = driver->scan(options);
 303
 304         sr_spew("Scan of '%s' found %d devices.", driver->name,
 305                 g_slist_length(l));
 306
 307         return l;
 308 }
 309
 310 /** Call driver cleanup function for all drivers.
 311  *  @private */
 312 SR_PRIV void sr_hw_cleanup_all(void)
 313 {
 314         int i;
 315         struct sr_dev_driver **drivers;
 316
 317         drivers = sr_driver_list();
 318         for (i = 0; drivers[i]; i++) {
 319                 if (drivers[i]->cleanup)
 320                         drivers[i]->cleanup();
 321         }
 322 }
 323
 324 /** Allocate struct sr_config.
 325  *  A floating reference can be passed in for data.
 326  *  @private
 327  */
 328 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data)
 329 {
 330         struct sr_config *src;
 331
 332         if (!(src = g_try_malloc(sizeof(struct sr_config))))
 333                 return NULL;
 334         src->key = key;
 335         src->data = g_variant_ref_sink(data);
 336
 337         return src;
 338 }
 339
 340 /** Free struct sr_config.
 341  *  @private
 342  */
 343 SR_PRIV void sr_config_free(struct sr_config *src)
 344 {
 345
 346         if (!src || !src->data) {
 347                 sr_err("%s: invalid data!", __func__);
 348                 return;
 349         }
 350
 351         g_variant_unref(src->data);
 352         g_free(src);
 353
 354 }
 355
 356 /**
 357  * Query value of a configuration key at the given driver or device instance.
 358  *
 359  * @param[in] driver The sr_dev_driver struct to query.
 360  * @param[in] sdi (optional) If the key is specific to a device, this must
 361  *            contain a pointer to the struct sr_dev_inst to be checked.
 362  *            Otherwise it must be NULL.
 363  * @param[in] cg The channel group on the device for which to list the
 364  *                    values, or NULL.
 365  * @param[in] key The configuration key (SR_CONF_*).
 366  * @param[in,out] data Pointer to a GVariant where the value will be stored.
 367  *             Must not be NULL. The caller is given ownership of the GVariant
 368  *             and must thus decrease the refcount after use. However if
 369  *             this function returns an error code, the field should be
 370  *             considered unused, and should not be unreferenced.
 371  *
 372  * @retval SR_OK Success.
 373  * @retval SR_ERR Error.
 374  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 375  *          interpreted as an error by the caller; merely as an indication
 376  *          that it's not applicable.
 377  *
 378  * @since 0.3.0
 379  */
 380 SR_API int sr_config_get(const struct sr_dev_driver *driver,
 381                 const struct sr_dev_inst *sdi,
 382                 const struct sr_channel_group *cg,
 383                 uint32_t key, GVariant **data)
 384 {
 385         int ret;
 386
 387         if (!driver || !data)
 388                 return SR_ERR;
 389
 390         if (!driver->config_get)
 391                 return SR_ERR_ARG;
 392
 393         if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
 394                 /* Got a floating reference from the driver. Sink it here,
 395                  * caller will need to unref when done with it. */
 396                 g_variant_ref_sink(*data);
 397         }
 398
 399         return ret;
 400 }
 401
 402 /**
 403  * Set value of a configuration key in a device instance.
 404  *
 405  * @param[in] sdi The device instance.
 406  * @param[in] cg The channel group on the device for which to list the
 407  *                    values, or NULL.
 408  * @param[in] key The configuration key (SR_CONF_*).
 409  * @param data The new value for the key, as a GVariant with GVariantType
 410  *        appropriate to that key. A floating reference can be passed
 411  *        in; its refcount will be sunk and unreferenced after use.
 412  *
 413  * @retval SR_OK Success.
 414  * @retval SR_ERR Error.
 415  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 416  *          interpreted as an error by the caller; merely as an indication
 417  *          that it's not applicable.
 418  *
 419  * @since 0.3.0
 420  */
 421 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
 422                 const struct sr_channel_group *cg,
 423                 uint32_t key, GVariant *data)
 424 {
 425         int ret;
 426
 427         g_variant_ref_sink(data);
 428
 429         if (!sdi || !sdi->driver || !data)
 430                 ret = SR_ERR;
 431         else if (!sdi->driver->config_set)
 432                 ret = SR_ERR_ARG;
 433         else if ((ret = sr_variant_type_check(key, data)) == SR_OK)
 434                 ret = sdi->driver->config_set(key, data, sdi, cg);
 435
 436         g_variant_unref(data);
 437
 438         return ret;
 439 }
 440
 441 /**
 442  * Apply configuration settings to the device hardware.
 443  *
 444  * @param sdi The device instance.
 445  *
 446  * @return SR_OK upon success or SR_ERR in case of error.
 447  *
 448  * @since 0.3.0
 449  */
 450 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
 451 {
 452         int ret;
 453
 454         if (!sdi || !sdi->driver)
 455                 ret = SR_ERR;
 456         else if (!sdi->driver->config_commit)
 457                 ret = SR_OK;
 458         else
 459                 ret = sdi->driver->config_commit(sdi);
 460
 461         return ret;
 462 }
 463
 464 /**
 465  * List all possible values for a configuration key.
 466  *
 467  * @param[in] driver The sr_dev_driver struct to query.
 468  * @param[in] sdi (optional) If the key is specific to a device, this must
 469  *            contain a pointer to the struct sr_dev_inst to be checked.
 470  * @param[in] cg The channel group on the device for which to list the
 471  *                    values, or NULL.
 472  * @param[in] key The configuration key (SR_CONF_*).
 473  * @param[in,out] data A pointer to a GVariant where the list will be stored.
 474  *             The caller is given ownership of the GVariant and must thus
 475  *             unref the GVariant after use. However if this function
 476  *             returns an error code, the field should be considered
 477  *             unused, and should not be unreferenced.
 478  *
 479  * @retval SR_OK Success.
 480  * @retval SR_ERR Error.
 481  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 482  *          interpreted as an error by the caller; merely as an indication
 483  *          that it's not applicable.
 484  *
 485  * @since 0.3.0
 486  */
 487 SR_API int sr_config_list(const struct sr_dev_driver *driver,
 488                 const struct sr_dev_inst *sdi,
 489                 const struct sr_channel_group *cg,
 490                 uint32_t key, GVariant **data)
 491 {
 492         int ret;
 493
 494         if (!driver || !data)
 495                 ret = SR_ERR;
 496         else if (!driver->config_list)
 497                 ret = SR_ERR_ARG;
 498         else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK)
 499                 g_variant_ref_sink(*data);
 500
 501         return ret;
 502 }
 503
 504 /**
 505  * Get information about a configuration key, by key.
 506  *
 507  * @param[in] key The configuration key.
 508  *
 509  * @return A pointer to a struct sr_config_info, or NULL if the key
 510  *         was not found.
 511  *
 512  * @since 0.2.0
 513  */
 514 SR_API const struct sr_config_info *sr_config_info_get(uint32_t key)
 515 {
 516         int i;
 517
 518         for (i = 0; sr_config_info_data[i].key; i++) {
 519                 if (sr_config_info_data[i].key == key)
 520                         return &sr_config_info_data[i];
 521         }
 522
 523         return NULL;
 524 }
 525
 526 /**
 527  * Get information about a configuration key, by name.
 528  *
 529  * @param[in] optname The configuration key.
 530  *
 531  * @return A pointer to a struct sr_config_info, or NULL if the key
 532  *         was not found.
 533  *
 534  * @since 0.2.0
 535  */
 536 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
 537 {
 538         int i;
 539
 540         for (i = 0; sr_config_info_data[i].key; i++) {
 541                 if (!strcmp(sr_config_info_data[i].id, optname))
 542                         return &sr_config_info_data[i];
 543         }
 544
 545         return NULL;
 546 }
 547
 548 /** @} */