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  * This enumerates which driver capabilities correspond to user-settable
  31  * options.
  32  */
  33 /* TODO: This shouldn't be a global. */
  34 SR_API struct sr_hwcap_option sr_hwcap_options[] = {
  35         /* Driver scanning options. */
  36         {SR_HWOPT_MODEL, SR_T_KEYVALUE, "Model", "model"},
  37         {SR_HWOPT_CONN, SR_T_CHAR, "Connection", "conn"},
  38         {SR_HWOPT_SERIALCOMM, SR_T_CHAR, "Serial communication", "serialcomm"},
  39         /* Device instance options. */
  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  * @param driver The driver.
 152  * @param options A list of struct sr_hwopt options to pass to the driver's
 153  *              scanner.
 154  *
 155  * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found.
 156  * This list must be freed by the caller, but without freeing the data
 157  * pointed to in the list.
 158  */
 159 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 160 {
 161
 162         if (driver->scan)
 163                 return driver->scan(options);
 164
 165         return NULL;
 166 }
 167
 168 SR_PRIV void sr_hw_cleanup_all(void)
 169 {
 170         int i;
 171         struct sr_dev_driver **drivers;
 172
 173         drivers = sr_driver_list();
 174         for (i = 0; drivers[i]; i++) {
 175                 if (drivers[i]->cleanup)
 176                         drivers[i]->cleanup();
 177         }
 178 }
 179
 180 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
 181                 const char *vendor, const char *model, const char *version)
 182 {
 183         struct sr_dev_inst *sdi;
 184
 185         if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
 186                 sr_err("hwdriver: %s: sdi malloc failed", __func__);
 187                 return NULL;
 188         }
 189
 190         sdi->index = index;
 191         sdi->status = status;
 192         sdi->inst_type = -1;
 193         sdi->vendor = vendor ? g_strdup(vendor) : NULL;
 194         sdi->model = model ? g_strdup(model) : NULL;
 195         sdi->version = version ? g_strdup(version) : NULL;
 196         sdi->priv = NULL;
 197
 198         return sdi;
 199 }
 200
 201 SR_PRIV struct sr_dev_inst *sr_dev_inst_get(GSList *dev_insts, int dev_index)
 202 {
 203         struct sr_dev_inst *sdi;
 204         GSList *l;
 205
 206         for (l = dev_insts; l; l = l->next) {
 207                 sdi = (struct sr_dev_inst *)(l->data);
 208                 if (sdi->index == dev_index)
 209                         return sdi;
 210         }
 211         sr_warn("could not find device index %d instance", dev_index);
 212
 213         return NULL;
 214 }
 215
 216 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
 217 {
 218         g_free(sdi->priv);
 219         g_free(sdi->vendor);
 220         g_free(sdi->model);
 221         g_free(sdi->version);
 222         g_free(sdi);
 223 }
 224
 225 #ifdef HAVE_LIBUSB_1_0
 226
 227 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 228                         uint8_t address, struct libusb_device_handle *hdl)
 229 {
 230         struct sr_usb_dev_inst *udi;
 231
 232         if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
 233                 sr_err("hwdriver: %s: udi malloc failed", __func__);
 234                 return NULL;
 235         }
 236
 237         udi->bus = bus;
 238         udi->address = address;
 239         udi->devhdl = hdl;
 240
 241         return udi;
 242 }
 243
 244 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
 245 {
 246         /* Avoid compiler warnings. */
 247         (void)usb;
 248
 249         /* Nothing to do for this device instance type. */
 250 }
 251
 252 #endif
 253
 254 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 255                                                           int fd)
 256 {
 257         struct sr_serial_dev_inst *serial;
 258
 259         if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) {
 260                 sr_err("hwdriver: %s: serial malloc failed", __func__);
 261                 return NULL;
 262         }
 263
 264         serial->port = g_strdup(port);
 265         serial->fd = fd;
 266
 267         return serial;
 268 }
 269
 270 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
 271 {
 272         g_free(serial->port);
 273 }
 274
 275 /**
 276  * Find out if a hardware driver has a specific capability.
 277  *
 278  * @param driver The hardware driver in which to search for the capability.
 279  * @param hwcap The capability to find in the list.
 280  *
 281  * @return TRUE if the specified capability exists in the specified driver,
 282  *         FALSE otherwise. Also, if 'driver' is NULL or the respective driver
 283  *         returns an invalid capability list, FALSE is returned.
 284  */
 285 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
 286 {
 287         const int *hwcaps;
 288         int i;
 289
 290         if (!driver) {
 291                 sr_err("hwdriver: %s: driver was NULL", __func__);
 292                 return FALSE;
 293         }
 294
 295         if (!(hwcaps = driver->hwcap_get_all())) {
 296                 sr_err("hwdriver: %s: hwcap_get_all() returned NULL", __func__);
 297                 return FALSE;
 298         }
 299
 300         for (i = 0; hwcaps[i]; i++) {
 301                 if (hwcaps[i] == hwcap)
 302                         return TRUE;
 303         }
 304
 305         return FALSE;
 306 }
 307
 308 /**
 309  * Get a hardware driver capability option.
 310  *
 311  * @param hwcap The capability to get.
 312  *
 313  * @return A pointer to a struct with information about the parameter, or NULL
 314  *         if the capability was not found.
 315  */
 316 SR_API const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap)
 317 {
 318         int i;
 319
 320         for (i = 0; sr_hwcap_options[i].hwcap; i++) {
 321                 if (sr_hwcap_options[i].hwcap == hwcap)
 322                         return &sr_hwcap_options[i];
 323         }
 324
 325         return NULL;
 326 }
 327
 328 /* Unnecessary level of indirection follows. */
 329
 330 SR_PRIV int sr_source_remove(int fd)
 331 {
 332         return sr_session_source_remove(fd);
 333 }
 334
 335 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 336                           sr_receive_data_callback_t cb, void *cb_data)
 337 {
 338         return sr_session_source_add(fd, events, timeout, cb, cb_data);
 339 }