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