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