NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
doca_sta_subsystem.h File Reference
#include <stdint.h>
#include <doca_compat.h>
#include <doca_error.h>
#include <doca_sta_handle.h>
#include <doca_sta_task.h>
Include dependency graph for doca_sta_subsystem.h:

Go to the source code of this file.

Functions

DOCA_EXPERIMENTAL doca_error_t doca_sta_subsystem_create (struct doca_sta *sta, const char *nqn, struct doca_sta_subs_handle **subs_handle)
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_subsystem_add_dev (struct doca_sta_subs_handle *subs_handle, const struct doca_dev *dev)
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_subsystem_task_rm_ns_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 remove namespace tasks configuration. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_subsystem_destroy (struct doca_sta_subs_handle *subs_handle)
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_subsystem_add_ns (struct doca_sta_subs_handle *subs_handle, uint32_t fe_ns_id, uint32_t ns_block_size, uint32_t be_ns_id, struct doca_sta_be_handle *be_handle, struct doca_sta_ns_handle **ns_handle)
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_subsystem_rm_ns (struct doca_sta_subs_handle *subs_handle, struct doca_sta_ns_handle *ns_handle)
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_subsystem_task_rm_ns_alloc_init (struct doca_sta_subs_handle *subs_handle, struct doca_sta_ns_handle *ns_handle, union doca_data user_data, struct doca_sta_producer_task_send **task)
 This method allocates and initializes a STA remove namespace task. More...
 

Function Documentation

◆ doca_sta_subsystem_add_dev()

DOCA_EXPERIMENTAL doca_error_t doca_sta_subsystem_add_dev ( struct doca_sta_subs_handle *  subs_handle,
const struct doca_dev *  dev 
)

◆ doca_sta_subsystem_add_ns()

DOCA_EXPERIMENTAL doca_error_t doca_sta_subsystem_add_ns ( struct doca_sta_subs_handle *  subs_handle,
uint32_t  fe_ns_id,
uint32_t  ns_block_size,
uint32_t  be_ns_id,
struct doca_sta_be_handle *  be_handle,
struct doca_sta_ns_handle **  ns_handle 
)

◆ doca_sta_subsystem_create()

DOCA_EXPERIMENTAL doca_error_t doca_sta_subsystem_create ( struct doca_sta *  sta,
const char *  nqn,
struct doca_sta_subs_handle **  subs_handle 
)

◆ doca_sta_subsystem_destroy()

DOCA_EXPERIMENTAL doca_error_t doca_sta_subsystem_destroy ( struct doca_sta_subs_handle *  subs_handle)

◆ doca_sta_subsystem_rm_ns()

DOCA_EXPERIMENTAL doca_error_t doca_sta_subsystem_rm_ns ( struct doca_sta_subs_handle *  subs_handle,
struct doca_sta_ns_handle *  ns_handle 
)

◆ doca_sta_subsystem_task_rm_ns_alloc_init()

DOCA_EXPERIMENTAL doca_error_t doca_sta_subsystem_task_rm_ns_alloc_init ( struct doca_sta_subs_handle *  subs_handle,
struct doca_sta_ns_handle *  ns_handle,
union doca_data  user_data,
struct doca_sta_producer_task_send **  task 
)

This method allocates and initializes a STA remove namespace task.

Parameters
[in]subs_handleThe subsystem handle
[in]ns_handleThe handle of the namespace that should be removed
[in]user_datadoca_data to attach to the task
[out]taskmemcpy 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_subsystem_task_rm_ns_set_conf()

DOCA_EXPERIMENTAL doca_error_t doca_sta_subsystem_task_rm_ns_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 remove namespace tasks configuration.

Parameters
[in]staThe STA context to config
[in]task_completion_cbTask completion callback
[in]task_error_cbTask error callback
Returns
DOCA_SUCCESS - in case of success. Error code - in case of failure. see doca_error_t.