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