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