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