Changeset 11658b64 in mainline for uspace/lib/usbvirt

Timestamp:

2010-12-16T11:54:53Z (15 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

557c7d0, 5863a95, 82122f3, a8b7dfd, f2962621

Parents:

a9b6bec (diff), 70e5ad5 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merged vojtechhorky/ - libusbvirt clean-up

Location:

uspace/lib/usbvirt

Files:

• Makefile (modified) (1 diff)
• ctrlpipe.c (deleted)
• include/usbvirt/device.h (moved) (moved from uspace/lib/usbvirt/device.h ) (5 diffs)
• include/usbvirt/hub.h (moved) (moved from uspace/lib/usbvirt/hub.h )
• src/callback.c (moved) (moved from uspace/lib/usbvirt/callback.c ) (1 diff)
• src/ctrlpipe.c (added)
• src/debug.c (moved) (moved from uspace/lib/usbvirt/debug.c ) (1 diff)
• src/main.c (moved) (moved from uspace/lib/usbvirt/main.c ) (1 diff)
• src/private.h (moved) (moved from uspace/lib/usbvirt/private.h ) (2 diffs)
• src/stdreq.c (moved) (moved from uspace/lib/usbvirt/stdreq.c ) (7 diffs)
• src/transaction.c (moved) (moved from uspace/lib/usbvirt/transaction.c ) (1 diff)

uspace/lib/usbvirt/Makefile

@@ -31 +31 @@
 
 LIBS = $(LIBUSB_PREFIX)/libusb.a
-EXTRA_CFLAGS = -I$(LIBUSB_PREFIX)/include
+EXTRA_CFLAGS = -I$(LIBUSB_PREFIX)/include -Iinclude
 
 SOURCES = \
-        callback.c \
-        ctrlpipe.c \
-        debug.c \
-        main.c \
-        stdreq.c \
-        transaction.c
+        src/callback.c \
+        src/ctrlpipe.c \
+        src/debug.c \
+        src/main.c \
+        src/stdreq.c \
+        src/transaction.c
 
 include $(USPACE_PREFIX)/Makefile.common

uspace/lib/usbvirt/include/usbvirt/device.h

@@ -40 +40 @@
 #include <usb/devreq.h>
 
+/** Request type of a control transfer. */
+typedef enum {
+        /** Standard USB request. */
+        USBVIRT_REQUEST_TYPE_STANDARD = 0,
+        /** Standard class USB request. */
+        USBVIRT_REQUEST_TYPE_CLASS = 1
+} usbvirt_request_type_t;
+
+/** Recipient of control request. */
+typedef enum {
+        /** Device is the recipient of the control request. */
+        USBVIRT_REQUEST_RECIPIENT_DEVICE = 0,
+        /** Interface is the recipient of the control request. */
+        USBVIRT_REQUEST_RECIPIENT_INTERFACE = 1,
+        /** Endpoint is the recipient of the control request. */
+        USBVIRT_REQUEST_RECIPIENT_ENDPOINT = 2,
+        /** Other part of the device is the recipient of the control request. */
+        USBVIRT_REQUEST_RECIPIENT_OTHER = 3
+} usbvirt_request_recipient_t;
+
+/** Possible states of virtual USB device.
+ * Notice that these are not 1:1 mappings to those in USB specification.
+ */
+typedef enum {
+        /** Default state, device listens at default address. */
+        USBVIRT_STATE_DEFAULT,
+        /** Device has non-default address assigned. */
+        USBVIRT_STATE_ADDRESS,
+        /** Device is configured. */
+        USBVIRT_STATE_CONFIGURED
+} usbvirt_device_state_t;
+
 typedef struct usbvirt_device usbvirt_device_t;
 struct usbvirt_control_transfer;
@@ -47 +79 @@
         uint8_t *data);
 
-/** Callbacks for standard device requests.
- * When these functions are NULL or return EFORWARD, this
- * framework will try to satisfy the request by itself.
- */
-typedef struct {
-        usbvirt_on_device_request_t on_get_status;
-        usbvirt_on_device_request_t on_clear_feature;
-        usbvirt_on_device_request_t on_set_feature;
-        usbvirt_on_device_request_t on_set_address;
-        usbvirt_on_device_request_t on_get_descriptor;
-        usbvirt_on_device_request_t on_set_descriptor;
-        usbvirt_on_device_request_t on_get_configuration;
-        usbvirt_on_device_request_t on_set_configuration;
-        usbvirt_on_device_request_t on_get_interface;
-        usbvirt_on_device_request_t on_set_interface;
-        usbvirt_on_device_request_t on_synch_frame;
-} usbvirt_standard_device_request_ops_t;
+/** Callback for control request over pipe zero.
+ *
+ * @param dev Virtual device answering the call.
+ * @param request Request setup packet.
+ * @param data Data when DATA stage is present.
+ * @return Error code.
+ */
+typedef int (*usbvirt_control_request_callback_t)(usbvirt_device_t *dev,
+        usb_device_request_setup_packet_t *request,
+        uint8_t *data);
+
+/** Handler for control transfer on endpoint zero. */
+typedef struct {
+        /** Request type bitmap.
+         * Use USBVIRT_MAKE_CONTROL_REQUEST_TYPE for creating the bitmap.
+         */
+        uint8_t request_type;
+        /** Request code. */
+        uint8_t request;
+        /** Request name for debugging. */
+        const char *name;
+        /** Callback for the request.
+         * NULL value here announces end of a list.
+         */
+        usbvirt_control_request_callback_t callback;
+} usbvirt_control_transfer_handler_t;
+
+/** Create control request type bitmap.
+ *
+ * @param direction Transfer direction (use usb_direction_t).
+ * @param type Request type (use usbvirt_request_type_t).
+ * @param recipient Recipient of the request (use usbvirt_request_recipient_t).
+ * @return Request type bitmap.
+ */
+#define USBVIRT_MAKE_CONTROL_REQUEST_TYPE(direction, type, recipient) \
+        ((((direction) == USB_DIRECTION_IN) ? 1 : 0) << 7) \
+        | (((type) & 3) << 5) \
+        | (((recipient) & 31))
+
+/** Create last item in an array of control request handlers. */
+#define USBVIRT_CONTROL_TRANSFER_HANDLER_LAST { 0, 0, NULL, NULL }
 
 /** Device operations. */
 typedef struct {
-        /** Callbacks for standard deivce requests. */
-        usbvirt_standard_device_request_ops_t *standard_request_ops;
-        /** Callback for class-specific USB request. */
-        usbvirt_on_device_request_t on_class_device_request;
-        
+        /** Callbacks for transfers over control pipe zero. */
+        usbvirt_control_transfer_handler_t *control_transfer_handlers;
+
         int (*on_control_transfer)(usbvirt_device_t *dev,
             usb_endpoint_t endpoint, struct usbvirt_control_transfer *transfer);
@@ -86 +140 @@
         usb_direction_t (*decide_control_transfer_direction)(
             usb_endpoint_t endpoint, void *buffer, size_t size);
+
+        /** Callback when device changes its state.
+         *
+         * It is correct that this function is called when both states
+         * are equal (e.g. this function is called during SET_CONFIGURATION
+         * request done on already configured device).
+         *
+         * @warning The value of <code>dev->state</code> before calling
+         * this function is not specified (i.e. can be @p old_state or
+         * @p new_state).
+         */
+        void (*on_state_change)(usbvirt_device_t *dev,
+            usbvirt_device_state_t old_state, usbvirt_device_state_t new_state);
 } usbvirt_device_ops_t;
 
@@ -120 +187 @@
         uint8_t current_configuration;
 } usbvirt_descriptors_t;
-
-/** Possible states of virtual USB device.
- * Notice that these are not 1:1 mappings to those in USB specification.
- */
-typedef enum {
-        USBVIRT_STATE_DEFAULT,
-        USBVIRT_STATE_ADDRESS,
-        USBVIRT_STATE_CONFIGURED
-} usbvirt_device_state_t;
 
 /** Information about on-going control transfer.
@@ -157 +215 @@
         usbvirt_device_ops_t *ops;
         
+        /** Custom device data. */
+        void *device_data;
+
         /** Reply onto control transfer.
          */

uspace/lib/usbvirt/src/callback.c

@@ -40 +40 @@
 #include <mem.h>
 
-#include "hub.h"
-#include "device.h"
 #include "private.h"
 

uspace/lib/usbvirt/src/debug.c

@@ -36 +36 @@
 #include <bool.h>
 
-#include "device.h"
 #include "private.h"
 

uspace/lib/usbvirt/src/main.c

@@ -39 +39 @@
 #include <assert.h>
 
-#include "hub.h"
-#include "device.h"
 #include "private.h"
 

uspace/lib/usbvirt/src/private.h

@@ -36 +36 @@
 #define LIBUSBVIRT_PRIVATE_H_
 
-#include "device.h"
-#include "hub.h"
+#include <usbvirt/device.h>
+#include <usbvirt/hub.h>
+#include <assert.h>
 
 
@@ -86 +87 @@
 }
 
+extern usbvirt_control_transfer_handler_t control_pipe_zero_local_handlers[];
+
 #endif
 /**

uspace/lib/usbvirt/src/stdreq.c

@@ -40 +40 @@
 #include "private.h"
 
-
-
 /*
  * All sub handlers must return EFORWARD to inform the caller that
@@ -51 +49 @@
 /** GET_DESCRIPTOR handler. */
 static int handle_get_descriptor(usbvirt_device_t *device,
-    uint8_t type, uint8_t index, uint16_t language,
-    uint16_t length)
+    usb_device_request_setup_packet_t *setup_packet, uint8_t *extra_data)
 {
+        uint8_t type = setup_packet->value_high;
+        uint8_t index = setup_packet->value_low;
+
         /* 
          * Standard device descriptor.
@@ -110 +110 @@
 /** SET_ADDRESS handler. */
 static int handle_set_address(usbvirt_device_t *device,
-    uint16_t new_address,
-    uint16_t zero1, uint16_t zero2)
+    usb_device_request_setup_packet_t *setup_packet, uint8_t *extra_data)
 {
+        uint16_t new_address = setup_packet->value;
+        uint16_t zero1 = setup_packet->index;
+        uint16_t zero2 = setup_packet->length;
+
         if ((zero1 != 0) || (zero2 != 0)) {
                 return EINVAL;
@@ -128 +131 @@
 /** SET_CONFIGURATION handler. */
 static int handle_set_configuration(usbvirt_device_t *device,
-    uint16_t configuration_value,
-    uint16_t zero1, uint16_t zero2)
+    usb_device_request_setup_packet_t *setup_packet, uint8_t *extra_data)
 {
+        uint16_t configuration_value = setup_packet->value;
+        uint16_t zero1 = setup_packet->index;
+        uint16_t zero2 = setup_packet->length;
+
         if ((zero1 != 0) || (zero2 != 0)) {
                 return EINVAL;
@@ -151 +157 @@
         
         if (configuration_value == 0) {
+                if (DEVICE_HAS_OP(device, on_state_change)) {
+                        device->ops->on_state_change(device, device->state,
+                            USBVIRT_STATE_ADDRESS);
+                }
                 device->state = USBVIRT_STATE_ADDRESS;
         } else {
@@ -157 +167 @@
                 * user selected existing configuration.
                 */
+                if (DEVICE_HAS_OP(device, on_state_change)) {
+                        device->ops->on_state_change(device, device->state,
+                            USBVIRT_STATE_CONFIGURED);
+                }
                 device->state = USBVIRT_STATE_CONFIGURED;
                 if (device->descriptors) {
@@ -167 +181 @@
 }
 
-#define HANDLE_REQUEST(request, data, type, dev, user_callback, default_handler) \
-        do { \
-                if ((request)->request == (type)) { \
-                        int _rc = EFORWARD; \
-                        if (((dev)->ops) && ((dev)->ops->standard_request_ops) \
-                            && ((dev)->ops->standard_request_ops->user_callback)) { \
-                                _rc = (dev)->ops->standard_request_ops->\
-                                    user_callback(dev, request, data); \
-                        } \
-                        if (_rc == EFORWARD) { \
-                                default_handler; \
-                        } \
-                        return _rc; \
-                } \
-        } while (false)
-
-/** Handle standard device request. */
-int handle_std_request(usbvirt_device_t *device,
-    usb_device_request_setup_packet_t *request, uint8_t *data)
-{
-        device->lib_debug(device, 3, USBVIRT_DEBUGTAG_CONTROL_PIPE_ZERO,
-            "handling standard request %d", request->request);
-        
-        HANDLE_REQUEST(request, data, USB_DEVREQ_GET_DESCRIPTOR,
-            device, on_get_descriptor,
-            handle_get_descriptor(device, request->value_high, request->value_low,
-                request->index, request->length));
-        
-        HANDLE_REQUEST(request, data, USB_DEVREQ_SET_ADDRESS,
-            device, on_set_address,
-            handle_set_address(device, request->value,
-                request->index, request->length));
-        
-        HANDLE_REQUEST(request, data, USB_DEVREQ_SET_CONFIGURATION,
-            device, on_set_configuration,
-            handle_set_configuration(device, request->value,
-                request->index, request->length));
-        
-        return ENOTSUP;
-}
+
+#define MAKE_BM_REQUEST(direction, recipient) \
+        USBVIRT_MAKE_CONTROL_REQUEST_TYPE(direction, \
+            USBVIRT_REQUEST_TYPE_STANDARD, recipient)
+#define MAKE_BM_REQUEST_DEV(direction) \
+        MAKE_BM_REQUEST(direction, USBVIRT_REQUEST_RECIPIENT_DEVICE)
+
+usbvirt_control_transfer_handler_t control_pipe_zero_local_handlers[] = {
+        {
+                .request_type = MAKE_BM_REQUEST_DEV(USB_DIRECTION_IN),
+                .request = USB_DEVREQ_GET_DESCRIPTOR,
+                .name = "GetDescriptor()",
+                .callback = handle_get_descriptor
+        },
+        {
+                .request_type = MAKE_BM_REQUEST_DEV(USB_DIRECTION_OUT),
+                .request = USB_DEVREQ_SET_ADDRESS,
+                .name = "SetAddress()",
+                .callback = handle_set_address
+        },
+        {
+                .request_type = MAKE_BM_REQUEST_DEV(USB_DIRECTION_OUT),
+                .request = USB_DEVREQ_SET_CONFIGURATION,
+                .name = "SetConfiguration()",
+                .callback = handle_set_configuration
+        },
+        USBVIRT_CONTROL_TRANSFER_HANDLER_LAST
+};
 
 /**

uspace/lib/usbvirt/src/transaction.c

@@ -37 +37 @@
 #include <mem.h>
 
-#include "hub.h"
 #include "private.h"