Documentation/isdn: CAPI controller interface amendment
authorTilman Schmidt <tilman@imap.cc>
Mon, 5 Jul 2010 14:18:22 +0000 (14:18 +0000)
committerDavid S. Miller <davem@davemloft.net>
Tue, 6 Jul 2010 02:41:22 +0000 (19:41 -0700)
Mention that the CAPI controller methods load_firmware() and
reset_ctr() are asynchronous, and should signal completion.

Signed-off-by: Tilman Schmidt <tilman@imap.cc>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/isdn/INTERFACE.CAPI

index f172091fb7cd4c592980a36272b2a61a4db71b7e..309eb5ed942b138a13f0123de28d02efd2d0de47 100644 (file)
@@ -113,12 +113,16 @@ char *driver_name
 int (*load_firmware)(struct capi_ctr *ctrlr, capiloaddata *ldata)
        (optional) pointer to a callback function for sending firmware and
        configuration data to the device
+       The function may return before the operation has completed.
+       Completion must be signalled by a call to capi_ctr_ready().
        Return value: 0 on success, error code on error
        Called in process context.
 
 void (*reset_ctr)(struct capi_ctr *ctrlr)
-       (optional) pointer to a callback function for performing a reset on
-       the device, releasing all registered applications
+       (optional) pointer to a callback function for stopping the device,
+       releasing all registered applications
+       The function may return before the operation has completed.
+       Completion must be signalled by a call to capi_ctr_down().
        Called in process context.
 
 void (*register_appl)(struct capi_ctr *ctrlr, u16 applid,