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