hwplugin.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 /* The list of loaded plugins lives here. */
  30 static GSList *plugins;
  31
  32 /*
  33  * This enumerates which plugin capabilities correspond to user-settable
  34  * options.
  35  */
  36 /* TODO: This shouldn't be a global. */
  37 SR_API struct sr_hwcap_option sr_hwcap_options[] = {
  38         {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "Sample rate", "samplerate"},
  39         {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "Pre-trigger capture ratio", "captureratio"},
  40         {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "Pattern generator mode", "patternmode"},
  41         {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"},
  42         {0, 0, NULL, NULL},
  43 };
  44
  45 #ifdef HAVE_LA_DEMO
  46 extern struct sr_device_plugin demo_plugin_info;
  47 #endif
  48 #ifdef HAVE_LA_SALEAE_LOGIC
  49 extern struct sr_device_plugin saleae_logic_plugin_info;
  50 #endif
  51 #ifdef HAVE_LA_OLS
  52 extern struct sr_device_plugin ols_plugin_info;
  53 #endif
  54 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
  55 extern struct sr_device_plugin zeroplus_logic_cube_plugin_info;
  56 #endif
  57 #ifdef HAVE_LA_ASIX_SIGMA
  58 extern struct sr_device_plugin asix_sigma_plugin_info;
  59 #endif
  60 #ifdef HAVE_LA_CHRONOVU_LA8
  61 extern SR_PRIV struct device_plugin chronovu_la8_plugin_info;
  62 #endif
  63 #ifdef HAVE_LA_LINK_MSO19
  64 extern struct sr_device_plugin link_mso19_plugin_info;
  65 #endif
  66 #ifdef HAVE_LA_ALSA
  67 extern struct sr_device_plugin alsa_plugin_info;
  68 #endif
  69
  70 /* TODO: No linked list needed, this can be a simple array. */
  71 SR_PRIV int load_hwplugins(void)
  72 {
  73 #ifdef HAVE_LA_DEMO
  74         plugins = g_slist_append(plugins, (gpointer *)&demo_plugin_info);
  75 #endif
  76 #ifdef HAVE_LA_SALEAE_LOGIC
  77         plugins =
  78             g_slist_append(plugins, (gpointer *)&saleae_logic_plugin_info);
  79 #endif
  80 #ifdef HAVE_LA_OLS
  81         plugins = g_slist_append(plugins, (gpointer *)&ols_plugin_info);
  82 #endif
  83 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
  84         plugins = g_slist_append(plugins,
  85                            (gpointer *)&zeroplus_logic_cube_plugin_info);
  86 #endif
  87 #ifdef HAVE_LA_ASIX_SIGMA
  88         plugins = g_slist_append(plugins, (gpointer *)&asix_sigma_plugin_info);
  89 #endif
  90 #ifdef HAVE_LA_CHRONOVU_LA8
  91         plugins = g_slist_append(plugins, (gpointer *)&chronovu_la8_plugin_info);
  92 #endif
  93 #ifdef HAVE_LA_LINK_MSO19
  94         plugins = g_slist_append(plugins, (gpointer *)&link_mso19_plugin_info);
  95 #endif
  96 #ifdef HAVE_LA_ALSA
  97         plugins = g_slist_append(plugins, (gpointer *)&alsa_plugin_info);
  98 #endif
  99
 100         return SR_OK;
 101 }
 102
 103 /**
 104  * Returns the list of loaded hardware plugins.
 105  *
 106  * The list of plugins is initialized from sr_init(), and can only be reset
 107  * by calling sr_exit().
 108  *
 109  * @return A GSList of pointers to loaded plugins.
 110  */
 111 SR_API GSList *sr_list_hwplugins(void)
 112 {
 113
 114         return plugins;
 115 }
 116
 117 /**
 118  * Initialize a hardware plugin.
 119  *
 120  * The specified plugin is initialized, and all devices discovered by the
 121  * plugin are instantiated.
 122  *
 123  * @param plugin The plugin to initialize.
 124  *
 125  * @return The number of devices found and instantiated by the plugin.
 126  */
 127 SR_API int sr_init_hwplugin(struct sr_device_plugin *plugin)
 128 {
 129         int num_devices, num_probes, i, j;
 130         int num_initialized_devices = 0;
 131         struct sr_device *device;
 132         char **probe_names;
 133
 134         sr_dbg("initializing %s plugin", plugin->name);
 135         num_devices = plugin->init(NULL);
 136         for (i = 0; i < num_devices; i++) {
 137                 num_probes = GPOINTER_TO_INT(
 138                                 plugin->get_device_info(i, SR_DI_NUM_PROBES));
 139                 probe_names = (char **)plugin->get_device_info(i,
 140                                                         SR_DI_PROBE_NAMES);
 141
 142                 if (!probe_names) {
 143                         sr_warn("hwplugin: %s: plugin %s does not return a "
 144                                 "list of probe names", __func__, plugin->name);
 145                         continue;
 146                 }
 147
 148                 device = sr_dev_new(plugin, i);
 149                 for (j = 0; j < num_probes; j++)
 150                         sr_dev_probe_add(device, probe_names[j]);
 151                 num_initialized_devices++;
 152         }
 153
 154         return num_initialized_devices;
 155 }
 156
 157 SR_PRIV void sr_cleanup_hwplugins(void)
 158 {
 159         struct sr_device_plugin *plugin;
 160         GSList *l;
 161
 162         for (l = plugins; l; l = l->next) {
 163                 plugin = l->data;
 164                 if (plugin->cleanup)
 165                         plugin->cleanup();
 166         }
 167 }
 168
 169 SR_PRIV struct sr_device_instance *sr_device_instance_new(int index, int status,
 170                 const char *vendor, const char *model, const char *version)
 171 {
 172         struct sr_device_instance *sdi;
 173
 174         if (!(sdi = g_try_malloc(sizeof(struct sr_device_instance)))) {
 175                 sr_err("hwplugin: %s: sdi malloc failed", __func__);
 176                 return NULL;
 177         }
 178
 179         sdi->index = index;
 180         sdi->status = status;
 181         sdi->instance_type = -1;
 182         sdi->vendor = vendor ? g_strdup(vendor) : NULL;
 183         sdi->model = model ? g_strdup(model) : NULL;
 184         sdi->version = version ? g_strdup(version) : NULL;
 185         sdi->priv = NULL;
 186
 187         return sdi;
 188 }
 189
 190 SR_PRIV struct sr_device_instance *sr_get_device_instance(
 191                 GSList *device_instances, int device_index)
 192 {
 193         struct sr_device_instance *sdi;
 194         GSList *l;
 195
 196         for (l = device_instances; l; l = l->next) {
 197                 sdi = (struct sr_device_instance *)(l->data);
 198                 if (sdi->index == device_index)
 199                         return sdi;
 200         }
 201         sr_warn("could not find device index %d instance", device_index);
 202
 203         return NULL;
 204 }
 205
 206 SR_PRIV void sr_device_instance_free(struct sr_device_instance *sdi)
 207 {
 208         g_free(sdi->priv);
 209         g_free(sdi->vendor);
 210         g_free(sdi->model);
 211         g_free(sdi->version);
 212         g_free(sdi);
 213 }
 214
 215 #ifdef HAVE_LIBUSB_1_0
 216
 217 SR_PRIV struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus,
 218                         uint8_t address, struct libusb_device_handle *hdl)
 219 {
 220         struct sr_usb_device_instance *udi;
 221
 222         if (!(udi = g_try_malloc(sizeof(struct sr_usb_device_instance)))) {
 223                 sr_err("hwplugin: %s: udi malloc failed", __func__);
 224                 return NULL;
 225         }
 226
 227         udi->bus = bus;
 228         udi->address = address;
 229         udi->devhdl = hdl; /* TODO: Check if this is NULL? */
 230
 231         return udi;
 232 }
 233
 234 SR_PRIV void sr_usb_device_instance_free(struct sr_usb_device_instance *usb)
 235 {
 236         /* Avoid compiler warnings. */
 237         (void)usb;
 238
 239         /* Nothing to do for this device instance type. */
 240 }
 241
 242 #endif
 243
 244 SR_PRIV struct sr_serial_device_instance *sr_serial_device_instance_new(
 245                                                 const char *port, int fd)
 246 {
 247         struct sr_serial_device_instance *serial;
 248
 249         if (!(serial = g_try_malloc(sizeof(struct sr_serial_device_instance)))) {
 250                 sr_err("hwplugin: %s: serial malloc failed", __func__);
 251                 return NULL;
 252         }
 253
 254         serial->port = g_strdup(port);
 255         serial->fd = fd;
 256
 257         return serial;
 258 }
 259
 260 SR_PRIV void sr_serial_device_instance_free(
 261                 struct sr_serial_device_instance *serial)
 262 {
 263         g_free(serial->port);
 264 }
 265
 266 /**
 267  * Find out if a list of hardware plugin capabilities has a specific cap.
 268  *
 269  * @param capabilities A NULL-terminated integer array of capabilities, as
 270  * returned by a plugin's get_capabilities() function.
 271  * @param hwcap The capability to find in the list.
 272  *
 273  * @return Returns TRUE if found, FALSE otherwise.
 274  */
 275 SR_API gboolean sr_has_hwcap(int *capabilities, int hwcap)
 276 {
 277         int i;
 278
 279         for (i = 0; capabilities[i]; i++) {
 280                 if (capabilities[i] == hwcap)
 281                         return TRUE;
 282         }
 283
 284         return FALSE;
 285 }
 286
 287 /**
 288  * Find a hardware plugin capability option parameter structure.
 289  *
 290  * @param hwcap The capability to find
 291  *
 292  * @return Returns a struct with information about the parameter, or NULL
 293  * if not found.
 294  */
 295 SR_API struct sr_hwcap_option *sr_find_hwcap_option(int hwcap)
 296 {
 297         int i;
 298
 299         for (i = 0; sr_hwcap_options[i].capability; i++) {
 300                 if (sr_hwcap_options[i].capability == hwcap)
 301                         return &sr_hwcap_options[i];
 302         }
 303
 304         return NULL;
 305 }
 306
 307 /* unnecessary level of indirection follows. */
 308
 309 SR_PRIV void sr_source_remove(int fd)
 310 {
 311         sr_session_source_remove(fd);
 312 }
 313
 314 SR_PRIV void sr_source_add(int fd, int events, int timeout,
 315                    sr_receive_data_callback rcv_cb, void *user_data)
 316 {
 317         sr_session_source_add(fd, events, timeout, rcv_cb, user_data);
 318 }