NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
DOCA DPA Device - Sync Event
Collaboration diagram for DOCA DPA Device - Sync Event:

Functions

DOCA_EXPERIMENTAL void doca_dpa_dev_sync_event_get (doca_dpa_dev_sync_event_t dpa_dev_se_handle, uint64_t *value)
 Get the counter's value of a DOCA Sync Event. More...
 
DOCA_EXPERIMENTAL void doca_dpa_dev_sync_event_update_add (doca_dpa_dev_sync_event_t dpa_dev_se_handle, uint64_t value)
 Atomically increase the counter of a DOCA Sync Event by a given value. More...
 
DOCA_EXPERIMENTAL void doca_dpa_dev_sync_event_update_set (doca_dpa_dev_sync_event_t dpa_dev_se_handle, uint64_t value)
 Set the counter of a DOCA Sync Event to a given value. More...
 
DOCA_EXPERIMENTAL void doca_dpa_dev_sync_event_wait_gt (doca_dpa_dev_sync_event_t dpa_dev_se_handle, uint64_t value, uint64_t mask)
 Wait for the value of a DOCA Sync Event to be greater than a given value. More...
 
DOCA_EXPERIMENTAL void doca_dpa_dev_sync_event_post_wait_gt (doca_dpa_dev_async_ops_t async_ops_handle, doca_dpa_dev_sync_event_t wait_se_handle, uint64_t value)
 Wait for the value of a DOCA Sync Event to be greater than a given value. More...
 
DOCA_EXPERIMENTAL void doca_dpa_dev_sync_event_post_wait_ne (doca_dpa_dev_async_ops_t async_ops_handle, doca_dpa_dev_sync_event_t wait_se_handle, uint64_t value)
 Wait for the value of a DOCA Sync Event to be not equal to a given value. More...
 

Variables

__dpa_global__ typedef uint64_t doca_dpa_dev_sync_event_t
 DPA sync event handle type definition. More...
 
__dpa_global__ typedef uint64_t doca_dpa_dev_sync_event_remote_net_t
 DPA remote sync event handle type definition. More...
 

Detailed Description

DOCA DPA Device - Sync Event

Function Documentation

◆ doca_dpa_dev_sync_event_get()

DOCA_EXPERIMENTAL void doca_dpa_dev_sync_event_get ( doca_dpa_dev_sync_event_t  dpa_dev_se_handle,
uint64_t *  value 
)

Get the counter's value of a DOCA Sync Event.

Parameters
[in]dpa_dev_se_handle- DOCA DPA device sync event handle
[out]value- DOCA sync event counter value

◆ doca_dpa_dev_sync_event_post_wait_gt()

DOCA_EXPERIMENTAL void doca_dpa_dev_sync_event_post_wait_gt ( doca_dpa_dev_async_ops_t  async_ops_handle,
doca_dpa_dev_sync_event_t  wait_se_handle,
uint64_t  value 
)

Wait for the value of a DOCA Sync Event to be greater than a given value.

This function posts a wait operation on the DOCA sync event using the DPA asynchronous ops context to obtain a DPA thread activation Attached thread is activated when value of DOCA Sync Event is greater than a given value This is a non-blocking routine.

Valid values must be in the range [0, 254] and can be called for event with value in the range [0, 254] - other scenarios result in undefined behavior.

Parameters
[in]async_ops_handle- DOCA DPA device asynchronous ops handle
[in]wait_se_handle- DOCA DPA device sync event handle
[in]value- the value to wait for the DOCA Sync Event to be greater than

◆ doca_dpa_dev_sync_event_post_wait_ne()

DOCA_EXPERIMENTAL void doca_dpa_dev_sync_event_post_wait_ne ( doca_dpa_dev_async_ops_t  async_ops_handle,
doca_dpa_dev_sync_event_t  wait_se_handle,
uint64_t  value 
)

Wait for the value of a DOCA Sync Event to be not equal to a given value.

This function posts a wait operation on the DOCA sync event using the DPA asynchronous ops context to obtain a DPA thread activation Attached thread is activated when value of DOCA Sync Event is not equal to a given value This is a non-blocking routine.

Parameters
[in]async_ops_handle- DOCA DPA device asynchronous ops handle
[in]wait_se_handle- DOCA DPA device sync event handle
[in]value- the value to wait for the DOCA Sync Event to be not equal

◆ doca_dpa_dev_sync_event_update_add()

DOCA_EXPERIMENTAL void doca_dpa_dev_sync_event_update_add ( doca_dpa_dev_sync_event_t  dpa_dev_se_handle,
uint64_t  value 
)

Atomically increase the counter of a DOCA Sync Event by a given value.

Parameters
[in]dpa_dev_se_handle- DOCA DPA device sync event handle
[in]value- the value to increment DOCA sync event by

◆ doca_dpa_dev_sync_event_update_set()

DOCA_EXPERIMENTAL void doca_dpa_dev_sync_event_update_set ( doca_dpa_dev_sync_event_t  dpa_dev_se_handle,
uint64_t  value 
)

Set the counter of a DOCA Sync Event to a given value.

Parameters
[in]dpa_dev_se_handle- DOCA DPA device sync event handle
[in]value- the value to set the DOCA sync event to

◆ doca_dpa_dev_sync_event_wait_gt()

DOCA_EXPERIMENTAL void doca_dpa_dev_sync_event_wait_gt ( doca_dpa_dev_sync_event_t  dpa_dev_se_handle,
uint64_t  value,
uint64_t  mask 
)

Wait for the value of a DOCA Sync Event to be greater than a given value.

Parameters
[in]dpa_dev_se_handle- DOCA DPA device sync event handle
[in]value- the value to wait for the DOCA Sync Event to be greater than
[in]mask- mask to apply (bitwise AND) on the DOCA Sync Event value for comparison with wait threshold.

Variable Documentation

◆ doca_dpa_dev_sync_event_remote_net_t

DPA remote sync event handle type definition.

Definition at line 40 of file doca_dpa_dev_sync_event.h.

◆ doca_dpa_dev_sync_event_t

DPA sync event handle type definition.

Definition at line 35 of file doca_dpa_dev_sync_event.h.