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