summaryrefslogtreecommitdiff
path: root/include/uhd/iface_list.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/uhd/iface_list.h')
-rw-r--r--include/uhd/iface_list.h112
1 files changed, 112 insertions, 0 deletions
diff --git a/include/uhd/iface_list.h b/include/uhd/iface_list.h
new file mode 100644
index 0000000..c93a3da
--- /dev/null
+++ b/include/uhd/iface_list.h
@@ -0,0 +1,112 @@
+/** @file
+ * @brief usbhid-dump - interface list
+ *
+ * Copyright (C) 2010 Nikolai Kondrashov
+ *
+ * This file is part of usbhid-dump.
+ *
+ * Usbhid-dump is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * Usbhid-dump is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with usbhid-dump; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * @author Nikolai Kondrashov <spbnick@gmail.com>
+ *
+ * @(#) $Id$
+ */
+
+#ifndef __UHD_IFACE_LIST_H__
+#define __UHD_IFACE_LIST_H__
+
+#include "uhd/iface.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * Check if an interface list is valid.
+ *
+ * @param list Interface list to check.
+ *
+ * @return True if the interface list is valid, false otherwise.
+ */
+extern bool uhd_iface_list_valid(const uhd_iface *list);
+
+/**
+ * Check if an interface list is empty.
+ *
+ * @param list Interface list to check.
+ *
+ * @return True if the interface list is empty, false otherwise.
+ */
+static inline bool
+uhd_iface_list_empty(const uhd_iface *list)
+{
+ return list == NULL;
+}
+
+/**
+ * Calculate length of an interface list.
+ *
+ * @param list The list to calculate length of.
+ *
+ * @return The list length.
+ */
+extern size_t uhd_iface_list_len(const uhd_iface *list);
+
+/**
+ * Free an interface list.
+ *
+ * @param list The interface list to free.
+ */
+extern void uhd_iface_list_free(uhd_iface *list);
+
+/**
+ * Iterate over an interface list.
+ *
+ * @param _iface Loop interface variable.
+ * @param _list Interface list to iterate over.
+ */
+#define UHD_IFACE_LIST_FOR_EACH(_iface, _list) \
+ for (_iface = _list; _iface != NULL; _iface = _iface->next)
+
+/**
+ * Fetch a list of HID interfaces from a device.
+ *
+ * @param handle The device handle to fetch interface list from.
+ * @param plist Location for the resulting list head; could be NULL.
+ *
+ * @return Libusb error code.
+ */
+enum libusb_error
+uhd_iface_list_new_from_dev(libusb_device_handle *handle,
+ uhd_iface **plist);
+
+/**
+ * Filter an interface list by an optional interface number, resulting
+ * either in an empty, a single-interface, or an unmodified list.
+ *
+ * @param plist The original list head.
+ * @param number The interface number to match against, or a negative
+ * integer meaning there is no restriction.
+ *
+ * @return The resulting list head
+ */
+extern uhd_iface *uhd_iface_list_fltr_by_num(uhd_iface *list,
+ int number);
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+#endif /* __UHD_IFACE_LIST_H__ */