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

RDMA/ib_srp: Add more documentation

Make it more clear what the different ib_srp data structures represent.

Link: https://lore.kernel.org/r/20220215210511.28303-2-bvanassche@acm.org
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
Signed-off-by: Jason Gunthorpe <jgg@nvidia.com>

authored by

Bart Van Assche and committed by
Jason Gunthorpe
4eaa29b4 77528e2a

+10 -1
+10 -1
drivers/infiniband/ulp/srp/ib_srp.h
··· 92 92 }; 93 93 94 94 /* 95 + * RDMA adapter in the initiator system. 96 + * 97 + * @dev_list: List of RDMA ports associated with this RDMA adapter (srp_host). 95 98 * @mr_page_mask: HCA memory registration page mask. 96 99 * @mr_page_size: HCA memory registration page size. 97 100 * @mr_max_size: Maximum size in bytes of a single FR registration request. ··· 112 109 bool use_fast_reg; 113 110 }; 114 111 112 + /* 113 + * One port of an RDMA adapter in the initiator system. 114 + * 115 + * @target_list: List of connected target ports (struct srp_target_port). 116 + * @target_lock: Protects @target_list. 117 + */ 115 118 struct srp_host { 116 119 struct srp_device *srp_dev; 117 120 u8 port; ··· 192 183 }; 193 184 194 185 /** 195 - * struct srp_target_port 186 + * struct srp_target_port - RDMA port in the SRP target system 196 187 * @comp_vector: Completion vector used by the first RDMA channel created for 197 188 * this target port. 198 189 */