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