Changeset 02cacce in mainline for uspace/drv/ohci/hc.h

Timestamp:

2011-05-18T18:24:22Z (13 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

030937e

Parents:

45e0e07

Message:

Doxygen and some minor code-style changes

File:

• uspace/drv/ohci/hc.h (modified) (4 diffs)

uspace/drv/ohci/hc.h

@@ -53 +53 @@
 #define OHCI_NEEDED_IRQ_COMMANDS 5
 
+/** Main OHCI drier structure */
 typedef struct hc {
+        /** USB bus driver, devices and addresses */
+        usb_device_keeper_t manager;
+        /** USB bus driver, endpoints */
+        usb_endpoint_manager_t ep_manager;
+
+        /** Memory mapped I/O registers area */
         ohci_regs_t *registers;
+        /** Host controller communication area structure */
         hcca_t *hcca;
 
-        usb_address_t rh_address;
-        rh_t rh;
-
+        /** Transfer schedules */
         endpoint_list_t lists[4];
+        /** List of active transfers */
         link_t pending_batches;
 
-        usb_device_keeper_t manager;
-        usb_endpoint_manager_t ep_manager;
+        /** Fibril for periodic checks if interrupts can't be used */
         fid_t interrupt_emulator;
+
+        /** Guards schedule and endpoint manipulation */
         fibril_mutex_t guard;
 
@@ -73 +81 @@
         /** Commands that form interrupt code */
         irq_cmd_t interrupt_commands[OHCI_NEEDED_IRQ_COMMANDS];
+
+        /** USB hub emulation structure */
+        rh_t rh;
 } hc_t;
 
 int hc_register_hub(hc_t *instance, ddf_fun_t *hub_fun);
-
 int hc_init(hc_t *instance, uintptr_t regs, size_t reg_size, bool interrupts);
-
 void hc_start_hw(hc_t *instance);
 
@@ -85 +94 @@
  * @param[in] instance Host controller structure to use.
  */
-static inline void hc_fini(hc_t *instance) { /* TODO: implement*/ };
+static inline void hc_fini(hc_t *instance)
+        { /* TODO: implement*/ };
 
 int hc_add_endpoint(hc_t *instance, usb_address_t address, usb_endpoint_t ep,
     usb_speed_t speed, usb_transfer_type_t type, usb_direction_t direction,
     size_t max_packet_size, size_t size, unsigned interval);
-
 int hc_remove_endpoint(hc_t *instance, usb_address_t address,
     usb_endpoint_t endpoint, usb_direction_t direction);
-
 endpoint_t * hc_get_endpoint(hc_t *instance, usb_address_t address,
     usb_endpoint_t endpoint, usb_direction_t direction, size_t *bw);
 
 int hc_schedule(hc_t *instance, usb_transfer_batch_t *batch);
-
 void hc_interrupt(hc_t *instance, uint32_t status);
 
@@ -107 +114 @@
  */
 static inline hc_t * fun_to_hc(ddf_fun_t *fun)
-        { return (hc_t*)fun->driver_data; }
+        { return fun->driver_data; }
 #endif
 /**