]> sigrok.org Git - libsigrok.git/blobdiff - hwplugin.c
sr/cli/gtk/qt: s/device/dev/ in many places.
[libsigrok.git] / hwplugin.c
index 8d08e342b703a317358babe8c122704882b7ce7a..1248bd773c238c4787a2c8270c0926e40a663e22 100644 (file)
@@ -43,32 +43,32 @@ SR_API struct sr_hwcap_option sr_hwcap_options[] = {
 };
 
 #ifdef HAVE_LA_DEMO
-extern struct sr_device_plugin demo_plugin_info;
+extern struct sr_dev_plugin demo_plugin_info;
 #endif
 #ifdef HAVE_LA_SALEAE_LOGIC
-extern struct sr_device_plugin saleae_logic_plugin_info;
+extern struct sr_dev_plugin saleae_logic_plugin_info;
 #endif
 #ifdef HAVE_LA_OLS
-extern struct sr_device_plugin ols_plugin_info;
+extern struct sr_dev_plugin ols_plugin_info;
 #endif
 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
-extern struct sr_device_plugin zeroplus_logic_cube_plugin_info;
+extern struct sr_dev_plugin zeroplus_logic_cube_plugin_info;
 #endif
 #ifdef HAVE_LA_ASIX_SIGMA
-extern struct sr_device_plugin asix_sigma_plugin_info;
+extern struct sr_dev_plugin asix_sigma_plugin_info;
 #endif
 #ifdef HAVE_LA_CHRONOVU_LA8
-extern SR_PRIV struct device_plugin chronovu_la8_plugin_info;
+extern SR_PRIV struct dev_plugin chronovu_la8_plugin_info;
 #endif
 #ifdef HAVE_LA_LINK_MSO19
-extern struct sr_device_plugin link_mso19_plugin_info;
+extern struct sr_dev_plugin link_mso19_plugin_info;
 #endif
 #ifdef HAVE_LA_ALSA
-extern struct sr_device_plugin alsa_plugin_info;
+extern struct sr_dev_plugin alsa_plugin_info;
 #endif
 
 /* TODO: No linked list needed, this can be a simple array. */
-SR_PRIV int load_hwplugins(void)
+SR_PRIV int sr_hw_load_all(void)
 {
 #ifdef HAVE_LA_DEMO
        plugins = g_slist_append(plugins, (gpointer *)&demo_plugin_info);
@@ -101,16 +101,15 @@ SR_PRIV int load_hwplugins(void)
 }
 
 /**
- * Returns the list of loaded hardware plugins.
+ * 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 A GSList of pointers to loaded plugins.
  */
-SR_API GSList *sr_hwplugins_list(void)
+SR_API GSList *sr_hw_list(void)
 {
-
        return plugins;
 }
 
@@ -124,19 +123,19 @@ SR_API GSList *sr_hwplugins_list(void)
  *
  * @return The number of devices found and instantiated by the plugin.
  */
-SR_API int sr_hwplugin_init(struct sr_device_plugin *plugin)
+SR_API int sr_hw_init(struct sr_dev_plugin *plugin)
 {
-       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++) {
+       num_devs = plugin->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,
+                               plugin->get_dev_info(i, SR_DI_NUM_PROBES));
+               probe_names = (char **)plugin->get_dev_info(i,
                                                        SR_DI_PROBE_NAMES);
 
                if (!probe_names) {
@@ -145,18 +144,18 @@ SR_API int sr_hwplugin_init(struct sr_device_plugin *plugin)
                        continue;
                }
 
-               device = sr_dev_new(plugin, i);
+               dev = sr_dev_new(plugin, i);
                for (j = 0; j < num_probes; j++)
-                       sr_dev_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_hwplugins_cleanup(void)
+SR_PRIV void sr_hw_cleanup_all(void)
 {
-       struct sr_device_plugin *plugin;
+       struct sr_dev_plugin *plugin;
        GSList *l;
 
        for (l = plugins; l; l = l->next) {
@@ -166,12 +165,12 @@ SR_PRIV void sr_hwplugins_cleanup(void)
        }
 }
 
-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)))) {
+       if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
                sr_err("hwplugin: %s: sdi malloc failed", __func__);
                return NULL;
        }
@@ -187,23 +186,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,12 +212,12 @@ 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)))) {
+       if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
                sr_err("hwplugin: %s: udi malloc failed", __func__);
                return NULL;
        }
@@ -231,7 +229,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,12 +239,12 @@ 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)))) {
+       if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) {
                sr_err("hwplugin: %s: serial malloc failed", __func__);
                return NULL;
        }
@@ -257,25 +255,24 @@ 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 plugin has a specific capability.
  *
- * @param capabilities A NULL-terminated integer array of capabilities, as
- * returned by a plugin's get_capabilities() function.
+ * @param plugin The hardware plugin 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_plugin *plugin, int hwcap)
 {
-       int i;
+       int *capabilities, i;
 
+       capabilities = plugin->get_capabilities();
        for (i = 0; capabilities[i]; i++) {
                if (capabilities[i] == hwcap)
                        return TRUE;
@@ -285,14 +282,14 @@ SR_API gboolean sr_has_hwcap(int *capabilities, int hwcap)
 }
 
 /**
- * Find a hardware plugin capability option parameter structure.
+ * Get a hardware plugin 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;