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 "sigrok.h"
  27 #include "sigrok-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         {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "Sample rate", "samplerate"},
  36         {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "Pre-trigger capture ratio", "captureratio"},
  37         {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "Pattern generator mode", "pattern"},
  38         {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"},
  39         {SR_HWCAP_TRIGGER_SLOPE, SR_T_UINT64, "Trigger slope", "triggerslope"},
  40         {SR_HWCAP_TRIGGER_SOURCE, SR_T_CHAR, "Trigger source", "triggersource"},
  41         {SR_HWCAP_HORIZ_TRIGGERPOS, SR_T_FLOAT, "Horizontal trigger position",
  42                         "horiz_triggerpos"},
  43         {SR_HWCAP_BUFFERSIZE, SR_T_UINT64, "Buffer size", "buffersize"},
  44         {SR_HWCAP_TIMEBASE, SR_T_RATIONAL_PERIOD, "Time base", "timebase"},
  45         {SR_HWCAP_FILTER, SR_T_CHAR, "Filter targets", "filter"},
  46         {SR_HWCAP_VDIV, SR_T_RATIONAL_VOLT, "Volts/div", "vdiv"},
  47         {SR_HWCAP_COUPLING, SR_T_CHAR, "Coupling", "coupling"},
  48         {0, 0, NULL, NULL},
  49 };
  50
  51 #ifdef HAVE_LA_DEMO
  52 extern SR_PRIV struct sr_dev_driver demo_driver_info;
  53 #endif
  54 #ifdef HAVE_LA_OLS
  55 extern SR_PRIV struct sr_dev_driver ols_driver_info;
  56 #endif
  57 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
  58 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
  59 #endif
  60 #ifdef HAVE_LA_ASIX_SIGMA
  61 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
  62 #endif
  63 #ifdef HAVE_LA_CHRONOVU_LA8
  64 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
  65 #endif
  66 #ifdef HAVE_LA_LINK_MSO19
  67 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
  68 #endif
  69 #ifdef HAVE_LA_ALSA
  70 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
  71 #endif
  72 #ifdef HAVE_LA_FX2LAFW
  73 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
  74 #endif
  75 #ifdef HAVE_HW_HANTEK_DSO
  76 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
  77 #endif
  78 #ifdef HAVE_HW_MASTECH_VA18B
  79 extern SR_PRIV struct sr_dev_driver mastech_va18b_driver_info;
  80 #endif
  81
  82 static struct sr_dev_driver *drivers_list[] = {
  83 #ifdef HAVE_LA_DEMO
  84         &demo_driver_info,
  85 #endif
  86 #ifdef HAVE_LA_OLS
  87         &ols_driver_info,
  88 #endif
  89 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
  90         &zeroplus_logic_cube_driver_info,
  91 #endif
  92 #ifdef HAVE_LA_ASIX_SIGMA
  93         &asix_sigma_driver_info,
  94 #endif
  95 #ifdef HAVE_LA_CHRONOVU_LA8
  96         &chronovu_la8_driver_info,
  97 #endif
  98 #ifdef HAVE_LA_LINK_MSO19
  99         &link_mso19_driver_info,
 100 #endif
 101 #ifdef HAVE_LA_ALSA
 102         &alsa_driver_info,
 103 #endif
 104 #ifdef HAVE_LA_FX2LAFW
 105         &fx2lafw_driver_info,
 106 #endif
 107 #ifdef HAVE_HW_HANTEK_DSO
 108         &hantek_dso_driver_info,
 109 #endif
 110 #ifdef HAVE_HW_MASTECH_VA18B
 111         &mastech_va18b_driver_info,
 112 #endif
 113         NULL,
 114 };
 115
 116 /**
 117  * Return the list of supported hardware drivers.
 118  *
 119  * @return Pointer to the NULL-terminated list of hardware driver pointers.
 120  */
 121 SR_API struct sr_dev_driver **sr_driver_list(void)
 122 {
 123         return drivers_list;
 124 }
 125
 126 /**
 127  * Initialize a hardware driver.
 128  *
 129  * The specified driver is initialized, and all devices discovered by the
 130  * driver are instantiated.
 131  *
 132  * @param driver The driver to initialize.
 133  *
 134  * @return The number of devices found and instantiated by the driver.
 135  */
 136 SR_API int sr_driver_init(struct sr_dev_driver *driver)
 137 {
 138         int num_devs, num_probes, i, j;
 139         int num_initialized_devs = 0;
 140         struct sr_dev *dev;
 141         char **probe_names;
 142
 143         sr_dbg("initializing %s driver", driver->name);
 144         num_devs = driver->init(NULL);
 145         for (i = 0; i < num_devs; i++) {
 146                 num_probes = GPOINTER_TO_INT(
 147                                 driver->dev_info_get(i, SR_DI_NUM_PROBES));
 148                 probe_names = (char **)driver->dev_info_get(i,
 149                                                         SR_DI_PROBE_NAMES);
 150
 151                 if (!probe_names) {
 152                         sr_warn("hwdriver: %s: driver %s does not return a "
 153                                 "list of probe names", __func__, driver->name);
 154                         continue;
 155                 }
 156
 157                 dev = sr_dev_new(driver, i);
 158                 for (j = 0; j < num_probes; j++)
 159                         sr_dev_probe_add(dev, probe_names[j]);
 160                 num_initialized_devs++;
 161         }
 162
 163         return num_initialized_devs;
 164 }
 165
 166 SR_PRIV void sr_hw_cleanup_all(void)
 167 {
 168         int i;
 169         struct sr_dev_driver **drivers;
 170
 171         drivers = sr_driver_list();
 172         for (i = 0; drivers[i]; i++) {
 173                 if (drivers[i]->cleanup)
 174                         drivers[i]->cleanup();
 175         }
 176 }
 177
 178 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
 179                 const char *vendor, const char *model, const char *version)
 180 {
 181         struct sr_dev_inst *sdi;
 182
 183         if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
 184                 sr_err("hwdriver: %s: sdi malloc failed", __func__);
 185                 return NULL;
 186         }
 187
 188         sdi->index = index;
 189         sdi->status = status;
 190         sdi->inst_type = -1;
 191         sdi->vendor = vendor ? g_strdup(vendor) : NULL;
 192         sdi->model = model ? g_strdup(model) : NULL;
 193         sdi->version = version ? g_strdup(version) : NULL;
 194         sdi->priv = NULL;
 195
 196         return sdi;
 197 }
 198
 199 SR_PRIV struct sr_dev_inst *sr_dev_inst_get(GSList *dev_insts, int dev_index)
 200 {
 201         struct sr_dev_inst *sdi;
 202         GSList *l;
 203
 204         for (l = dev_insts; l; l = l->next) {
 205                 sdi = (struct sr_dev_inst *)(l->data);
 206                 if (sdi->index == dev_index)
 207                         return sdi;
 208         }
 209         sr_warn("could not find device index %d instance", dev_index);
 210
 211         return NULL;
 212 }
 213
 214 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
 215 {
 216         g_free(sdi->priv);
 217         g_free(sdi->vendor);
 218         g_free(sdi->model);
 219         g_free(sdi->version);
 220         g_free(sdi);
 221 }
 222
 223 #ifdef HAVE_LIBUSB_1_0
 224
 225 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 226                         uint8_t address, struct libusb_device_handle *hdl)
 227 {
 228         struct sr_usb_dev_inst *udi;
 229
 230         if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
 231                 sr_err("hwdriver: %s: udi malloc failed", __func__);
 232                 return NULL;
 233         }
 234
 235         udi->bus = bus;
 236         udi->address = address;
 237         udi->devhdl = hdl; /* TODO: Check if this is NULL? */
 238
 239         return udi;
 240 }
 241
 242 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
 243 {
 244         /* Avoid compiler warnings. */
 245         (void)usb;
 246
 247         /* Nothing to do for this device instance type. */
 248 }
 249
 250 #endif
 251
 252 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 253                                                           int fd)
 254 {
 255         struct sr_serial_dev_inst *serial;
 256
 257         if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) {
 258                 sr_err("hwdriver: %s: serial malloc failed", __func__);
 259                 return NULL;
 260         }
 261
 262         serial->port = g_strdup(port);
 263         serial->fd = fd;
 264
 265         return serial;
 266 }
 267
 268 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
 269 {
 270         g_free(serial->port);
 271 }
 272
 273 /**
 274  * Find out if a hardware driver has a specific capability.
 275  *
 276  * @param driver The hardware driver in which to search for the capability.
 277  * @param hwcap The capability to find in the list.
 278  *
 279  * @return TRUE if the specified capability exists in the specified driver,
 280  *         FALSE otherwise. Also, if 'driver' is NULL or the respective driver
 281  *         returns an invalid capability list, FALSE is returned.
 282  */
 283 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
 284 {
 285         const int *hwcaps;
 286         int i;
 287
 288         if (!driver) {
 289                 sr_err("hwdriver: %s: driver was NULL", __func__);
 290                 return FALSE;
 291         }
 292
 293         if (!(hwcaps = driver->hwcap_get_all())) {
 294                 sr_err("hwdriver: %s: hwcap_get_all() returned NULL", __func__);
 295                 return FALSE;
 296         }
 297
 298         for (i = 0; hwcaps[i]; i++) {
 299                 if (hwcaps[i] == hwcap)
 300                         return TRUE;
 301         }
 302
 303         return FALSE;
 304 }
 305
 306 /**
 307  * Get a hardware driver capability option.
 308  *
 309  * @param hwcap The capability to get.
 310  *
 311  * @return A pointer to a struct with information about the parameter, or NULL
 312  *         if the capability was not found.
 313  */
 314 SR_API const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap)
 315 {
 316         int i;
 317
 318         for (i = 0; sr_hwcap_options[i].hwcap; i++) {
 319                 if (sr_hwcap_options[i].hwcap == hwcap)
 320                         return &sr_hwcap_options[i];
 321         }
 322
 323         return NULL;
 324 }
 325
 326 /* Unnecessary level of indirection follows. */
 327
 328 SR_PRIV int sr_source_remove(int fd)
 329 {
 330         return sr_session_source_remove(fd);
 331 }
 332
 333 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 334                           sr_receive_data_callback_t cb, void *cb_data)
 335 {
 336         return sr_session_source_add(fd, events, timeout, cb, cb_data);
 337 }