hwplugin.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010 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 "config.h"
  21 #include <stdlib.h>
  22 #include <stdio.h>
  23 #include <sys/types.h>
  24 #include <dirent.h>
  25 #include <string.h>
  26 #include <glib.h>
  27 #include "sigrok.h"
  28 #include "sigrok-internal.h"
  29
  30 /* The list of loaded plugins lives here. */
  31 static GSList *plugins;
  32
  33 /*
  34  * This enumerates which plugin capabilities correspond to user-settable
  35  * options.
  36  */
  37 /* TODO: This shouldn't be a global. */
  38 struct sr_hwcap_option sr_hwcap_options[] = {
  39         {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "Sample rate", "samplerate"},
  40         {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "Pre-trigger capture ratio", "captureratio"},
  41         {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "Pattern generator mode", "patternmode"},
  42         {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"},
  43         {0, 0, NULL, NULL},
  44 };
  45
  46 #ifdef HAVE_LA_DEMO
  47 extern struct sr_device_plugin demo_plugin_info;
  48 #endif
  49 #ifdef HAVE_LA_SALEAE_LOGIC
  50 extern struct sr_device_plugin saleae_logic_plugin_info;
  51 #endif
  52 #ifdef HAVE_LA_OLS
  53 extern struct sr_device_plugin ols_plugin_info;
  54 #endif
  55 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
  56 extern struct sr_device_plugin zeroplus_logic_cube_plugin_info;
  57 #endif
  58 #ifdef HAVE_LA_ASIX_SIGMA
  59 extern struct sr_device_plugin asix_sigma_plugin_info;
  60 #endif
  61 #ifdef HAVE_LA_CHRONOVU_LA8
  62 extern struct device_plugin chronovu_la8_plugin_info;
  63 #endif
  64 #ifdef HAVE_LA_LINK_MSO19
  65 extern struct sr_device_plugin link_mso19_plugin_info;
  66 #endif
  67 #ifdef HAVE_LA_ALSA
  68 extern struct sr_device_plugin alsa_plugin_info;
  69 #endif
  70
  71 /* TODO: No linked list needed, this can be a simple array. */
  72 int load_hwplugins(void)
  73 {
  74 #ifdef HAVE_LA_DEMO
  75         plugins = g_slist_append(plugins, (gpointer *)&demo_plugin_info);
  76 #endif
  77 #ifdef HAVE_LA_SALEAE_LOGIC
  78         plugins =
  79             g_slist_append(plugins, (gpointer *)&saleae_logic_plugin_info);
  80 #endif
  81 #ifdef HAVE_LA_OLS
  82         plugins = g_slist_append(plugins, (gpointer *)&ols_plugin_info);
  83 #endif
  84 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
  85         plugins = g_slist_append(plugins,
  86                            (gpointer *)&zeroplus_logic_cube_plugin_info);
  87 #endif
  88 #ifdef HAVE_LA_ASIX_SIGMA
  89         plugins = g_slist_append(plugins, (gpointer *)&asix_sigma_plugin_info);
  90 #endif
  91 #ifdef HAVE_LA_CHRONOVU_LA8
  92         plugins = g_slist_append(plugins, (gpointer *)&chronovu_la8_plugin_info);
  93 #endif
  94 #ifdef HAVE_LA_LINK_MSO19
  95         plugins = g_slist_append(plugins, (gpointer *)&link_mso19_plugin_info);
  96 #endif
  97 #ifdef HAVE_LA_ALSA
  98         plugins = g_slist_append(plugins, (gpointer *)&alsa_plugin_info);
  99 #endif
 100
 101         return SR_OK;
 102 }
 103
 104 GSList *sr_list_hwplugins(void)
 105 {
 106         return plugins;
 107 }
 108
 109 int sr_init_hwplugins(struct sr_device_plugin *plugin)
 110 {
 111         int num_devices, num_probes, i, j;
 112         int num_initialized_devices = 0;
 113         struct sr_device *device;
 114         char **probe_names;
 115
 116         g_message("initializing %s plugin", plugin->name);
 117         num_devices = plugin->init(NULL);
 118         for (i = 0; i < num_devices; i++) {
 119                 num_probes = GPOINTER_TO_INT(
 120                                 plugin->get_device_info(i, SR_DI_NUM_PROBES));
 121                 probe_names = (char**)plugin->get_device_info(i, SR_DI_PROBE_NAMES);
 122
 123                 if (!probe_names) {
 124                         sr_warn("Plugin %s does not return a list of probe names.", plugin->name);
 125                         continue;
 126                 }
 127
 128                 device = sr_device_new(plugin, i);
 129                 for (j = 0; j < num_probes; j++) {
 130                         sr_device_probe_add(device, probe_names[j]);
 131                 }
 132                 num_initialized_devices++;
 133         }
 134
 135         return num_initialized_devices;
 136 }
 137
 138 void sr_cleanup_hwplugins(void)
 139 {
 140         struct sr_device_plugin *plugin;
 141         GSList *l;
 142
 143         for (l = plugins; l; l = l->next) {
 144                 plugin = l->data;
 145                 if (plugin->cleanup)
 146                         plugin->cleanup();
 147         }
 148 }
 149
 150 struct sr_device_instance *sr_device_instance_new(int index, int status,
 151                 const char *vendor, const char *model, const char *version)
 152 {
 153         struct sr_device_instance *sdi;
 154
 155         if (!(sdi = g_malloc(sizeof(struct sr_device_instance))))
 156                 return NULL;
 157
 158         sdi->index = index;
 159         sdi->status = status;
 160         sdi->instance_type = -1;
 161         sdi->vendor = vendor ? g_strdup(vendor) : NULL;
 162         sdi->model = model ? g_strdup(model) : NULL;
 163         sdi->version = version ? g_strdup(version) : NULL;
 164         sdi->priv = NULL;
 165         sdi->usb = NULL;
 166
 167         return sdi;
 168 }
 169
 170 struct sr_device_instance *sr_get_device_instance(GSList *device_instances,
 171                                                   int device_index)
 172 {
 173         struct sr_device_instance *sdi;
 174         GSList *l;
 175
 176         for (l = device_instances; l; l = l->next) {
 177                 sdi = (struct sr_device_instance *)(l->data);
 178                 if (sdi->index == device_index)
 179                         return sdi;
 180         }
 181         sr_warn("could not find device index %d instance", device_index);
 182
 183         return NULL;
 184 }
 185
 186 void sr_device_instance_free(struct sr_device_instance *sdi)
 187 {
 188         switch (sdi->instance_type) {
 189 #ifdef HAVE_LIBUSB_1_0
 190         case SR_USB_INSTANCE:
 191                 sr_usb_device_instance_free(sdi->usb);
 192                 break;
 193 #endif
 194         case SR_SERIAL_INSTANCE:
 195                 sr_serial_device_instance_free(sdi->serial);
 196                 break;
 197         default:
 198                 /* No specific type, nothing extra to free. */
 199                 break;
 200         }
 201
 202         if (sdi->priv)
 203                 g_free(sdi->priv);
 204
 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 struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus,
 214                         uint8_t address, struct libusb_device_handle *hdl)
 215 {
 216         struct sr_usb_device_instance *udi;
 217
 218         if (!(udi = malloc(sizeof(struct sr_usb_device_instance))))
 219                 return NULL;
 220
 221         udi->bus = bus;
 222         udi->address = address;
 223         udi->devhdl = hdl; /* TODO: Check if this is NULL? */
 224
 225         return udi;
 226 }
 227
 228 void sr_usb_device_instance_free(struct sr_usb_device_instance *usb)
 229 {
 230         /* Avoid compiler warnings. */
 231         (void)usb;
 232
 233         /* Nothing to do for this device instance type. */
 234 }
 235
 236 #endif
 237
 238 struct sr_serial_device_instance *sr_serial_device_instance_new(
 239                                                 const char *port, int fd)
 240 {
 241         struct sr_serial_device_instance *serial;
 242
 243         if (!(serial = malloc(sizeof(struct sr_serial_device_instance))))
 244                 return NULL;
 245
 246         serial->port = strdup(port);
 247         serial->fd = fd;
 248
 249         return serial;
 250 }
 251
 252 void sr_serial_device_instance_free(struct sr_serial_device_instance *serial)
 253 {
 254         free(serial->port);
 255 }
 256
 257 int sr_find_hwcap(int *capabilities, int hwcap)
 258 {
 259         int i;
 260
 261         for (i = 0; capabilities[i]; i++) {
 262                 if (capabilities[i] == hwcap)
 263                         return TRUE;
 264         }
 265
 266         return FALSE;
 267 }
 268
 269 struct sr_hwcap_option *sr_find_hwcap_option(int hwcap)
 270 {
 271         int i;
 272
 273         for (i = 0; sr_hwcap_options[i].capability; i++) {
 274                 if (sr_hwcap_options[i].capability == hwcap)
 275                         return &sr_hwcap_options[i];
 276         }
 277
 278         return NULL;
 279 }
 280
 281 /* unnecessary level of indirection follows. */
 282
 283 void sr_source_remove(int fd)
 284 {
 285         sr_session_source_remove(fd);
 286 }
 287
 288 void sr_source_add(int fd, int events, int timeout,
 289                    sr_receive_data_callback rcv_cb, void *user_data)
 290 {
 291         sr_session_source_add(fd, events, timeout, rcv_cb, user_data);
 292 }