hwdriver.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2013 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 /* Message logging helpers with driver-specific prefix string. */
  31 #define DRIVER_LOG_DOMAIN "hwdriver: "
  32 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
  33 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
  34 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
  35 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
  36 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
  37 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
  38
  39 /**
  40  * @file
  41  *
  42  * Hardware driver handling in libsigrok.
  43  */
  44
  45 /**
  46  * @defgroup grp_driver Hardware drivers
  47  *
  48  * Hardware driver handling in libsigrok.
  49  *
  50  * @{
  51  */
  52
  53 static struct sr_config_info sr_config_info_data[] = {
  54         {SR_CONF_CONN, SR_T_CHAR, "conn",
  55                 "Connection", NULL},
  56         {SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm",
  57                 "Serial communication", NULL},
  58         {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
  59                 "Sample rate", NULL},
  60         {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
  61                 "Pre-trigger capture ratio", NULL},
  62         {SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern",
  63                 "Pattern generator mode", NULL},
  64         {SR_CONF_RLE, SR_T_BOOL, "rle",
  65                 "Run Length Encoding", NULL},
  66         {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
  67                 "Trigger slope", NULL},
  68         {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
  69                 "Trigger source", NULL},
  70         {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
  71                 "Horizontal trigger position", NULL},
  72         {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
  73                 "Buffer size", NULL},
  74         {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
  75                 "Time base", NULL},
  76         {SR_CONF_FILTER, SR_T_CHAR, "filter",
  77                 "Filter targets", NULL},
  78         {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
  79                 "Volts/div", NULL},
  80         {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
  81                 "Coupling", NULL},
  82         {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
  83                 "Datalog", NULL},
  84         {0, 0, NULL, NULL, NULL},
  85 };
  86
  87 /** @cond PRIVATE */
  88 #ifdef HAVE_HW_BRYMEN_DMM
  89 extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
  90 #endif
  91 #ifdef HAVE_HW_COLEAD_SLM
  92 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
  93 #endif
  94 #ifdef HAVE_LA_DEMO
  95 extern SR_PRIV struct sr_dev_driver demo_driver_info;
  96 #endif
  97 #ifdef HAVE_HW_LASCAR_EL_USB
  98 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
  99 #endif
 100 #ifdef HAVE_HW_MIC_985XX
 101 extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
 102 extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
 103 #endif
 104 #ifdef HAVE_HW_NEXUS_OSCIPRIME
 105 extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
 106 #endif
 107 #ifdef HAVE_LA_OLS
 108 extern SR_PRIV struct sr_dev_driver ols_driver_info;
 109 #endif
 110 #ifdef HAVE_HW_RIGOL_DS1XX2
 111 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
 112 #endif
 113 #ifdef HAVE_HW_TONDAJ_SL_814
 114 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
 115 #endif
 116 #ifdef HAVE_HW_VICTOR_DMM
 117 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
 118 #endif
 119 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
 120 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
 121 #endif
 122 #ifdef HAVE_LA_ASIX_SIGMA
 123 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
 124 #endif
 125 #ifdef HAVE_LA_CHRONOVU_LA8
 126 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
 127 #endif
 128 #ifdef HAVE_LA_LINK_MSO19
 129 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
 130 #endif
 131 #ifdef HAVE_HW_ALSA
 132 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
 133 #endif
 134 #ifdef HAVE_LA_FX2LAFW
 135 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 136 #endif
 137 #ifdef HAVE_HW_HANTEK_DSO
 138 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
 139 #endif
 140 #ifdef HAVE_HW_AGILENT_DMM
 141 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
 142 #endif
 143 #ifdef HAVE_HW_FLUKE_DMM
 144 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
 145 #endif
 146 #ifdef HAVE_HW_SERIAL_DMM
 147 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
 148 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
 149 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
 150 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
 151 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
 152 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
 153 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
 154 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
 155 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
 156 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
 157 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
 158 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
 159 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
 160 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
 161 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
 162 #endif
 163 #ifdef HAVE_HW_UNI_T_DMM
 164 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
 165 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
 166 #endif
 167 /** @endcond */
 168
 169 static struct sr_dev_driver *drivers_list[] = {
 170 #ifdef HAVE_HW_BRYMEN_DMM
 171         &brymen_bm857_driver_info,
 172 #endif
 173 #ifdef HAVE_HW_COLEAD_SLM
 174         &colead_slm_driver_info,
 175 #endif
 176 #ifdef HAVE_LA_DEMO
 177         &demo_driver_info,
 178 #endif
 179 #ifdef HAVE_HW_LASCAR_EL_USB
 180         &lascar_el_usb_driver_info,
 181 #endif
 182 #ifdef HAVE_HW_MIC_985XX
 183         &mic_98581_driver_info,
 184         &mic_98583_driver_info,
 185 #endif
 186 #ifdef HAVE_HW_NEXUS_OSCIPRIME
 187         &nexus_osciprime_driver_info,
 188 #endif
 189 #ifdef HAVE_LA_OLS
 190         &ols_driver_info,
 191 #endif
 192 #ifdef HAVE_HW_RIGOL_DS1XX2
 193         &rigol_ds1xx2_driver_info,
 194 #endif
 195 #ifdef HAVE_HW_TONDAJ_SL_814
 196         &tondaj_sl_814_driver_info,
 197 #endif
 198 #ifdef HAVE_HW_VICTOR_DMM
 199         &victor_dmm_driver_info,
 200 #endif
 201 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
 202         &zeroplus_logic_cube_driver_info,
 203 #endif
 204 #ifdef HAVE_LA_ASIX_SIGMA
 205         &asix_sigma_driver_info,
 206 #endif
 207 #ifdef HAVE_LA_CHRONOVU_LA8
 208         &chronovu_la8_driver_info,
 209 #endif
 210 #ifdef HAVE_LA_LINK_MSO19
 211         &link_mso19_driver_info,
 212 #endif
 213 #ifdef HAVE_HW_ALSA
 214         &alsa_driver_info,
 215 #endif
 216 #ifdef HAVE_LA_FX2LAFW
 217         &fx2lafw_driver_info,
 218 #endif
 219 #ifdef HAVE_HW_HANTEK_DSO
 220         &hantek_dso_driver_info,
 221 #endif
 222 #ifdef HAVE_HW_AGILENT_DMM
 223         &agdmm_driver_info,
 224 #endif
 225 #ifdef HAVE_HW_FLUKE_DMM
 226         &flukedmm_driver_info,
 227 #endif
 228 #ifdef HAVE_HW_SERIAL_DMM
 229         &digitek_dt4000zc_driver_info,
 230         &tekpower_tp4000zc_driver_info,
 231         &metex_me31_driver_info,
 232         &peaktech_3410_driver_info,
 233         &mastech_mas345_driver_info,
 234         &va_va18b_driver_info,
 235         &metex_m3640d_driver_info,
 236         &peaktech_4370_driver_info,
 237         &pce_pce_dm32_driver_info,
 238         &radioshack_22_168_driver_info,
 239         &radioshack_22_805_driver_info,
 240         &radioshack_22_812_driver_info,
 241         &voltcraft_vc820_ser_driver_info,
 242         &voltcraft_vc840_ser_driver_info,
 243         &uni_t_ut61e_ser_driver_info,
 244 #endif
 245 #ifdef HAVE_HW_UNI_T_DMM
 246         &uni_t_ut61d_driver_info,
 247         &voltcraft_vc820_driver_info,
 248 #endif
 249         NULL,
 250 };
 251
 252 /**
 253  * Return the list of supported hardware drivers.
 254  *
 255  * @return Pointer to the NULL-terminated list of hardware driver pointers.
 256  */
 257 SR_API struct sr_dev_driver **sr_driver_list(void)
 258 {
 259
 260         return drivers_list;
 261 }
 262
 263 /**
 264  * Initialize a hardware driver.
 265  *
 266  * This usually involves memory allocations and variable initializations
 267  * within the driver, but _not_ scanning for attached devices.
 268  * The API call sr_driver_scan() is used for that.
 269  *
 270  * @param ctx A libsigrok context object allocated by a previous call to
 271  *            sr_init(). Must not be NULL.
 272  * @param driver The driver to initialize. This must be a pointer to one of
 273  *               the entries returned by sr_driver_list(). Must not be NULL.
 274  *
 275  * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
 276  *         SR_ERR_BUG upon internal errors, or another negative error code
 277  *         upon other errors.
 278  */
 279 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 280 {
 281         int ret;
 282
 283         if (!ctx) {
 284                 sr_err("Invalid libsigrok context, can't initialize.");
 285                 return SR_ERR_ARG;
 286         }
 287
 288         if (!driver) {
 289                 sr_err("Invalid driver, can't initialize.");
 290                 return SR_ERR_ARG;
 291         }
 292
 293         sr_spew("Initializing driver '%s'.", driver->name);
 294         if ((ret = driver->init(ctx)) < 0)
 295                 sr_err("Failed to initialize the driver: %d.", ret);
 296
 297         return ret;
 298 }
 299
 300 /**
 301  * Tell a hardware driver to scan for devices.
 302  *
 303  * In addition to the detection, the devices that are found are also
 304  * initialized automatically. On some devices, this involves a firmware upload,
 305  * or other such measures.
 306  *
 307  * The order in which the system is scanned for devices is not specified. The
 308  * caller should not assume or rely on any specific order.
 309  *
 310  * Before calling sr_driver_scan(), the user must have previously initialized
 311  * the driver by calling sr_driver_init().
 312  *
 313  * @param driver The driver that should scan. This must be a pointer to one of
 314  *               the entries returned by sr_driver_list(). Must not be NULL.
 315  * @param options A list of 'struct sr_hwopt' options to pass to the driver's
 316  *                scanner. Can be NULL/empty.
 317  *
 318  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
 319  *         found (or errors were encountered). This list must be freed by the
 320  *         caller using g_slist_free(), but without freeing the data pointed
 321  *         to in the list.
 322  */
 323 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 324 {
 325         GSList *l;
 326
 327         if (!driver) {
 328                 sr_err("Invalid driver, can't scan for devices.");
 329                 return NULL;
 330         }
 331
 332         if (!driver->priv) {
 333                 sr_err("Driver not initialized, can't scan for devices.");
 334                 return NULL;
 335         }
 336
 337         l = driver->scan(options);
 338
 339         sr_spew("Scan of '%s' found %d devices.", driver->name,
 340                 g_slist_length(l));
 341
 342         return l;
 343 }
 344
 345 /** @private */
 346 SR_PRIV void sr_hw_cleanup_all(void)
 347 {
 348         int i;
 349         struct sr_dev_driver **drivers;
 350
 351         drivers = sr_driver_list();
 352         for (i = 0; drivers[i]; i++) {
 353                 if (drivers[i]->cleanup)
 354                         drivers[i]->cleanup();
 355         }
 356 }
 357
 358 /** A floating reference can be passed in for data. */
 359 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
 360 {
 361         struct sr_config *src;
 362
 363         if (!(src = g_try_malloc(sizeof(struct sr_config))))
 364                 return NULL;
 365         src->key = key;
 366         src->data = g_variant_ref_sink(data);
 367
 368         return src;
 369 }
 370
 371 /**
 372  * Returns information about the given driver or device instance.
 373  *
 374  * @param driver The sr_dev_driver struct to query.
 375  * @param key The configuration key (SR_CONF_*).
 376  * @param data Pointer to a GVariant where the value will be stored. Must
 377  *             not be NULL. The caller is given ownership of the GVariant
 378  *             and must thus decrease the refcount after use. However if
 379  *             this function returns an error code, the field should be
 380  *             considered unused, and should not be unreferenced.
 381  * @param sdi (optional) If the key is specific to a device, this must
 382  *            contain a pointer to the struct sr_dev_inst to be checked.
 383  *            Otherwise it must be NULL.
 384  *
 385  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 386  *         may be returned by the driver indicating it doesn't know that key,
 387  *         but this is not to be flagged as an error by the caller; merely
 388  *         as an indication that it's not applicable.
 389  */
 390 SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
 391                 GVariant **data, const struct sr_dev_inst *sdi)
 392 {
 393         int ret;
 394
 395         if (!driver || !data)
 396                 return SR_ERR;
 397
 398         if ((ret = driver->config_get(key, data, sdi)) == SR_OK) {
 399                 /* Got a floating reference from the driver. Sink it here,
 400                  * caller will need to unref when done with it. */
 401                 g_variant_ref_sink(*data);
 402         }
 403
 404         return ret;
 405 }
 406
 407 /**
 408  * Set a configuration key in a device instance.
 409  *
 410  * @param sdi The device instance.
 411  * @param key The configuration key (SR_CONF_*).
 412  * @param data The new value for the key, as a GVariant with GVariantType
 413  *        appropriate to that key. A floating reference can be passed
 414  *        in; its refcount will be sunk and unreferenced after use.
 415  *
 416  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 417  *         may be returned by the driver indicating it doesn't know that key,
 418  *         but this is not to be flagged as an error by the caller; merely
 419  *         as an indication that it's not applicable.
 420  */
 421 SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data)
 422 {
 423         int ret;
 424
 425         g_variant_ref_sink(data);
 426
 427         if (!sdi || !sdi->driver || !data)
 428                 ret = SR_ERR;
 429         else if (!sdi->driver->config_set)
 430                 ret = SR_ERR_ARG;
 431         else
 432                 ret = sdi->driver->config_set(key, data, sdi);
 433
 434         g_variant_unref(data);
 435
 436         return ret;
 437 }
 438
 439 /**
 440  * List all possible values for a configuration key.
 441  *
 442  * @param driver The sr_dev_driver struct to query.
 443  * @param key The configuration key (SR_CONF_*).
 444  * @param data A pointer to a GVariant where the list will be stored. The
 445  *             caller is given ownership of the GVariant and must thus
 446  *             unref the GVariant after use. However if this function
 447  *             returns an error code, the field should be considered
 448  *             unused, and should not be unreferenced.
 449  * @param sdi (optional) If the key is specific to a device, this must
 450  *            contain a pointer to the struct sr_dev_inst to be checked.
 451  *
 452  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 453  *         may be returned by the driver indicating it doesn't know that key,
 454  *         but this is not to be flagged as an error by the caller; merely
 455  *         as an indication that it's not applicable.
 456  */
 457 SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
 458                 GVariant **data, const struct sr_dev_inst *sdi)
 459 {
 460         int ret;
 461
 462         if (!driver || !data || !driver->config_list)
 463                 ret = SR_ERR;
 464         else if ((ret = driver->config_list(key, data, sdi)) == SR_OK)
 465                 g_variant_ref_sink(*data);
 466
 467         return ret;
 468 }
 469
 470 /**
 471  * Get information about a configuration key.
 472  *
 473  * @param key The configuration key.
 474  *
 475  * @return A pointer to a struct sr_config_info, or NULL if the key
 476  *         was not found.
 477  */
 478 SR_API const struct sr_config_info *sr_config_info_get(int key)
 479 {
 480         int i;
 481
 482         for (i = 0; sr_config_info_data[i].key; i++) {
 483                 if (sr_config_info_data[i].key == key)
 484                         return &sr_config_info_data[i];
 485         }
 486
 487         return NULL;
 488 }
 489
 490 /**
 491  * Get information about an configuration key, by name.
 492  *
 493  * @param optname The configuration key.
 494  *
 495  * @return A pointer to a struct sr_config_info, or NULL if the key
 496  *         was not found.
 497  */
 498 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
 499 {
 500         int i;
 501
 502         for (i = 0; sr_config_info_data[i].key; i++) {
 503                 if (!strcmp(sr_config_info_data[i].id, optname))
 504                         return &sr_config_info_data[i];
 505         }
 506
 507         return NULL;
 508 }
 509
 510 /* Unnecessary level of indirection follows. */
 511
 512 /** @private */
 513 SR_PRIV int sr_source_remove(int fd)
 514 {
 515         return sr_session_source_remove(fd);
 516 }
 517
 518 /** @private */
 519 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 520                           sr_receive_data_callback_t cb, void *cb_data)
 521 {
 522         return sr_session_source_add(fd, events, timeout, cb, cb_data);
 523 }
 524
 525 /** @} */