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