Documentation/isdn: CAPI controller interface amendment

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>

diff --git a/Documentation/isdn/INTERFACE.CAPI b/Documentation/isdn/INTERFACE.CAPI
index f172091..309eb5e 100644 (file)
--- a/Documentation/isdn/INTERFACE.CAPI
+++ b/Documentation/isdn/INTERFACE.CAPI
@@ -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,