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 "config.h"
  28
  29 source_callback_add source_cb_add = NULL;
  30 source_callback_remove source_cb_remove = NULL;
  31
  32 /* The list of loaded plugins lives here. */
  33 GSList *plugins;
  34
  35 /*
  36  * This enumerates which plugin capabilities correspond to user-settable
  37  * options.
  38  */
  39 struct hwcap_option hwcap_options[] = {
  40         {HWCAP_SAMPLERATE, T_UINT64, "Sample rate", "samplerate"},
  41         {HWCAP_CAPTURE_RATIO, T_UINT64, "Pre-trigger capture ratio", "captureratio"},
  42         {0, 0, NULL, NULL},
  43 };
  44
  45 extern struct device_plugin demo_plugin_info;
  46 #ifdef HAVE_LA_SALEAE_LOGIC
  47 extern struct device_plugin saleae_logic_plugin_info;
  48 #endif
  49 #ifdef HAVE_LA_OLS
  50 extern struct device_plugin ols_plugin_info;
  51 #endif
  52 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
  53 extern struct device_plugin zeroplus_logic_cube_plugin_info;
  54 #endif
  55 #ifdef HAVE_LA_ASIX_SIGMA
  56 extern struct device_plugin asix_sigma_plugin_info;
  57 #endif
  58 #ifdef HAVE_LA_LINK_MSO19
  59 extern struct device_plugin link_mso19_plugin_info;
  60 #endif
  61
  62
  63 /* TODO: No linked list needed, this can be a simple array. */
  64 int load_hwplugins(void)
  65 {
  66         plugins = g_slist_append(plugins, (gpointer *)&demo_plugin_info);
  67 #ifdef HAVE_LA_SALEAE_LOGIC
  68         plugins =
  69             g_slist_append(plugins, (gpointer *)&saleae_logic_plugin_info);
  70 #endif
  71 #ifdef HAVE_LA_OLS
  72         plugins = g_slist_append(plugins, (gpointer *)&ols_plugin_info);
  73 #endif
  74 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
  75         plugins = g_slist_append(plugins,
  76                            (gpointer *)&zeroplus_logic_cube_plugin_info);
  77 #endif
  78 #ifdef HAVE_LA_ASIX_SIGMA
  79         plugins = g_slist_append(plugins, (gpointer *)&asix_sigma_plugin_info);
  80 #endif
  81 #ifdef HAVE_LA_LINK_MSO19
  82         plugins = g_slist_append(plugins, (gpointer *)&link_mso19_plugin_info);
  83 #endif
  84
  85         return SIGROK_OK;
  86 }
  87
  88 GSList *list_hwplugins(void)
  89 {
  90         return plugins;
  91 }
  92
  93 struct sigrok_device_instance *sigrok_device_instance_new(int index, int status,
  94                 const char *vendor, const char *model, const char *version)
  95 {
  96         struct sigrok_device_instance *sdi;
  97
  98         if (!(sdi = malloc(sizeof(struct sigrok_device_instance))))
  99                 return NULL;
 100
 101         sdi->index = index;
 102         sdi->status = status;
 103         sdi->instance_type = -1;
 104         sdi->vendor = strdup(vendor);
 105         sdi->model = strdup(model);
 106         sdi->version = strdup(version);
 107         sdi->priv = NULL;
 108         sdi->usb = NULL;
 109
 110         return sdi;
 111 }
 112
 113 struct sigrok_device_instance *get_sigrok_device_instance(
 114                                 GSList *device_instances, int device_index)
 115 {
 116         struct sigrok_device_instance *sdi;
 117         GSList *l;
 118
 119         for (l = device_instances; l; l = l->next) {
 120                 sdi = (struct sigrok_device_instance *)(l->data);
 121                 if (sdi->index == device_index)
 122                         return sdi;
 123         }
 124         g_warning("could not find device index %d instance", device_index);
 125
 126         return NULL;
 127 }
 128
 129 void sigrok_device_instance_free(struct sigrok_device_instance *sdi)
 130 {
 131         switch (sdi->instance_type) {
 132         case USB_INSTANCE:
 133                 usb_device_instance_free(sdi->usb);
 134                 break;
 135         case SERIAL_INSTANCE:
 136                 serial_device_instance_free(sdi->serial);
 137                 break;
 138         default:
 139                 /* No specific type, nothing extra to free. */
 140                 break;
 141         }
 142
 143         free(sdi->vendor);
 144         free(sdi->model);
 145         free(sdi->version);
 146         free(sdi);
 147 }
 148
 149 struct usb_device_instance *usb_device_instance_new(uint8_t bus,
 150                         uint8_t address, struct libusb_device_handle *hdl)
 151 {
 152         struct usb_device_instance *udi;
 153
 154         if (!(udi = malloc(sizeof(struct usb_device_instance))))
 155                 return NULL;
 156
 157         udi->bus = bus;
 158         udi->address = address;
 159         udi->devhdl = hdl; /* TODO: Check if this is NULL? */
 160
 161         return udi;
 162 }
 163
 164 void usb_device_instance_free(struct usb_device_instance *usb)
 165 {
 166         /* QUICK HACK */
 167         usb = usb;
 168
 169         /* Nothing to do for this device instance type. */
 170 }
 171
 172 struct serial_device_instance *serial_device_instance_new(
 173                                                 const char *port, int fd)
 174 {
 175         struct serial_device_instance *serial;
 176
 177         if (!(serial = malloc(sizeof(struct serial_device_instance))))
 178                 return NULL;
 179
 180         serial->port = strdup(port);
 181         serial->fd = fd;
 182
 183         return serial;
 184 }
 185
 186 void serial_device_instance_free(struct serial_device_instance *serial)
 187 {
 188         free(serial->port);
 189 }
 190
 191 int find_hwcap(int *capabilities, int hwcap)
 192 {
 193         int i;
 194
 195         for (i = 0; capabilities[i]; i++) {
 196                 if (capabilities[i] == hwcap)
 197                         return TRUE;
 198         }
 199
 200         return FALSE;
 201 }
 202
 203 struct hwcap_option *find_hwcap_option(int hwcap)
 204 {
 205         int i;
 206
 207         for (i = 0; hwcap_options[i].capability; i++) {
 208                 if (hwcap_options[i].capability == hwcap)
 209                         return &hwcap_options[i];
 210         }
 211
 212         return NULL;
 213 }
 214
 215 void source_remove(int fd)
 216 {
 217         if (source_cb_remove)
 218                 source_cb_remove(fd);
 219 }
 220
 221 void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb,
 222                 void *user_data)
 223 {
 224         if (source_cb_add)
 225                 source_cb_add(fd, events, timeout, rcv_cb, user_data);
 226 }