doca_sta_io_qp.h File Reference

#include <stdint.h>
#include <doca_compat.h>
#include <doca_error.h>
#include <doca_sta_handle.h>

Include dependency graph for doca_sta_io_qp.h:

Go to the source code of this file.

Functions
DOCA_EXPERIMENTAL doca_error_t	doca_sta_io_qp_alloc (struct doca_sta_io *sta_io, const struct doca_dev *dev, struct doca_sta_qp_handle **qp_handle)
	Allocate an 'empty' STA QP The QP can be used later to accept a remote connection represented by cm_id. More...
DOCA_EXPERIMENTAL doca_error_t	doca_sta_io_qp_accept (struct doca_sta_io *sta_io, struct doca_sta_qp_handle *qp_handle, const struct doca_dev *dev, struct rdma_cm_id *cm_id, const void *priv_data, uint32_t priv_size, struct doca_sta_subs_handle *subs_handle)
	Accept a new remote connection. More...
DOCA_EXPERIMENTAL doca_error_t	doca_sta_io_qp_connect (struct doca_sta_io *sta_io, const struct doca_dev *dev, struct rdma_cm_id *cm_id, const void *priv_data, uint32_t priv_size, struct doca_sta_subs_handle *subs_handle, struct doca_sta_qp_handle **qp_handle)
	Create a newly connected STA QP. More...
DOCA_EXPERIMENTAL doca_error_t	doca_sta_io_qp_connect_set_sq_size (struct doca_sta_io *sta_io, struct doca_sta_qp_handle *qp_handle, uint16_t sq_size)
DOCA_EXPERIMENTAL doca_error_t	doca_sta_io_qp_connect_established (struct doca_sta_io *sta_io, struct doca_sta_qp_handle *qp_handle)
DOCA_EXPERIMENTAL doca_error_t	doca_sta_io_qp_destroy (struct doca_sta_io *sta_io, struct doca_sta_qp_handle *qp_handle)
DOCA_EXPERIMENTAL doca_error_t	doca_sta_io_qp_add_subsystem (struct doca_sta_io *sta_io, struct doca_sta_subs_handle *subs_handle, struct doca_sta_qp_handle *qp_handle)
DOCA_EXPERIMENTAL doca_error_t	doca_sta_io_qp_get_id (struct doca_sta_qp_handle *qp_handle, uint32_t *qp_id)
DOCA_EXPERIMENTAL doca_error_t	doca_sta_io_qp_get_port_id (struct doca_sta_qp_handle *qp_handle, uint16_t *port_id)
DOCA_EXPERIMENTAL doca_error_t	doca_sta_io_qp_get_group_id (struct doca_sta_qp_handle *qp_handle, uint16_t *group_id)
DOCA_EXPERIMENTAL doca_error_t	doca_sta_io_qp_get_index_in_group (struct doca_sta_qp_handle *qp_handle, uint16_t *qp_idx)

Function Documentation

doca_sta_io_qp_accept()

DOCA_EXPERIMENTAL doca_error_t doca_sta_io_qp_accept	(	struct doca_sta_io *	sta_io,
		struct doca_sta_qp_handle *	qp_handle,
		const struct doca_dev *	dev,
		struct rdma_cm_id *	cm_id,
		const void *	priv_data,
		uint32_t	priv_size,
		struct doca_sta_subs_handle *	subs_handle
	)

Accept a new remote connection.

This function accept (connect) a remote QP represented by cm_id to the previously allocated STA QP.

Parameters

[in]	sta_io	- Previously created STA IO context
[in]	qp_handle	- previously allocated STA QP
[in]	dev	- The device to attach to the STA QP
[in]	cm_id	- RDMA CM ID object that carries the remote connection details
[in]	subsys	- subsystem details

Returns

DOCA_SUCCESS - in case of success Error code - in case of failure. see doca_error_t.

doca_sta_io_qp_add_subsystem()

DOCA_EXPERIMENTAL doca_error_t doca_sta_io_qp_add_subsystem	(	struct doca_sta_io *	sta_io,
		struct doca_sta_subs_handle *	subs_handle,
		struct doca_sta_qp_handle *	qp_handle
	)

doca_sta_io_qp_alloc()

DOCA_EXPERIMENTAL doca_error_t doca_sta_io_qp_alloc	(	struct doca_sta_io *	sta_io,
		const struct doca_dev *	dev,
		struct doca_sta_qp_handle **	qp_handle
	)

Allocate an 'empty' STA QP The QP can be used later to accept a remote connection represented by cm_id.

Parameters

[in]	sta_io	- Previously created STA IO context
[in]	dev	- The device to attach to the STA QP
[out]	qp_handle	- STA QP handle

Returns

DOCA_SUCCESS - in case of success Error code - in case of failure. see doca_error_t.

doca_sta_io_qp_connect()

DOCA_EXPERIMENTAL doca_error_t doca_sta_io_qp_connect	(	struct doca_sta_io *	sta_io,
		const struct doca_dev *	dev,
		struct rdma_cm_id *	cm_id,
		const void *	priv_data,
		uint32_t	priv_size,
		struct doca_sta_subs_handle *	subs_handle,
		struct doca_sta_qp_handle **	qp_handle
	)

Create a newly connected STA QP.

This function connect a remote QP represented by cm_id to a newly created STA QP, that represents an offloaded QP.

Parameters

[in]	sta_io	- Previously created STA IO context
[in]	dev	- The device to attach to the STA QP
[in]	cm_id	- RDMA CM ID object that carries the remote connection details
[in]	subsys	- subsystem details
[out]	qp_handle	- STA QP handle

Returns

DOCA_SUCCESS - in case of success Error code - in case of failure. see doca_error_t.

doca_sta_io_qp_connect_established()

DOCA_EXPERIMENTAL doca_error_t doca_sta_io_qp_connect_established	(	struct doca_sta_io *	sta_io,
		struct doca_sta_qp_handle *	qp_handle
	)

doca_sta_io_qp_connect_set_sq_size()

DOCA_EXPERIMENTAL doca_error_t doca_sta_io_qp_connect_set_sq_size	(	struct doca_sta_io *	sta_io,
		struct doca_sta_qp_handle *	qp_handle,
		uint16_t	sq_size
	)

doca_sta_io_qp_destroy()

DOCA_EXPERIMENTAL doca_error_t doca_sta_io_qp_destroy	(	struct doca_sta_io *	sta_io,
		struct doca_sta_qp_handle *	qp_handle
	)

doca_sta_io_qp_get_group_id()

DOCA_EXPERIMENTAL doca_error_t doca_sta_io_qp_get_group_id	(	struct doca_sta_qp_handle *	qp_handle,
		uint16_t *	group_id
	)

doca_sta_io_qp_get_id()

DOCA_EXPERIMENTAL doca_error_t doca_sta_io_qp_get_id	(	struct doca_sta_qp_handle *	qp_handle,
		uint32_t *	qp_id
	)

doca_sta_io_qp_get_index_in_group()

DOCA_EXPERIMENTAL doca_error_t doca_sta_io_qp_get_index_in_group	(	struct doca_sta_qp_handle *	qp_handle,
		uint16_t *	qp_idx
	)

doca_sta_io_qp_get_port_id()

DOCA_EXPERIMENTAL doca_error_t doca_sta_io_qp_get_port_id	(	struct doca_sta_qp_handle *	qp_handle,
		uint16_t *	port_id
	)