Changeset f6d0c7c in mainline

Timestamp:

2011-03-10T15:24:57Z (14 years ago)

Author:

Lubos Slovak <lubos.slovak@…>

Branches:

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

Children:

2b12f06

Parents:

77ab674

Message:

Comments to hiddev

File:

• uspace/drv/usbhid/hiddev.h (modified) (1 diff)

uspace/drv/usbhid/hiddev.h

@@ -48 +48 @@
 
 /**
- * @brief USB/HID device type.
+ * USB/HID device type.
+ *
+ * Holds a reference to DDF device structure, and HID-specific data, such 
+ * as information about used pipes (one Control pipe and one Interrupt In pipe),
+ * polling interval, assigned interface number, Report descriptor and a
+ * reference to the Report parser used to parse incoming reports and composing
+ * outgoing reports.
  */
 typedef struct {
+        /** DDF device representing the controlled HID device. */
         ddf_dev_t *device;
 
+        /** Physical connection to the device. */
         usb_device_connection_t wire;
+        /** USB pipe corresponding to the default Control endpoint. */
         usb_endpoint_pipe_t ctrl_pipe;
+        /** USB pipe corresponding to the Interrupt In (polling) pipe. */
         usb_endpoint_pipe_t poll_pipe;
         
+        /** Polling interval retreived from the Interface descriptor. */
         short poll_interval;
         
+        /** Interface number assigned to this device. */
         uint16_t iface;
         
+        /** Report descriptor. */
         uint8_t *report_desc;
+        /** HID Report parser. */
         usb_hid_report_parser_t *parser;
         
+        /** State of the structure (for checking before use). */
         int initialized;
 } usbhid_dev_t;