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