diff mbox series

[v2,1/4] scsi: ufs: core: Improve the struct ufs_hba documentation

Message ID 20240909231139.2367576-2-bvanassche@acm.org (mailing list archive)
State Changes Requested
Headers show
Series Improve the UFS driver link hibernation code | expand

Commit Message

Bart Van Assche Sept. 9, 2024, 11:11 p.m. UTC
Make the role of the structure members related to UIC command processing
more clear.

Signed-off-by: Bart Van Assche <bvanassche@acm.org>
---
 include/ufs/ufshcd.h | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

Comments

Peter Wang (王信友) Sept. 10, 2024, 12:32 p.m. UTC | #1
On Mon, 2024-09-09 at 16:11 -0700, Bart Van Assche wrote:
>  	 
> External email : Please do not click links or open attachments until
> you have verified the sender or the content.
>  Make the role of the structure members related to UIC command
> processing
> more clear.
> 
> Signed-off-by: Bart Van Assche <bvanassche@acm.org>
> ---
>  include/ufs/ufshcd.h | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/include/ufs/ufshcd.h b/include/ufs/ufshcd.h
> index a43b14276bc3..85933775c9f3 100644
> --- a/include/ufs/ufshcd.h
> +++ b/include/ufs/ufshcd.h
> @@ -868,9 +868,10 @@ enum ufshcd_mcq_opr {
>   * @tmf_tag_set: TMF tag set.
>   * @tmf_queue: Used to allocate TMF tags.
>   * @tmf_rqs: array with pointers to TMF requests while these are in
> progress.
> - * @active_uic_cmd: handle of active UIC command
> - * @uic_cmd_mutex: mutex for UIC command
> - * @uic_async_done: completion used during UIC processing
> + * @active_uic_cmd: pointer to active UIC command.
> + * @uic_cmd_mutex: mutex used for serializing UIC command
> processing.
> + * @uic_async_done: completion used to wait for power mode or
> hibernation state
> + *	changes.
>   * @ufshcd_state: UFSHCD state
>   * @eh_flags: Error handling flags
>   * @intr_mask: Interrupt Mask Bits

Reviewed-by: Peter Wang <peter.wang@mediatek.com>
diff mbox series

Patch

diff --git a/include/ufs/ufshcd.h b/include/ufs/ufshcd.h
index a43b14276bc3..85933775c9f3 100644
--- a/include/ufs/ufshcd.h
+++ b/include/ufs/ufshcd.h
@@ -868,9 +868,10 @@  enum ufshcd_mcq_opr {
  * @tmf_tag_set: TMF tag set.
  * @tmf_queue: Used to allocate TMF tags.
  * @tmf_rqs: array with pointers to TMF requests while these are in progress.
- * @active_uic_cmd: handle of active UIC command
- * @uic_cmd_mutex: mutex for UIC command
- * @uic_async_done: completion used during UIC processing
+ * @active_uic_cmd: pointer to active UIC command.
+ * @uic_cmd_mutex: mutex used for serializing UIC command processing.
+ * @uic_async_done: completion used to wait for power mode or hibernation state
+ *	changes.
  * @ufshcd_state: UFSHCD state
  * @eh_flags: Error handling flags
  * @intr_mask: Interrupt Mask Bits