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 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
 134 #endif
 135 #ifdef HAVE_HW_UNI_T_DMM
 136 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
 137 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
 138 #endif
 139 /** @endcond */
 140
 141 static struct sr_dev_driver *drivers_list[] = {
 142 #ifdef HAVE_HW_COLEAD_SLM
 143         &colead_slm_driver_info,
 144 #endif
 145 #ifdef HAVE_LA_DEMO
 146         &demo_driver_info,
 147 #endif
 148 #ifdef HAVE_HW_LASCAR_EL_USB
 149         &lascar_el_usb_driver_info,
 150 #endif
 151 #ifdef HAVE_HW_NEXUS_OSCIPRIME
 152         &nexus_osciprime_driver_info,
 153 #endif
 154 #ifdef HAVE_LA_OLS
 155         &ols_driver_info,
 156 #endif
 157 #ifdef HAVE_HW_TONDAJ_SL_814
 158         &tondaj_sl_814_driver_info,
 159 #endif
 160 #ifdef HAVE_HW_VICTOR_DMM
 161         &victor_dmm_driver_info,
 162 #endif
 163 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
 164         &zeroplus_logic_cube_driver_info,
 165 #endif
 166 #ifdef HAVE_LA_ASIX_SIGMA
 167         &asix_sigma_driver_info,
 168 #endif
 169 #ifdef HAVE_LA_CHRONOVU_LA8
 170         &chronovu_la8_driver_info,
 171 #endif
 172 #ifdef HAVE_LA_LINK_MSO19
 173         &link_mso19_driver_info,
 174 #endif
 175 #ifdef HAVE_HW_ALSA
 176         &alsa_driver_info,
 177 #endif
 178 #ifdef HAVE_LA_FX2LAFW
 179         &fx2lafw_driver_info,
 180 #endif
 181 #ifdef HAVE_HW_HANTEK_DSO
 182         &hantek_dso_driver_info,
 183 #endif
 184 #ifdef HAVE_HW_AGILENT_DMM
 185         &agdmm_driver_info,
 186 #endif
 187 #ifdef HAVE_HW_FLUKE_DMM
 188         &flukedmm_driver_info,
 189 #endif
 190 #ifdef HAVE_HW_SERIAL_DMM
 191         &digitek_dt4000zc_driver_info,
 192         &tekpower_tp4000zc_driver_info,
 193         &metex_me31_driver_info,
 194         &peaktech_3410_driver_info,
 195         &mastech_mas345_driver_info,
 196         &va_va18b_driver_info,
 197         &metex_m3640d_driver_info,
 198         &peaktech_4370_driver_info,
 199         &pce_pce_dm32_driver_info,
 200         &radioshack_22_168_driver_info,
 201         &radioshack_22_812_driver_info,
 202         &voltcraft_vc820_ser_driver_info,
 203         &voltcraft_vc840_ser_driver_info,
 204         &uni_t_ut61e_ser_driver_info,
 205 #endif
 206 #ifdef HAVE_HW_UNI_T_DMM
 207         &uni_t_ut61d_driver_info,
 208         &voltcraft_vc820_driver_info,
 209 #endif
 210         NULL,
 211 };
 212
 213 /**
 214  * Return the list of supported hardware drivers.
 215  *
 216  * @return Pointer to the NULL-terminated list of hardware driver pointers.
 217  */
 218 SR_API struct sr_dev_driver **sr_driver_list(void)
 219 {
 220
 221         return drivers_list;
 222 }
 223
 224 /**
 225  * Initialize a hardware driver.
 226  *
 227  * @param ctx A libsigrok context object allocated by a previous call to
 228  *              sr_init().
 229  * @param driver The driver to initialize.
 230  *
 231  * @return SR_OK if all went well, or an error code otherwise.
 232  */
 233 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 234 {
 235
 236         if (driver->init)
 237                 return driver->init(ctx);
 238
 239         return SR_OK;
 240 }
 241
 242 /**
 243  * Tell a hardware driver to scan for devices.
 244  *
 245  * In addition to the detection, the devices that are found are also
 246  * initialized automatically. On some devices, this involves a firmware upload,
 247  * or other such measures.
 248  *
 249  * The order in which the system is scanned for devices is not specified. The
 250  * caller should not assume or rely on any specific order.
 251  *
 252  * @param driver The driver.
 253  * @param options A list of struct sr_hwopt options to pass to the driver's
 254  *              scanner.
 255  *
 256  * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found.
 257  * This list must be freed by the caller, but without freeing the data
 258  * pointed to in the list.
 259  */
 260 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 261 {
 262
 263         if (driver->scan)
 264                 return driver->scan(options);
 265
 266         return NULL;
 267 }
 268
 269 /** @private */
 270 SR_PRIV void sr_hw_cleanup_all(void)
 271 {
 272         int i;
 273         struct sr_dev_driver **drivers;
 274
 275         drivers = sr_driver_list();
 276         for (i = 0; drivers[i]; i++) {
 277                 if (drivers[i]->cleanup)
 278                         drivers[i]->cleanup();
 279         }
 280 }
 281
 282 /**
 283  * Returns information about the given driver or device instance.
 284  *
 285  * @param driver The sr_dev_driver struct to query.
 286  * @param id The type of information, in the form of an SR_HWCAP_* option.
 287  * @param data Pointer where the value. will be stored. Must not be NULL.
 288  * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL.
 289  *
 290  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 291  *         may be returned by the driver indicating it doesn't know that id,
 292  *         but this is not to be flagged as an error by the caller; merely
 293  *         as an indication that it's not applicable.
 294  */
 295 SR_API int sr_info_get(struct sr_dev_driver *driver, int id,
 296                 const void **data, const struct sr_dev_inst *sdi)
 297 {
 298         int ret;
 299
 300         if (driver == NULL || data == NULL)
 301                 return SR_ERR;
 302
 303         ret = driver->info_get(id, data, sdi);
 304
 305         return ret;
 306 }
 307
 308 /**
 309  * Find out if a hardware driver has a specific capability.
 310  *
 311  * @param driver The hardware driver in which to search for the capability.
 312  * @param hwcap The capability to find in the list.
 313  *
 314  * @return TRUE if the specified capability exists in the specified driver,
 315  *         FALSE otherwise. Also, if 'driver' is NULL or the respective driver
 316  *         returns an invalid capability list, FALSE is returned.
 317  */
 318 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
 319 {
 320         const int *hwcaps;
 321         int i;
 322
 323         if (!driver) {
 324                 sr_err("hwdriver: %s: driver was NULL", __func__);
 325                 return FALSE;
 326         }
 327
 328         if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK)
 329                 return FALSE;
 330
 331         for (i = 0; hwcaps[i]; i++) {
 332                 if (hwcaps[i] == hwcap)
 333                         return TRUE;
 334         }
 335
 336         return FALSE;
 337 }
 338
 339 /**
 340  * Get information about a hardware driver option.
 341  *
 342  * @param opt The option to get.
 343  *
 344  * @return A pointer to a struct sr_hwcap_option, or NULL if the option
 345  *         was not found.
 346  */
 347 SR_API const struct sr_hwcap_option *sr_drvopt_get(int opt)
 348 {
 349         int i;
 350
 351         for (i = 0; sr_drvopts[i].hwcap; i++) {
 352                 if (sr_drvopts[i].hwcap == opt)
 353                         return &sr_drvopts[i];
 354         }
 355
 356         return NULL;
 357 }
 358
 359 /**
 360  * Get information about a hardware driver option, by name.
 361  *
 362  * @param optname The name of the option to get.
 363  *
 364  * @return A pointer to a struct sr_hwcap_option, or NULL if the option
 365  *         was not found.
 366  */
 367 SR_API const struct sr_hwcap_option *sr_drvopt_name_get(const char *optname)
 368 {
 369         int i;
 370
 371         for (i = 0; sr_drvopts[i].hwcap; i++) {
 372                 if (!strcmp(sr_drvopts[i].shortname, optname))
 373                         return &sr_drvopts[i];
 374         }
 375
 376         return NULL;
 377 }
 378
 379 /**
 380  * Get information about a device option.
 381  *
 382  * @param opt The option to get.
 383  *
 384  * @return A pointer to a struct sr_hwcap_option, or NULL if the option
 385  *         was not found.
 386  */
 387 SR_API const struct sr_hwcap_option *sr_devopt_get(int opt)
 388 {
 389         int i;
 390
 391         for (i = 0; sr_devopts[i].hwcap; i++) {
 392                 if (sr_devopts[i].hwcap == opt)
 393                         return &sr_devopts[i];
 394         }
 395
 396         return NULL;
 397 }
 398
 399 /**
 400  * Get information about a device option, by name.
 401  *
 402  * @param optname The name of the option to get.
 403  *
 404  * @return A pointer to a struct sr_hwcap_option, or NULL if the option
 405  *         was not found.
 406  */
 407 SR_API const struct sr_hwcap_option *sr_devopt_name_get(const char *optname)
 408 {
 409         int i;
 410
 411         for (i = 0; sr_devopts[i].hwcap; i++) {
 412                 if (!strcmp(sr_devopts[i].shortname, optname))
 413                         return &sr_devopts[i];
 414         }
 415
 416         return NULL;
 417 }
 418
 419 /* Unnecessary level of indirection follows. */
 420
 421 /** @private */
 422 SR_PRIV int sr_source_remove(int fd)
 423 {
 424         return sr_session_source_remove(fd);
 425 }
 426
 427 /** @private */
 428 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 429                           sr_receive_data_callback_t cb, void *cb_data)
 430 {
 431         return sr_session_source_add(fd, events, timeout, cb, cb_data);
 432 }
 433
 434 /** @} */