Re: [PATCH 1/3] ib_srp: Add more documentation

[Leon Romanovsky <leonro@mellanox.com>]

On Tue, Feb 15, 2022 at 10:26:48AM -0800, Bart Van Assche wrote:
> Make it more clear what the different ib_srp data structures represent.
> 
> Cc: Tetsuo Handa <penguin-kernel@i-love.sakura.ne.jp>
> Signed-off-by: Bart Van Assche <bvanassche@acm.org>
> ---
>  drivers/infiniband/ulp/srp/ib_srp.h | 11 ++++++++++-
>  1 file changed, 10 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/infiniband/ulp/srp/ib_srp.h b/drivers/infiniband/ulp/srp/ib_srp.h
> index abccddeea1e3..55a575e2cace 100644
> --- a/drivers/infiniband/ulp/srp/ib_srp.h
> +++ b/drivers/infiniband/ulp/srp/ib_srp.h
> @@ -92,6 +92,9 @@ enum srp_iu_type {
>  };
>  
>  /*
> + * RDMA adapter in the initiator system.
> + *
> + * @dev_list: List of RDMA ports associated with this RDMA adapter (srp_host).

Isn't this list of RDMA devices and not ports?

>   * @mr_page_mask: HCA memory registration page mask.
>   * @mr_page_size: HCA memory registration page size.
>   * @mr_max_size: Maximum size in bytes of a single FR registration request.
> @@ -109,6 +112,12 @@ struct srp_device {
>  	bool			use_fast_reg;
>  };
>  
> +/*
> + * One port of an RDMA adapter in the initiator system.
> + *
> + * @target_list: List of connected target ports (struct srp_target_port).
> + * @target_lock: Protects @target_list.
> + */
>  struct srp_host {
>  	struct srp_device      *srp_dev;
>  	u8			port;
> @@ -183,7 +192,7 @@ struct srp_rdma_ch {
>  };
>  
>  /**
> - * struct srp_target_port
> + * struct srp_target_port - RDMA port in the SRP target system
>   * @comp_vector: Completion vector used by the first RDMA channel created for
>   *   this target port.
>   */