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_config_info sr_drvopts[] = {
  46         {SR_HWOPT_CONN, SR_T_CHAR, "conn",
  47                 "Connection", NULL},
  48         {SR_HWOPT_SERIALCOMM, SR_T_CHAR, "serialcomm",
  49                 "Serial communication", NULL},
  50         {0, 0, NULL, NULL, NULL},
  51 };
  52
  53 /* Device instance options. */
  54 static struct sr_config_info sr_devopts[] = {
  55         {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "samplerate",
  56                 "Sample rate", NULL},
  57         {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
  58                 "Pre-trigger capture ratio", NULL},
  59         {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "pattern",
  60                 "Pattern generator mode", NULL},
  61         {SR_HWCAP_RLE, SR_T_BOOL, "rle",
  62                 "Run Length Encoding", NULL},
  63         {SR_HWCAP_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
  64                 "Trigger slope", NULL},
  65         {SR_HWCAP_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
  66                 "Trigger source", NULL},
  67         {SR_HWCAP_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
  68                 "Horizontal trigger position", NULL},
  69         {SR_HWCAP_BUFFERSIZE, SR_T_UINT64, "buffersize",
  70                 "Buffer size", NULL},
  71         {SR_HWCAP_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
  72                 "Time base", NULL},
  73         {SR_HWCAP_FILTER, SR_T_CHAR, "filter",
  74                 "Filter targets", NULL},
  75         {SR_HWCAP_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
  76                 "Volts/div", NULL},
  77         {SR_HWCAP_COUPLING, SR_T_CHAR, "coupling",
  78                 "Coupling", NULL},
  79         {0, 0, NULL, NULL, NULL},
  80 };
  81
  82 /** @cond PRIVATE */
  83 #ifdef HAVE_HW_COLEAD_SLM
  84 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
  85 #endif
  86 #ifdef HAVE_LA_DEMO
  87 extern SR_PRIV struct sr_dev_driver demo_driver_info;
  88 #endif
  89 #ifdef HAVE_HW_LASCAR_EL_USB
  90 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
  91 #endif
  92 #ifdef HAVE_HW_NEXUS_OSCIPRIME
  93 extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
  94 #endif
  95 #ifdef HAVE_LA_OLS
  96 extern SR_PRIV struct sr_dev_driver ols_driver_info;
  97 #endif
  98 #ifdef HAVE_HW_RIGOL_DS1XX2
  99 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
 100 #endif
 101 #ifdef HAVE_HW_TONDAJ_SL_814
 102 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
 103 #endif
 104 #ifdef HAVE_HW_VICTOR_DMM
 105 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
 106 #endif
 107 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
 108 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
 109 #endif
 110 #ifdef HAVE_LA_ASIX_SIGMA
 111 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
 112 #endif
 113 #ifdef HAVE_LA_CHRONOVU_LA8
 114 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
 115 #endif
 116 #ifdef HAVE_LA_LINK_MSO19
 117 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
 118 #endif
 119 #ifdef HAVE_HW_ALSA
 120 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
 121 #endif
 122 #ifdef HAVE_LA_FX2LAFW
 123 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 124 #endif
 125 #ifdef HAVE_HW_HANTEK_DSO
 126 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
 127 #endif
 128 #ifdef HAVE_HW_AGILENT_DMM
 129 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
 130 #endif
 131 #ifdef HAVE_HW_FLUKE_DMM
 132 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
 133 #endif
 134 #ifdef HAVE_HW_SERIAL_DMM
 135 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
 136 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
 137 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
 138 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
 139 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
 140 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
 141 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
 142 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
 143 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
 144 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
 145 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
 146 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
 147 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
 148 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
 149 #endif
 150 #ifdef HAVE_HW_UNI_T_DMM
 151 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
 152 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
 153 #endif
 154 /** @endcond */
 155
 156 static struct sr_dev_driver *drivers_list[] = {
 157 #ifdef HAVE_HW_COLEAD_SLM
 158         &colead_slm_driver_info,
 159 #endif
 160 #ifdef HAVE_LA_DEMO
 161         &demo_driver_info,
 162 #endif
 163 #ifdef HAVE_HW_LASCAR_EL_USB
 164         &lascar_el_usb_driver_info,
 165 #endif
 166 #ifdef HAVE_HW_NEXUS_OSCIPRIME
 167         &nexus_osciprime_driver_info,
 168 #endif
 169 #ifdef HAVE_LA_OLS
 170         &ols_driver_info,
 171 #endif
 172 #ifdef HAVE_HW_RIGOL_DS1XX2
 173         &rigol_ds1xx2_driver_info,
 174 #endif
 175 #ifdef HAVE_HW_TONDAJ_SL_814
 176         &tondaj_sl_814_driver_info,
 177 #endif
 178 #ifdef HAVE_HW_VICTOR_DMM
 179         &victor_dmm_driver_info,
 180 #endif
 181 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
 182         &zeroplus_logic_cube_driver_info,
 183 #endif
 184 #ifdef HAVE_LA_ASIX_SIGMA
 185         &asix_sigma_driver_info,
 186 #endif
 187 #ifdef HAVE_LA_CHRONOVU_LA8
 188         &chronovu_la8_driver_info,
 189 #endif
 190 #ifdef HAVE_LA_LINK_MSO19
 191         &link_mso19_driver_info,
 192 #endif
 193 #ifdef HAVE_HW_ALSA
 194         &alsa_driver_info,
 195 #endif
 196 #ifdef HAVE_LA_FX2LAFW
 197         &fx2lafw_driver_info,
 198 #endif
 199 #ifdef HAVE_HW_HANTEK_DSO
 200         &hantek_dso_driver_info,
 201 #endif
 202 #ifdef HAVE_HW_AGILENT_DMM
 203         &agdmm_driver_info,
 204 #endif
 205 #ifdef HAVE_HW_FLUKE_DMM
 206         &flukedmm_driver_info,
 207 #endif
 208 #ifdef HAVE_HW_SERIAL_DMM
 209         &digitek_dt4000zc_driver_info,
 210         &tekpower_tp4000zc_driver_info,
 211         &metex_me31_driver_info,
 212         &peaktech_3410_driver_info,
 213         &mastech_mas345_driver_info,
 214         &va_va18b_driver_info,
 215         &metex_m3640d_driver_info,
 216         &peaktech_4370_driver_info,
 217         &pce_pce_dm32_driver_info,
 218         &radioshack_22_168_driver_info,
 219         &radioshack_22_812_driver_info,
 220         &voltcraft_vc820_ser_driver_info,
 221         &voltcraft_vc840_ser_driver_info,
 222         &uni_t_ut61e_ser_driver_info,
 223 #endif
 224 #ifdef HAVE_HW_UNI_T_DMM
 225         &uni_t_ut61d_driver_info,
 226         &voltcraft_vc820_driver_info,
 227 #endif
 228         NULL,
 229 };
 230
 231 /**
 232  * Return the list of supported hardware drivers.
 233  *
 234  * @return Pointer to the NULL-terminated list of hardware driver pointers.
 235  */
 236 SR_API struct sr_dev_driver **sr_driver_list(void)
 237 {
 238
 239         return drivers_list;
 240 }
 241
 242 /**
 243  * Initialize a hardware driver.
 244  *
 245  * @param ctx A libsigrok context object allocated by a previous call to
 246  *              sr_init().
 247  * @param driver The driver to initialize.
 248  *
 249  * @return SR_OK if all went well, or an error code otherwise.
 250  */
 251 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 252 {
 253
 254         if (driver->init)
 255                 return driver->init(ctx);
 256
 257         return SR_OK;
 258 }
 259
 260 /**
 261  * Tell a hardware driver to scan for devices.
 262  *
 263  * In addition to the detection, the devices that are found are also
 264  * initialized automatically. On some devices, this involves a firmware upload,
 265  * or other such measures.
 266  *
 267  * The order in which the system is scanned for devices is not specified. The
 268  * caller should not assume or rely on any specific order.
 269  *
 270  * @param driver The driver.
 271  * @param options A list of struct sr_hwopt options to pass to the driver's
 272  *              scanner.
 273  *
 274  * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found.
 275  * This list must be freed by the caller, but without freeing the data
 276  * pointed to in the list.
 277  */
 278 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 279 {
 280
 281         if (driver->scan)
 282                 return driver->scan(options);
 283
 284         return NULL;
 285 }
 286
 287 /** @private */
 288 SR_PRIV void sr_hw_cleanup_all(void)
 289 {
 290         int i;
 291         struct sr_dev_driver **drivers;
 292
 293         drivers = sr_driver_list();
 294         for (i = 0; drivers[i]; i++) {
 295                 if (drivers[i]->cleanup)
 296                         drivers[i]->cleanup();
 297         }
 298 }
 299
 300 SR_PRIV struct sr_config *sr_config_make(int key, const void *value)
 301 {
 302         struct sr_config *src;
 303
 304         if (!(src = g_try_malloc(sizeof(struct sr_config))))
 305                 return NULL;
 306         src->key = key;
 307         src->value = value;
 308
 309         return src;
 310 }
 311
 312 /**
 313  * Returns information about the given driver or device instance.
 314  *
 315  * @param driver The sr_dev_driver struct to query.
 316  * @param id The type of information, in the form of an SR_HWCAP_* option.
 317  * @param data Pointer where the value. will be stored. Must not be NULL.
 318  * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL.
 319  *
 320  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 321  *         may be returned by the driver indicating it doesn't know that id,
 322  *         but this is not to be flagged as an error by the caller; merely
 323  *         as an indication that it's not applicable.
 324  */
 325 SR_API int sr_info_get(struct sr_dev_driver *driver, int id,
 326                 const void **data, const struct sr_dev_inst *sdi)
 327 {
 328         int ret;
 329
 330         if (driver == NULL || data == NULL)
 331                 return SR_ERR;
 332
 333         ret = driver->info_get(id, data, sdi);
 334
 335         return ret;
 336 }
 337
 338 /**
 339  * Find out if a hardware driver has a specific capability.
 340  *
 341  * @param driver The hardware driver in which to search for the capability.
 342  * @param hwcap The capability to find in the list.
 343  *
 344  * @return TRUE if the specified capability exists in the specified driver,
 345  *         FALSE otherwise. Also, if 'driver' is NULL or the respective driver
 346  *         returns an invalid capability list, FALSE is returned.
 347  */
 348 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
 349 {
 350         const int *hwcaps;
 351         int i;
 352
 353         if (!driver) {
 354                 sr_err("hwdriver: %s: driver was NULL", __func__);
 355                 return FALSE;
 356         }
 357
 358         if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK)
 359                 return FALSE;
 360
 361         for (i = 0; hwcaps[i]; i++) {
 362                 if (hwcaps[i] == hwcap)
 363                         return TRUE;
 364         }
 365
 366         return FALSE;
 367 }
 368
 369 /**
 370  * Get information about a hardware driver option.
 371  *
 372  * @param opt 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_config_info *sr_drvopt_get(int opt)
 378 {
 379         int i;
 380
 381         for (i = 0; sr_drvopts[i].key; i++) {
 382                 if (sr_drvopts[i].key == opt)
 383                         return &sr_drvopts[i];
 384         }
 385
 386         return NULL;
 387 }
 388
 389 /**
 390  * Get information about a hardware driver option, by name.
 391  *
 392  * @param optname The name of the option to get.
 393  *
 394  * @return A pointer to a struct sr_hwcap_option, or NULL if the option
 395  *         was not found.
 396  */
 397 SR_API const struct sr_config_info *sr_drvopt_name_get(const char *optname)
 398 {
 399         int i;
 400
 401         for (i = 0; sr_drvopts[i].key; i++) {
 402                 if (!strcmp(sr_drvopts[i].id, optname))
 403                         return &sr_drvopts[i];
 404         }
 405
 406         return NULL;
 407 }
 408
 409 /**
 410  * Get information about a device option.
 411  *
 412  * @param opt The option to get.
 413  *
 414  * @return A pointer to a struct sr_hwcap_option, or NULL if the option
 415  *         was not found.
 416  */
 417 SR_API const struct sr_config_info *sr_devopt_get(int opt)
 418 {
 419         int i;
 420
 421         for (i = 0; sr_devopts[i].key; i++) {
 422                 if (sr_devopts[i].key == opt)
 423                         return &sr_devopts[i];
 424         }
 425
 426         return NULL;
 427 }
 428
 429 /**
 430  * Get information about a device option, by name.
 431  *
 432  * @param optname The name of the option to get.
 433  *
 434  * @return A pointer to a struct sr_hwcap_option, or NULL if the option
 435  *         was not found.
 436  */
 437 SR_API const struct sr_config_info *sr_devopt_name_get(const char *optname)
 438 {
 439         int i;
 440
 441         for (i = 0; sr_devopts[i].key; i++) {
 442                 if (!strcmp(sr_devopts[i].id, optname))
 443                         return &sr_devopts[i];
 444         }
 445
 446         return NULL;
 447 }
 448
 449 /* Unnecessary level of indirection follows. */
 450
 451 /** @private */
 452 SR_PRIV int sr_source_remove(int fd)
 453 {
 454         return sr_session_source_remove(fd);
 455 }
 456
 457 /** @private */
 458 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 459                           sr_receive_data_callback_t cb, void *cb_data)
 460 {
 461         return sr_session_source_add(fd, events, timeout, cb, cb_data);
 462 }
 463
 464 /** @} */