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

Go to the source code of this file.

Data Structures

struct  comch_config
 
struct  comch_ctrl_path_client_cb_config
 
struct  comch_ctrl_path_server_cb_config
 

Macros

#define MAX_SAMPLE_TXT_SIZE   4080 /* Maximum size of user input text for the sample */
 
#define MAX_TXT_SIZE   (MAX_SAMPLE_TXT_SIZE + 1) /* Maximum size of input text */
 
#define SLEEP_IN_NANOS   (10 * 1000) /* Sample tasks every 10 microseconds */
 

Functions

doca_error_t register_comch_params (void)
 
void clean_comch_ctrl_path_client (struct doca_comch_client *client, struct doca_pe *pe)
 
doca_error_t init_comch_ctrl_path_client (const char *server_name, struct doca_dev *hw_dev, struct comch_ctrl_path_client_cb_config *cb_cfg, struct doca_comch_client **client, struct doca_pe **pe)
 
void clean_comch_ctrl_path_server (struct doca_comch_server *server, struct doca_pe *pe)
 
doca_error_t init_comch_ctrl_path_server (const char *server_name, struct doca_dev *hw_dev, struct doca_dev_rep *rep_dev, struct comch_ctrl_path_server_cb_config *cb_cfg, struct doca_comch_server **server, struct doca_pe **pe)
 

Macro Definition Documentation

◆ MAX_SAMPLE_TXT_SIZE

#define MAX_SAMPLE_TXT_SIZE   4080 /* Maximum size of user input text for the sample */

Definition at line 37 of file comch_ctrl_path_common.h.

◆ MAX_TXT_SIZE

#define MAX_TXT_SIZE   (MAX_SAMPLE_TXT_SIZE + 1) /* Maximum size of input text */

Definition at line 38 of file comch_ctrl_path_common.h.

◆ SLEEP_IN_NANOS

#define SLEEP_IN_NANOS   (10 * 1000) /* Sample tasks every 10 microseconds */

Definition at line 39 of file comch_ctrl_path_common.h.

Function Documentation

◆ clean_comch_ctrl_path_client()

void clean_comch_ctrl_path_client ( struct doca_comch_client *  client,
struct doca_pe *  pe 
)

Clean client and its PE

@client [in]: Client object to clean @pe [in]: Client PE object to clean

Definition at line 190 of file comch_ctrl_path_common.c.

◆ clean_comch_ctrl_path_server()

void clean_comch_ctrl_path_server ( struct doca_comch_server *  server,
struct doca_pe *  pe 
)

Clean server and its PE

@server [in]: Server object to clean @pe [in]: Server PE object to clean

Definition at line 315 of file comch_ctrl_path_common.c.

◆ init_comch_ctrl_path_client()

doca_error_t init_comch_ctrl_path_client ( const char *  server_name,
struct doca_dev *  hw_dev,
struct comch_ctrl_path_client_cb_config cb_cfg,
struct doca_comch_client **  client,
struct doca_pe **  pe 
)

Initialize a cc client and its PE

@server_name [in]: Server name to connect to @hw_dev [in]: Device to use @cb_cfg [in]: Client callback configuration @client [out]: Client object struct to initialize @pe [out]: Client PE object struct to initialize

Returns
: DOCA_SUCCESS on success and DOCA_ERROR otherwise

Definition at line 207 of file comch_ctrl_path_common.c.

◆ init_comch_ctrl_path_server()

doca_error_t init_comch_ctrl_path_server ( const char *  server_name,
struct doca_dev *  hw_dev,
struct doca_dev_rep *  rep_dev,
struct comch_ctrl_path_server_cb_config cb_cfg,
struct doca_comch_server **  server,
struct doca_pe **  pe 
)

Initialize a cc server and its PE

@server_name [in]: Server name to connect to @hw_dev [in]: Device to use @rep_dev [in]: Representor device to use @cb_cfg [in]: Server callback configuration @server [out]: Server object struct to initialize @pe [out]: Server PE object struct to initialize

Returns
: DOCA_SUCCESS on success and DOCA_ERROR otherwise

Definition at line 332 of file comch_ctrl_path_common.c.

◆ register_comch_params()

doca_error_t register_comch_params ( void  )

Definition at line 129 of file comch_ctrl_path_common.c.