Differential D5792 Diff 21886 contrib/ofed/libibverbs/man/ibv_create_qp.3

Changeset View

Standalone View

contrib/ofed/libibverbs/man/ibv_create_qp.3

	Show All 22 Lines
	.nf			.nf
	struct ibv_qp_init_attr {			struct ibv_qp_init_attr {
	.in +8			.in +8
	void qp_context; / Associated context of the QP */			void qp_context; / Associated context of the QP */
	struct ibv_cq send_cq; / CQ to be associated with the Send Queue (SQ) */			struct ibv_cq send_cq; / CQ to be associated with the Send Queue (SQ) */
	struct ibv_cq recv_cq; / CQ to be associated with the Receive Queue (RQ) */			struct ibv_cq recv_cq; / CQ to be associated with the Receive Queue (RQ) */
	struct ibv_srq srq; / SRQ handle if QP is to be associated with an SRQ, otherwise NULL */			struct ibv_srq srq; / SRQ handle if QP is to be associated with an SRQ, otherwise NULL */
	struct ibv_qp_cap cap; /* QP capabilities */			struct ibv_qp_cap cap; /* QP capabilities */
	enum ibv_qp_type qp_type; /* QP Transport Service Type: IBV_QPT_RC, IBV_QPT_UC, IBV_QPT_UD or IBV_QPT_XRC */			enum ibv_qp_type qp_type; /* QP Transport Service Type: IBV_QPT_RC, IBV_QPT_UC, IBV_QPT_UD or IBV_QPT_RAW_PACKET */
	int sq_sig_all; /* If set, each Work Request (WR) submitted to the SQ generates a completion entry */			int sq_sig_all; /* If set, each Work Request (WR) submitted to the SQ generates a completion entry */
	struct ibv_xrc_domain xrc_domain; / XRC domain the QP will be associated with (valid only for IBV_QPT_XRC QP), otherwise NULL */
	.in -8			.in -8
	};			};
	.sp			.sp
	.nf			.nf
	struct ibv_qp_cap {			struct ibv_qp_cap {
	.in +8			.in +8
	uint32_t max_send_wr; /* Requested max number of outstanding WRs in the SQ */			uint32_t max_send_wr; /* Requested max number of outstanding WRs in the SQ */
	uint32_t max_recv_wr; /* Requested max number of outstanding WRs in the RQ */			uint32_t max_recv_wr; /* Requested max number of outstanding WRs in the RQ */
	Show All 17 Lines
	.SH "RETURN VALUE"			.SH "RETURN VALUE"
	.B ibv_create_qp()			.B ibv_create_qp()
	returns a pointer to the created QP, or NULL if the request fails.			returns a pointer to the created QP, or NULL if the request fails.
	Check the QP number (\fBqp_num\fR) in the returned QP.			Check the QP number (\fBqp_num\fR) in the returned QP.
	.PP			.PP
	.B ibv_destroy_qp()			.B ibv_destroy_qp()
	returns 0 on success, or the value of errno on failure (which indicates the failure reason).			returns 0 on success, or the value of errno on failure (which indicates the failure reason).
	.SH "NOTES"			.SH "NOTES"
	.B ibv_create_qp()
	will fail if a it is asked to create QP of a type other than
	.B IBV_QPT_RC
	or
	.B IBV_QPT_UD
	associated with an SRQ.
	.PP			.PP
	The attributes max_recv_wr and max_recv_sge are ignored by			The attributes max_recv_wr and max_recv_sge are ignored by
	.B ibv_create_qp()			.B ibv_create_qp()
	if the QP is to be associated with an SRQ.			if the QP is to be associated with an SRQ.
	.PP			.PP
	.B ibv_destroy_qp()			.B ibv_destroy_qp()
	fails if the QP is attached to a multicast group.			fails if the QP is attached to a multicast group.
	.SH "SEE ALSO"			.SH "SEE ALSO"
	.BR ibv_alloc_pd (3),			.BR ibv_alloc_pd (3),
	.BR ibv_modify_qp (3),			.BR ibv_modify_qp (3),
	.BR ibv_query_qp (3)			.BR ibv_query_qp (3)
	.SH "AUTHORS"			.SH "AUTHORS"
	.TP			.TP
	Dotan Barak <dotanb@mellanox.co.il>			Dotan Barak <dotanba@gmail.com>