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 /* Message logging helpers with subsystem-specific prefix string. */
  31 #define LOG_PREFIX "hwdriver: "
  32 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  33 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  34 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  35 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  36 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  37 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
  38
  39 /**
  40  * @file
  41  *
  42  * Hardware driver handling in libsigrok.
  43  */
  44
  45 /**
  46  * @defgroup grp_driver Hardware drivers
  47  *
  48  * Hardware driver handling in libsigrok.
  49  *
  50  * @{
  51  */
  52
  53 static struct sr_config_info sr_config_info_data[] = {
  54         {SR_CONF_CONN, SR_T_CHAR, "conn",
  55                 "Connection", NULL},
  56         {SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm",
  57                 "Serial communication", NULL},
  58         {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
  59                 "Sample rate", NULL},
  60         {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
  61                 "Pre-trigger capture ratio", NULL},
  62         {SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern",
  63                 "Pattern generator mode", NULL},
  64         {SR_CONF_TRIGGER_TYPE, SR_T_CHAR, "triggertype",
  65                 "Trigger types", NULL},
  66         {SR_CONF_RLE, SR_T_BOOL, "rle",
  67                 "Run Length Encoding", NULL},
  68         {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
  69                 "Trigger slope", NULL},
  70         {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
  71                 "Trigger source", NULL},
  72         {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
  73                 "Horizontal trigger position", NULL},
  74         {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
  75                 "Buffer size", NULL},
  76         {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
  77                 "Time base", NULL},
  78         {SR_CONF_FILTER, SR_T_CHAR, "filter",
  79                 "Filter targets", NULL},
  80         {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
  81                 "Volts/div", NULL},
  82         {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
  83                 "Coupling", NULL},
  84         {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
  85                 "Datalog", NULL},
  86         {0, 0, NULL, NULL, NULL},
  87 };
  88
  89 /** @cond PRIVATE */
  90 #ifdef HAVE_HW_BRYMEN_DMM
  91 extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
  92 #endif
  93 #ifdef HAVE_HW_CEM_DT_885X
  94 extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
  95 #endif
  96 #ifdef HAVE_HW_COLEAD_SLM
  97 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
  98 #endif
  99 #ifdef HAVE_HW_DEMO
 100 extern SR_PRIV struct sr_dev_driver demo_driver_info;
 101 #endif
 102 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
 103 extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
 104 #endif
 105 #ifdef HAVE_HW_LASCAR_EL_USB
 106 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
 107 #endif
 108 #ifdef HAVE_HW_MIC_985XX
 109 extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
 110 extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
 111 #endif
 112 #ifdef HAVE_HW_NEXUS_OSCIPRIME
 113 extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
 114 #endif
 115 #ifdef HAVE_HW_OLS
 116 extern SR_PRIV struct sr_dev_driver ols_driver_info;
 117 #endif
 118 #ifdef HAVE_HW_RIGOL_DS1XX2
 119 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
 120 #endif
 121 #ifdef HAVE_HW_TONDAJ_SL_814
 122 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
 123 #endif
 124 #ifdef HAVE_HW_VICTOR_DMM
 125 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
 126 #endif
 127 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
 128 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
 129 #endif
 130 #ifdef HAVE_HW_ASIX_SIGMA
 131 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
 132 #endif
 133 #ifdef HAVE_HW_CHRONOVU_LA8
 134 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
 135 #endif
 136 #ifdef HAVE_HW_LINK_MSO19
 137 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
 138 #endif
 139 #ifdef HAVE_HW_ALSA
 140 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
 141 #endif
 142 #ifdef HAVE_HW_FX2LAFW
 143 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 144 #endif
 145 #ifdef HAVE_HW_HANTEK_DSO
 146 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
 147 #endif
 148 #ifdef HAVE_HW_AGILENT_DMM
 149 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
 150 #endif
 151 #ifdef HAVE_HW_FLUKE_DMM
 152 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
 153 #endif
 154 #ifdef HAVE_HW_SERIAL_DMM
 155 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
 156 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
 157 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
 158 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
 159 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
 160 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
 161 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
 162 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
 163 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
 164 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
 165 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
 166 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
 167 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8060_ser_driver_info;
 168 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
 169 extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
 170 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
 171 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
 172 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
 173 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
 174 #endif
 175 #ifdef HAVE_HW_UNI_T_DMM
 176 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8060_driver_info;
 177 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
 178 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
 179 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
 180 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
 181 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
 182 #endif
 183 /** @endcond */
 184
 185 static struct sr_dev_driver *drivers_list[] = {
 186 #ifdef HAVE_HW_BRYMEN_DMM
 187         &brymen_bm857_driver_info,
 188 #endif
 189 #ifdef HAVE_HW_CEM_DT_885X
 190         &cem_dt_885x_driver_info,
 191 #endif
 192 #ifdef HAVE_HW_COLEAD_SLM
 193         &colead_slm_driver_info,
 194 #endif
 195 #ifdef HAVE_HW_DEMO
 196         &demo_driver_info,
 197 #endif
 198 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
 199         &ikalogic_scanalogic2_driver_info,
 200 #endif
 201 #ifdef HAVE_HW_LASCAR_EL_USB
 202         &lascar_el_usb_driver_info,
 203 #endif
 204 #ifdef HAVE_HW_MIC_985XX
 205         &mic_98581_driver_info,
 206         &mic_98583_driver_info,
 207 #endif
 208 #ifdef HAVE_HW_NEXUS_OSCIPRIME
 209         &nexus_osciprime_driver_info,
 210 #endif
 211 #ifdef HAVE_HW_OLS
 212         &ols_driver_info,
 213 #endif
 214 #ifdef HAVE_HW_RIGOL_DS1XX2
 215         &rigol_ds1xx2_driver_info,
 216 #endif
 217 #ifdef HAVE_HW_TONDAJ_SL_814
 218         &tondaj_sl_814_driver_info,
 219 #endif
 220 #ifdef HAVE_HW_VICTOR_DMM
 221         &victor_dmm_driver_info,
 222 #endif
 223 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
 224         &zeroplus_logic_cube_driver_info,
 225 #endif
 226 #ifdef HAVE_HW_ASIX_SIGMA
 227         &asix_sigma_driver_info,
 228 #endif
 229 #ifdef HAVE_HW_CHRONOVU_LA8
 230         &chronovu_la8_driver_info,
 231 #endif
 232 #ifdef HAVE_HW_LINK_MSO19
 233         &link_mso19_driver_info,
 234 #endif
 235 #ifdef HAVE_HW_ALSA
 236         &alsa_driver_info,
 237 #endif
 238 #ifdef HAVE_HW_FX2LAFW
 239         &fx2lafw_driver_info,
 240 #endif
 241 #ifdef HAVE_HW_HANTEK_DSO
 242         &hantek_dso_driver_info,
 243 #endif
 244 #ifdef HAVE_HW_AGILENT_DMM
 245         &agdmm_driver_info,
 246 #endif
 247 #ifdef HAVE_HW_FLUKE_DMM
 248         &flukedmm_driver_info,
 249 #endif
 250 #ifdef HAVE_HW_SERIAL_DMM
 251         &digitek_dt4000zc_driver_info,
 252         &tekpower_tp4000zc_driver_info,
 253         &metex_me31_driver_info,
 254         &peaktech_3410_driver_info,
 255         &mastech_mas345_driver_info,
 256         &va_va18b_driver_info,
 257         &metex_m3640d_driver_info,
 258         &peaktech_4370_driver_info,
 259         &pce_pce_dm32_driver_info,
 260         &radioshack_22_168_driver_info,
 261         &radioshack_22_805_driver_info,
 262         &radioshack_22_812_driver_info,
 263         &tecpel_dmm_8060_ser_driver_info,
 264         &tecpel_dmm_8061_ser_driver_info,
 265         &voltcraft_m3650d_driver_info,
 266         &voltcraft_vc820_ser_driver_info,
 267         &voltcraft_vc840_ser_driver_info,
 268         &uni_t_ut61d_ser_driver_info,
 269         &uni_t_ut61e_ser_driver_info,
 270 #endif
 271 #ifdef HAVE_HW_UNI_T_DMM
 272         &tecpel_dmm_8060_driver_info,
 273         &tecpel_dmm_8061_driver_info,
 274         &uni_t_ut61d_driver_info,
 275         &uni_t_ut61e_driver_info,
 276         &voltcraft_vc820_driver_info,
 277         &voltcraft_vc840_driver_info,
 278 #endif
 279         NULL,
 280 };
 281
 282 /**
 283  * Return the list of supported hardware drivers.
 284  *
 285  * @return Pointer to the NULL-terminated list of hardware driver pointers.
 286  */
 287 SR_API struct sr_dev_driver **sr_driver_list(void)
 288 {
 289
 290         return drivers_list;
 291 }
 292
 293 /**
 294  * Initialize a hardware driver.
 295  *
 296  * This usually involves memory allocations and variable initializations
 297  * within the driver, but _not_ scanning for attached devices.
 298  * The API call sr_driver_scan() is used for that.
 299  *
 300  * @param ctx A libsigrok context object allocated by a previous call to
 301  *            sr_init(). Must not be NULL.
 302  * @param driver The driver to initialize. This must be a pointer to one of
 303  *               the entries returned by sr_driver_list(). Must not be NULL.
 304  *
 305  * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
 306  *         SR_ERR_BUG upon internal errors, or another negative error code
 307  *         upon other errors.
 308  */
 309 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 310 {
 311         int ret;
 312
 313         if (!ctx) {
 314                 sr_err("Invalid libsigrok context, can't initialize.");
 315                 return SR_ERR_ARG;
 316         }
 317
 318         if (!driver) {
 319                 sr_err("Invalid driver, can't initialize.");
 320                 return SR_ERR_ARG;
 321         }
 322
 323         sr_spew("Initializing driver '%s'.", driver->name);
 324         if ((ret = driver->init(ctx)) < 0)
 325                 sr_err("Failed to initialize the driver: %d.", ret);
 326
 327         return ret;
 328 }
 329
 330 /**
 331  * Tell a hardware driver to scan for devices.
 332  *
 333  * In addition to the detection, the devices that are found are also
 334  * initialized automatically. On some devices, this involves a firmware upload,
 335  * or other such measures.
 336  *
 337  * The order in which the system is scanned for devices is not specified. The
 338  * caller should not assume or rely on any specific order.
 339  *
 340  * Before calling sr_driver_scan(), the user must have previously initialized
 341  * the driver by calling sr_driver_init().
 342  *
 343  * @param driver The driver that should scan. This must be a pointer to one of
 344  *               the entries returned by sr_driver_list(). Must not be NULL.
 345  * @param options A list of 'struct sr_hwopt' options to pass to the driver's
 346  *                scanner. Can be NULL/empty.
 347  *
 348  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
 349  *         found (or errors were encountered). This list must be freed by the
 350  *         caller using g_slist_free(), but without freeing the data pointed
 351  *         to in the list.
 352  */
 353 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 354 {
 355         GSList *l;
 356
 357         if (!driver) {
 358                 sr_err("Invalid driver, can't scan for devices.");
 359                 return NULL;
 360         }
 361
 362         if (!driver->priv) {
 363                 sr_err("Driver not initialized, can't scan for devices.");
 364                 return NULL;
 365         }
 366
 367         l = driver->scan(options);
 368
 369         sr_spew("Scan of '%s' found %d devices.", driver->name,
 370                 g_slist_length(l));
 371
 372         return l;
 373 }
 374
 375 /** @private */
 376 SR_PRIV void sr_hw_cleanup_all(void)
 377 {
 378         int i;
 379         struct sr_dev_driver **drivers;
 380
 381         drivers = sr_driver_list();
 382         for (i = 0; drivers[i]; i++) {
 383                 if (drivers[i]->cleanup)
 384                         drivers[i]->cleanup();
 385         }
 386 }
 387
 388 /** A floating reference can be passed in for data. */
 389 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
 390 {
 391         struct sr_config *src;
 392
 393         if (!(src = g_try_malloc(sizeof(struct sr_config))))
 394                 return NULL;
 395         src->key = key;
 396         src->data = g_variant_ref_sink(data);
 397
 398         return src;
 399 }
 400
 401 SR_PRIV void sr_config_free(struct sr_config *src)
 402 {
 403
 404         if (!src || !src->data) {
 405                 sr_err("%s: invalid data!", __func__);
 406                 return;
 407         }
 408
 409         g_variant_unref(src->data);
 410         g_free(src);
 411
 412 }
 413
 414 /**
 415  * Returns information about the given driver or device instance.
 416  *
 417  * @param driver The sr_dev_driver struct to query.
 418  * @param key The configuration key (SR_CONF_*).
 419  * @param data Pointer to a GVariant where the value will be stored. Must
 420  *             not be NULL. The caller is given ownership of the GVariant
 421  *             and must thus decrease the refcount after use. However if
 422  *             this function returns an error code, the field should be
 423  *             considered unused, and should not be unreferenced.
 424  * @param sdi (optional) If the key is specific to a device, this must
 425  *            contain a pointer to the struct sr_dev_inst to be checked.
 426  *            Otherwise it must be NULL.
 427  *
 428  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 429  *         may be returned by the driver indicating it doesn't know that key,
 430  *         but this is not to be flagged as an error by the caller; merely
 431  *         as an indication that it's not applicable.
 432  */
 433 SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
 434                 GVariant **data, const struct sr_dev_inst *sdi)
 435 {
 436         int ret;
 437
 438         if (!driver || !data)
 439                 return SR_ERR;
 440
 441         if (!driver->config_get)
 442                 return SR_ERR_ARG;
 443
 444         if ((ret = driver->config_get(key, data, sdi)) == SR_OK) {
 445                 /* Got a floating reference from the driver. Sink it here,
 446                  * caller will need to unref when done with it. */
 447                 g_variant_ref_sink(*data);
 448         }
 449
 450         return ret;
 451 }
 452
 453 /**
 454  * Set a configuration key in a device instance.
 455  *
 456  * @param sdi The device instance.
 457  * @param key The configuration key (SR_CONF_*).
 458  * @param data The new value for the key, as a GVariant with GVariantType
 459  *        appropriate to that key. A floating reference can be passed
 460  *        in; its refcount will be sunk and unreferenced after use.
 461  *
 462  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 463  *         may be returned by the driver indicating it doesn't know that key,
 464  *         but this is not to be flagged as an error by the caller; merely
 465  *         as an indication that it's not applicable.
 466  */
 467 SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data)
 468 {
 469         int ret;
 470
 471         g_variant_ref_sink(data);
 472
 473         if (!sdi || !sdi->driver || !data)
 474                 ret = SR_ERR;
 475         else if (!sdi->driver->config_set)
 476                 ret = SR_ERR_ARG;
 477         else
 478                 ret = sdi->driver->config_set(key, data, sdi);
 479
 480         g_variant_unref(data);
 481
 482         return ret;
 483 }
 484
 485 /**
 486  * List all possible values for a configuration key.
 487  *
 488  * @param driver The sr_dev_driver struct to query.
 489  * @param key The configuration key (SR_CONF_*).
 490  * @param data A pointer to a GVariant where the list will be stored. The
 491  *             caller is given ownership of the GVariant and must thus
 492  *             unref the GVariant after use. However if this function
 493  *             returns an error code, the field should be considered
 494  *             unused, and should not be unreferenced.
 495  * @param sdi (optional) If the key is specific to a device, this must
 496  *            contain a pointer to the struct sr_dev_inst to be checked.
 497  *
 498  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 499  *         may be returned by the driver indicating it doesn't know that key,
 500  *         but this is not to be flagged as an error by the caller; merely
 501  *         as an indication that it's not applicable.
 502  */
 503 SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
 504                 GVariant **data, const struct sr_dev_inst *sdi)
 505 {
 506         int ret;
 507
 508         if (!driver || !data)
 509                 ret = SR_ERR;
 510         else if (!driver->config_list)
 511                 ret = SR_ERR_ARG;
 512         else if ((ret = driver->config_list(key, data, sdi)) == SR_OK)
 513                 g_variant_ref_sink(*data);
 514
 515         return ret;
 516 }
 517
 518 /**
 519  * Get information about a configuration key.
 520  *
 521  * @param key The configuration key.
 522  *
 523  * @return A pointer to a struct sr_config_info, or NULL if the key
 524  *         was not found.
 525  */
 526 SR_API const struct sr_config_info *sr_config_info_get(int key)
 527 {
 528         int i;
 529
 530         for (i = 0; sr_config_info_data[i].key; i++) {
 531                 if (sr_config_info_data[i].key == key)
 532                         return &sr_config_info_data[i];
 533         }
 534
 535         return NULL;
 536 }
 537
 538 /**
 539  * Get information about an configuration key, by name.
 540  *
 541  * @param optname The configuration key.
 542  *
 543  * @return A pointer to a struct sr_config_info, or NULL if the key
 544  *         was not found.
 545  */
 546 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
 547 {
 548         int i;
 549
 550         for (i = 0; sr_config_info_data[i].key; i++) {
 551                 if (!strcmp(sr_config_info_data[i].id, optname))
 552                         return &sr_config_info_data[i];
 553         }
 554
 555         return NULL;
 556 }
 557
 558 /* Unnecessary level of indirection follows. */
 559
 560 /** @private */
 561 SR_PRIV int sr_source_remove(int fd)
 562 {
 563         return sr_session_source_remove(fd);
 564 }
 565
 566 /** @private */
 567 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 568                           sr_receive_data_callback_t cb, void *cb_data)
 569 {
 570         return sr_session_source_add(fd, events, timeout, cb, cb_data);
 571 }
 572
 573 /** @} */