hwdriver.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010-2012 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_RLE, SR_T_BOOL, "rle",
  65                 "Run Length Encoding", NULL},
  66         {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
  67                 "Trigger slope", NULL},
  68         {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
  69                 "Trigger source", NULL},
  70         {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
  71                 "Horizontal trigger position", NULL},
  72         {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
  73                 "Buffer size", NULL},
  74         {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
  75                 "Time base", NULL},
  76         {SR_CONF_FILTER, SR_T_CHAR, "filter",
  77                 "Filter targets", NULL},
  78         {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
  79                 "Volts/div", NULL},
  80         {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
  81                 "Coupling", NULL},
  82         {0, 0, NULL, NULL, NULL},
  83 };
  84
  85 /** @cond PRIVATE */
  86 #ifdef HAVE_HW_COLEAD_SLM
  87 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
  88 #endif
  89 #ifdef HAVE_LA_DEMO
  90 extern SR_PRIV struct sr_dev_driver demo_driver_info;
  91 #endif
  92 #ifdef HAVE_HW_LASCAR_EL_USB
  93 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
  94 #endif
  95 #ifdef HAVE_HW_MIC_985XX
  96 extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
  97 #endif
  98 #ifdef HAVE_HW_NEXUS_OSCIPRIME
  99 extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
 100 #endif
 101 #ifdef HAVE_LA_OLS
 102 extern SR_PRIV struct sr_dev_driver ols_driver_info;
 103 #endif
 104 #ifdef HAVE_HW_RIGOL_DS1XX2
 105 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
 106 #endif
 107 #ifdef HAVE_HW_TONDAJ_SL_814
 108 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
 109 #endif
 110 #ifdef HAVE_HW_VICTOR_DMM
 111 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
 112 #endif
 113 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
 114 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
 115 #endif
 116 #ifdef HAVE_LA_ASIX_SIGMA
 117 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
 118 #endif
 119 #ifdef HAVE_LA_CHRONOVU_LA8
 120 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
 121 #endif
 122 #ifdef HAVE_LA_LINK_MSO19
 123 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
 124 #endif
 125 #ifdef HAVE_HW_ALSA
 126 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
 127 #endif
 128 #ifdef HAVE_LA_FX2LAFW
 129 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 130 #endif
 131 #ifdef HAVE_HW_HANTEK_DSO
 132 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
 133 #endif
 134 #ifdef HAVE_HW_AGILENT_DMM
 135 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
 136 #endif
 137 #ifdef HAVE_HW_FLUKE_DMM
 138 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
 139 #endif
 140 #ifdef HAVE_HW_SERIAL_DMM
 141 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
 142 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
 143 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
 144 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
 145 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
 146 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
 147 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
 148 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
 149 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
 150 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
 151 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
 152 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
 153 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
 154 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
 155 #endif
 156 #ifdef HAVE_HW_UNI_T_DMM
 157 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
 158 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
 159 #endif
 160 /** @endcond */
 161
 162 static struct sr_dev_driver *drivers_list[] = {
 163 #ifdef HAVE_HW_COLEAD_SLM
 164         &colead_slm_driver_info,
 165 #endif
 166 #ifdef HAVE_LA_DEMO
 167         &demo_driver_info,
 168 #endif
 169 #ifdef HAVE_HW_LASCAR_EL_USB
 170         &lascar_el_usb_driver_info,
 171 #endif
 172 #ifdef HAVE_HW_MIC_985XX
 173         &mic_98583_driver_info,
 174 #endif
 175 #ifdef HAVE_HW_NEXUS_OSCIPRIME
 176         &nexus_osciprime_driver_info,
 177 #endif
 178 #ifdef HAVE_LA_OLS
 179         &ols_driver_info,
 180 #endif
 181 #ifdef HAVE_HW_RIGOL_DS1XX2
 182         &rigol_ds1xx2_driver_info,
 183 #endif
 184 #ifdef HAVE_HW_TONDAJ_SL_814
 185         &tondaj_sl_814_driver_info,
 186 #endif
 187 #ifdef HAVE_HW_VICTOR_DMM
 188         &victor_dmm_driver_info,
 189 #endif
 190 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
 191         &zeroplus_logic_cube_driver_info,
 192 #endif
 193 #ifdef HAVE_LA_ASIX_SIGMA
 194         &asix_sigma_driver_info,
 195 #endif
 196 #ifdef HAVE_LA_CHRONOVU_LA8
 197         &chronovu_la8_driver_info,
 198 #endif
 199 #ifdef HAVE_LA_LINK_MSO19
 200         &link_mso19_driver_info,
 201 #endif
 202 #ifdef HAVE_HW_ALSA
 203         &alsa_driver_info,
 204 #endif
 205 #ifdef HAVE_LA_FX2LAFW
 206         &fx2lafw_driver_info,
 207 #endif
 208 #ifdef HAVE_HW_HANTEK_DSO
 209         &hantek_dso_driver_info,
 210 #endif
 211 #ifdef HAVE_HW_AGILENT_DMM
 212         &agdmm_driver_info,
 213 #endif
 214 #ifdef HAVE_HW_FLUKE_DMM
 215         &flukedmm_driver_info,
 216 #endif
 217 #ifdef HAVE_HW_SERIAL_DMM
 218         &digitek_dt4000zc_driver_info,
 219         &tekpower_tp4000zc_driver_info,
 220         &metex_me31_driver_info,
 221         &peaktech_3410_driver_info,
 222         &mastech_mas345_driver_info,
 223         &va_va18b_driver_info,
 224         &metex_m3640d_driver_info,
 225         &peaktech_4370_driver_info,
 226         &pce_pce_dm32_driver_info,
 227         &radioshack_22_168_driver_info,
 228         &radioshack_22_812_driver_info,
 229         &voltcraft_vc820_ser_driver_info,
 230         &voltcraft_vc840_ser_driver_info,
 231         &uni_t_ut61e_ser_driver_info,
 232 #endif
 233 #ifdef HAVE_HW_UNI_T_DMM
 234         &uni_t_ut61d_driver_info,
 235         &voltcraft_vc820_driver_info,
 236 #endif
 237         NULL,
 238 };
 239
 240 /**
 241  * Return the list of supported hardware drivers.
 242  *
 243  * @return Pointer to the NULL-terminated list of hardware driver pointers.
 244  */
 245 SR_API struct sr_dev_driver **sr_driver_list(void)
 246 {
 247
 248         return drivers_list;
 249 }
 250
 251 /**
 252  * Initialize a hardware driver.
 253  *
 254  * This usually involves memory allocations and variable initializations
 255  * within the driver, but _not_ scanning for attached devices.
 256  * The API call sr_driver_scan() is used for that.
 257  *
 258  * @param ctx A libsigrok context object allocated by a previous call to
 259  *            sr_init(). Must not be NULL.
 260  * @param driver The driver to initialize. This must be a pointer to one of
 261  *               the entries returned by sr_driver_list(). Must not be NULL.
 262  *
 263  * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
 264  *         SR_ERR_BUG upon internal errors, or another negative error code
 265  *         upon other errors.
 266  */
 267 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 268 {
 269         int ret;
 270
 271         if (!ctx) {
 272                 sr_err("Invalid libsigrok context, can't initialize.");
 273                 return SR_ERR_ARG;
 274         }
 275
 276         if (!driver) {
 277                 sr_err("Invalid driver, can't initialize.");
 278                 return SR_ERR_ARG;
 279         }
 280
 281         sr_spew("Initializing driver '%s'.", driver->name);
 282         if ((ret = driver->init(ctx)) < 0)
 283                 sr_err("Failed to initialize the driver: %d.", ret);
 284
 285         return ret;
 286 }
 287
 288 /**
 289  * Tell a hardware driver to scan for devices.
 290  *
 291  * In addition to the detection, the devices that are found are also
 292  * initialized automatically. On some devices, this involves a firmware upload,
 293  * or other such measures.
 294  *
 295  * The order in which the system is scanned for devices is not specified. The
 296  * caller should not assume or rely on any specific order.
 297  *
 298  * Before calling sr_driver_scan(), the user must have previously initialized
 299  * the driver by calling sr_driver_init().
 300  *
 301  * @param driver The driver that should scan. This must be a pointer to one of
 302  *               the entries returned by sr_driver_list(). Must not be NULL.
 303  * @param options A list of 'struct sr_hwopt' options to pass to the driver's
 304  *                scanner. Can be NULL/empty.
 305  *
 306  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
 307  *         found (or errors were encountered). This list must be freed by the
 308  *         caller using g_slist_free(), but without freeing the data pointed
 309  *         to in the list.
 310  */
 311 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 312 {
 313         GSList *l;
 314
 315         if (!driver) {
 316                 sr_err("Invalid driver, can't scan for devices.");
 317                 return NULL;
 318         }
 319
 320         if (!driver->priv) {
 321                 sr_err("Driver not initialized, can't scan for devices.");
 322                 return NULL;
 323         }
 324
 325         l = driver->scan(options);
 326
 327         sr_spew("Scan of '%s' found %d devices.", driver->name,
 328                 g_slist_length(l));
 329
 330         return l;
 331 }
 332
 333 /** @private */
 334 SR_PRIV void sr_hw_cleanup_all(void)
 335 {
 336         int i;
 337         struct sr_dev_driver **drivers;
 338
 339         drivers = sr_driver_list();
 340         for (i = 0; drivers[i]; i++) {
 341                 if (drivers[i]->cleanup)
 342                         drivers[i]->cleanup();
 343         }
 344 }
 345
 346 SR_PRIV struct sr_config *sr_config_make(int key, const void *value)
 347 {
 348         struct sr_config *src;
 349
 350         if (!(src = g_try_malloc(sizeof(struct sr_config))))
 351                 return NULL;
 352         src->key = key;
 353         src->value = value;
 354
 355         return src;
 356 }
 357
 358 /**
 359  * Returns information about the given driver or device instance.
 360  *
 361  * @param driver The sr_dev_driver struct to query.
 362  * @param key The configuration key (SR_CONF_*).
 363  * @param data Pointer where the value will be stored. Must not be NULL.
 364  * @param sdi If the key is specific to a device, this must contain a
 365  *            pointer to the struct sr_dev_inst to be checked.
 366  *
 367  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 368  *         may be returned by the driver indicating it doesn't know that key,
 369  *         but this is not to be flagged as an error by the caller; merely
 370  *         as an indication that it's not applicable.
 371  */
 372 SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
 373                 const void **data, const struct sr_dev_inst *sdi)
 374 {
 375         int ret;
 376
 377         if (!driver || !data)
 378                 return SR_ERR;
 379
 380         if (!driver->config_get)
 381                 return SR_ERR_ARG;
 382
 383         ret = driver->config_get(key, data, sdi);
 384
 385         return ret;
 386 }
 387
 388 /**
 389  * Set a configuration key in a device instance.
 390  *
 391  * @param sdi The device instance.
 392  * @param key The configuration key (SR_CONF_*).
 393  * @param value The new value for the key, as a pointer to whatever type
 394  *        is appropriate for that key.
 395  *
 396  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 397  *         may be returned by the driver indicating it doesn't know that key,
 398  *         but this is not to be flagged as an error by the caller; merely
 399  *         as an indication that it's not applicable.
 400  */
 401 SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key,
 402                 const void *value)
 403 {
 404         int ret;
 405
 406         if (!sdi || !sdi->driver || !value)
 407                 return SR_ERR;
 408
 409         if (!sdi->driver->config_set)
 410                 return SR_ERR_ARG;
 411
 412         ret = sdi->driver->config_set(key, value, sdi);
 413
 414         return ret;
 415 }
 416
 417 /**
 418  * List all possible values for a configuration key.
 419  *
 420  * @param driver The sr_dev_driver struct to query.
 421  * @param key The configuration key (SR_CONF_*).
 422  * @param data A pointer to a list of values, in whatever format is
 423  *             appropriate for that key.
 424  * @param sdi If the key is specific to a device, this must contain a
 425  *            pointer to the struct sr_dev_inst to be checked.
 426  *
 427  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 428  *         may be returned by the driver indicating it doesn't know that key,
 429  *         but this is not to be flagged as an error by the caller; merely
 430  *         as an indication that it's not applicable.
 431  */
 432 SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
 433                 const void **data, const struct sr_dev_inst *sdi)
 434 {
 435         int ret;
 436
 437         if (!driver || !data)
 438                 return SR_ERR;
 439
 440         if (!driver->config_list)
 441                 return SR_ERR_ARG;
 442
 443         ret = driver->config_list(key, data, sdi);
 444
 445         return ret;
 446 }
 447
 448 /**
 449  * Get information about a configuration key.
 450  *
 451  * @param opt The configuration key.
 452  *
 453  * @return A pointer to a struct sr_config_info, or NULL if the key
 454  *         was not found.
 455  */
 456 SR_API const struct sr_config_info *sr_config_info_get(int key)
 457 {
 458         int i;
 459
 460         for (i = 0; sr_config_info_data[i].key; i++) {
 461                 if (sr_config_info_data[i].key == key)
 462                         return &sr_config_info_data[i];
 463         }
 464
 465         return NULL;
 466 }
 467
 468 /**
 469  * Get information about an configuration key, by name.
 470  *
 471  * @param optname The configuration key.
 472  *
 473  * @return A pointer to a struct sr_config_info, or NULL if the key
 474  *         was not found.
 475  */
 476 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
 477 {
 478         int i;
 479
 480         for (i = 0; sr_config_info_data[i].key; i++) {
 481                 if (!strcmp(sr_config_info_data[i].id, optname))
 482                         return &sr_config_info_data[i];
 483         }
 484
 485         return NULL;
 486 }
 487
 488 /* Unnecessary level of indirection follows. */
 489
 490 /** @private */
 491 SR_PRIV int sr_source_remove(int fd)
 492 {
 493         return sr_session_source_remove(fd);
 494 }
 495
 496 /** @private */
 497 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 498                           sr_receive_data_callback_t cb, void *cb_data)
 499 {
 500         return sr_session_source_add(fd, events, timeout, cb, cb_data);
 501 }
 502
 503 /** @} */