2 * This file is part of the sigrok project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include <sys/types.h>
27 #include "sigrok-internal.h"
29 /* The list of loaded plugins lives here. */
30 static GSList *plugins;
33 * This enumerates which plugin capabilities correspond to user-settable
36 /* TODO: This shouldn't be a global. */
37 SR_API struct sr_hwcap_option sr_hwcap_options[] = {
38 {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "Sample rate", "samplerate"},
39 {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "Pre-trigger capture ratio", "captureratio"},
40 {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "Pattern generator mode", "patternmode"},
41 {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"},
46 extern struct sr_device_plugin demo_plugin_info;
48 #ifdef HAVE_LA_SALEAE_LOGIC
49 extern struct sr_device_plugin saleae_logic_plugin_info;
52 extern struct sr_device_plugin ols_plugin_info;
54 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
55 extern struct sr_device_plugin zeroplus_logic_cube_plugin_info;
57 #ifdef HAVE_LA_ASIX_SIGMA
58 extern struct sr_device_plugin asix_sigma_plugin_info;
60 #ifdef HAVE_LA_CHRONOVU_LA8
61 extern SR_PRIV struct device_plugin chronovu_la8_plugin_info;
63 #ifdef HAVE_LA_LINK_MSO19
64 extern struct sr_device_plugin link_mso19_plugin_info;
67 extern struct sr_device_plugin alsa_plugin_info;
70 /* TODO: No linked list needed, this can be a simple array. */
71 SR_PRIV int sr_hwplugins_load(void)
74 plugins = g_slist_append(plugins, (gpointer *)&demo_plugin_info);
76 #ifdef HAVE_LA_SALEAE_LOGIC
78 g_slist_append(plugins, (gpointer *)&saleae_logic_plugin_info);
81 plugins = g_slist_append(plugins, (gpointer *)&ols_plugin_info);
83 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
84 plugins = g_slist_append(plugins,
85 (gpointer *)&zeroplus_logic_cube_plugin_info);
87 #ifdef HAVE_LA_ASIX_SIGMA
88 plugins = g_slist_append(plugins, (gpointer *)&asix_sigma_plugin_info);
90 #ifdef HAVE_LA_CHRONOVU_LA8
91 plugins = g_slist_append(plugins, (gpointer *)&chronovu_la8_plugin_info);
93 #ifdef HAVE_LA_LINK_MSO19
94 plugins = g_slist_append(plugins, (gpointer *)&link_mso19_plugin_info);
97 plugins = g_slist_append(plugins, (gpointer *)&alsa_plugin_info);
104 * Returns the list of loaded hardware plugins.
106 * The list of plugins is initialized from sr_init(), and can only be reset
107 * by calling sr_exit().
109 * @return A GSList of pointers to loaded plugins.
111 SR_API GSList *sr_hwplugins_list(void)
118 * Initialize a hardware plugin.
120 * The specified plugin is initialized, and all devices discovered by the
121 * plugin are instantiated.
123 * @param plugin The plugin to initialize.
125 * @return The number of devices found and instantiated by the plugin.
127 SR_API int sr_hwplugin_init(struct sr_device_plugin *plugin)
129 int num_devices, num_probes, i, j;
130 int num_initialized_devices = 0;
131 struct sr_device *device;
134 sr_dbg("initializing %s plugin", plugin->name);
135 num_devices = plugin->init(NULL);
136 for (i = 0; i < num_devices; i++) {
137 num_probes = GPOINTER_TO_INT(
138 plugin->get_device_info(i, SR_DI_NUM_PROBES));
139 probe_names = (char **)plugin->get_device_info(i,
143 sr_warn("hwplugin: %s: plugin %s does not return a "
144 "list of probe names", __func__, plugin->name);
148 device = sr_dev_new(plugin, i);
149 for (j = 0; j < num_probes; j++)
150 sr_dev_probe_add(device, probe_names[j]);
151 num_initialized_devices++;
154 return num_initialized_devices;
157 SR_PRIV void sr_hwplugins_cleanup(void)
159 struct sr_device_plugin *plugin;
162 for (l = plugins; l; l = l->next) {
169 SR_PRIV struct sr_device_instance *sr_dev_inst_new(int index, int status,
170 const char *vendor, const char *model, const char *version)
172 struct sr_device_instance *sdi;
174 if (!(sdi = g_try_malloc(sizeof(struct sr_device_instance)))) {
175 sr_err("hwplugin: %s: sdi malloc failed", __func__);
180 sdi->status = status;
181 sdi->instance_type = -1;
182 sdi->vendor = vendor ? g_strdup(vendor) : NULL;
183 sdi->model = model ? g_strdup(model) : NULL;
184 sdi->version = version ? g_strdup(version) : NULL;
190 SR_PRIV struct sr_device_instance *sr_dev_inst_get(
191 GSList *device_instances, int device_index)
193 struct sr_device_instance *sdi;
196 for (l = device_instances; l; l = l->next) {
197 sdi = (struct sr_device_instance *)(l->data);
198 if (sdi->index == device_index)
201 sr_warn("could not find device index %d instance", device_index);
206 SR_PRIV void sr_dev_inst_free(struct sr_device_instance *sdi)
211 g_free(sdi->version);
215 #ifdef HAVE_LIBUSB_1_0
217 SR_PRIV struct sr_usb_device_instance *sr_usb_dev_inst_new(uint8_t bus,
218 uint8_t address, struct libusb_device_handle *hdl)
220 struct sr_usb_device_instance *udi;
222 if (!(udi = g_try_malloc(sizeof(struct sr_usb_device_instance)))) {
223 sr_err("hwplugin: %s: udi malloc failed", __func__);
228 udi->address = address;
229 udi->devhdl = hdl; /* TODO: Check if this is NULL? */
234 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_device_instance *usb)
236 /* Avoid compiler warnings. */
239 /* Nothing to do for this device instance type. */
244 SR_PRIV struct sr_serial_device_instance *sr_serial_dev_inst_new(
245 const char *port, int fd)
247 struct sr_serial_device_instance *serial;
249 if (!(serial = g_try_malloc(sizeof(struct sr_serial_device_instance)))) {
250 sr_err("hwplugin: %s: serial malloc failed", __func__);
254 serial->port = g_strdup(port);
260 SR_PRIV void sr_serial_dev_inst_free(
261 struct sr_serial_device_instance *serial)
263 g_free(serial->port);
267 * Find out if a hardware plugin has a specific capability.
269 * @param capabilities A NULL-terminated integer array of capabilities, as
270 * returned by a plugin's get_capabilities() function.
271 * @param hwcap The capability to find in the list.
273 * @return TRUE if found, FALSE otherwise.
275 SR_API gboolean sr_hwplugin_has_hwcap(struct sr_device_plugin *plugin, int hwcap)
277 int *capabilities, i;
279 capabilities = plugin->get_capabilities();
280 for (i = 0; capabilities[i]; i++) {
281 if (capabilities[i] == hwcap)
289 * Find a hardware plugin capability option.
291 * @param hwcap The capability to find
293 * @return A struct with information about the parameter, or NULL
296 SR_API struct sr_hwcap_option *sr_hwplugins_hwcap_get(int hwcap)
300 for (i = 0; sr_hwcap_options[i].capability; i++) {
301 if (sr_hwcap_options[i].capability == hwcap)
302 return &sr_hwcap_options[i];
308 /* unnecessary level of indirection follows. */
310 SR_PRIV void sr_source_remove(int fd)
312 sr_session_source_remove(fd);
315 SR_PRIV void sr_source_add(int fd, int events, int timeout,
316 sr_receive_data_callback rcv_cb, void *user_data)
318 sr_session_source_add(fd, events, timeout, rcv_cb, user_data);