X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hwplugin.c;h=4ad7502b7705068ec241f4ce5c37696944f2e862;hb=c73d2ea421c2b425c3f0ae33bce2bfd0c448ca5f;hp=db0e72f135a9b3f4cba2b5db2fc55d091bef3bd8;hpb=1ebdb3fdc3e28d138046539d9a38610254d9c00a;p=libsigrok.git diff --git a/hwplugin.c b/hwplugin.c index db0e72f1..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 @@ -23,179 +23,296 @@ #include #include #include -#include - -source_callback_add source_cb_add = NULL; -source_callback_remove source_cb_remove = NULL; +#include "sigrok.h" +#include "sigrok-internal.h" /* The list of loaded plugins lives here. */ -GSList *plugins; +static GSList *plugins; /* * This enumerates which plugin capabilities correspond to user-settable * options. */ -struct hwcap_option hwcap_options[] = { - {HWCAP_SAMPLERATE, T_UINT64, "Sample rate", "samplerate"}, - {0, 0, NULL, NULL} +/* TODO: This shouldn't be a global. */ +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"}, + {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"}, + {0, 0, NULL, NULL}, }; -extern struct device_plugin saleae_logic_plugin_info; -extern struct device_plugin ols_plugin_info; -extern struct device_plugin zeroplus_logic_cube_plugin_info; -extern struct device_plugin asix_sigma_plugin_info; - -int load_hwplugins(void) +#ifdef HAVE_LA_DEMO +extern struct sr_device_plugin demo_plugin_info; +#endif +#ifdef HAVE_LA_SALEAE_LOGIC +extern struct sr_device_plugin saleae_logic_plugin_info; +#endif +#ifdef HAVE_LA_OLS +extern struct sr_device_plugin ols_plugin_info; +#endif +#ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE +extern struct sr_device_plugin zeroplus_logic_cube_plugin_info; +#endif +#ifdef HAVE_LA_ASIX_SIGMA +extern struct sr_device_plugin asix_sigma_plugin_info; +#endif +#ifdef HAVE_LA_CHRONOVU_LA8 +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; +#endif +#ifdef HAVE_LA_ALSA +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) { +#ifdef HAVE_LA_DEMO + plugins = g_slist_append(plugins, (gpointer *)&demo_plugin_info); +#endif +#ifdef HAVE_LA_SALEAE_LOGIC plugins = - g_slist_append(plugins, (gpointer *) &saleae_logic_plugin_info); - plugins = g_slist_append(plugins, (gpointer *) &ols_plugin_info); + g_slist_append(plugins, (gpointer *)&saleae_logic_plugin_info); +#endif +#ifdef HAVE_LA_OLS + plugins = g_slist_append(plugins, (gpointer *)&ols_plugin_info); +#endif +#ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE plugins = g_slist_append(plugins, - (gpointer *) &zeroplus_logic_cube_plugin_info); + (gpointer *)&zeroplus_logic_cube_plugin_info); +#endif +#ifdef HAVE_LA_ASIX_SIGMA plugins = g_slist_append(plugins, (gpointer *)&asix_sigma_plugin_info); - - return SIGROK_OK; +#endif +#ifdef HAVE_LA_CHRONOVU_LA8 + plugins = g_slist_append(plugins, (gpointer *)&chronovu_la8_plugin_info); +#endif +#ifdef HAVE_LA_LINK_MSO19 + plugins = g_slist_append(plugins, (gpointer *)&link_mso19_plugin_info); +#endif +#ifdef HAVE_LA_ALSA + plugins = g_slist_append(plugins, (gpointer *)&alsa_plugin_info); +#endif + + return SR_OK; } -GSList *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; } -struct sigrok_device_instance *sigrok_device_instance_new(int index, int status, - char *vendor, char *model, char *version) +/** + * 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) { - struct sigrok_device_instance *sdi; + int num_devices, num_probes, i, j; + int num_initialized_devices = 0; + struct sr_device *device; + char **probe_names; + + sr_dbg("initializing %s plugin", plugin->name); + num_devices = plugin->init(NULL); + for (i = 0; i < num_devices; i++) { + num_probes = GPOINTER_TO_INT( + plugin->get_device_info(i, SR_DI_NUM_PROBES)); + probe_names = (char **)plugin->get_device_info(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); + continue; + } + + device = sr_dev_new(plugin, i); + for (j = 0; j < num_probes; j++) + sr_dev_probe_add(device, probe_names[j]); + num_initialized_devices++; + } + + return num_initialized_devices; +} - sdi = malloc(sizeof(struct sigrok_device_instance)); - if (!sdi) +SR_PRIV void sr_cleanup_hwplugins(void) +{ + struct sr_device_plugin *plugin; + GSList *l; + + for (l = plugins; l; l = l->next) { + plugin = l->data; + if (plugin->cleanup) + plugin->cleanup(); + } +} + +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_try_malloc(sizeof(struct sr_device_instance)))) { + sr_err("hwplugin: %s: sdi malloc failed", __func__); return NULL; + } sdi->index = index; sdi->status = status; sdi->instance_type = -1; - sdi->vendor = strdup(vendor); - sdi->model = strdup(model); - sdi->version = strdup(version); - sdi->usb = NULL; + sdi->vendor = vendor ? g_strdup(vendor) : NULL; + sdi->model = model ? g_strdup(model) : NULL; + sdi->version = version ? g_strdup(version) : NULL; + sdi->priv = NULL; return sdi; } -struct sigrok_device_instance *get_sigrok_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 sigrok_device_instance *sdi; + struct sr_device_instance *sdi; GSList *l; - sdi = NULL; for (l = device_instances; l; l = l->next) { - sdi = (struct sigrok_device_instance *)(l->data); + sdi = (struct sr_device_instance *)(l->data); if (sdi->index == device_index) return sdi; } - g_warning("could not find device index %d instance", device_index); + sr_warn("could not find device index %d instance", device_index); return NULL; } -void sigrok_device_instance_free(struct sigrok_device_instance *sdi) +SR_PRIV void sr_device_instance_free(struct sr_device_instance *sdi) { - switch (sdi->instance_type) { - case USB_INSTANCE: - usb_device_instance_free(sdi->usb); - break; - case SERIAL_INSTANCE: - serial_device_instance_free(sdi->serial); - break; - /* No specific type, nothing extra to free. */ - } - - free(sdi->vendor); - free(sdi->model); - free(sdi->version); - free(sdi); + g_free(sdi->priv); + g_free(sdi->vendor); + g_free(sdi->model); + g_free(sdi->version); + g_free(sdi); } -struct usb_device_instance *usb_device_instance_new(uint8_t bus, +#ifdef HAVE_LIBUSB_1_0 + +SR_PRIV struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus, uint8_t address, struct libusb_device_handle *hdl) { - struct usb_device_instance *udi; + struct sr_usb_device_instance *udi; - udi = malloc(sizeof(struct usb_device_instance)); - if (!udi) + 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; - udi->devhdl = hdl; + udi->devhdl = hdl; /* TODO: Check if this is NULL? */ return udi; } -void usb_device_instance_free(struct usb_device_instance *usb) +SR_PRIV void sr_usb_device_instance_free(struct sr_usb_device_instance *usb) { - /* QUICK HACK */ - usb = usb; + /* Avoid compiler warnings. */ + (void)usb; /* Nothing to do for this device instance type. */ } -struct serial_device_instance *serial_device_instance_new(char *port, int fd) +#endif + +SR_PRIV struct sr_serial_device_instance *sr_serial_device_instance_new( + const char *port, int fd) { - struct serial_device_instance *serial; + struct sr_serial_device_instance *serial; - serial = malloc(sizeof(struct serial_device_instance)); - if (!serial) + 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 serial_device_instance_free(struct 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 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; - for (i = 0; capabilities[i]; i++) + for (i = 0; capabilities[i]; i++) { if (capabilities[i] == hwcap) return TRUE; + } return FALSE; } -struct hwcap_option *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) { - struct hwcap_option *hwo; int i; - hwo = NULL; - for (i = 0; hwcap_options[i].capability; i++) { - if (hwcap_options[i].capability == hwcap) { - hwo = &hwcap_options[i]; - break; - } + for (i = 0; sr_hwcap_options[i].capability; i++) { + if (sr_hwcap_options[i].capability == hwcap) + return &sr_hwcap_options[i]; } - return hwo; + return NULL; } -void source_remove(int fd) +/* unnecessary level of indirection follows. */ + +SR_PRIV void sr_source_remove(int fd) { - if (source_cb_remove) - source_cb_remove(fd); + sr_session_source_remove(fd); } -void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb, - void *user_data) +SR_PRIV void sr_source_add(int fd, int events, int timeout, + sr_receive_data_callback rcv_cb, void *user_data) { - if (source_cb_add) - source_cb_add(fd, events, timeout, rcv_cb, user_data); + sr_session_source_add(fd, events, timeout, rcv_cb, user_data); }