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