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