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