Changeset 69334af in mainline for uspace/lib/usb/include/usb/devdrv.h

Timestamp:

2011-03-13T17:18:55Z (14 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

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

Children:

4bf94df

Parents:

489c3e7

Message:

Replace asserts with proper checks

Also, added doxygen comments.

File:

• uspace/lib/usb/include/usb/devdrv.h (modified) (1 diff)

uspace/lib/usb/include/usb/devdrv.h

@@ -38 +38 @@
 #include <usb/pipes.h>
 
+/** USB device structure. */
 typedef struct {
+        /** The default control pipe. */
         usb_endpoint_pipe_t ctrl_pipe;
+        /** Other endpoint pipes.
+         * This is an array of other endpoint pipes in the same order as
+         * in usb_driver_t.
+         */
         usb_endpoint_mapping_t *pipes;
+        /** Generic DDF device backing this one. */
         ddf_dev_t *ddf_dev;
+        /** Custom driver data.
+         * Do not use the entry in generic device, that is already used
+         * by the framework.
+         */
         void *driver_data;
+
+        /** Connection backing the pipes.
+         * Typically, you will not need to use this attribute at all.
+         */
         usb_device_connection_t wire;
 } usb_device_t;
 
+/** USB driver ops. */
 typedef struct {
+        /** Callback when new device is about to be controlled by the driver. */
         int (*add_device)(usb_device_t *);
 } usb_driver_ops_t;
 
+/** USB driver structure. */
 typedef struct {
+        /** Driver name.
+         * This name is copied to the generic driver name and must be exactly
+         * the same as the directory name where the driver executable resides.
+         */
         const char *name;
+        /** Expected endpoints description. */
         usb_endpoint_description_t **endpoints;
+        /** Driver ops. */
         usb_driver_ops_t *ops;
 } usb_driver_t;