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 SR_API 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 SR_API struct sr_hwcap_option sr_hwcap_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  * In addition to the detection, the devices that are found are also
 152  * initialized automatically. On some devices, this involves a firmware upload,
 153  * or other such measures.
 154  *
 155  * The order in which the system is scanned for devices is not specified. The
 156  * caller should not assume or rely on any specific order.
 157  *
 158  * @param driver The driver.
 159  * @param options A list of struct sr_hwopt options to pass to the driver's
 160  *              scanner.
 161  *
 162  * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found.
 163  * This list must be freed by the caller, but without freeing the data
 164  * pointed to in the list.
 165  */
 166 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 167 {
 168
 169         if (driver->scan)
 170                 return driver->scan(options);
 171
 172         return NULL;
 173 }
 174
 175 SR_PRIV void sr_hw_cleanup_all(void)
 176 {
 177         int i;
 178         struct sr_dev_driver **drivers;
 179
 180         drivers = sr_driver_list();
 181         for (i = 0; drivers[i]; i++) {
 182                 if (drivers[i]->cleanup)
 183                         drivers[i]->cleanup();
 184         }
 185 }
 186
 187 /**
 188  * Returns information about the given driver or device instance.
 189  *
 190  * @param driver The sr_dev_driver struct to query.
 191  * @param id The type of information, in the form of an SR_HWCAP_* option.
 192  * @param data Pointer where the value. will be stored. Must not be NULL.
 193  * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL.
 194  *
 195  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 196  *         may be returned by the driver indicating it doesn't know that id,
 197  *         but this is not to be flagged as an error by the caller; merely
 198  *         as an indication that it's not applicable.
 199  */
 200 SR_API int sr_info_get(struct sr_dev_driver *driver, int id,
 201                 const void **data, const struct sr_dev_inst *sdi)
 202 {
 203         int ret;
 204
 205         if (driver == NULL || data == NULL)
 206                 return SR_ERR;
 207
 208         ret = driver->info_get(id, data, sdi);
 209
 210         return ret;
 211 }
 212
 213 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
 214                 const char *vendor, const char *model, const char *version)
 215 {
 216         struct sr_dev_inst *sdi;
 217
 218         if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
 219                 sr_err("hwdriver: %s: sdi malloc failed", __func__);
 220                 return NULL;
 221         }
 222
 223         sdi->index = index;
 224         sdi->status = status;
 225         sdi->inst_type = -1;
 226         sdi->vendor = vendor ? g_strdup(vendor) : NULL;
 227         sdi->model = model ? g_strdup(model) : NULL;
 228         sdi->version = version ? g_strdup(version) : NULL;
 229         sdi->probes = NULL;
 230         sdi->priv = NULL;
 231
 232         return sdi;
 233 }
 234
 235 SR_PRIV struct sr_dev_inst *sr_dev_inst_get(GSList *dev_insts, int dev_index)
 236 {
 237         struct sr_dev_inst *sdi;
 238         GSList *l;
 239
 240         for (l = dev_insts; l; l = l->next) {
 241                 sdi = (struct sr_dev_inst *)(l->data);
 242                 if (sdi->index == dev_index)
 243                         return sdi;
 244         }
 245         sr_warn("could not find device index %d instance", dev_index);
 246
 247         return NULL;
 248 }
 249
 250 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
 251 {
 252         g_free(sdi->priv);
 253         g_free(sdi->vendor);
 254         g_free(sdi->model);
 255         g_free(sdi->version);
 256         g_free(sdi);
 257 }
 258
 259 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
 260                 gboolean enabled, const char *name)
 261 {
 262         struct sr_probe *probe;
 263
 264         if (!(probe = g_try_malloc0(sizeof(struct sr_probe)))) {
 265                 sr_err("hwdriver: probe malloc failed");
 266                 return NULL;
 267         }
 268
 269         probe->index = index;
 270         probe->type = type;
 271         probe->enabled = enabled;
 272         if (name)
 273                 probe->name = g_strdup(name);
 274
 275         return probe;
 276 }
 277
 278 #ifdef HAVE_LIBUSB_1_0
 279
 280 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 281                         uint8_t address, struct libusb_device_handle *hdl)
 282 {
 283         struct sr_usb_dev_inst *udi;
 284
 285         if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
 286                 sr_err("hwdriver: %s: udi malloc failed", __func__);
 287                 return NULL;
 288         }
 289
 290         udi->bus = bus;
 291         udi->address = address;
 292         udi->devhdl = hdl;
 293
 294         return udi;
 295 }
 296
 297 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
 298 {
 299         /* Avoid compiler warnings. */
 300         (void)usb;
 301
 302         /* Nothing to do for this device instance type. */
 303 }
 304
 305 #endif
 306
 307 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 308                                                           int fd)
 309 {
 310         struct sr_serial_dev_inst *serial;
 311
 312         if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) {
 313                 sr_err("hwdriver: %s: serial malloc failed", __func__);
 314                 return NULL;
 315         }
 316
 317         serial->port = g_strdup(port);
 318         serial->fd = fd;
 319
 320         return serial;
 321 }
 322
 323 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
 324 {
 325         g_free(serial->port);
 326 }
 327
 328 /**
 329  * Find out if a hardware driver has a specific capability.
 330  *
 331  * @param driver The hardware driver in which to search for the capability.
 332  * @param hwcap The capability to find in the list.
 333  *
 334  * @return TRUE if the specified capability exists in the specified driver,
 335  *         FALSE otherwise. Also, if 'driver' is NULL or the respective driver
 336  *         returns an invalid capability list, FALSE is returned.
 337  */
 338 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
 339 {
 340         const int *hwcaps;
 341         int i;
 342
 343         if (!driver) {
 344                 sr_err("hwdriver: %s: driver was NULL", __func__);
 345                 return FALSE;
 346         }
 347
 348         if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK)
 349                 return FALSE;
 350
 351         for (i = 0; hwcaps[i]; i++) {
 352                 if (hwcaps[i] == hwcap)
 353                         return TRUE;
 354         }
 355
 356         return FALSE;
 357 }
 358
 359 /**
 360  * Get a hardware driver option.
 361  *
 362  * @param hwopt The option to get.
 363  *
 364  * @return A pointer to a struct with information about the parameter, or NULL
 365  *         if the option was not found.
 366  */
 367 SR_API const struct sr_hwcap_option *sr_drvopt_get(int hwopt)
 368 {
 369         int i;
 370
 371         for (i = 0; sr_drvopts[i].hwcap; i++) {
 372                 if (sr_drvopts[i].hwcap == hwopt)
 373                         return &sr_drvopts[i];
 374         }
 375
 376         return NULL;
 377 }
 378
 379 /**
 380  * Get a hardware driver capability option.
 381  *
 382  * @param hwcap The capability to get.
 383  *
 384  * @return A pointer to a struct with information about the parameter, or NULL
 385  *         if the capability was not found.
 386  */
 387 SR_API const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap)
 388 {
 389         int i;
 390
 391         for (i = 0; sr_hwcap_options[i].hwcap; i++) {
 392                 if (sr_hwcap_options[i].hwcap == hwcap)
 393                         return &sr_hwcap_options[i];
 394         }
 395
 396         return NULL;
 397 }
 398
 399 /* Unnecessary level of indirection follows. */
 400
 401 SR_PRIV int sr_source_remove(int fd)
 402 {
 403         return sr_session_source_remove(fd);
 404 }
 405
 406 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 407                           sr_receive_data_callback_t cb, void *cb_data)
 408 {
 409         return sr_session_source_add(fd, events, timeout, cb, cb_data);
 410 }