Changeset aab02fb in mainline

Timestamp:

2010-10-26T22:21:45Z (14 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

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

Children:

efedee77

Parents:

fa2a361

Message:

Debugging support for libusbvirt

Added methods debug and lib_debug to device structure to simplify
debugging. Each method gets as a parameter debug level describing
verbosity of the message and also message tag that allows filtering
based on message type (e.g. messages related to transactions, to
device requests etc.).

Location:

uspace

Files:

• lib/usbvirt/Makefile (modified) (1 diff)
• lib/usbvirt/ctrlpipe.c (modified) (4 diffs)
• lib/usbvirt/debug.c (added)
• lib/usbvirt/device.h (modified) (2 diffs)
• lib/usbvirt/main.c (modified) (1 diff)
• lib/usbvirt/private.h (modified) (1 diff)
• lib/usbvirt/stdreq.c (modified) (1 diff)
• lib/usbvirt/transaction.c (modified) (3 diffs)
• srv/hw/bus/usb/hcd/virtual/hub.c (modified) (1 diff)

uspace/lib/usbvirt/Makefile

@@ -36 +36 @@
         callback.c \
         ctrlpipe.c \
+        debug.c \
         main.c \
         stdreq.c \

uspace/lib/usbvirt/ctrlpipe.c

@@ -45 +45 @@
         ((value & GET_MIDBITS_MASK(size, shift)) >> shift)
 
-usb_address_t dev_new_address = -1;
+
+static const char *str_request_type(int type)
+{
+        switch (type) {
+                case REQUEST_TYPE_STANDARD:
+                        return "standard";
+                case REQUEST_TYPE_CLASS:
+                        return "class";
+                default:
+                        return "unknown";
+        }
+}
 
 /** Tell request type.
@@ -59 +70 @@
 int control_pipe(usbvirt_device_t *device, usbvirt_control_transfer_t *transfer)
 {
+        device->lib_debug(device, 1, USBVIRT_DEBUGTAG_CONTROL_PIPE_ZERO,
+            "op on control pipe zero (request_size=%u)", transfer->request_size);
+        
         if (transfer->request_size < sizeof(usb_device_request_setup_packet_t)) {
                 return ENOMEM;
@@ -69 +83 @@
         
         int rc = EOK;
+        
+        device->lib_debug(device, 2, USBVIRT_DEBUGTAG_CONTROL_PIPE_ZERO,
+            "request type: %s", str_request_type(type));
         
         switch (type) {
@@ -97 +114 @@
                 
                 device->new_address = -1;
+                
+                device->lib_debug(device, 2, USBVIRT_DEBUGTAG_CONTROL_PIPE_ZERO,
+                    "device address changed to %d (state %s)",
+                    device->address, str_device_state(device->state));
         }
         

uspace/lib/usbvirt/device.h

@@ -145 +145 @@
 } usbvirt_control_transfer_t;
 
+typedef enum {
+        USBVIRT_DEBUGTAG_BASE = 1,
+        USBVIRT_DEBUGTAG_TRANSACTION = 2,
+        USBVIRT_DEBUGTAG_CONTROL_PIPE_ZERO = 4,
+        USBVIRT_DEBUGTAG_ALL = 255
+} usbvirt_debug_tags_t;
+
 /** Virtual USB device. */
 struct usbvirt_device {
@@ -186 +193 @@
         /** State information on control-transfer endpoints. */
         usbvirt_control_transfer_t current_control_transfers[USB11_ENDPOINT_MAX];
+        
+        /* User debugging. */
+        
+        /** Debug print. */
+        void (*debug)(usbvirt_device_t *dev, int level, uint8_t tag,
+            const char *format, ...);
+        
+        /** Current debug level. */
+        int debug_level;
+        
+        /** Bitmap of currently enabled tags. */
+        uint8_t debug_enabled_tags;
+        
+        /* Library debugging. */
+        
+        /** Debug print. */
+        void (*lib_debug)(usbvirt_device_t *dev, int level, uint8_t tag,
+            const char *format, ...);
+        
+        /** Current debug level. */
+        int lib_debug_level;
+        
+        /** Bitmap of currently enabled tags. */
+        uint8_t lib_debug_enabled_tags;
 };
 

uspace/lib/usbvirt/main.c

@@ -124 +124 @@
         dev->control_transfer_reply = control_transfer_reply;
         
+        dev->debug = user_debug;
+        dev->lib_debug = lib_debug;
+        
         dev->state = USBVIRT_STATE_DEFAULT;
         dev->address = 0;

uspace/lib/usbvirt/private.h

@@ -66 +66 @@
     void *buffer, size_t size, size_t *data_size);
 
+
+void user_debug(usbvirt_device_t *device, int level, uint8_t tag,
+    const char *format, ...);
+void lib_debug(usbvirt_device_t *device, int level, uint8_t tag,
+    const char *format, ...);
+    
+static inline const char *str_device_state(usbvirt_device_state_t state)
+{
+        switch (state) {
+                case USBVIRT_STATE_DEFAULT:
+                        return "default";
+                case USBVIRT_STATE_ADDRESS:
+                        return "address";
+                case USBVIRT_STATE_CONFIGURED:
+                        return "configured";
+                default:
+                        return "unknown";
+        }
+}
+
 #endif
 /**

uspace/lib/usbvirt/stdreq.c

@@ -187 +187 @@
     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,

uspace/lib/usbvirt/transaction.c

@@ -67 +67 @@
     void *buffer, size_t size)
 {
+        device->lib_debug(device, 1, USBVIRT_DEBUGTAG_TRANSACTION,
+            "setup transaction: endpoint=%d, size=%u", endpoint, size);
+        
         usbvirt_control_transfer_t *transfer = &device->current_control_transfers[endpoint];
         
@@ -97 +100 @@
     void *buffer, size_t size)
 {
+        device->lib_debug(device, 1, USBVIRT_DEBUGTAG_TRANSACTION,
+            "out transaction: endpoint=%d, size=%u", endpoint, size);
+        
         /*
          * First check whether it is a transaction over control pipe.
@@ -151 +157 @@
     void *buffer, size_t size, size_t *data_size)
 {
+        device->lib_debug(device, 1, USBVIRT_DEBUGTAG_TRANSACTION,
+            "in transaction: endpoint=%d, size=%u", endpoint, size);
+        
         /*
          * First check whether it is a transaction over control pipe.

uspace/srv/hw/bus/usb/hcd/virtual/hub.c

@@ -141 +141 @@
         .ops = &hub_ops,
         .descriptors = &descriptors,
+        .lib_debug_level = 4,
+        .lib_debug_enabled_tags = USBVIRT_DEBUGTAG_ALL
 };