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 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         {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 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
  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
 102         return SR_OK;
 103 }
 104
 105 GSList *sr_list_hwplugins(void)
 106 {
 107         return plugins;
 108 }
 109
 110 int sr_init_hwplugins(struct sr_device_plugin *plugin)
 111 {
 112         int num_devices, num_probes, i;
 113
 114         g_message("initializing %s plugin", plugin->name);
 115         num_devices = plugin->init(NULL);
 116         for (i = 0; i < num_devices; i++) {
 117                 num_probes = (int)plugin->get_device_info(i, SR_DI_NUM_PROBES);
 118                 sr_device_new(plugin, i, num_probes);
 119         }
 120
 121         return num_devices;
 122 }
 123
 124 void sr_cleanup_hwplugins(void)
 125 {
 126         struct sr_device_plugin *plugin;
 127         GSList *l;
 128
 129         for (l = plugins; l; l = l->next) {
 130                 plugin = l->data;
 131                 if (plugin->cleanup)
 132                         plugin->cleanup();
 133         }
 134
 135 }
 136
 137 struct sr_device_instance *sr_device_instance_new(int index, int status,
 138                 const char *vendor, const char *model, const char *version)
 139 {
 140         struct sr_device_instance *sdi;
 141
 142         if (!(sdi = g_malloc(sizeof(struct sr_device_instance))))
 143                 return NULL;
 144
 145         sdi->index = index;
 146         sdi->status = status;
 147         sdi->instance_type = -1;
 148         sdi->vendor = vendor ? g_strdup(vendor) : NULL;
 149         sdi->model = model ? g_strdup(model) : NULL;
 150         sdi->version = version ? g_strdup(version) : NULL;
 151         sdi->priv = NULL;
 152         sdi->usb = NULL;
 153
 154         return sdi;
 155 }
 156
 157 struct sr_device_instance *sr_get_device_instance(GSList *device_instances,
 158                                                   int device_index)
 159 {
 160         struct sr_device_instance *sdi;
 161         GSList *l;
 162
 163         for (l = device_instances; l; l = l->next) {
 164                 sdi = (struct sr_device_instance *)(l->data);
 165                 if (sdi->index == device_index)
 166                         return sdi;
 167         }
 168         sr_warn("could not find device index %d instance", device_index);
 169
 170         return NULL;
 171 }
 172
 173 void sr_device_instance_free(struct sr_device_instance *sdi)
 174 {
 175         switch (sdi->instance_type) {
 176 #ifdef HAVE_LIBUSB_1_0
 177         case SR_USB_INSTANCE:
 178                 sr_usb_device_instance_free(sdi->usb);
 179                 break;
 180 #endif
 181         case SR_SERIAL_INSTANCE:
 182                 sr_serial_device_instance_free(sdi->serial);
 183                 break;
 184         default:
 185                 /* No specific type, nothing extra to free. */
 186                 break;
 187         }
 188
 189         if (sdi->priv)
 190                 g_free(sdi->priv);
 191
 192         g_free(sdi->vendor);
 193         g_free(sdi->model);
 194         g_free(sdi->version);
 195         g_free(sdi);
 196
 197 }
 198
 199 #ifdef HAVE_LIBUSB_1_0
 200
 201 struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus,
 202                         uint8_t address, struct libusb_device_handle *hdl)
 203 {
 204         struct sr_usb_device_instance *udi;
 205
 206         if (!(udi = malloc(sizeof(struct sr_usb_device_instance))))
 207                 return NULL;
 208
 209         udi->bus = bus;
 210         udi->address = address;
 211         udi->devhdl = hdl; /* TODO: Check if this is NULL? */
 212
 213         return udi;
 214 }
 215
 216 void sr_usb_device_instance_free(struct sr_usb_device_instance *usb)
 217 {
 218         /* Avoid compiler warnings. */
 219         usb = usb;
 220
 221         /* Nothing to do for this device instance type. */
 222 }
 223
 224 #endif
 225
 226 struct sr_serial_device_instance *sr_serial_device_instance_new(
 227                                                 const char *port, int fd)
 228 {
 229         struct sr_serial_device_instance *serial;
 230
 231         if (!(serial = malloc(sizeof(struct sr_serial_device_instance))))
 232                 return NULL;
 233
 234         serial->port = strdup(port);
 235         serial->fd = fd;
 236
 237         return serial;
 238 }
 239
 240 void sr_serial_device_instance_free(struct sr_serial_device_instance *serial)
 241 {
 242         free(serial->port);
 243 }
 244
 245 int sr_find_hwcap(int *capabilities, int hwcap)
 246 {
 247         int i;
 248
 249         for (i = 0; capabilities[i]; i++) {
 250                 if (capabilities[i] == hwcap)
 251                         return TRUE;
 252         }
 253
 254         return FALSE;
 255 }
 256
 257 struct sr_hwcap_option *sr_find_hwcap_option(int hwcap)
 258 {
 259         int i;
 260
 261         for (i = 0; sr_hwcap_options[i].capability; i++) {
 262                 if (sr_hwcap_options[i].capability == hwcap)
 263                         return &sr_hwcap_options[i];
 264         }
 265
 266         return NULL;
 267 }
 268
 269 /* unnecessary level of indirection follows. */
 270
 271 void sr_source_remove(int fd)
 272 {
 273         sr_session_source_remove(fd);
 274 }
 275
 276 void sr_source_add(int fd, int events, int timeout,
 277                    sr_receive_data_callback rcv_cb, void *user_data)
 278 {
 279         sr_session_source_add(fd, events, timeout, rcv_cb, user_data);
 280 }