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