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 "libsigrok.h"
  27 #include "libsigrok-internal.h"
  28
  29
  30 /* Driver scanning options. */
  31 static struct sr_hwcap_option sr_drvopts[] = {
  32         {SR_HWOPT_MODEL, SR_T_KEYVALUE, "Model", "model"},
  33         {SR_HWOPT_CONN, SR_T_CHAR, "Connection", "conn"},
  34         {SR_HWOPT_SERIALCOMM, SR_T_CHAR, "Serial communication", "serialcomm"},
  35         {0, 0, NULL, NULL},
  36 };
  37
  38 /* Device instance options. */
  39 static struct sr_hwcap_option sr_devopts[] = {
  40         {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "Sample rate", "samplerate"},
  41         {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "Pre-trigger capture ratio", "captureratio"},
  42         {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "Pattern generator mode", "pattern"},
  43         {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"},
  44         {SR_HWCAP_TRIGGER_SLOPE, SR_T_UINT64, "Trigger slope", "triggerslope"},
  45         {SR_HWCAP_TRIGGER_SOURCE, SR_T_CHAR, "Trigger source", "triggersource"},
  46         {SR_HWCAP_HORIZ_TRIGGERPOS, SR_T_FLOAT, "Horizontal trigger position",
  47                         "horiz_triggerpos"},
  48         {SR_HWCAP_BUFFERSIZE, SR_T_UINT64, "Buffer size", "buffersize"},
  49         {SR_HWCAP_TIMEBASE, SR_T_RATIONAL_PERIOD, "Time base", "timebase"},
  50         {SR_HWCAP_FILTER, SR_T_CHAR, "Filter targets", "filter"},
  51         {SR_HWCAP_VDIV, SR_T_RATIONAL_VOLT, "Volts/div", "vdiv"},
  52         {SR_HWCAP_COUPLING, SR_T_CHAR, "Coupling", "coupling"},
  53         {0, 0, NULL, NULL},
  54 };
  55
  56 /** @cond PRIVATE */
  57 #ifdef HAVE_LA_DEMO
  58 extern SR_PRIV struct sr_dev_driver demo_driver_info;
  59 #endif
  60 #ifdef HAVE_LA_OLS
  61 extern SR_PRIV struct sr_dev_driver ols_driver_info;
  62 #endif
  63 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
  64 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
  65 #endif
  66 #ifdef HAVE_LA_ASIX_SIGMA
  67 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
  68 #endif
  69 #ifdef HAVE_LA_CHRONOVU_LA8
  70 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
  71 #endif
  72 #ifdef HAVE_LA_LINK_MSO19
  73 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
  74 #endif
  75 #ifdef HAVE_LA_ALSA
  76 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
  77 #endif
  78 #ifdef HAVE_LA_FX2LAFW
  79 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
  80 #endif
  81 #ifdef HAVE_HW_HANTEK_DSO
  82 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
  83 #endif
  84 #ifdef HAVE_HW_GENERICDMM
  85 extern SR_PRIV struct sr_dev_driver genericdmm_driver_info;
  86 #endif
  87 #ifdef HAVE_HW_AGILENT_DMM
  88 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
  89 #endif
  90 #ifdef HAVE_HW_FLUKE_DMM
  91 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
  92 #endif
  93 #ifdef HAVE_HW_RADIOSHACK_DMM
  94 extern SR_PRIV struct sr_dev_driver radioshackdmm_driver_info;
  95 #endif
  96 /** @endcond */
  97
  98 static struct sr_dev_driver *drivers_list[] = {
  99 #ifdef HAVE_LA_DEMO
 100         &demo_driver_info,
 101 #endif
 102 #ifdef HAVE_LA_OLS
 103         &ols_driver_info,
 104 #endif
 105 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
 106         &zeroplus_logic_cube_driver_info,
 107 #endif
 108 #ifdef HAVE_LA_ASIX_SIGMA
 109         &asix_sigma_driver_info,
 110 #endif
 111 #ifdef HAVE_LA_CHRONOVU_LA8
 112         &chronovu_la8_driver_info,
 113 #endif
 114 #ifdef HAVE_LA_LINK_MSO19
 115         &link_mso19_driver_info,
 116 #endif
 117 #ifdef HAVE_LA_ALSA
 118         &alsa_driver_info,
 119 #endif
 120 #ifdef HAVE_LA_FX2LAFW
 121         &fx2lafw_driver_info,
 122 #endif
 123 #ifdef HAVE_HW_HANTEK_DSO
 124         &hantek_dso_driver_info,
 125 #endif
 126 #ifdef HAVE_HW_GENERICDMM
 127         &genericdmm_driver_info,
 128 #endif
 129 #ifdef HAVE_HW_AGILENT_DMM
 130         &agdmm_driver_info,
 131 #endif
 132 #ifdef HAVE_HW_FLUKE_DMM
 133         &flukedmm_driver_info,
 134 #endif
 135 #ifdef HAVE_HW_RADIOSHACK_DMM
 136         &radioshackdmm_driver_info,
 137 #endif
 138         NULL,
 139 };
 140
 141 /**
 142  * Return the list of supported hardware drivers.
 143  *
 144  * @return Pointer to the NULL-terminated list of hardware driver pointers.
 145  */
 146 SR_API struct sr_dev_driver **sr_driver_list(void)
 147 {
 148
 149         return drivers_list;
 150 }
 151
 152 /**
 153  * Initialize a hardware driver.
 154  *
 155  * @param driver The driver to initialize.
 156  *
 157  * @return SR_OK if all went well, or an error code otherwise.
 158  */
 159 SR_API int sr_driver_init(struct sr_dev_driver *driver)
 160 {
 161
 162         if (driver->init)
 163                 return driver->init();
 164
 165         return SR_OK;
 166 }
 167
 168 /**
 169  * Tell a hardware driver to scan for devices.
 170  *
 171  * In addition to the detection, the devices that are found are also
 172  * initialized automatically. On some devices, this involves a firmware upload,
 173  * or other such measures.
 174  *
 175  * The order in which the system is scanned for devices is not specified. The
 176  * caller should not assume or rely on any specific order.
 177  *
 178  * @param driver The driver.
 179  * @param options A list of struct sr_hwopt options to pass to the driver's
 180  *              scanner.
 181  *
 182  * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found.
 183  * This list must be freed by the caller, but without freeing the data
 184  * pointed to in the list.
 185  */
 186 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 187 {
 188
 189         if (driver->scan)
 190                 return driver->scan(options);
 191
 192         return NULL;
 193 }
 194
 195 /** @private */
 196 SR_PRIV void sr_hw_cleanup_all(void)
 197 {
 198         int i;
 199         struct sr_dev_driver **drivers;
 200
 201         drivers = sr_driver_list();
 202         for (i = 0; drivers[i]; i++) {
 203                 if (drivers[i]->cleanup)
 204                         drivers[i]->cleanup();
 205         }
 206 }
 207
 208 /**
 209  * Returns information about the given driver or device instance.
 210  *
 211  * @param driver The sr_dev_driver struct to query.
 212  * @param id The type of information, in the form of an SR_HWCAP_* option.
 213  * @param data Pointer where the value. will be stored. Must not be NULL.
 214  * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL.
 215  *
 216  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 217  *         may be returned by the driver indicating it doesn't know that id,
 218  *         but this is not to be flagged as an error by the caller; merely
 219  *         as an indication that it's not applicable.
 220  */
 221 SR_API int sr_info_get(struct sr_dev_driver *driver, int id,
 222                 const void **data, const struct sr_dev_inst *sdi)
 223 {
 224         int ret;
 225
 226         if (driver == NULL || data == NULL)
 227                 return SR_ERR;
 228
 229         ret = driver->info_get(id, data, sdi);
 230
 231         return ret;
 232 }
 233
 234 /**
 235  * Find out if a hardware driver has a specific capability.
 236  *
 237  * @param driver The hardware driver in which to search for the capability.
 238  * @param hwcap The capability to find in the list.
 239  *
 240  * @return TRUE if the specified capability exists in the specified driver,
 241  *         FALSE otherwise. Also, if 'driver' is NULL or the respective driver
 242  *         returns an invalid capability list, FALSE is returned.
 243  */
 244 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
 245 {
 246         const int *hwcaps;
 247         int i;
 248
 249         if (!driver) {
 250                 sr_err("hwdriver: %s: driver was NULL", __func__);
 251                 return FALSE;
 252         }
 253
 254         if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK)
 255                 return FALSE;
 256
 257         for (i = 0; hwcaps[i]; i++) {
 258                 if (hwcaps[i] == hwcap)
 259                         return TRUE;
 260         }
 261
 262         return FALSE;
 263 }
 264
 265 /**
 266  * Get information about a hardware driver option.
 267  *
 268  * @param opt The option to get.
 269  *
 270  * @return A pointer to a struct sr_hwcap_option, or NULL if the option
 271  *         was not found.
 272  */
 273 SR_API const struct sr_hwcap_option *sr_drvopt_get(int opt)
 274 {
 275         int i;
 276
 277         for (i = 0; sr_drvopts[i].hwcap; i++) {
 278                 if (sr_drvopts[i].hwcap == opt)
 279                         return &sr_drvopts[i];
 280         }
 281
 282         return NULL;
 283 }
 284
 285 /**
 286  * Get information about a hardware driver option, by name.
 287  *
 288  * @param optname The name of the option to get.
 289  *
 290  * @return A pointer to a struct sr_hwcap_option, or NULL if the option
 291  *         was not found.
 292  */
 293 SR_API const struct sr_hwcap_option *sr_drvopt_name_get(const char *optname)
 294 {
 295         int i;
 296
 297         for (i = 0; sr_drvopts[i].hwcap; i++) {
 298                 if (!strcmp(sr_drvopts[i].shortname, optname))
 299                         return &sr_drvopts[i];
 300         }
 301
 302         return NULL;
 303 }
 304
 305 /**
 306  * Get information about a device option.
 307  *
 308  * @param opt The option to get.
 309  *
 310  * @return A pointer to a struct sr_hwcap_option, or NULL if the option
 311  *         was not found.
 312  */
 313 SR_API const struct sr_hwcap_option *sr_devopt_get(int opt)
 314 {
 315         int i;
 316
 317         for (i = 0; sr_devopts[i].hwcap; i++) {
 318                 if (sr_devopts[i].hwcap == opt)
 319                         return &sr_devopts[i];
 320         }
 321
 322         return NULL;
 323 }
 324
 325 /**
 326  * Get information about a device option, by name.
 327  *
 328  * @param optname The name of the option to get.
 329  *
 330  * @return A pointer to a struct sr_hwcap_option, or NULL if the option
 331  *         was not found.
 332  */
 333 SR_API const struct sr_hwcap_option *sr_devopt_name_get(const char *optname)
 334 {
 335         int i;
 336
 337         for (i = 0; sr_devopts[i].hwcap; i++) {
 338                 if (!strcmp(sr_devopts[i].shortname, optname))
 339                         return &sr_devopts[i];
 340         }
 341
 342         return NULL;
 343 }
 344
 345 /* Unnecessary level of indirection follows. */
 346
 347 /** @private */
 348 SR_PRIV int sr_source_remove(int fd)
 349 {
 350         return sr_session_source_remove(fd);
 351 }
 352
 353 /** @private */
 354 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 355                           sr_receive_data_callback_t cb, void *cb_data)
 356 {
 357         return sr_session_source_add(fd, events, timeout, cb, cb_data);
 358 }