X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hwplugin.c;h=4ad7502b7705068ec241f4ce5c37696944f2e862;hb=c73d2ea421c2b425c3f0ae33bce2bfd0c448ca5f;hp=4e13ed1f04ae06ef10265332cee3035b9af3edde;hpb=ca070ed9a0237e5cea10e5dd974e06da62de890d;p=libsigrok.git

diff --git a/hwplugin.c b/hwplugin.c
index 4e13ed1f..4ad7502b 100644
--- 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
@@ -100,12 +100,31 @@ SR_PRIV int load_hwplugins(void)
 	return SR_OK;
 }
 
+/**
+ * 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_list_hwplugins(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_init_hwplugin(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_API void sr_cleanup_hwplugins(void)
+SR_PRIV void sr_cleanup_hwplugins(void)
 {
 	struct sr_device_plugin *plugin;
 	GSList *l;
@@ -147,13 +166,15 @@ SR_API void sr_cleanup_hwplugins(void)
 	}
 }
 
-SR_API struct sr_device_instance *sr_device_instance_new(int index, int status,
+SR_PRIV struct sr_device_instance *sr_device_instance_new(int index, int status,
 		const char *vendor, const char *model, const char *version)
 {
 	struct sr_device_instance *sdi;
 
-	if (!(sdi = g_malloc(sizeof(struct sr_device_instance))))
+	if (!(sdi = g_try_malloc(sizeof(struct sr_device_instance)))) {
+		sr_err("hwplugin: %s: sdi malloc failed", __func__);
 		return NULL;
+	}
 
 	sdi->index = index;
 	sdi->status = status;
@@ -166,7 +187,7 @@ SR_API struct sr_device_instance *sr_device_instance_new(int index, int status,
 	return sdi;
 }
 
-SR_API struct sr_device_instance *sr_get_device_instance(
+SR_PRIV struct sr_device_instance *sr_get_device_instance(
 		GSList *device_instances, int device_index)
 {
 	struct sr_device_instance *sdi;
@@ -182,7 +203,7 @@ SR_API struct sr_device_instance *sr_get_device_instance(
 	return NULL;
 }
 
-SR_API void sr_device_instance_free(struct sr_device_instance *sdi)
+SR_PRIV void sr_device_instance_free(struct sr_device_instance *sdi)
 {
 	g_free(sdi->priv);
 	g_free(sdi->vendor);
@@ -198,8 +219,10 @@ SR_PRIV struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus,
 {
 	struct sr_usb_device_instance *udi;
 
-	if (!(udi = malloc(sizeof(struct sr_usb_device_instance))))
+	if (!(udi = g_try_malloc(sizeof(struct sr_usb_device_instance)))) {
+		sr_err("hwplugin: %s: udi malloc failed", __func__);
 		return NULL;
+	}
 
 	udi->bus = bus;
 	udi->address = address;
@@ -223,10 +246,12 @@ SR_PRIV struct sr_serial_device_instance *sr_serial_device_instance_new(
 {
 	struct sr_serial_device_instance *serial;
 
-	if (!(serial = malloc(sizeof(struct sr_serial_device_instance))))
+	if (!(serial = g_try_malloc(sizeof(struct sr_serial_device_instance)))) {
+		sr_err("hwplugin: %s: serial malloc failed", __func__);
 		return NULL;
+	}
 
-	serial->port = strdup(port);
+	serial->port = g_strdup(port);
 	serial->fd = fd;
 
 	return serial;
@@ -235,10 +260,19 @@ SR_PRIV struct sr_serial_device_instance *sr_serial_device_instance_new(
 SR_PRIV void sr_serial_device_instance_free(
 		struct sr_serial_device_instance *serial)
 {
-	free(serial->port);
+	g_free(serial->port);
 }
 
-SR_API int sr_find_hwcap(int *capabilities, int hwcap)
+/**
+ * Find out if a list of hardware plugin capabilities has a specific cap.
+ *
+ * @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 Returns TRUE if found, FALSE otherwise.
+ */
+SR_API gboolean sr_has_hwcap(int *capabilities, int hwcap)
 {
 	int i;
 
@@ -250,6 +284,14 @@ SR_API int sr_find_hwcap(int *capabilities, int hwcap)
 	return FALSE;
 }
 
+/**
+ * Find a hardware plugin capability option parameter structure.
+ *
+ * @param hwcap The capability to find
+ *
+ * @return Returns a struct with information about the parameter, or NULL
+ * if not found.
+ */
 SR_API struct sr_hwcap_option *sr_find_hwcap_option(int hwcap)
 {
 	int i;
@@ -264,12 +306,12 @@ SR_API struct sr_hwcap_option *sr_find_hwcap_option(int hwcap)
 
 /* unnecessary level of indirection follows. */
 
-void sr_source_remove(int fd)
+SR_PRIV void sr_source_remove(int fd)
 {
 	sr_session_source_remove(fd);
 }
 
-void sr_source_add(int fd, int events, int timeout,
+SR_PRIV void sr_source_add(int fd, int events, int timeout,
 		   sr_receive_data_callback rcv_cb, void *user_data)
 {
 	sr_session_source_add(fd, events, timeout, rcv_cb, user_data);