Changes between Version 17 and Version 18 of DeviceDrivers

Timestamp:

2011-11-14T21:25:17Z (13 years ago)

Author:

Jiri Svoboda

Comment:

fun_online, fun_offline

DeviceDrivers

@@ -67 +67 @@
  * #include <ddf/driver.h>
  * driver_t
- * driver_ops_t
-   * dev_add
-   * dev_remove
-   * dev_gone
-   * fun_online
-   * fun_offline
+ * driver_ops_t -- driver entry points
+   * dev_add -- ask driver to take ownership of device
+   * dev_remove -- ask driver to give up device
+   * dev_gone -- device connectivity lost
+   * fun_online -- ask driver to online function
+   * fun_offline -- ask driver to offline function
  * ddf_dev_ops_t
 
@@ -119 +119 @@
 software state associated with the device. If this entry point is not implemented, it should
 be either set to NULL or it should always return ENOTSUP.
+
+==== fun_online ====
+{{{
+int (*fun_online)(ddf_fun_t *fun)
+}}}
+This entry point is called by DDF to ask the driver to online a function. The driver must
+online the function ''fun''. It may also online other functions, if necessary (in case the
+function states are interlocked somehow). For many drivers this function will simply call
+{{{ddf_fun_online(fun)}}}.
+
+If this entry point is not implemented, it should be either set to NULL or it should always
+return ENOTSUP.
+
+==== fun_offline ====
+{{{
+int (*fun_offline)(ddf_fun_t *fun)
+}}}
+This entry point is called by DDF to ask the driver to offline a function. The driver must
+offline the function ''fun''. It may also offline other functions, if necessary (in case the
+function states are interlocked somehow). For many drivers this function will simply call
+{{{ddf_fun_offline(fun)}}}.
+
+If this entry point is not implemented, it should be either set to NULL or it should always
+return ENOTSUP.
 
 == Device and Function Life Cycle ==