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