Changeset 193da9d6 in mainline

Timestamp:

2011-09-19T14:15:55Z (13 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

7a05ced0

Parents:

34a0d17

Message:

usbhub: Rename usbhub_private.h ⇒ utils.h.

Add error checks, comments, and slight refactoring.

Location:

uspace/drv/bus/usb/usbhub

Files:

• port_status.h (modified) (2 diffs)
• ports.c (modified) (1 diff)
• ports.h (modified) (1 diff)
• usbhub.c (modified) (9 diffs)
• usbhub.h (modified) (1 diff)
• utils.c (modified) (1 diff)
• utils.h (moved) (moved from uspace/drv/bus/usb/usbhub/usbhub_private.h ) (5 diffs)

uspace/drv/bus/usb/usbhub/port_status.h

@@ -1 +1 @@
 /*
  * Copyright (c) 2010 Matus Dekanek
+ * Copyright (c) 2011 Jan Vesely
  * All rights reserved.
  *
@@ -36 +37 @@
 #include <sys/types.h>
 #include <usb/dev/request.h>
-#include "usbhub_private.h"
 
 /**

uspace/drv/bus/usb/usbhub/ports.c

@@ -44 +44 @@
 #include "ports.h"
 #include "usbhub.h"
-#include "usbhub_private.h"
+#include "utils.h"
 #include "port_status.h"
 

uspace/drv/bus/usb/usbhub/ports.h

@@ -62 +62 @@
  * @param port Port to be initialized.
  */
-static inline void usb_hub_port_init(usb_hub_port_t *port) {
+static inline void usb_hub_port_init(usb_hub_port_t *port)
+{
+        assert(port);
         port->attached_device.address = -1;
         port->attached_device.handle = 0;

uspace/drv/bus/usb/usbhub/usbhub.c

@@ -38 +38 @@
 #include <str_error.h>
 #include <inttypes.h>
-
-#include <usb_iface.h>
+#include <stdio.h>
+
+#include <usb/usb.h>
+#include <usb/dev/pipes.h>
+#include <usb/classes/classes.h>
 #include <usb/ddfiface.h>
 #include <usb/descriptor.h>
@@ -46 +49 @@
 #include <usb/classes/hub.h>
 #include <usb/dev/poll.h>
-#include <stdio.h>
+#include <usb_iface.h>
 
 #include "usbhub.h"
-#include "usbhub_private.h"
+#include "utils.h"
 #include "port_status.h"
-#include <usb/usb.h>
-#include <usb/dev/pipes.h>
-#include <usb/classes/classes.h>
 
 #define HUB_FNC_NAME "hub"
 
+static int usb_set_first_configuration(usb_device_t *usb_device);
 static usb_hub_info_t * usb_hub_info_create(usb_device_t *usb_dev);
 static int usb_hub_process_hub_specific_info(usb_hub_info_t *hub_info);
-static int usb_hub_set_configuration(usb_hub_info_t *hub_info);
 static int usb_process_hub_over_current(usb_hub_info_t *hub_info,
     usb_hub_status_t status);
@@ -85 +85 @@
 int usb_hub_add_device(usb_device_t *usb_dev)
 {
-        if (!usb_dev) return EINVAL;
+        assert(usb_dev);
+        /* Create driver soft-state structure */
         usb_hub_info_t *hub_info = usb_hub_info_create(usb_dev);
-
-        //create hc connection
+        if (hub_info == NULL) {
+                usb_log_error("Failed to create hun driver structure.\n");
+                return ENOMEM;
+        }
+
+        /* Create hc connection */
         usb_log_debug("Initializing USB wire abstraction.\n");
         int opResult = usb_hc_connection_initialize_from_device(
@@ -99 +104 @@
         }
 
-        //set hub configuration
-        opResult = usb_hub_set_configuration(hub_info);
+        /* Set hub's first configuration. (There should be only one) */
+        opResult = usb_set_first_configuration(usb_dev);
         if (opResult != EOK) {
                 usb_log_error("Could not set hub configuration: %s\n",
@@ -233 +238 @@
  * information. If there are non-removable devices, start initializing them.
  * This function is hub-specific and should be run only after the hub is
- * configured using usb_hub_set_configuration function.
+ * configured using usb_set_first_configuration function.
  * @param hub_info hub representation
  * @return error code
@@ -239 +244 @@
 int usb_hub_process_hub_specific_info(usb_hub_info_t *hub_info)
 {
+        assert(hub_info);
         // get hub descriptor
         usb_log_debug("Retrieving descriptor\n");
@@ -267 +273 @@
         hub_info->port_count = descriptor.ports_count;
 
+        // TODO Why +1 ?
         hub_info->ports =
             malloc(sizeof(usb_hub_port_t) * (hub_info->port_count + 1));
@@ -304 +311 @@
 
         } else {
-                usb_log_debug("Power not switched, not going to be powered\n");
+                usb_log_debug("Power not switched, ports always powered\n");
         }
         return EOK;
@@ -310 +317 @@
 
 /**
- * Set configuration of hub
+ * Set configuration of and USB device
  *
  * Check whether there is at least one configuration and sets the first one.
  * This function should be run prior to running any hub-specific action.
- * @param hub_info hub representation
+ * @param usb_device usb device representation
  * @return error code
  */
-static int usb_hub_set_configuration(usb_hub_info_t *hub_info)
+static int usb_set_first_configuration(usb_device_t *usb_device)
 {
-        //device descriptor
-        const usb_standard_device_descriptor_t *std_descriptor
-            = &hub_info->usb_device->descriptors.device;
-        usb_log_debug("Hub has %d configurations\n",
-            std_descriptor->configuration_count);
-
-        if (std_descriptor->configuration_count < 1) {
+        assert(usb_device);
+        /* Get number of possible configurations from device descriptor */
+        const size_t configuration_count =
+            usb_device->descriptors.device.configuration_count;
+        usb_log_debug("Hub has %d configurations.\n", configuration_count);
+
+        if (configuration_count < 1) {
                 usb_log_error("There are no configurations available\n");
                 return EINVAL;
         }
 
+        // TODO: Make sure that there is enough data and the cast is correct
         usb_standard_configuration_descriptor_t *config_descriptor
             = (usb_standard_configuration_descriptor_t *)
-            hub_info->usb_device->descriptors.configuration;
-
-        /* Set configuration. */
-        int opResult = usb_request_set_configuration(
-            &hub_info->usb_device->ctrl_pipe,
-            config_descriptor->configuration_number);
-
+            usb_device->descriptors.configuration;
+
+        /* Set configuration. Use the configuration that was in
+         * usb_device->descriptors.configuration */
+        const int opResult = usb_request_set_configuration(
+            &usb_device->ctrl_pipe, config_descriptor->configuration_number);
         if (opResult != EOK) {
                 usb_log_error("Failed to set hub configuration: %s.\n",

uspace/drv/bus/usb/usbhub/usbhub.h

@@ -56 +56 @@
         size_t port_count;
 
-        /** attached device handles, for each port one */
+        /** Attached device handles, for each port one */
         usb_hub_port_t *ports;
 
         fibril_mutex_t port_mutex;
 
-        /** connection to hcd */
+        /** Connection to hcd */
         usb_hc_connection_t connection;
 

uspace/drv/bus/usb/usbhub/utils.c

@@ -42 +42 @@
 
 #include "usbhub.h"
-#include "usbhub_private.h"
-#include "port_status.h"
+#include "utils.h"
 
 

uspace/drv/bus/usb/usbhub/utils.h

@@ -1 +1 @@
 /*
  * Copyright (c) 2010 Matus Dekanek
+ * Copyright (c) 2011 Jan Vesely
  * All rights reserved.
  *
@@ -34 +35 @@
  */
 
-#ifndef USBHUB_PRIVATE_H
-#define USBHUB_PRIVATE_H
-
-#include "usbhub.h"
+#ifndef USBHUB_UTILS_H
+#define USBHUB_UTILS_H
 
 #include <adt/list.h>
@@ -48 +47 @@
 #include <usb/debug.h>
 #include <usb/dev/request.h>
+
+#include "usbhub.h"
 
 //************
@@ -166 +167 @@
 }
 
-
 void * usb_create_serialized_hub_descriptor(usb_hub_descriptor_t *descriptor);
 
@@ -175 +175 @@
     void *serialized_descriptor, size_t size, usb_hub_descriptor_t *descriptor);
 
-
-#endif  /* USBHUB_PRIVATE_H */
-
+#endif
 /**
  * @}