]> sigrok.org Git - libsigrok.git/blobdiff - hwplugin.c
sr: Fix/document probe names.
[libsigrok.git] / hwplugin.c
index 6c0f06b31fefca62ac3b995d8df767de1b9df1b3..5204a0f02c7ba2341bd377495725ddb5ebb1cdc8 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * This file is part of the sigrok project.
  *
- * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 #include <dirent.h>
 #include <string.h>
 #include <glib.h>
-#include <gmodule.h>
 #include "sigrok.h"
+#include "sigrok-internal.h"
 
-source_callback_add source_cb_add = NULL;
-source_callback_remove source_cb_remove = NULL;
-
-/* the list of loaded plugins lives here */
-GSList *plugins;
+/*
+ * This enumerates which plugin capabilities correspond to user-settable
+ * options.
+ */
+/* TODO: This shouldn't be a global. */
+SR_API struct sr_hwcap_option sr_hwcap_options[] = {
+       {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "Sample rate", "samplerate"},
+       {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "Pre-trigger capture ratio", "captureratio"},
+       {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "Pattern generator mode", "patternmode"},
+       {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"},
+       {0, 0, NULL, NULL},
+};
 
-/* this enumerates which plugin capabilities correspond to user-settable options */
-struct hwcap_option hwcap_options[] = {
-       { HWCAP_SAMPLERATE, T_UINT64, "Sample rate", "samplerate" },
-       { 0, 0, NULL, NULL }
+#ifdef HAVE_LA_DEMO
+extern SR_PRIV struct sr_dev_plugin demo_plugin_info;
+#endif
+#ifdef HAVE_LA_SALEAE_LOGIC
+extern SR_PRIV struct sr_dev_plugin saleae_logic_plugin_info;
+#endif
+#ifdef HAVE_LA_OLS
+extern SR_PRIV struct sr_dev_plugin ols_plugin_info;
+#endif
+#ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
+extern SR_PRIV struct sr_dev_plugin zeroplus_logic_cube_plugin_info;
+#endif
+#ifdef HAVE_LA_ASIX_SIGMA
+extern SR_PRIV struct sr_dev_plugin asix_sigma_plugin_info;
+#endif
+#ifdef HAVE_LA_CHRONOVU_LA8
+extern SR_PRIV struct sr_dev_plugin chronovu_la8_plugin_info;
+#endif
+#ifdef HAVE_LA_LINK_MSO19
+extern SR_PRIV struct sr_dev_plugin link_mso19_plugin_info;
+#endif
+#ifdef HAVE_LA_ALSA
+extern SR_PRIV struct sr_dev_plugin alsa_plugin_info;
+#endif
+#ifdef HAVE_LA_FX2LAFW
+extern SR_PRIV struct sr_dev_plugin fx2lafw_plugin_info;
+#endif
+
+static struct sr_dev_plugin *plugins_list[] = {
+#ifdef HAVE_LA_DEMO
+       &demo_plugin_info,
+#endif
+#ifdef HAVE_LA_SALEAE_LOGIC
+       &saleae_logic_plugin_info,
+#endif
+#ifdef HAVE_LA_OLS
+       &ols_plugin_info,
+#endif
+#ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
+       &zeroplus_logic_cube_plugin_info,
+#endif
+#ifdef HAVE_LA_ASIX_SIGMA
+       &asix_sigma_plugin_info,
+#endif
+#ifdef HAVE_LA_CHRONOVU_LA8
+       &chronovu_la8_plugin_info,
+#endif
+#ifdef HAVE_LA_LINK_MSO19
+       &link_mso19_plugin_info,
+#endif
+#ifdef HAVE_LA_ALSA
+       &alsa_plugin_info,
+#endif
+#ifdef HAVE_LA_FX2LAFW
+       &fx2lafw_plugin_info,
+#endif
+       NULL,
 };
 
-extern struct device_plugin saleae_logic_plugin_info;
-extern struct device_plugin ols_plugin_info;
-extern struct device_plugin zeroplus_logic_cube_plugin_info;
+/**
+ * Return the list of loaded hardware plugins.
+ *
+ * The list of plugins is initialized from sr_init(), and can only be reset
+ * by calling sr_exit().
+ *
+ * @return Pointer to the NULL-terminated list of hardware plugin pointers.
+ */
+SR_API struct sr_dev_plugin **sr_hw_list(void)
+{
+       return plugins_list;
+}
 
-int load_hwplugins(void)
+/**
+ * Initialize a hardware plugin.
+ *
+ * The specified plugin is initialized, and all devices discovered by the
+ * plugin are instantiated.
+ *
+ * @param plugin The plugin to initialize.
+ *
+ * @return The number of devices found and instantiated by the plugin.
+ */
+SR_API int sr_hw_init(struct sr_dev_plugin *plugin)
 {
-       plugins = g_slist_append(plugins, (gpointer *)&saleae_logic_plugin_info);
-       plugins = g_slist_append(plugins, (gpointer *)&ols_plugin_info);
-       plugins = g_slist_append(plugins, (gpointer *)&zeroplus_logic_cube_plugin_info);
+       int num_devs, num_probes, i, j;
+       int num_initialized_devs = 0;
+       struct sr_dev *dev;
+       char **probe_names;
+
+       sr_dbg("initializing %s plugin", plugin->name);
+       num_devs = plugin->init(NULL);
+       for (i = 0; i < num_devs; i++) {
+               num_probes = GPOINTER_TO_INT(
+                               plugin->dev_info_get(i, SR_DI_NUM_PROBES));
+               probe_names = (char **)plugin->dev_info_get(i,
+                                                       SR_DI_PROBE_NAMES);
+
+               if (!probe_names) {
+                       sr_warn("hwplugin: %s: plugin %s does not return a "
+                               "list of probe names", __func__, plugin->name);
+                       continue;
+               }
 
-       return SIGROK_OK;
-}
+               dev = sr_dev_new(plugin, i);
+               for (j = 0; j < num_probes; j++)
+                       sr_dev_probe_add(dev, probe_names[j]);
+               num_initialized_devs++;
+       }
 
+       return num_initialized_devs;
+}
 
-GSList *list_hwplugins(void)
+SR_PRIV void sr_hw_cleanup_all(void)
 {
+       int i;
+       struct sr_dev_plugin **plugins;
 
-       return plugins;
+       plugins = sr_hw_list();
+       for (i = 0; plugins[i]; i++) {
+               if (plugins[i]->cleanup)
+                       plugins[i]->cleanup();
+       }
 }
 
-
-struct sigrok_device_instance *sigrok_device_instance_new(int index, int status,
-               char *vendor, char *model, char *version)
+SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
+               const char *vendor, const char *model, const char *version)
 {
-       struct sigrok_device_instance *sdi;
+       struct sr_dev_inst *sdi;
 
-       sdi = malloc(sizeof(struct sigrok_device_instance));
-       if(!sdi)
+       if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
+               sr_err("hwplugin: %s: sdi malloc failed", __func__);
                return NULL;
+       }
 
        sdi->index = index;
        sdi->status = status;
-       sdi->instance_type = -1;
-       sdi->vendor = strdup(vendor);
-       sdi->model = strdup(model);
-       sdi->version = strdup(version);
-       sdi->usb = NULL;
+       sdi->inst_type = -1;
+       sdi->vendor = vendor ? g_strdup(vendor) : NULL;
+       sdi->model = model ? g_strdup(model) : NULL;
+       sdi->version = version ? g_strdup(version) : NULL;
+       sdi->priv = NULL;
 
        return sdi;
 }
 
-
-struct sigrok_device_instance *get_sigrok_device_instance(GSList *device_instances, int device_index)
+SR_PRIV struct sr_dev_inst *sr_dev_inst_get(GSList *dev_insts, int dev_index)
 {
-       struct sigrok_device_instance *sdi;
+       struct sr_dev_inst *sdi;
        GSList *l;
 
-       sdi = NULL;
-       for(l = device_instances; l; l = l->next) {
-               sdi = (struct sigrok_device_instance *) (l->data);
-               if(sdi->index == device_index)
+       for (l = dev_insts; l; l = l->next) {
+               sdi = (struct sr_dev_inst *)(l->data);
+               if (sdi->index == dev_index)
                        return sdi;
        }
-       g_warning("could not find device index %d instance", device_index);
+       sr_warn("could not find device index %d instance", dev_index);
 
        return NULL;
 }
 
-
-void sigrok_device_instance_free(struct sigrok_device_instance *sdi)
+SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
 {
-
-       switch(sdi->instance_type) {
-       case USB_INSTANCE:
-               usb_device_instance_free(sdi->usb);
-               break;
-       case SERIAL_INSTANCE:
-               serial_device_instance_free(sdi->serial);
-               break;
-               /* no specific type, nothing extra to free */
-       }
-
-       free(sdi->vendor);
-       free(sdi->model);
-       free(sdi->version);
-       free(sdi);
-
+       g_free(sdi->priv);
+       g_free(sdi->vendor);
+       g_free(sdi->model);
+       g_free(sdi->version);
+       g_free(sdi);
 }
 
+#ifdef HAVE_LIBUSB_1_0
 
-struct usb_device_instance *usb_device_instance_new(uint8_t bus, uint8_t address,
-               struct libusb_device_handle *hdl)
+SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
+                       uint8_t address, struct libusb_device_handle *hdl)
 {
-       struct usb_device_instance *udi;
+       struct sr_usb_dev_inst *udi;
 
-       udi = malloc(sizeof(struct usb_device_instance));
-       if(!udi)
+       if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
+               sr_err("hwplugin: %s: udi malloc failed", __func__);
                return NULL;
+       }
 
        udi->bus = bus;
        udi->address = address;
-       udi->devhdl = hdl;
+       udi->devhdl = hdl; /* TODO: Check if this is NULL? */
 
        return udi;
 }
 
-
-void usb_device_instance_free(struct usb_device_instance *usb)
+SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
 {
+       /* Avoid compiler warnings. */
+       (void)usb;
 
-       /* nothing to do for this device instance type */
-
+       /* Nothing to do for this device instance type. */
 }
 
+#endif
 
-struct serial_device_instance *serial_device_instance_new(char *port, int fd)
+SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
+                                                         int fd)
 {
-       struct serial_device_instance *serial;
+       struct sr_serial_dev_inst *serial;
 
-       serial = malloc(sizeof(struct serial_device_instance));
-       if(!serial)
+       if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) {
+               sr_err("hwplugin: %s: serial malloc failed", __func__);
                return NULL;
+       }
 
-       serial->port = strdup(port);
+       serial->port = g_strdup(port);
        serial->fd = fd;
 
        return serial;
 }
 
-
-void serial_device_instance_free(struct serial_device_instance *serial)
+SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
 {
-
-       free(serial->port);
-
+       g_free(serial->port);
 }
 
-
-int find_hwcap(int *capabilities, int hwcap)
+/**
+ * Find out if a hardware plugin has a specific capability.
+ *
+ * @param plugin The hardware plugin in which to search for the capability.
+ * @param hwcap The capability to find in the list.
+ *
+ * @return TRUE if found, FALSE otherwise.
+ */
+SR_API gboolean sr_hw_has_hwcap(struct sr_dev_plugin *plugin, int hwcap)
 {
-       int i;
+       int *hwcaps, i;
 
-       for(i = 0; capabilities[i]; i++)
-               if(capabilities[i] == hwcap)
+       hwcaps = plugin->hwcap_get_all();
+       for (i = 0; hwcaps[i]; i++) {
+               if (hwcaps[i] == hwcap)
                        return TRUE;
+       }
 
        return FALSE;
 }
 
-
-struct hwcap_option *find_hwcap_option(int hwcap)
+/**
+ * Get a hardware plugin capability option.
+ *
+ * @param hwcap The capability to get.
+ *
+ * @return A pointer to a struct with information about the parameter, or NULL
+ *         if the capability was not found.
+ */
+SR_API struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap)
 {
-       struct hwcap_option *hwo;
        int i;
 
-       hwo = NULL;
-       for(i = 0; hwcap_options[i].capability; i++)
-       {
-               if(hwcap_options[i].capability == hwcap)
-               {
-                       hwo = &hwcap_options[i];
-                       break;
-               }
+       for (i = 0; sr_hwcap_options[i].hwcap; i++) {
+               if (sr_hwcap_options[i].hwcap == hwcap)
+                       return &sr_hwcap_options[i];
        }
 
-       return hwo;
+       return NULL;
 }
 
+/* unnecessary level of indirection follows. */
 
-void source_remove(int fd)
+SR_PRIV void sr_source_remove(int fd)
 {
-
-       if(source_cb_remove)
-               source_cb_remove(fd);
-
+       sr_session_source_remove(fd);
 }
 
-
-void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb, void *user_data)
+SR_PRIV void sr_source_add(int fd, int events, int timeout,
+                  sr_receive_data_callback rcv_cb, void *user_data)
 {
-
-       if(source_cb_add)
-               source_cb_add(fd, events, timeout, rcv_cb, user_data);
-
+       sr_session_source_add(fd, events, timeout, rcv_cb, user_data);
 }
-
-
-
-