NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
doca_pcc_dev_services.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES, ALL RIGHTS RESERVED.
3  *
4  * This software product is a proprietary product of NVIDIA CORPORATION &
5  * AFFILIATES (the "Company") and all right, title, and interest in and to the
6  * software product, including all associated intellectual property rights, are
7  * and shall remain exclusively with the Company.
8  *
9  * This software product is governed by the End User License Agreement
10  * provided with the software product.
11  *
12  */
13 
23 #ifndef DOCA_PCC_DEV_SERVICES_H_
24 #define DOCA_PCC_DEV_SERVICES_H_
25 
31 #define DOCA_DPA_DEVICE
32 
33 #include <doca_pcc_dev_common.h>
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
56 DOCA_EXPERIMENTAL
57 doca_pcc_dev_error_t doca_pcc_dev_user_mailbox_handle(void *request,
58  uint32_t request_size,
59  uint32_t max_response_size,
60  void *response,
61  uint32_t *response_size) __attribute__((weak));
62 
72 DOCA_STABLE
73 void doca_pcc_dev_printf(const char *format, ...) __attribute__((format(printf, 1, 2)));
74 
85 DOCA_STABLE
86 void doca_pcc_dev_trace_5(int format_id, uint64_t arg1, uint64_t arg2, uint64_t arg3, uint64_t arg4, uint64_t arg5);
87 
97 DOCA_STABLE
98 void doca_pcc_dev_trace_flush(void);
99 
109 DOCA_EXPERIMENTAL
110 unsigned int doca_pcc_dev_thread_rank(void);
111 
112 #ifdef __cplusplus
113 }
114 #endif
115 
116 #endif /* DOCA_PCC_DEV_SERVICES_H_ */
117 
doca_pcc_dev_common.h
__attribute__
#define __attribute__(_x_)
To allow compiling functions and structs that are using GCC attributes using attribute() in compilers...
Definition: doca_compat.h:81
DOCA_EXPERIMENTAL
#define DOCA_EXPERIMENTAL
To set a Symbol (or specifically a function) as experimental.
Definition: doca_compat.h:103
DOCA_STABLE
#define DOCA_STABLE
To set a Symbol (or specifically a function) as stable API, i.e. it won't be changed.
Definition: doca_compat.h:96
doca_pcc_dev_error_t
doca_pcc_dev_error_t
API functions return status.
Definition: doca_pcc_dev_common.h:54
doca_pcc_dev_user_mailbox_handle
DOCA_EXPERIMENTAL doca_pcc_dev_error_t doca_pcc_dev_user_mailbox_handle(void *request, uint32_t request_size, uint32_t max_response_size, void *response, uint32_t *response_size) __attribute__((weak))
User callback to process a request from host to device.
Definition: np_switch_telemetry_dev_main.c:283
doca_pcc_dev_thread_rank
DOCA_EXPERIMENTAL unsigned int doca_pcc_dev_thread_rank(void)
Obtains the thread rank.
doca_pcc_dev_trace_flush
DOCA_STABLE void doca_pcc_dev_trace_flush(void)
Flush the trace message buffer to Host.
doca_pcc_dev_trace_5
DOCA_STABLE void DOCA_STABLE void doca_pcc_dev_trace_5(int format_id, uint64_t arg1, uint64_t arg2, uint64_t arg3, uint64_t arg4, uint64_t arg5)
Creates trace message entry with 5 arguments.
doca_pcc_dev_printf
DOCA_STABLE void doca_pcc_dev_printf(const char *format,...) __attribute__((format(printf
Print to Host.