Changes in uspace/lib/drv/include/usbhc_iface.h [d4da860:a6afb4c] in mainline

File:

• uspace/lib/drv/include/usbhc_iface.h (modified) (3 diffs)

uspace/lib/drv/include/usbhc_iface.h

@@ -1 +1 @@
 /*
  * Copyright (c) 2010 Vojtech Horky
- * Copyright (c) 2011 Jan Vesely
+ * Copyright (c) 2017 Ondrej Hlavaty
  * All rights reserved.
  *
@@ -32 +32 @@
  * @{
  */
-
 /** @file
- * @brief USB host controller interface definition.
+ * @brief USB host controler interface definition. This is the interface of
+ * USB host controller function, which can be used by usb device drivers.
  */
 
@@ -41 +41 @@
 
 #include "ddf/driver.h"
-#include <usb_iface.h>
-#include <stdbool.h>
+#include <async.h>
 
-extern int usbhc_read(async_exch_t *, usb_address_t, usb_endpoint_t,
-    uint64_t, void *, size_t, size_t *);
-extern int usbhc_write(async_exch_t *, usb_address_t, usb_endpoint_t,
-    uint64_t, const void *, size_t);
+/** USB speeds. */
+typedef enum {
+        /** USB 1.1 low speed (1.5Mbits/s). */
+        USB_SPEED_LOW,
+        /** USB 1.1 full speed (12Mbits/s). */
+        USB_SPEED_FULL,
+        /** USB 2.0 high speed (480Mbits/s). */
+        USB_SPEED_HIGH,
+        /** USB 3.0 super speed (5Gbits/s). */
+        USB_SPEED_SUPER,
+        /** Psuedo-speed serving as a boundary. */
+        USB_SPEED_MAX
+} usb_speed_t;
 
-/** Callback for outgoing transfer. */
-typedef void (*usbhc_iface_transfer_out_callback_t)(int, void *);
+/** USB endpoint number type.
+ * Negative values could be used to indicate error.
+ */
+typedef uint16_t usb_endpoint_t;
 
-/** Callback for incoming transfer. */
-typedef void (*usbhc_iface_transfer_in_callback_t)(int, size_t, void *);
+/** USB address type.
+ * Negative values could be used to indicate error.
+ */
+typedef uint16_t usb_address_t;
 
-/** USB host controller communication interface. */
+/**
+ * USB Stream ID type.
+ */
+typedef uint16_t usb_stream_t;
+
+/** USB transfer type. */
+typedef enum {
+        USB_TRANSFER_CONTROL = 0,
+        USB_TRANSFER_ISOCHRONOUS = 1,
+        USB_TRANSFER_BULK = 2,
+        USB_TRANSFER_INTERRUPT = 3,
+} usb_transfer_type_t;
+
+#define USB_TRANSFER_COUNT  (USB_TRANSFER_INTERRUPT + 1)
+
+/** USB data transfer direction. */
+typedef enum {
+        USB_DIRECTION_IN,
+        USB_DIRECTION_OUT,
+        USB_DIRECTION_BOTH,
+} usb_direction_t;
+
+#define USB_DIRECTION_COUNT  (USB_DIRECTION_BOTH + 1)
+
+/** USB complete address type.
+ * Pair address + endpoint is identification of transaction recipient.
+ */
+typedef union {
+        struct {
+                usb_address_t address;
+                usb_endpoint_t endpoint;
+                usb_stream_t stream;
+        } __attribute__((packed));
+        uint64_t packed;
+} usb_target_t;
+
+typedef struct usb_pipe_desc {
+        /** Endpoint number. */
+        usb_endpoint_t endpoint_no;
+
+        /** Endpoint transfer type. */
+        usb_transfer_type_t transfer_type;
+
+        /** Endpoint direction. */
+        usb_direction_t direction;
+
+        /** Maximum size of one transfer */
+        size_t max_transfer_size;
+} usb_pipe_desc_t;
+
+/** This structure follows standard endpoint descriptor + superspeed companion
+ * descriptor, and exists to avoid dependency of libdrv on libusb. Keep the
+ * internal fields named exactly like their source (because we want to use the
+ * same macros to access them).
+ * Callers shall fill it with bare contents of respective descriptors (in usb endianity).
+ */
+typedef struct usb_endpoint_descriptors {
+        struct {
+                uint8_t endpoint_address;
+                uint8_t attributes;
+                uint16_t max_packet_size;
+                uint8_t poll_interval;
+        } endpoint;
+
+        /* Superspeed companion descriptor */
+        struct companion_desc_t {
+                uint8_t max_burst;
+                uint8_t attributes;
+                uint16_t bytes_per_interval;
+        } companion;
+} usb_endpoint_descriptors_t;
+
+extern int usbhc_reserve_default_address(async_exch_t *);
+extern int usbhc_release_default_address(async_exch_t *);
+
+extern int usbhc_device_enumerate(async_exch_t *, unsigned, usb_speed_t);
+extern int usbhc_device_remove(async_exch_t *, unsigned);
+
+extern int usbhc_register_endpoint(async_exch_t *, usb_pipe_desc_t *, const usb_endpoint_descriptors_t *);
+extern int usbhc_unregister_endpoint(async_exch_t *, const usb_pipe_desc_t *);
+
+extern int usbhc_read(async_exch_t *, usb_endpoint_t, uint64_t, void *, size_t,
+    size_t *);
+extern int usbhc_write(async_exch_t *, usb_endpoint_t, uint64_t, const void *,
+    size_t);
+
+/** Callback for outgoing transfer */
+typedef int (*usbhc_iface_transfer_callback_t)(void *, int, size_t);
+
+/** USB device communication interface. */
 typedef struct {
-        int (*read)(ddf_fun_t *, usb_target_t, uint64_t, uint8_t *, size_t,
-            usbhc_iface_transfer_in_callback_t, void *);
-        int (*write)(ddf_fun_t *, usb_target_t, uint64_t, const uint8_t *,
-            size_t, usbhc_iface_transfer_out_callback_t, void *);
+        int (*default_address_reservation)(ddf_fun_t *, bool);
+
+        int (*device_enumerate)(ddf_fun_t *, unsigned, usb_speed_t);
+        int (*device_remove)(ddf_fun_t *, unsigned);
+
+        int (*register_endpoint)(ddf_fun_t *, usb_pipe_desc_t *, const usb_endpoint_descriptors_t *);
+        int (*unregister_endpoint)(ddf_fun_t *, const usb_pipe_desc_t *);
+
+        int (*read)(ddf_fun_t *, usb_target_t,
+                uint64_t, char *, size_t,
+                usbhc_iface_transfer_callback_t, void *);
+        int (*write)(ddf_fun_t *, usb_target_t,
+                uint64_t, const char *, size_t,
+                usbhc_iface_transfer_callback_t, void *);
 } usbhc_iface_t;
-
 
 #endif