Changeset 52f1882 in mainline for uspace/drv/bus/usb/ohci/ohci_rh.c

Timestamp:

2013-02-08T23:31:23Z (11 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

db71e2a

Parents:

39339378

Message:

ohci: Add comments. Fix uninitialized pointer.

File:

• uspace/drv/bus/usb/ohci/ohci_rh.c (modified) (5 diffs)

uspace/drv/bus/usb/ohci/ohci_rh.c

@@ -43 +43 @@
 static usbvirt_device_ops_t ops;
 
+/** Initialize internal USB HUB class descriptor.
+ * @param instance OHCI root hub.
+ * Use register based info to create accurate descriptor.
+ */
 static void ohci_rh_hub_desc_init(ohci_rh_t *instance)
 {
@@ -83 +87 @@
 
 }
-
+/** Initialize OHCI root hub.
+ * @param instance Place to initialize.
+ * @param regs OHCI device registers.
+ * @param name Device name.
+ * return Error code, EOK on success.
+ *
+ * Selects preconfigured port powering mode, sets up descriptor, and
+ * initializes internal virtual hub.
+ */
 int ohci_rh_init(ohci_rh_t *instance, ohci_regs_t *regs, const char *name)
 {
@@ -137 +149 @@
 
         ohci_rh_hub_desc_init(instance);
+        instance->unfinished_interrupt_transfer = NULL;
         return virthub_base_init(&instance->base, name, &ops, instance,
             NULL, &instance->hub_descriptor.header, HUB_STATUS_CHANGE_PIPE);
 }
 
+/** Schedule USB request.
+ * @param instance OCHI root hub instance.
+ * @param batch USB requst batch to schedule.
+ * @return Always EOK.
+ * Most requests complete even before this function returns,
+ * status change requests might be postponed until there is something to report.
+ */
 int ohci_rh_schedule(ohci_rh_t *instance, usb_transfer_batch_t *batch)
 {
@@ -165 +185 @@
 }
 
+/** Handle OHCI RHSC interrupt.
+ * @param instance OHCI root hub isntance.
+ * @return Always EOK.
+ *
+ * Interrupt means there is a change of status to report. It may trigger
+ * processing of a postponed request.
+ */
 int ohci_rh_interrupt(ohci_rh_t *instance)
 {
+        //TODO atomic swap needed
         usb_transfer_batch_t *batch = instance->unfinished_interrupt_transfer;
         instance->unfinished_interrupt_transfer = NULL;
@@ -484 +512 @@
 };
 
+/** Virtual OHCI root hub ops */
 static usbvirt_device_ops_t ops = {
         .control = control_transfer_handlers,