sr: rename more functions to sr_thing_action format

[libsigrok.git] / hwplugin.c

diff --git a/hwplugin.c b/hwplugin.c
index 06cd96905397c4c42d9ca2f97947a4fa8d74463c..6caa39dba9845c378e1b7265ae192c55d82be729 100644 (file)
--- a/hwplugin.c
+++ b/hwplugin.c
@@ -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
@@ -68,7 +68,7 @@ extern struct sr_device_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_hwplugins_load(void)
 {
 #ifdef HAVE_LA_DEMO
        plugins = g_slist_append(plugins, (gpointer *)&demo_plugin_info);
@@ -100,12 +100,31 @@ SR_PRIV int load_hwplugins(void)
        return SR_OK;
 }
 
-SR_API GSList *sr_list_hwplugins(void)
+/**
+ * Returns 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)
 {
+
        return plugins;
 }
 
-SR_API int sr_init_hwplugins(struct sr_device_plugin *plugin)
+/**
+ * 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_hwplugin_init(struct sr_device_plugin *plugin)
 {
        int num_devices, num_probes, i, j;
        int num_initialized_devices = 0;
@@ -126,16 +145,16 @@ SR_API int sr_init_hwplugins(struct sr_device_plugin *plugin)
                        continue;
                }
 
-               device = sr_device_new(plugin, i);
+               device = sr_dev_new(plugin, i);
                for (j = 0; j < num_probes; j++)
-                       sr_device_probe_add(device, probe_names[j]);
+                       sr_dev_probe_add(device, probe_names[j]);
                num_initialized_devices++;
        }
 
        return num_initialized_devices;
 }
 
-SR_PRIV void sr_cleanup_hwplugins(void)
+SR_PRIV void sr_hwplugins_cleanup(void)
 {
        struct sr_device_plugin *plugin;
        GSList *l;
@@ -147,7 +166,7 @@ SR_PRIV void sr_cleanup_hwplugins(void)
        }
 }
 
-SR_PRIV struct sr_device_instance *sr_device_instance_new(int index, int status,
+SR_PRIV struct sr_device_instance *sr_dev_inst_new(int index, int status,
                const char *vendor, const char *model, const char *version)
 {
        struct sr_device_instance *sdi;
@@ -168,7 +187,7 @@ 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(
+SR_PRIV struct sr_device_instance *sr_dev_inst_get(
                GSList *device_instances, int device_index)
 {
        struct sr_device_instance *sdi;
@@ -184,7 +203,7 @@ SR_PRIV struct sr_device_instance *sr_get_device_instance(
        return NULL;
 }
 
-SR_PRIV void sr_device_instance_free(struct sr_device_instance *sdi)
+SR_PRIV void sr_dev_inst_free(struct sr_device_instance *sdi)
 {
        g_free(sdi->priv);
        g_free(sdi->vendor);
@@ -195,7 +214,7 @@ 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_device_instance *sr_usb_dev_inst_new(uint8_t bus,
                        uint8_t address, struct libusb_device_handle *hdl)
 {
        struct sr_usb_device_instance *udi;
@@ -212,7 +231,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_device_instance *usb)
 {
        /* Avoid compiler warnings. */
        (void)usb;
@@ -222,7 +241,7 @@ 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(
+SR_PRIV struct sr_serial_device_instance *sr_serial_dev_inst_new(
                                                const char *port, int fd)
 {
        struct sr_serial_device_instance *serial;
@@ -238,16 +257,26 @@ SR_PRIV struct sr_serial_device_instance *sr_serial_device_instance_new(
        return serial;
 }
 
-SR_PRIV void sr_serial_device_instance_free(
+SR_PRIV void sr_serial_dev_inst_free(
                struct sr_serial_device_instance *serial)
 {
        g_free(serial->port);
 }
 
-SR_API int sr_find_hwcap(int *capabilities, int hwcap)
+/**
+ * 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 hwcap The capability to find in the list.
+ *
+ * @return TRUE if found, FALSE otherwise.
+ */
+SR_API gboolean sr_hwplugin_has_hwcap(struct sr_device_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;
@@ -256,7 +285,15 @@ SR_API int sr_find_hwcap(int *capabilities, int hwcap)
        return FALSE;
 }
 
-SR_API struct sr_hwcap_option *sr_find_hwcap_option(int hwcap)
+/**
+ * Find a hardware plugin capability option.
+ *
+ * @param hwcap The capability to find
+ *
+ * @return A struct with information about the parameter, or NULL
+ * if not found.
+ */
+SR_API struct sr_hwcap_option *sr_hwplugins_hwcap_get(int hwcap)
 {
        int i;