X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hwplugin.c;h=4ad7502b7705068ec241f4ce5c37696944f2e862;hb=c73d2ea421c2b425c3f0ae33bce2bfd0c448ca5f;hp=23bbef4455463503ceb49f35bde6659b8e3a06b2;hpb=66410a8617185da7abf4ca21da99e934b22351bb;p=libsigrok.git diff --git a/hwplugin.c b/hwplugin.c index 23bbef44..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 + * Copyright (C) 2010-2012 Bert Vermeulen * * 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 @@ -17,7 +17,6 @@ * along with this program. If not, see . */ -#include "config.h" #include #include #include @@ -35,7 +34,7 @@ static GSList *plugins; * options. */ /* TODO: This shouldn't be a global. */ -struct sr_hwcap_option sr_hwcap_options[] = { +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"}, @@ -59,7 +58,7 @@ extern struct sr_device_plugin zeroplus_logic_cube_plugin_info; extern struct sr_device_plugin asix_sigma_plugin_info; #endif #ifdef HAVE_LA_CHRONOVU_LA8 -extern struct device_plugin chronovu_la8_plugin_info; +extern SR_PRIV struct device_plugin chronovu_la8_plugin_info; #endif #ifdef HAVE_LA_LINK_MSO19 extern struct sr_device_plugin link_mso19_plugin_info; @@ -69,7 +68,7 @@ extern struct sr_device_plugin alsa_plugin_info; #endif /* TODO: No linked list needed, this can be a simple array. */ -int load_hwplugins(void) +SR_PRIV int load_hwplugins(void) { #ifdef HAVE_LA_DEMO plugins = g_slist_append(plugins, (gpointer *)&demo_plugin_info); @@ -101,12 +100,31 @@ int load_hwplugins(void) return SR_OK; } -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_list_hwplugins(void) { + return plugins; } -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; @@ -127,16 +145,16 @@ 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; } -void sr_cleanup_hwplugins(void) +SR_PRIV void sr_cleanup_hwplugins(void) { struct sr_device_plugin *plugin; GSList *l; @@ -148,13 +166,15 @@ void sr_cleanup_hwplugins(void) } } -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; @@ -163,13 +183,12 @@ struct sr_device_instance *sr_device_instance_new(int index, int status, sdi->model = model ? g_strdup(model) : NULL; sdi->version = version ? g_strdup(version) : NULL; sdi->priv = NULL; - sdi->usb = NULL; return sdi; } -struct sr_device_instance *sr_get_device_instance(GSList *device_instances, - int device_index) +SR_PRIV struct sr_device_instance *sr_get_device_instance( + GSList *device_instances, int device_index) { struct sr_device_instance *sdi; GSList *l; @@ -184,22 +203,8 @@ struct sr_device_instance *sr_get_device_instance(GSList *device_instances, return NULL; } -void sr_device_instance_free(struct sr_device_instance *sdi) +SR_PRIV void sr_device_instance_free(struct sr_device_instance *sdi) { - switch (sdi->instance_type) { -#ifdef HAVE_LIBUSB_1_0 - case SR_USB_INSTANCE: - sr_usb_device_instance_free(sdi->usb); - break; -#endif - case SR_SERIAL_INSTANCE: - sr_serial_device_instance_free(sdi->serial); - break; - default: - /* No specific type, nothing extra to free. */ - break; - } - g_free(sdi->priv); g_free(sdi->vendor); g_free(sdi->model); @@ -209,13 +214,15 @@ void sr_device_instance_free(struct sr_device_instance *sdi) #ifdef HAVE_LIBUSB_1_0 -struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus, +SR_PRIV struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus, uint8_t address, struct libusb_device_handle *hdl) { 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; @@ -224,7 +231,7 @@ struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus, return udi; } -void sr_usb_device_instance_free(struct sr_usb_device_instance *usb) +SR_PRIV void sr_usb_device_instance_free(struct sr_usb_device_instance *usb) { /* Avoid compiler warnings. */ (void)usb; @@ -234,26 +241,38 @@ void sr_usb_device_instance_free(struct sr_usb_device_instance *usb) #endif -struct sr_serial_device_instance *sr_serial_device_instance_new( +SR_PRIV struct sr_serial_device_instance *sr_serial_device_instance_new( const char *port, int fd) { 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; } -void sr_serial_device_instance_free(struct sr_serial_device_instance *serial) +SR_PRIV void sr_serial_device_instance_free( + struct sr_serial_device_instance *serial) { - free(serial->port); + g_free(serial->port); } -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; @@ -265,7 +284,15 @@ int sr_find_hwcap(int *capabilities, int hwcap) return FALSE; } -struct sr_hwcap_option *sr_find_hwcap_option(int hwcap) +/** + * 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; @@ -279,12 +306,12 @@ 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);