diff options
author | Richard Hughes <richard@hughsie.com> | 2015-11-10 11:42:01 +0000 |
---|---|---|
committer | Richard Hughes <richard@hughsie.com> | 2015-11-10 11:42:01 +0000 |
commit | 9e8bc342a5d5aaf9c70d9f1cd16241d853eefd31 (patch) | |
tree | 3dd5f331c87594b3f96d049b9eab4c829c396b3e | |
parent | 424700bb3aa643041f4b62efdd5f39f9a50924f4 (diff) | |
download | gusb-9e8bc342a5d5aaf9c70d9f1cd16241d853eefd31.tar.gz |
Add a thin glib wrapper around a libusb_interface_descriptor
Sometimes we do actually need to care about what interfaces a device exports.
-rw-r--r-- | docs/api/gusb-docs.sgml | 1 | ||||
-rw-r--r-- | gusb/Makefile.am | 3 | ||||
-rw-r--r-- | gusb/gusb-autocleanups.h | 1 | ||||
-rw-r--r-- | gusb/gusb-interface-private.h | 34 | ||||
-rw-r--r-- | gusb/gusb-interface.c | 250 | ||||
-rw-r--r-- | gusb/gusb-interface.h | 68 | ||||
-rw-r--r-- | gusb/gusb.h | 1 |
7 files changed, 358 insertions, 0 deletions
diff --git a/docs/api/gusb-docs.sgml b/docs/api/gusb-docs.sgml index f5bf08d..9eb5e03 100644 --- a/docs/api/gusb-docs.sgml +++ b/docs/api/gusb-docs.sgml @@ -50,6 +50,7 @@ <xi:include href="xml/gusb-source.xml"/> <xi:include href="xml/gusb-device.xml"/> <xi:include href="xml/gusb-device-list.xml"/> + <xi:include href="xml/gusb-interface.xml"/> </reference> <reference id="libgusb-helpers"> diff --git a/gusb/Makefile.am b/gusb/Makefile.am index 5c45ac5..4307b7c 100644 --- a/gusb/Makefile.am +++ b/gusb/Makefile.am @@ -27,6 +27,8 @@ libgusbbase_include_HEADERS = \ gusb-device.h \ gusb-device-private.h \ gusb-device-list.h \ + gusb-interface.h \ + gusb-interface-private.h \ gusb-source.h \ gusb-util.h @@ -34,6 +36,7 @@ libgusb_la_SOURCES = \ gusb-context.c \ gusb-device.c \ gusb-device-list.c \ + gusb-interface.c \ gusb-source.c \ gusb-util.c diff --git a/gusb/gusb-autocleanups.h b/gusb/gusb-autocleanups.h index 0adf613..ce7dc45 100644 --- a/gusb/gusb-autocleanups.h +++ b/gusb/gusb-autocleanups.h @@ -29,6 +29,7 @@ G_DEFINE_AUTOPTR_CLEANUP_FUNC(GUsbContext, g_object_unref) G_DEFINE_AUTOPTR_CLEANUP_FUNC(GUsbDevice, g_object_unref) +G_DEFINE_AUTOPTR_CLEANUP_FUNC(GUsbInterface, g_object_unref) G_DEFINE_AUTOPTR_CLEANUP_FUNC(GUsbDeviceList, g_object_unref) #endif diff --git a/gusb/gusb-interface-private.h b/gusb/gusb-interface-private.h new file mode 100644 index 0000000..386cc1f --- /dev/null +++ b/gusb/gusb-interface-private.h @@ -0,0 +1,34 @@ +/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- + * + * Copyright (C) 2015 Richard Hughes <richard@hughsie.com> + * + * Licensed under the GNU Lesser General Public License Version 2.1 + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, see <http://www.gnu.org/licenses/>. + */ + +#ifndef __GUSB_INTERFACE_PRIVATE_H__ +#define __GUSB_INTERFACE_PRIVATE_H__ + +#include <libusb-1.0/libusb.h> + +#include <gusb/gusb-interface.h> + +G_BEGIN_DECLS + +GUsbInterface *_g_usb_interface_new (const struct libusb_interface_descriptor *iface); + +G_END_DECLS + +#endif /* __GUSB_INTERFACE_PRIVATE_H__ */ diff --git a/gusb/gusb-interface.c b/gusb/gusb-interface.c new file mode 100644 index 0000000..0614679 --- /dev/null +++ b/gusb/gusb-interface.c @@ -0,0 +1,250 @@ +/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- + * + * Copyright (C) 2015 Richard Hughes <richard@hughsie.com> + * + * Licensed under the GNU Lesser General Public License Version 2.1 + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, see <http://www.gnu.org/licenses/>. + */ + +/** + * SECTION:gusb-interface + * @short_description: GLib wrapper around a USB interface. + * + * This object is a thin glib wrapper around a libusb_interface_descriptor. + * + * All the data is copied when the object is created and the original + * descriptor can be destoyed any at point. + */ + +#include "config.h" + +#include <string.h> + +#include "gusb-interface.h" +#include "gusb-interface-private.h" + +/** + * GUsbInterfacePrivate: + * + * Private #GUsbInterface data + **/ +struct _GUsbInterfacePrivate +{ + struct libusb_interface_descriptor iface; + GBytes *extra; +}; + +G_DEFINE_TYPE_WITH_PRIVATE (GUsbInterface, g_usb_interface, G_TYPE_OBJECT) + +static void +g_usb_interface_finalize (GObject *object) +{ + GUsbInterface *interface = G_USB_INTERFACE (object); + GUsbInterfacePrivate *priv = interface->priv; + + g_bytes_unref (priv->extra); + + G_OBJECT_CLASS (g_usb_interface_parent_class)->finalize (object); +} + +static void +g_usb_interface_class_init (GUsbInterfaceClass *klass) +{ + GObjectClass *object_class = G_OBJECT_CLASS (klass); + object_class->finalize = g_usb_interface_finalize; +} + +static void +g_usb_interface_init (GUsbInterface *interface) +{ + interface->priv = g_usb_interface_get_instance_private (interface); +} + +/** + * _g_usb_interface_new: + * + * Return value: a new #GUsbInterface object. + * + * Since: 0.2.8 + **/ +GUsbInterface * +_g_usb_interface_new (const struct libusb_interface_descriptor *iface) +{ + GUsbInterface *interface; + interface = g_object_new (G_USB_TYPE_INTERFACE, NULL); + + /* copy the data */ + memcpy (&interface->priv->iface, + iface, + sizeof (struct libusb_interface_descriptor)); + interface->priv->extra = g_bytes_new (iface->extra, iface->extra_length); + + return G_USB_INTERFACE (interface); +} + +/** + * g_usb_interface_get_length: + * @interface: a #GUsbInterface + * + * Gets the USB bus number for the interface. + * + * Return value: The 8-bit bus number + * + * Since: 0.2.8 + **/ +guint8 +g_usb_interface_get_length (GUsbInterface *interface) +{ + g_return_val_if_fail (G_USB_IS_INTERFACE (interface), 0); + return interface->priv->iface.bLength; +} + +/** + * g_usb_interface_get_kind: + * @interface: a #GUsbInterface + * + * Gets the type of interface. + * + * Return value: The 8-bit address + * + * Since: 0.2.8 + **/ +guint8 +g_usb_interface_get_kind (GUsbInterface *interface) +{ + g_return_val_if_fail (G_USB_IS_INTERFACE (interface), 0); + return interface->priv->iface.bDescriptorType; +} + +/** + * g_usb_interface_get_number: + * @interface: a #GUsbInterface + * + * Gets the interface number. + * + * Return value: The interface ID + * + * Since: 0.2.8 + **/ +guint8 +g_usb_interface_get_number (GUsbInterface *interface) +{ + g_return_val_if_fail (G_USB_IS_INTERFACE (interface), 0); + return interface->priv->iface.bInterfaceNumber; +} + +/** + * g_usb_interface_get_alternate: + * @interface: a #GUsbInterface + * + * Gets the alternate setting for the interface. + * + * Return value: alt setting, typically zero. + * + * Since: 0.2.8 + **/ +guint8 +g_usb_interface_get_alternate (GUsbInterface *interface) +{ + g_return_val_if_fail (G_USB_IS_INTERFACE (interface), 0); + return interface->priv->iface.bAlternateSetting; +} + +/** + * g_usb_interface_get_class: + * @interface: a #GUsbInterface + * + * Gets the interface class, typically a #GUsbInterfaceClassCode. + * + * Return value: a interface class number, e.g. 0x09 is a USB hub. + * + * Since: 0.2.8 + **/ +guint8 +g_usb_interface_get_class (GUsbInterface *interface) +{ + g_return_val_if_fail (G_USB_IS_INTERFACE (interface), 0); + return interface->priv->iface.bInterfaceClass; +} + +/** + * g_usb_interface_get_subclass: + * @interface: a #GUsbInterface + * + * Gets the interface subclass qualified by the class number. + * See g_usb_interface_get_class(). + * + * Return value: a interface subclass number. + * + * Since: 0.2.8 + **/ +guint8 +g_usb_interface_get_subclass (GUsbInterface *interface) +{ + g_return_val_if_fail (G_USB_IS_INTERFACE (interface), 0); + return interface->priv->iface.bInterfaceSubClass; +} + +/** + * g_usb_interface_get_protocol: + * @interface: a #GUsbInterface + * + * Gets the interface protocol qualified by the class and subclass numbers. + * See g_usb_interface_get_class() and g_usb_interface_get_subclass(). + * + * Return value: a interface protocol number. + * + * Since: 0.2.8 + **/ +guint8 +g_usb_interface_get_protocol (GUsbInterface *interface) +{ + g_return_val_if_fail (G_USB_IS_INTERFACE (interface), 0); + return interface->priv->iface.bInterfaceProtocol; +} + +/** + * g_usb_interface_get_index: + * @interface: a #GUsbInterface + * + * Gets the index for the string descriptor. + * + * Return value: a string descriptor index. + * + * Since: 0.2.8 + **/ +guint8 +g_usb_interface_get_index (GUsbInterface *interface) +{ + g_return_val_if_fail (G_USB_IS_INTERFACE (interface), 0); + return interface->priv->iface.iInterface; +} + +/** + * g_usb_interface_get_extra: + * @interface: a #GUsbInterface + * + * Gets any extra data from the interface. + * + * Return value: (transfer none): a #GBytes, or %NULL for failure + * + * Since: 0.2.8 + **/ +GBytes * +g_usb_interface_get_extra (GUsbInterface *interface) +{ + g_return_val_if_fail (G_USB_IS_INTERFACE (interface), NULL); + return interface->priv->extra; +} diff --git a/gusb/gusb-interface.h b/gusb/gusb-interface.h new file mode 100644 index 0000000..816373b --- /dev/null +++ b/gusb/gusb-interface.h @@ -0,0 +1,68 @@ +/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- + * + * Copyright (C) 2015 Richard Hughes <richard@hughsie.com> + * + * Licensed under the GNU Lesser General Public License Version 2.1 + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, see <http://www.gnu.org/licenses/>. + */ + +#ifndef __GUSB_INTERFACE_H__ +#define __GUSB_INTERFACE_H__ + +#include <glib-object.h> +#include <gio/gio.h> + +G_BEGIN_DECLS + +#define G_USB_TYPE_INTERFACE (g_usb_interface_get_type ()) +#define G_USB_INTERFACE(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_USB_TYPE_INTERFACE, GUsbInterface)) +#define G_USB_IS_INTERFACE(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_USB_TYPE_INTERFACE)) + +typedef struct _GUsbInterfacePrivate GUsbInterfacePrivate; +typedef struct _GUsbInterface GUsbInterface; +typedef struct _GUsbInterfaceClass GUsbInterfaceClass; + +struct _GUsbInterface +{ + GObject parent; + GUsbInterfacePrivate *priv; +}; + +struct _GUsbInterfaceClass +{ + GObjectClass parent_class; + /*< private >*/ + /* + * If adding fields to this struct, remove corresponding + * amount of padding to avoid changing overall struct size + */ + gpointer _gusb_reserved[31]; +}; + +GType g_usb_interface_get_type (void); + +guint8 g_usb_interface_get_length (GUsbInterface *interface); +guint8 g_usb_interface_get_kind (GUsbInterface *interface); +guint8 g_usb_interface_get_number (GUsbInterface *interface); +guint8 g_usb_interface_get_alternate (GUsbInterface *interface); +guint8 g_usb_interface_get_class (GUsbInterface *interface); +guint8 g_usb_interface_get_subclass (GUsbInterface *interface); +guint8 g_usb_interface_get_protocol (GUsbInterface *interface); +guint8 g_usb_interface_get_index (GUsbInterface *interface); +GBytes *g_usb_interface_get_extra (GUsbInterface *interface); + +G_END_DECLS + +#endif /* __GUSB_INTERFACE_H__ */ diff --git a/gusb/gusb.h b/gusb/gusb.h index 50a9cd0..56d08e1 100644 --- a/gusb/gusb.h +++ b/gusb/gusb.h @@ -26,6 +26,7 @@ #include <gusb/gusb-autocleanups.h> #include <gusb/gusb-context.h> +#include <gusb/gusb-interface.h> #include <gusb/gusb-source.h> #include <gusb/gusb-device.h> #include <gusb/gusb-device-list.h> |