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