Add a thin glib wrapper around libusb_endpoint_descriptor

1 files changed, 244 insertions, 0 deletions

diff --git a/gusb/gusb-endpoint.c b/gusb/gusb-endpoint.c
new file mode 100644
index 0000000..82c18ad
--- /dev/null
+++ b/gusb/gusb-endpoint.c
@@ -0,0 +1,244 @@
+/* -*- 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-endponit
+ * @short_description: GLib wrapper around a USB endpoint.
+ *
+ * This object is a thin glib wrapper around a libusb_endpoint_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 "gusb-endpoint.h"
+#include "gusb-endpoint-private.h"
+
+struct _GUsbEndpoint
+{
+	GObject parent_instance;
+
+	struct libusb_endpoint_descriptor endpoint_descriptor;
+	GBytes *extra;
+};
+
+G_DEFINE_TYPE (GUsbEndpoint, g_usb_endpoint, G_TYPE_OBJECT)
+
+static void
+g_usb_endpoint_finalize (GObject *object)
+{
+	GUsbEndpoint *endpoint = G_USB_ENDPOINT (object);
+
+	g_bytes_unref (endpoint->extra);
+
+	G_OBJECT_CLASS (g_usb_endpoint_parent_class)->finalize (object);
+}
+
+static void
+g_usb_endpoint_class_init (GUsbEndpointClass *klass)
+{
+	GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+	object_class->finalize = g_usb_endpoint_finalize;
+}
+
+static void
+g_usb_endpoint_init (GUsbEndpoint *endpoint)
+{
+}
+
+/**
+ * _g_usb_endpoint_new:
+ *
+ * Return value: a new #GUsbEndpoint object.
+ *
+ * Since: 0.3.3
+ **/
+GUsbEndpoint *
+_g_usb_endpoint_new (const struct libusb_endpoint_descriptor *endpoint_descriptor)
+{
+	GUsbEndpoint *endpoint;
+	endpoint = g_object_new (G_USB_TYPE_ENDPOINT, NULL);
+
+	/* copy the data */
+	memcpy (&endpoint->endpoint_descriptor,
+		endpoint_descriptor,
+		sizeof (struct libusb_endpoint_descriptor));
+	endpoint->extra = g_bytes_new (endpoint_descriptor->extra, endpoint_descriptor->extra_length);
+
+	return G_USB_ENDPOINT (endpoint);
+}
+
+/*
+ * g_usb_endpoint_get_kind:
+ * @endpoint: a #GUsbEndpoint
+ *
+ * Gets the type of endpoint.
+ *
+ * Return value: The 8-bit type
+ *
+ * Since: 0.3.3
+ **/
+guint8
+g_usb_endpoint_get_kind	(GUsbEndpoint *endpoint)
+{
+	g_return_val_if_fail (G_USB_IS_ENDPOINT (endpoint), 0);
+	return endpoint->endpoint_descriptor.bDescriptorType;
+}
+
+/*
+ * g_usb_endpoint_get_maximum_packet_size:
+ * @endpoint: a #GUsbEndpoint
+ *
+ * Gets the maximum packet size this endpoint is capable of sending/receiving.
+ *
+ * Return value: The maximum packet size
+ *
+ * Since: 0.3.3
+ **/
+guint16
+g_usb_endpoint_get_maximum_packet_size (GUsbEndpoint *endpoint)
+{
+	g_return_val_if_fail (G_USB_IS_ENDPOINT (endpoint), 0);
+	return endpoint->endpoint_descriptor.wMaxPacketSize;
+}
+
+/*
+ * g_usb_endpoint_get_polling_interval:
+ * @endpoint: a #GUsbEndpoint
+ *
+ * Gets the endpoint polling interval.
+ *
+ * Return value: The endpoint polling interval
+ *
+ * Since: 0.3.3
+ **/
+guint8
+g_usb_endpoint_get_polling_interval (GUsbEndpoint *endpoint)
+{
+	g_return_val_if_fail (G_USB_IS_ENDPOINT (endpoint), 0);
+	return endpoint->endpoint_descriptor.bInterval;
+}
+
+/*
+ * g_usb_endpoint_get_refresh:
+ * @endpoint: a #GUsbEndpoint
+ *
+ * Gets the rate at which synchronization feedback is provided, for audio device only.
+ *
+ * Return value: The endpoint refresh
+ *
+ * Since: 0.3.3
+ **/
+guint8
+g_usb_endpoint_get_refresh (GUsbEndpoint *endpoint)
+{
+	g_return_val_if_fail (G_USB_IS_ENDPOINT (endpoint), 0);
+	return endpoint->endpoint_descriptor.bRefresh;
+}
+
+/*
+ * g_usb_endpoint_get_synch_address:
+ * @endpoint: a #GUsbEndpoint
+ *
+ * Gets the address if the synch endpoint, for audio device only.
+ *
+ * Return value: The synch endpoint address
+ *
+ * Since: 0.3.3
+ **/
+guint8
+g_usb_endpoint_get_synch_address (GUsbEndpoint *endpoint)
+{
+	g_return_val_if_fail (G_USB_IS_ENDPOINT (endpoint), 0);
+	return endpoint->endpoint_descriptor.bSynchAddress;
+}
+
+/**
+ * g_usb_endpoint_get_address:
+ * @endpoint: a #GUsbEndpoint
+ *
+ * Gets the address of the endpoint.
+ *
+ * Return value: The 4-bit endpoint address
+ *
+ * Since: 0.3.3
+ **/
+guint8
+g_usb_endpoint_get_address (GUsbEndpoint *endpoint)
+{
+	g_return_val_if_fail (G_USB_IS_ENDPOINT (endpoint), 0);
+	return endpoint->endpoint_descriptor.bEndpointAddress;
+}
+
+/**
+ * g_usb_endpoint_get_number:
+ * @endpoint: a #GUsbEndpoint
+ *
+ * Gets the number part of endpoint address.
+ *
+ * Return value: The lower 4-bit of endpoint address
+ *
+ * Since: 0.3.3
+ **/
+guint8
+g_usb_endpoint_get_number (GUsbEndpoint *endpoint)
+{
+	g_return_val_if_fail (G_USB_IS_ENDPOINT (endpoint), 0);
+	return (endpoint->endpoint_descriptor.bEndpointAddress) & 0xf;
+}
+
+/**
+ * g_usb_endpoint_get_direction:
+ * @endpoint: a #GUsbEndpoint
+ *
+ * Gets the direction of the endpoint.
+ *
+ * Return value: The endpoint direction
+ *
+ * Since: 0.3.3
+ **/
+GUsbDeviceDirection
+g_usb_endpoint_get_direction (GUsbEndpoint *endpoint)
+{
+	g_return_val_if_fail (G_USB_IS_ENDPOINT (endpoint), 0);
+	return (endpoint->endpoint_descriptor.bEndpointAddress & 0x80) ?
+		G_USB_DEVICE_DIRECTION_DEVICE_TO_HOST :
+		G_USB_DEVICE_DIRECTION_HOST_TO_DEVICE;
+}
+
+/**
+ * g_usb_endpoint_get_extra:
+ * @endpoint: a #GUsbEndpoint
+ *
+ * Gets any extra data from the endpoint.
+ *
+ * Return value: (transfer none): a #GBytes, or %NULL for failure
+ *
+ * Since: 0.3.3
+ **/
+GBytes *
+g_usb_endpoint_get_extra (GUsbEndpoint *endpoint)
+{
+	g_return_val_if_fail (G_USB_IS_ENDPOINT (endpoint), NULL);
+	return endpoint->extra;
+}