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