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