Commit 831334cbbbdc2b2923513104e6e70c80dda0bff0
Committed by
David S. Miller
1 parent
83cc0a1b1b
Exists in
master
and in
4 other branches
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>
Showing 1 changed file with 6 additions and 2 deletions Side-by-side Diff
Documentation/isdn/INTERFACE.CAPI
... | ... | @@ -113,12 +113,16 @@ |
113 | 113 | int (*load_firmware)(struct capi_ctr *ctrlr, capiloaddata *ldata) |
114 | 114 | (optional) pointer to a callback function for sending firmware and |
115 | 115 | configuration data to the device |
116 | + The function may return before the operation has completed. | |
117 | + Completion must be signalled by a call to capi_ctr_ready(). | |
116 | 118 | Return value: 0 on success, error code on error |
117 | 119 | Called in process context. |
118 | 120 | |
119 | 121 | void (*reset_ctr)(struct capi_ctr *ctrlr) |
120 | - (optional) pointer to a callback function for performing a reset on | |
121 | - the device, releasing all registered applications | |
122 | + (optional) pointer to a callback function for stopping the device, | |
123 | + releasing all registered applications | |
124 | + The function may return before the operation has completed. | |
125 | + Completion must be signalled by a call to capi_ctr_down(). | |
122 | 126 | Called in process context. |
123 | 127 | |
124 | 128 | void (*register_appl)(struct capi_ctr *ctrlr, u16 applid, |