Commit 613c15e8 authored by Johan Hovold's avatar Johan Hovold Committed by Greg Kroah-Hartman

greybus: operation: update gb_operation_request_send() documentation

Fix and update gb_operation_request_send() documentation and add
kernel-doc formatting.
Signed-off-by: default avatarJohan Hovold <johan@hovoldconsulting.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@google.com>
parent 410abddb
...@@ -627,13 +627,20 @@ static void gb_operation_sync_callback(struct gb_operation *operation) ...@@ -627,13 +627,20 @@ static void gb_operation_sync_callback(struct gb_operation *operation)
complete(&operation->completion); complete(&operation->completion);
} }
/* /**
* Send an operation request message. The caller has filled in any payload so * gb_operation_request_send() - send an operation request message
* the request message is ready to go. The callback function supplied will be * @operation: the operation to initiate
* called when the response message has arrived indicating the operation is * @callback: the operation completion callback
* complete. In that case, the callback function is responsible for fetching * @gfp: the memory flags to use for any allocations
* the result of the operation using gb_operation_result() if desired, and *
* dropping the initial reference to the operation. * 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, int gb_operation_request_send(struct gb_operation *operation,
gb_operation_callback callback, gb_operation_callback callback,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment