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