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