diff options
author | Johan Hovold <johan@hovoldconsulting.com> | 2016-04-29 17:08:31 +0200 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@google.com> | 2016-04-29 14:27:05 -0700 |
commit | 613c15e86b7ac30cb3e3f16e13ee367845a941b2 (patch) | |
tree | 804cd14169777bf79c06be2578a62c7f4a569214 /drivers/staging/greybus/operation.c | |
parent | 410abddb0389aa1e456f980b336eb20948ccce51 (diff) |
greybus: operation: update gb_operation_request_send() documentation
Fix and update gb_operation_request_send() documentation and add
kernel-doc formatting.
Signed-off-by: Johan Hovold <johan@hovoldconsulting.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@google.com>
Diffstat (limited to 'drivers/staging/greybus/operation.c')
-rw-r--r-- | drivers/staging/greybus/operation.c | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/drivers/staging/greybus/operation.c b/drivers/staging/greybus/operation.c index 5af65353b141..bb8995583f6a 100644 --- a/drivers/staging/greybus/operation.c +++ b/drivers/staging/greybus/operation.c @@ -627,13 +627,20 @@ static void gb_operation_sync_callback(struct gb_operation *operation) complete(&operation->completion); } -/* - * Send an operation request message. The caller has filled in any payload so - * the request message is ready to go. The callback function supplied will be - * called when the response message has arrived indicating the operation is - * complete. In that case, the callback function is responsible for fetching - * the result of the operation using gb_operation_result() if desired, and - * dropping the initial reference to the operation. +/** + * gb_operation_request_send() - send an operation request message + * @operation: the operation to initiate + * @callback: the operation completion callback + * @gfp: the memory flags to use for any allocations + * + * The caller has filled in any payload so the request message is ready to go. + * The callback function supplied will be called when the response message has + * arrived, or the operation is cancelled, indicating that the operation is + * complete. The callback function can fetch the result of the operation using + * gb_operation_result() if desired. + * + * Return: 0 if the request was successfully queued in the host-driver queues, + * or a negative errno. */ int gb_operation_request_send(struct gb_operation *operation, gb_operation_callback callback, |