diff options
| author | Sudeep Holla <sudeep.holla@arm.com> | 2018-05-09 17:52:06 +0100 |
|---|---|---|
| committer | Sudeep Holla <sudeep.holla@arm.com> | 2018-05-09 17:52:06 +0100 |
| commit | 1baf47c2e5c946fd17ef07597b9d25722d13ff14 (patch) | |
| tree | 0184e819b88b19cd5c092758d0dbe85a9ae51aa1 /drivers/firmware/arm_scmi/common.h | |
| parent | 354b2e36d7dea9f5d67945498bbbf65551d72e15 (diff) | |
firmware: arm_scmi: fix kernel-docs documentation
There are few missing descriptions for function parameters and structure
members along with certain instances where excessive function parameters
or structure members are described.
This patch fixes all of those warnings.
Reported-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
Diffstat (limited to 'drivers/firmware/arm_scmi/common.h')
| -rw-r--r-- | drivers/firmware/arm_scmi/common.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/drivers/firmware/arm_scmi/common.h b/drivers/firmware/arm_scmi/common.h index e8f332c9c469..0821662a4633 100644 --- a/drivers/firmware/arm_scmi/common.h +++ b/drivers/firmware/arm_scmi/common.h @@ -51,8 +51,11 @@ struct scmi_msg_resp_prot_version { * @id: The identifier of the command being sent * @protocol_id: The identifier of the protocol used to send @id command * @seq: The token to identify the message. when a message/command returns, - * the platform returns the whole message header unmodified including - * the token. + * the platform returns the whole message header unmodified including + * the token + * @status: Status of the transfer once it's complete + * @poll_completion: Indicate if the transfer needs to be polled for + * completion or interrupt mode is used */ struct scmi_msg_hdr { u8 id; |