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