doca_sta_be.h File Reference

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

Include dependency graph for doca_sta_be.h:

Go to the source code of this file.

Functions
DOCA_EXPERIMENTAL doca_error_t	doca_sta_be_create (struct doca_sta *sta, struct doca_sta_be_handle **be_handle)
DOCA_EXPERIMENTAL doca_error_t	doca_sta_be_destroy (struct doca_sta_be_handle *be_handle)
DOCA_EXPERIMENTAL doca_error_t	doca_sta_be_add_queue (struct doca_sta_be_handle *be_handle, struct doca_mmap *sq, struct doca_mmap *sq_db_reg, uint16_t sq_db_offset, struct doca_mmap *cq, struct doca_mmap *cq_db_reg, uint16_t cq_db_offset, struct doca_sta_be_q_handle **be_q_handle)
DOCA_EXPERIMENTAL doca_error_t	doca_sta_be_task_destroy_queue_set_conf (struct doca_sta *sta, doca_sta_task_completion_cb_t task_completion_cb, doca_sta_task_completion_cb_t task_error_cb)
	This method sets the STA destroy queue tasks configuration. More...
DOCA_EXPERIMENTAL doca_error_t	doca_sta_be_destroy_queue_task_alloc_init (struct doca_sta_be_q_handle *be_q_handle, union doca_data user_data, struct doca_sta_producer_task_send **task)
	This method allocates and initializes a STA destroy queue task. More...

Function Documentation

doca_sta_be_add_queue()

DOCA_EXPERIMENTAL doca_error_t doca_sta_be_add_queue	(	struct doca_sta_be_handle *	be_handle,
		struct doca_mmap *	sq,
		struct doca_mmap *	sq_db_reg,
		uint16_t	sq_db_offset,
		struct doca_mmap *	cq,
		struct doca_mmap *	cq_db_reg,
		uint16_t	cq_db_offset,
		struct doca_sta_be_q_handle **	be_q_handle
	)

doca_sta_be_create()

DOCA_EXPERIMENTAL doca_error_t doca_sta_be_create	(	struct doca_sta *	sta,
		struct doca_sta_be_handle **	be_handle
	)

doca_sta_be_destroy()

DOCA_EXPERIMENTAL doca_error_t doca_sta_be_destroy

(

struct doca_sta_be_handle *

be_handle

)

doca_sta_be_destroy_queue_task_alloc_init()

DOCA_EXPERIMENTAL doca_error_t doca_sta_be_destroy_queue_task_alloc_init	(	struct doca_sta_be_q_handle *	be_q_handle,
		union doca_data	user_data,
		struct doca_sta_producer_task_send **	task
	)

This method allocates and initializes a STA destroy queue task.

Parameters

[in]	be_q_handle	The handle of the be queue that should be destroyed
[in]	user_data	doca_data to attach to the task
[out]	task	memcpy task to allocate

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

• DOCA_ERROR_NO_MEMORY - No more tasks to allocate

doca_sta_be_task_destroy_queue_set_conf()

DOCA_EXPERIMENTAL doca_error_t doca_sta_be_task_destroy_queue_set_conf	(	struct doca_sta *	sta,
		doca_sta_task_completion_cb_t	task_completion_cb,
		doca_sta_task_completion_cb_t	task_error_cb
	)

This method sets the STA destroy queue tasks configuration.

Parameters

[in]	sta	The STA context to config
[in]	task_completion_cb	Task completion callback
[in]	task_error_cb	Task error callback

Returns

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