]> sigrok.org Git - libsigrok.git/blobdiff - hwplugin.c
sr/cli/gtk/qt/: s/plugin/driver/.
[libsigrok.git] / hwplugin.c
index dfee3814bd32e4ce6533db4fc052b04fa5d42b71..c68d6e0c2167347d68f30283b8f065066f741606 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 "sigrok.h"
 #include "sigrok-internal.h"
 
-/* The list of loaded plugins lives here. */
-static GSList *plugins;
-
 /*
- * This enumerates which plugin capabilities correspond to user-settable
+ * This enumerates which driver capabilities correspond to user-settable
  * options.
  */
 /* TODO: This shouldn't be a global. */
@@ -43,142 +40,142 @@ SR_API struct sr_hwcap_option sr_hwcap_options[] = {
 };
 
 #ifdef HAVE_LA_DEMO
-extern struct sr_device_plugin demo_plugin_info;
+extern SR_PRIV struct sr_dev_driver demo_driver_info;
 #endif
 #ifdef HAVE_LA_SALEAE_LOGIC
-extern struct sr_device_plugin saleae_logic_plugin_info;
+extern SR_PRIV struct sr_dev_driver saleae_logic_driver_info;
 #endif
 #ifdef HAVE_LA_OLS
-extern struct sr_device_plugin ols_plugin_info;
+extern SR_PRIV struct sr_dev_driver ols_driver_info;
 #endif
 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
-extern struct sr_device_plugin zeroplus_logic_cube_plugin_info;
+extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
 #endif
 #ifdef HAVE_LA_ASIX_SIGMA
-extern struct sr_device_plugin asix_sigma_plugin_info;
+extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
 #endif
 #ifdef HAVE_LA_CHRONOVU_LA8
-extern SR_PRIV struct device_plugin chronovu_la8_plugin_info;
+extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
 #endif
 #ifdef HAVE_LA_LINK_MSO19
-extern struct sr_device_plugin link_mso19_plugin_info;
+extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
 #endif
 #ifdef HAVE_LA_ALSA
-extern struct sr_device_plugin alsa_plugin_info;
+extern SR_PRIV struct sr_dev_driver alsa_driver_info;
+#endif
+#ifdef HAVE_LA_FX2LAFW
+extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 #endif
 
-/* TODO: No linked list needed, this can be a simple array. */
-SR_PRIV int load_hwplugins(void)
-{
+static struct sr_dev_driver *drivers_list[] = {
 #ifdef HAVE_LA_DEMO
-       plugins = g_slist_append(plugins, (gpointer *)&demo_plugin_info);
+       &demo_driver_info,
 #endif
 #ifdef HAVE_LA_SALEAE_LOGIC
-       plugins =
-           g_slist_append(plugins, (gpointer *)&saleae_logic_plugin_info);
+       &saleae_logic_driver_info,
 #endif
 #ifdef HAVE_LA_OLS
-       plugins = g_slist_append(plugins, (gpointer *)&ols_plugin_info);
+       &ols_driver_info,
 #endif
 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
-       plugins = g_slist_append(plugins,
-                          (gpointer *)&zeroplus_logic_cube_plugin_info);
+       &zeroplus_logic_cube_driver_info,
 #endif
 #ifdef HAVE_LA_ASIX_SIGMA
-       plugins = g_slist_append(plugins, (gpointer *)&asix_sigma_plugin_info);
+       &asix_sigma_driver_info,
 #endif
 #ifdef HAVE_LA_CHRONOVU_LA8
-       plugins = g_slist_append(plugins, (gpointer *)&chronovu_la8_plugin_info);
+       &chronovu_la8_driver_info,
 #endif
 #ifdef HAVE_LA_LINK_MSO19
-       plugins = g_slist_append(plugins, (gpointer *)&link_mso19_plugin_info);
+       &link_mso19_driver_info,
 #endif
 #ifdef HAVE_LA_ALSA
-       plugins = g_slist_append(plugins, (gpointer *)&alsa_plugin_info);
+       &alsa_driver_info,
 #endif
-
-       return SR_OK;
-}
+#ifdef HAVE_LA_FX2LAFW
+       &fx2lafw_driver_info,
+#endif
+       NULL,
+};
 
 /**
- * Returns the list of loaded hardware plugins.
+ * Return the list of loaded hardware drivers.
  *
- * The list of plugins is initialized from sr_init(), and can only be reset
+ * The list of drivers is initialized from sr_init(), and can only be reset
  * by calling sr_exit().
  *
- * @return A GSList of pointers to loaded plugins.
+ * @return Pointer to the NULL-terminated list of hardware driver pointers.
  */
-SR_API GSList *sr_list_hwplugins(void)
+SR_API struct sr_dev_driver **sr_hw_list(void)
 {
-
-       return plugins;
+       return drivers_list;
 }
 
 /**
- * Initialize a hardware plugin.
+ * Initialize a hardware driver.
  *
- * The specified plugin is initialized, and all devices discovered by the
- * plugin are instantiated.
+ * The specified driver is initialized, and all devices discovered by the
+ * driver are instantiated.
  *
- * @param plugin The plugin to initialize.
+ * @param driver The driver to initialize.
  *
- * @return The number of devices found and instantiated by the plugin.
+ * @return The number of devices found and instantiated by the driver.
  */
-SR_API int sr_init_hwplugin(struct sr_device_plugin *plugin)
+SR_API int sr_hw_init(struct sr_dev_driver *driver)
 {
-       int num_devices, num_probes, i, j;
-       int num_initialized_devices = 0;
-       struct sr_device *device;
+       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_devices = plugin->init(NULL);
-       for (i = 0; i < num_devices; i++) {
+       sr_dbg("initializing %s driver", driver->name);
+       num_devs = driver->init(NULL);
+       for (i = 0; i < num_devs; i++) {
                num_probes = GPOINTER_TO_INT(
-                               plugin->get_device_info(i, SR_DI_NUM_PROBES));
-               probe_names = (char **)plugin->get_device_info(i,
+                               driver->dev_info_get(i, SR_DI_NUM_PROBES));
+               probe_names = (char **)driver->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);
+                       sr_warn("hwdriver: %s: driver %s does not return a "
+                               "list of probe names", __func__, driver->name);
                        continue;
                }
 
-               device = sr_device_new(plugin, i);
+               dev = sr_dev_new(driver, i);
                for (j = 0; j < num_probes; j++)
-                       sr_device_probe_add(device, probe_names[j]);
-               num_initialized_devices++;
+                       sr_dev_probe_add(dev, probe_names[j]);
+               num_initialized_devs++;
        }
 
-       return num_initialized_devices;
+       return num_initialized_devs;
 }
 
-SR_PRIV void sr_cleanup_hwplugins(void)
+SR_PRIV void sr_hw_cleanup_all(void)
 {
-       struct sr_device_plugin *plugin;
-       GSList *l;
+       int i;
+       struct sr_dev_driver **drivers;
 
-       for (l = plugins; l; l = l->next) {
-               plugin = l->data;
-               if (plugin->cleanup)
-                       plugin->cleanup();
+       drivers = sr_hw_list();
+       for (i = 0; drivers[i]; i++) {
+               if (drivers[i]->cleanup)
+                       drivers[i]->cleanup();
        }
 }
 
-SR_PRIV struct sr_device_instance *sr_device_instance_new(int index, int status,
+SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
                const char *vendor, const char *model, const char *version)
 {
-       struct sr_device_instance *sdi;
+       struct sr_dev_inst *sdi;
 
-       if (!(sdi = g_try_malloc(sizeof(struct sr_device_instance)))) {
-               sr_err("hwplugin: %s: sdi malloc failed", __func__);
+       if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
+               sr_err("hwdriver: %s: sdi malloc failed", __func__);
                return NULL;
        }
 
        sdi->index = index;
        sdi->status = status;
-       sdi->instance_type = -1;
+       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;
@@ -187,23 +184,22 @@ SR_PRIV struct sr_device_instance *sr_device_instance_new(int index, int status,
        return sdi;
 }
 
-SR_PRIV struct sr_device_instance *sr_get_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 sr_device_instance *sdi;
+       struct sr_dev_inst *sdi;
        GSList *l;
 
-       for (l = device_instances; l; l = l->next) {
-               sdi = (struct sr_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;
        }
-       sr_warn("could not find device index %d instance", device_index);
+       sr_warn("could not find device index %d instance", dev_index);
 
        return NULL;
 }
 
-SR_PRIV void sr_device_instance_free(struct sr_device_instance *sdi)
+SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
 {
        g_free(sdi->priv);
        g_free(sdi->vendor);
@@ -214,13 +210,13 @@ SR_PRIV void sr_device_instance_free(struct sr_device_instance *sdi)
 
 #ifdef HAVE_LIBUSB_1_0
 
-SR_PRIV struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus,
+SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
                        uint8_t address, struct libusb_device_handle *hdl)
 {
-       struct sr_usb_device_instance *udi;
+       struct sr_usb_dev_inst *udi;
 
-       if (!(udi = g_try_malloc(sizeof(struct sr_usb_device_instance)))) {
-               sr_err("hwplugin: %s: udi malloc failed", __func__);
+       if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
+               sr_err("hwdriver: %s: udi malloc failed", __func__);
                return NULL;
        }
 
@@ -231,7 +227,7 @@ SR_PRIV struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus,
        return udi;
 }
 
-SR_PRIV void sr_usb_device_instance_free(struct sr_usb_device_instance *usb)
+SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
 {
        /* Avoid compiler warnings. */
        (void)usb;
@@ -241,13 +237,13 @@ SR_PRIV void sr_usb_device_instance_free(struct sr_usb_device_instance *usb)
 
 #endif
 
-SR_PRIV struct sr_serial_device_instance *sr_serial_device_instance_new(
-                                               const char *port, int fd)
+SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
+                                                         int fd)
 {
-       struct sr_serial_device_instance *serial;
+       struct sr_serial_dev_inst *serial;
 
-       if (!(serial = g_try_malloc(sizeof(struct sr_serial_device_instance)))) {
-               sr_err("hwplugin: %s: serial malloc failed", __func__);
+       if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) {
+               sr_err("hwdriver: %s: serial malloc failed", __func__);
                return NULL;
        }
 
@@ -257,27 +253,26 @@ SR_PRIV struct sr_serial_device_instance *sr_serial_device_instance_new(
        return serial;
 }
 
-SR_PRIV void sr_serial_device_instance_free(
-               struct sr_serial_device_instance *serial)
+SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
 {
        g_free(serial->port);
 }
 
 /**
- * Find out if a list of hardware plugin capabilities has a specific cap.
+ * Find out if a hardware driver has a specific capability.
  *
- * @param capabilities A NULL-terminated integer array of capabilities, as
- * returned by a plugin's get_capabilities() function.
+ * @param driver The hardware driver in which to search for the capability.
  * @param hwcap The capability to find in the list.
  *
- * @return Returns TRUE if found, FALSE otherwise.
+ * @return TRUE if found, FALSE otherwise.
  */
-SR_API gboolean sr_has_hwcap(int *capabilities, int hwcap)
+SR_API gboolean sr_hw_has_hwcap(struct sr_dev_driver *driver, int hwcap)
 {
-       int i;
+       int *hwcaps, i;
 
-       for (i = 0; capabilities[i]; i++) {
-               if (capabilities[i] == hwcap)
+       hwcaps = driver->hwcap_get_all();
+       for (i = 0; hwcaps[i]; i++) {
+               if (hwcaps[i] == hwcap)
                        return TRUE;
        }
 
@@ -285,19 +280,19 @@ SR_API gboolean sr_has_hwcap(int *capabilities, int hwcap)
 }
 
 /**
- * Find a hardware plugin capability option parameter structure.
+ * Get a hardware driver capability option.
  *
- * @param hwcap The capability to find
+ * @param hwcap The capability to get.
  *
- * @return Returns a struct with information about the parameter, or NULL
- * if not found.
+ * @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_find_hwcap_option(int hwcap)
+SR_API struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap)
 {
        int i;
 
-       for (i = 0; sr_hwcap_options[i].capability; i++) {
-               if (sr_hwcap_options[i].capability == hwcap)
+       for (i = 0; sr_hwcap_options[i].hwcap; i++) {
+               if (sr_hwcap_options[i].hwcap == hwcap)
                        return &sr_hwcap_options[i];
        }