Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

rpmsg: smd: fix kerneldoc warnings

This patch fixes below kerneldoc warnings

qcom_smd.c:141: warning: Function parameter or member 'dev' not described in 'qcom_smd_edge'
qcom_smd.c:141: warning: Function parameter or member 'name' not described in 'qcom_smd_edge'
qcom_smd.c:141: warning: Function parameter or member 'new_channel_event' not described in 'qcom_smd_edge'
qcom_smd.c:222: warning: Function parameter or member 'qsept' not described in 'qcom_smd_channel'
qcom_smd.c:222: warning: Function parameter or member 'registered' not described in 'qcom_smd_channel'
qcom_smd.c:222: warning: Function parameter or member 'state_change_event' not described in 'qcom_smd_channel'
qcom_smd.c:222: warning: Function parameter or member 'drvdata' not described in 'qcom_smd_channel'
qcom_smd.c:737: warning: Function parameter or member 'wait' not described in '__qcom_smd_send'

Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>

authored by

Srinivas Kandagatla and committed by
Bjorn Andersson
82eca590 6f0b9584

+8 -1
+8 -1
drivers/rpmsg/qcom_smd.c
··· 94 94 95 95 /** 96 96 * struct qcom_smd_edge - representing a remote processor 97 + * @dev: device associated with this edge 98 + * @name: name of this edge 97 99 * @of_node: of_node handle for information related to this edge 98 100 * @edge_id: identifier of this edge 99 101 * @remote_pid: identifier of remote processor ··· 109 107 * @channels_lock: guard for modifications of @channels 110 108 * @allocated: array of bitmaps representing already allocated channels 111 109 * @smem_available: last available amount of smem triggering a channel scan 110 + * @new_channel_event: wait queue for new channel events 112 111 * @scan_work: work item for discovering new channels 113 112 * @state_work: work item for edge state changes 114 113 */ ··· 176 173 /** 177 174 * struct qcom_smd_channel - smd channel struct 178 175 * @edge: qcom_smd_edge this channel is living on 179 - * @qsdev: reference to a associated smd client device 176 + * @qsept: reference to a associated smd endpoint 177 + * @registered: flag to indicate if the channel is registered 180 178 * @name: name of the channel 181 179 * @state: local state of the channel 182 180 * @remote_state: remote state of the channel 181 + * @state_change_event: state change event 183 182 * @info: byte aligned outgoing/incoming channel info 184 183 * @info_word: word aligned outgoing/incoming channel info 185 184 * @tx_lock: lock to make writes to the channel mutually exclusive ··· 193 188 * @cb: callback function registered for this channel 194 189 * @recv_lock: guard for rx info modifications and cb pointer 195 190 * @pkt_size: size of the currently handled packet 191 + * @drvdata: driver private data 196 192 * @list: lite entry for @channels in qcom_smd_edge 197 193 */ 198 194 struct qcom_smd_channel { ··· 733 727 * @channel: channel handle 734 728 * @data: buffer of data to write 735 729 * @len: number of bytes to write 730 + * @wait: flag to indicate if write has ca wait 736 731 * 737 732 * This is a blocking write of len bytes into the channel's tx ring buffer and 738 733 * signal the remote end. It will sleep until there is enough space available