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