NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
common_common.h File Reference
#include <stdbool.h>
#include <doca_comch.h>
#include <doca_ctx.h>
#include <doca_dev.h>
#include <doca_pe.h>
#include <doca_sync_event.h>
Include dependency graph for common_common.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  sync_event_config
 
struct  sync_event_runtime_objects
 

Macros

#define SYNC_EVENT_CC_MAX_MSG_SIZE   1024 /* DOCA comch maximum message size */
 
#define SYNC_EVENT_CC_MAX_QUEUE_SIZE   8 /* DOCA comch maximum queue size */
 
#define SYNC_EVENT_CC_MAX_TASKS   8 /* DOCA comch maximum send tasks to allocate */
 
#define SYNC_EVENT_CC_SERVICE_NAME   "sync_event_cc" /* DOCA comch service name */
 
#define SYNC_EVENT_CC_TIMEOUT_SEC   30 /* DOCA comch timeout in seconds */
 
#define SYNC_EVENT_CC_ACK_SIZE   1 /* DOCA comch acknowledge size in bytes */
 
#define SYNC_EVENT_CC_ACK_VALUE   1 /* DOCA comch acknowledge value */
 

Functions

doca_error_t sync_event_params_register (void)
 
doca_error_t sync_event_get_export_to_dpu_supported (struct doca_devinfo *devinfo)
 
doca_error_t sync_event_config_validate (const struct sync_event_config *se_cfg, const struct sync_event_runtime_objects *se_rt_objs)
 
doca_error_t sync_event_start_async (const struct sync_event_config *se_cfg, struct sync_event_runtime_objects *se_rt_objs)
 
doca_error_t sync_event_cc_handshake (struct sync_event_runtime_objects *se_rt_objs)
 
doca_error_t sync_event_async_task_submit (struct sync_event_runtime_objects *se_rt_objs, struct doca_task *se_task)
 
void sync_event_tear_down (struct sync_event_runtime_objects *se_rt_objs)
 

Macro Definition Documentation

◆ SYNC_EVENT_CC_ACK_SIZE

#define SYNC_EVENT_CC_ACK_SIZE   1 /* DOCA comch acknowledge size in bytes */

Definition at line 42 of file common_common.h.

◆ SYNC_EVENT_CC_ACK_VALUE

#define SYNC_EVENT_CC_ACK_VALUE   1 /* DOCA comch acknowledge value */

Definition at line 43 of file common_common.h.

◆ SYNC_EVENT_CC_MAX_MSG_SIZE

#define SYNC_EVENT_CC_MAX_MSG_SIZE   1024 /* DOCA comch maximum message size */

Definition at line 37 of file common_common.h.

◆ SYNC_EVENT_CC_MAX_QUEUE_SIZE

#define SYNC_EVENT_CC_MAX_QUEUE_SIZE   8 /* DOCA comch maximum queue size */

Definition at line 38 of file common_common.h.

◆ SYNC_EVENT_CC_MAX_TASKS

#define SYNC_EVENT_CC_MAX_TASKS   8 /* DOCA comch maximum send tasks to allocate */

Definition at line 39 of file common_common.h.

◆ SYNC_EVENT_CC_SERVICE_NAME

#define SYNC_EVENT_CC_SERVICE_NAME   "sync_event_cc" /* DOCA comch service name */

Definition at line 40 of file common_common.h.

◆ SYNC_EVENT_CC_TIMEOUT_SEC

#define SYNC_EVENT_CC_TIMEOUT_SEC   30 /* DOCA comch timeout in seconds */

Definition at line 41 of file common_common.h.

Function Documentation

◆ sync_event_async_task_submit()

doca_error_t sync_event_async_task_submit ( struct sync_event_runtime_objects se_rt_objs,
struct doca_task *  se_task 
)

Definition at line 854 of file common_common.c.

◆ sync_event_cc_handshake()

doca_error_t sync_event_cc_handshake ( struct sync_event_runtime_objects se_rt_objs)

Definition at line 805 of file common_common.c.

◆ sync_event_config_validate()

doca_error_t sync_event_config_validate ( const struct sync_event_config se_cfg,
const struct sync_event_runtime_objects se_rt_objs 
)

Definition at line 410 of file common_common.c.

◆ sync_event_get_export_to_dpu_supported()

doca_error_t sync_event_get_export_to_dpu_supported ( struct doca_devinfo *  devinfo)

Definition at line 44 of file sync_event_local_pci_sample.c.

◆ sync_event_params_register()

doca_error_t sync_event_params_register ( void  )

Definition at line 299 of file common_common.c.

◆ sync_event_start_async()

doca_error_t sync_event_start_async ( const struct sync_event_config se_cfg,
struct sync_event_runtime_objects se_rt_objs 
)

Definition at line 440 of file common_common.c.

◆ sync_event_tear_down()

void sync_event_tear_down ( struct sync_event_runtime_objects se_rt_objs)

Definition at line 895 of file common_common.c.