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         return drivers_list;
 129 }
 130
 131 /**
 132  * Initialize a hardware driver.
 133  *
 134  * The specified driver is initialized, and all devices discovered by the
 135  * driver are instantiated.
 136  *
 137  * @param driver The driver to initialize.
 138  *
 139  * @return The number of devices found and instantiated by the driver.
 140  */
 141 SR_API int sr_driver_init(struct sr_dev_driver *driver)
 142 {
 143         int num_devs, num_probes, i, j;
 144         int num_initialized_devs = 0;
 145         struct sr_dev *dev;
 146         char **probe_names;
 147
 148         sr_dbg("initializing %s driver", driver->name);
 149         num_devs = driver->init();
 150         for (i = 0; i < num_devs; i++) {
 151                 num_probes = GPOINTER_TO_INT(
 152                                 driver->dev_info_get(i, SR_DI_NUM_PROBES));
 153                 probe_names = (char **)driver->dev_info_get(i,
 154                                                         SR_DI_PROBE_NAMES);
 155
 156                 if (!probe_names) {
 157                         sr_warn("hwdriver: %s: driver %s does not return a "
 158                                 "list of probe names", __func__, driver->name);
 159                         continue;
 160                 }
 161
 162                 dev = sr_dev_new(driver, i);
 163                 for (j = 0; j < num_probes; j++)
 164                         sr_dev_probe_add(dev, probe_names[j]);
 165                 num_initialized_devs++;
 166         }
 167
 168         return num_initialized_devs;
 169 }
 170
 171 SR_PRIV void sr_hw_cleanup_all(void)
 172 {
 173         int i;
 174         struct sr_dev_driver **drivers;
 175
 176         drivers = sr_driver_list();
 177         for (i = 0; drivers[i]; i++) {
 178                 if (drivers[i]->cleanup)
 179                         drivers[i]->cleanup();
 180         }
 181 }
 182
 183 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
 184                 const char *vendor, const char *model, const char *version)
 185 {
 186         struct sr_dev_inst *sdi;
 187
 188         if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
 189                 sr_err("hwdriver: %s: sdi malloc failed", __func__);
 190                 return NULL;
 191         }
 192
 193         sdi->index = index;
 194         sdi->status = status;
 195         sdi->inst_type = -1;
 196         sdi->vendor = vendor ? g_strdup(vendor) : NULL;
 197         sdi->model = model ? g_strdup(model) : NULL;
 198         sdi->version = version ? g_strdup(version) : NULL;
 199         sdi->priv = NULL;
 200
 201         return sdi;
 202 }
 203
 204 SR_PRIV struct sr_dev_inst *sr_dev_inst_get(GSList *dev_insts, int dev_index)
 205 {
 206         struct sr_dev_inst *sdi;
 207         GSList *l;
 208
 209         for (l = dev_insts; l; l = l->next) {
 210                 sdi = (struct sr_dev_inst *)(l->data);
 211                 if (sdi->index == dev_index)
 212                         return sdi;
 213         }
 214         sr_warn("could not find device index %d instance", dev_index);
 215
 216         return NULL;
 217 }
 218
 219 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
 220 {
 221         g_free(sdi->priv);
 222         g_free(sdi->vendor);
 223         g_free(sdi->model);
 224         g_free(sdi->version);
 225         g_free(sdi);
 226 }
 227
 228 #ifdef HAVE_LIBUSB_1_0
 229
 230 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 231                         uint8_t address, struct libusb_device_handle *hdl)
 232 {
 233         struct sr_usb_dev_inst *udi;
 234
 235         if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
 236                 sr_err("hwdriver: %s: udi malloc failed", __func__);
 237                 return NULL;
 238         }
 239
 240         udi->bus = bus;
 241         udi->address = address;
 242         udi->devhdl = hdl;
 243
 244         return udi;
 245 }
 246
 247 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
 248 {
 249         /* Avoid compiler warnings. */
 250         (void)usb;
 251
 252         /* Nothing to do for this device instance type. */
 253 }
 254
 255 #endif
 256
 257 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 258                                                           int fd)
 259 {
 260         struct sr_serial_dev_inst *serial;
 261
 262         if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) {
 263                 sr_err("hwdriver: %s: serial malloc failed", __func__);
 264                 return NULL;
 265         }
 266
 267         serial->port = g_strdup(port);
 268         serial->fd = fd;
 269
 270         return serial;
 271 }
 272
 273 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
 274 {
 275         g_free(serial->port);
 276 }
 277
 278 /**
 279  * Find out if a hardware driver has a specific capability.
 280  *
 281  * @param driver The hardware driver in which to search for the capability.
 282  * @param hwcap The capability to find in the list.
 283  *
 284  * @return TRUE if the specified capability exists in the specified driver,
 285  *         FALSE otherwise. Also, if 'driver' is NULL or the respective driver
 286  *         returns an invalid capability list, FALSE is returned.
 287  */
 288 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
 289 {
 290         const int *hwcaps;
 291         int i;
 292
 293         if (!driver) {
 294                 sr_err("hwdriver: %s: driver was NULL", __func__);
 295                 return FALSE;
 296         }
 297
 298         if (!(hwcaps = driver->hwcap_get_all())) {
 299                 sr_err("hwdriver: %s: hwcap_get_all() returned NULL", __func__);
 300                 return FALSE;
 301         }
 302
 303         for (i = 0; hwcaps[i]; i++) {
 304                 if (hwcaps[i] == hwcap)
 305                         return TRUE;
 306         }
 307
 308         return FALSE;
 309 }
 310
 311 /**
 312  * Get a hardware driver capability option.
 313  *
 314  * @param hwcap The capability to get.
 315  *
 316  * @return A pointer to a struct with information about the parameter, or NULL
 317  *         if the capability was not found.
 318  */
 319 SR_API const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap)
 320 {
 321         int i;
 322
 323         for (i = 0; sr_hwcap_options[i].hwcap; i++) {
 324                 if (sr_hwcap_options[i].hwcap == hwcap)
 325                         return &sr_hwcap_options[i];
 326         }
 327
 328         return NULL;
 329 }
 330
 331 /* Unnecessary level of indirection follows. */
 332
 333 SR_PRIV int sr_source_remove(int fd)
 334 {
 335         return sr_session_source_remove(fd);
 336 }
 337
 338 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 339                           sr_receive_data_callback_t cb, void *cb_data)
 340 {
 341         return sr_session_source_add(fd, events, timeout, cb, cb_data);
 342 }