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 /**
  31  * @file
  32  *
  33  * Hardware driver handling in libsigrok.
  34  */
  35
  36 /**
  37  * @defgroup grp_driver Hardware drivers
  38  *
  39  * Hardware driver handling in libsigrok.
  40  *
  41  * @{
  42  */
  43
  44 /* Driver scanning options. */
  45 static struct sr_hwcap_option sr_drvopts[] = {
  46         {SR_HWOPT_MODEL, SR_T_KEYVALUE, "Model", "model"},
  47         {SR_HWOPT_CONN, SR_T_CHAR, "Connection", "conn"},
  48         {SR_HWOPT_SERIALCOMM, SR_T_CHAR, "Serial communication", "serialcomm"},
  49         {0, 0, NULL, NULL},
  50 };
  51
  52 /* Device instance options. */
  53 static struct sr_hwcap_option sr_devopts[] = {
  54         {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "Sample rate", "samplerate"},
  55         {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "Pre-trigger capture ratio", "captureratio"},
  56         {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "Pattern generator mode", "pattern"},
  57         {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"},
  58         {SR_HWCAP_TRIGGER_SLOPE, SR_T_UINT64, "Trigger slope", "triggerslope"},
  59         {SR_HWCAP_TRIGGER_SOURCE, SR_T_CHAR, "Trigger source", "triggersource"},
  60         {SR_HWCAP_HORIZ_TRIGGERPOS, SR_T_FLOAT, "Horizontal trigger position",
  61                         "horiz_triggerpos"},
  62         {SR_HWCAP_BUFFERSIZE, SR_T_UINT64, "Buffer size", "buffersize"},
  63         {SR_HWCAP_TIMEBASE, SR_T_RATIONAL_PERIOD, "Time base", "timebase"},
  64         {SR_HWCAP_FILTER, SR_T_CHAR, "Filter targets", "filter"},
  65         {SR_HWCAP_VDIV, SR_T_RATIONAL_VOLT, "Volts/div", "vdiv"},
  66         {SR_HWCAP_COUPLING, SR_T_CHAR, "Coupling", "coupling"},
  67         {0, 0, NULL, NULL},
  68 };
  69
  70 /** @cond PRIVATE */
  71 #ifdef HAVE_HW_COLEAD_SLM
  72 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
  73 #endif
  74 #ifdef HAVE_LA_DEMO
  75 extern SR_PRIV struct sr_dev_driver demo_driver_info;
  76 #endif
  77 #ifdef HAVE_HW_LASCAR_EL_USB
  78 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
  79 #endif
  80 #ifdef HAVE_HW_NEXUS_OSCIPRIME
  81 extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
  82 #endif
  83 #ifdef HAVE_LA_OLS
  84 extern SR_PRIV struct sr_dev_driver ols_driver_info;
  85 #endif
  86 #ifdef HAVE_HW_TONDAJ_SL_814
  87 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
  88 #endif
  89 #ifdef HAVE_HW_VICTOR_DMM
  90 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
  91 #endif
  92 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
  93 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
  94 #endif
  95 #ifdef HAVE_LA_ASIX_SIGMA
  96 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
  97 #endif
  98 #ifdef HAVE_LA_CHRONOVU_LA8
  99 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
 100 #endif
 101 #ifdef HAVE_LA_LINK_MSO19
 102 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
 103 #endif
 104 #ifdef HAVE_HW_ALSA
 105 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
 106 #endif
 107 #ifdef HAVE_LA_FX2LAFW
 108 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 109 #endif
 110 #ifdef HAVE_HW_HANTEK_DSO
 111 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
 112 #endif
 113 #ifdef HAVE_HW_AGILENT_DMM
 114 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
 115 #endif
 116 #ifdef HAVE_HW_FLUKE_DMM
 117 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
 118 #endif
 119 #ifdef HAVE_HW_SERIAL_DMM
 120 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
 121 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
 122 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
 123 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
 124 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
 125 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
 126 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
 127 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
 128 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
 129 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
 130 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
 131 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
 132 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
 133 #endif
 134 #ifdef HAVE_HW_UNI_T_DMM
 135 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
 136 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
 137 #endif
 138 /** @endcond */
 139
 140 static struct sr_dev_driver *drivers_list[] = {
 141 #ifdef HAVE_HW_COLEAD_SLM
 142         &colead_slm_driver_info,
 143 #endif
 144 #ifdef HAVE_LA_DEMO
 145         &demo_driver_info,
 146 #endif
 147 #ifdef HAVE_HW_LASCAR_EL_USB
 148         &lascar_el_usb_driver_info,
 149 #endif
 150 #ifdef HAVE_HW_NEXUS_OSCIPRIME
 151         &nexus_osciprime_driver_info,
 152 #endif
 153 #ifdef HAVE_LA_OLS
 154         &ols_driver_info,
 155 #endif
 156 #ifdef HAVE_HW_TONDAJ_SL_814
 157         &tondaj_sl_814_driver_info,
 158 #endif
 159 #ifdef HAVE_HW_VICTOR_DMM
 160         &victor_dmm_driver_info,
 161 #endif
 162 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
 163         &zeroplus_logic_cube_driver_info,
 164 #endif
 165 #ifdef HAVE_LA_ASIX_SIGMA
 166         &asix_sigma_driver_info,
 167 #endif
 168 #ifdef HAVE_LA_CHRONOVU_LA8
 169         &chronovu_la8_driver_info,
 170 #endif
 171 #ifdef HAVE_LA_LINK_MSO19
 172         &link_mso19_driver_info,
 173 #endif
 174 #ifdef HAVE_HW_ALSA
 175         &alsa_driver_info,
 176 #endif
 177 #ifdef HAVE_LA_FX2LAFW
 178         &fx2lafw_driver_info,
 179 #endif
 180 #ifdef HAVE_HW_HANTEK_DSO
 181         &hantek_dso_driver_info,
 182 #endif
 183 #ifdef HAVE_HW_AGILENT_DMM
 184         &agdmm_driver_info,
 185 #endif
 186 #ifdef HAVE_HW_FLUKE_DMM
 187         &flukedmm_driver_info,
 188 #endif
 189 #ifdef HAVE_HW_SERIAL_DMM
 190         &digitek_dt4000zc_driver_info,
 191         &tekpower_tp4000zc_driver_info,
 192         &metex_me31_driver_info,
 193         &peaktech_3410_driver_info,
 194         &mastech_mas345_driver_info,
 195         &va_va18b_driver_info,
 196         &metex_m3640d_driver_info,
 197         &peaktech_4370_driver_info,
 198         &pce_pce_dm32_driver_info,
 199         &radioshack_22_168_driver_info,
 200         &radioshack_22_812_driver_info,
 201         &voltcraft_vc820_ser_driver_info,
 202         &voltcraft_vc840_ser_driver_info,
 203 #endif
 204 #ifdef HAVE_HW_UNI_T_DMM
 205         &uni_t_ut61d_driver_info,
 206         &voltcraft_vc820_driver_info,
 207 #endif
 208         NULL,
 209 };
 210
 211 /**
 212  * Return the list of supported hardware drivers.
 213  *
 214  * @return Pointer to the NULL-terminated list of hardware driver pointers.
 215  */
 216 SR_API struct sr_dev_driver **sr_driver_list(void)
 217 {
 218
 219         return drivers_list;
 220 }
 221
 222 /**
 223  * Initialize a hardware driver.
 224  *
 225  * @param ctx A libsigrok context object allocated by a previous call to
 226  *              sr_init().
 227  * @param driver The driver to initialize.
 228  *
 229  * @return SR_OK if all went well, or an error code otherwise.
 230  */
 231 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 232 {
 233
 234         if (driver->init)
 235                 return driver->init(ctx);
 236
 237         return SR_OK;
 238 }
 239
 240 /**
 241  * Tell a hardware driver to scan for devices.
 242  *
 243  * In addition to the detection, the devices that are found are also
 244  * initialized automatically. On some devices, this involves a firmware upload,
 245  * or other such measures.
 246  *
 247  * The order in which the system is scanned for devices is not specified. The
 248  * caller should not assume or rely on any specific order.
 249  *
 250  * @param driver The driver.
 251  * @param options A list of struct sr_hwopt options to pass to the driver's
 252  *              scanner.
 253  *
 254  * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found.
 255  * This list must be freed by the caller, but without freeing the data
 256  * pointed to in the list.
 257  */
 258 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 259 {
 260
 261         if (driver->scan)
 262                 return driver->scan(options);
 263
 264         return NULL;
 265 }
 266
 267 /** @private */
 268 SR_PRIV void sr_hw_cleanup_all(void)
 269 {
 270         int i;
 271         struct sr_dev_driver **drivers;
 272
 273         drivers = sr_driver_list();
 274         for (i = 0; drivers[i]; i++) {
 275                 if (drivers[i]->cleanup)
 276                         drivers[i]->cleanup();
 277         }
 278 }
 279
 280 /**
 281  * Returns information about the given driver or device instance.
 282  *
 283  * @param driver The sr_dev_driver struct to query.
 284  * @param id The type of information, in the form of an SR_HWCAP_* option.
 285  * @param data Pointer where the value. will be stored. Must not be NULL.
 286  * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL.
 287  *
 288  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 289  *         may be returned by the driver indicating it doesn't know that id,
 290  *         but this is not to be flagged as an error by the caller; merely
 291  *         as an indication that it's not applicable.
 292  */
 293 SR_API int sr_info_get(struct sr_dev_driver *driver, int id,
 294                 const void **data, const struct sr_dev_inst *sdi)
 295 {
 296         int ret;
 297
 298         if (driver == NULL || data == NULL)
 299                 return SR_ERR;
 300
 301         ret = driver->info_get(id, data, sdi);
 302
 303         return ret;
 304 }
 305
 306 /**
 307  * Find out if a hardware driver has a specific capability.
 308  *
 309  * @param driver The hardware driver in which to search for the capability.
 310  * @param hwcap The capability to find in the list.
 311  *
 312  * @return TRUE if the specified capability exists in the specified driver,
 313  *         FALSE otherwise. Also, if 'driver' is NULL or the respective driver
 314  *         returns an invalid capability list, FALSE is returned.
 315  */
 316 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
 317 {
 318         const int *hwcaps;
 319         int i;
 320
 321         if (!driver) {
 322                 sr_err("hwdriver: %s: driver was NULL", __func__);
 323                 return FALSE;
 324         }
 325
 326         if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK)
 327                 return FALSE;
 328
 329         for (i = 0; hwcaps[i]; i++) {
 330                 if (hwcaps[i] == hwcap)
 331                         return TRUE;
 332         }
 333
 334         return FALSE;
 335 }
 336
 337 /**
 338  * Get information about a hardware driver option.
 339  *
 340  * @param opt The option to get.
 341  *
 342  * @return A pointer to a struct sr_hwcap_option, or NULL if the option
 343  *         was not found.
 344  */
 345 SR_API const struct sr_hwcap_option *sr_drvopt_get(int opt)
 346 {
 347         int i;
 348
 349         for (i = 0; sr_drvopts[i].hwcap; i++) {
 350                 if (sr_drvopts[i].hwcap == opt)
 351                         return &sr_drvopts[i];
 352         }
 353
 354         return NULL;
 355 }
 356
 357 /**
 358  * Get information about a hardware driver option, by name.
 359  *
 360  * @param optname The name of the option to get.
 361  *
 362  * @return A pointer to a struct sr_hwcap_option, or NULL if the option
 363  *         was not found.
 364  */
 365 SR_API const struct sr_hwcap_option *sr_drvopt_name_get(const char *optname)
 366 {
 367         int i;
 368
 369         for (i = 0; sr_drvopts[i].hwcap; i++) {
 370                 if (!strcmp(sr_drvopts[i].shortname, optname))
 371                         return &sr_drvopts[i];
 372         }
 373
 374         return NULL;
 375 }
 376
 377 /**
 378  * Get information about a device option.
 379  *
 380  * @param opt The option to get.
 381  *
 382  * @return A pointer to a struct sr_hwcap_option, or NULL if the option
 383  *         was not found.
 384  */
 385 SR_API const struct sr_hwcap_option *sr_devopt_get(int opt)
 386 {
 387         int i;
 388
 389         for (i = 0; sr_devopts[i].hwcap; i++) {
 390                 if (sr_devopts[i].hwcap == opt)
 391                         return &sr_devopts[i];
 392         }
 393
 394         return NULL;
 395 }
 396
 397 /**
 398  * Get information about a device option, by name.
 399  *
 400  * @param optname The name of the option to get.
 401  *
 402  * @return A pointer to a struct sr_hwcap_option, or NULL if the option
 403  *         was not found.
 404  */
 405 SR_API const struct sr_hwcap_option *sr_devopt_name_get(const char *optname)
 406 {
 407         int i;
 408
 409         for (i = 0; sr_devopts[i].hwcap; i++) {
 410                 if (!strcmp(sr_devopts[i].shortname, optname))
 411                         return &sr_devopts[i];
 412         }
 413
 414         return NULL;
 415 }
 416
 417 /* Unnecessary level of indirection follows. */
 418
 419 /** @private */
 420 SR_PRIV int sr_source_remove(int fd)
 421 {
 422         return sr_session_source_remove(fd);
 423 }
 424
 425 /** @private */
 426 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 427                           sr_receive_data_callback_t cb, void *cb_data)
 428 {
 429         return sr_session_source_add(fd, events, timeout, cb, cb_data);
 430 }
 431
 432 /** @} */