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