Changeset 52b7b1bb in mainline for uspace/lib/libdrv/include/driver.h

Timestamp:

2010-04-01T14:08:55Z (14 years ago)

Author:

Lenka Trochtova <trochtova.lenka@…>

Branches:

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

Children:

57937dd

Parents:

a1769ee

Message:

device interfaces - parts of code

File:

• uspace/lib/libdrv/include/driver.h (modified) (7 diffs)

uspace/lib/libdrv/include/driver.h

@@ -39 +39 @@
 #include <ipc/devman.h>
 #include <ipc/dev_iface.h>
+#include <assert.h>
 
 struct device;
@@ -50 +51 @@
 
 typedef struct {
-        int method_count;
+        size_t method_count;
         remote_iface_func_ptr_t *methods;
 } remote_iface_t;
@@ -68 +69 @@
 }
 
+remote_iface_t* get_remote_iface(dev_inferface_id_t id);
+remote_iface_func_ptr_t get_remote_method(remote_iface_t *rem_iface, ipcarg_t iface_method_idx);
+
+
 // device
 
+/** The device. */
 struct device {
+        /** Globally unique device identifier (assigned to the device by the device manager). */
         device_handle_t handle;
+        /** The phone to the parent device driver.*/
         ipcarg_t parent_phone;
+        /** The device's name.*/
         const char *name;
+        /** The list of device ids for device-to-driver matching.*/
         match_id_list_t match_ids;
+        /** The device driver's data associated with this device.*/
         void *driver_data;
+        /** The table of interfaces exported by this device. */
         void *interfaces[DEV_IFACE_COUNT];
-
-        // TODO add more items
-
+        /** Pointer to the previous and next device in the list of devices handled by the driver */
         link_t link;
 };
@@ -86 +96 @@
 // driver
 
+/** Generic device driver operations. */
 typedef struct driver_ops {
+        /** Callback method for passing a new device to the device driver.*/
         bool (*add_device)(device_t *dev);
         // TODO add other generic driver operations
 } driver_ops_t;
 
+/** The driver structure.*/
 typedef struct driver {
+        /** The name of the device driver. */
         const char *name;
+        /** Generic device driver operations. */
         driver_ops_t *driver_ops;
 } driver_t;
@@ -102 +117 @@
 int driver_main(driver_t *drv);
 
+/** Create new device structure. 
+ * 
+ * @return the device structure.
+ */
 static inline device_t * create_device()
 {
@@ -112 +131 @@
 }
 
+/** Delete device structure. 
+ * 
+ * @param dev the device structure.
+ */
 static inline void delete_device(device_t *dev)
 {
@@ -129 +152 @@
 }
 
+static inline void * device_get_iface(device_t *dev, dev_inferface_id_t id)
+{
+        assert(is_valid_iface_id(id));
+        
+        int idx = get_iface_index(id);
+        return dev->interfaces[idx];    
+}
+
 bool child_device_register(device_t *child, device_t *parent);