libxcoder  5.5.0
ni_quadraprobe.h
Go to the documentation of this file.
1 /*******************************************************************************
2  *
3  * Copyright (C) 2022 NETINT Technologies
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy
6  * of this software and associated documentation files (the "Software"), to deal
7  * in the Software without restriction, including without limitation the rights
8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9  * copies of the Software, and to permit persons to whom the Software is
10  * furnished to do so, subject to the following conditions:
11  *
12  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
13  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
14  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
15  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
16  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
17  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
18  * SOFTWARE.
19  *
20  ******************************************************************************/
21 
22 /*!*****************************************************************************
23  * \file ni_quadraprobe.h
24  *
25  * \brief Quadraprobe definitions
26  ******************************************************************************/
27 
28 #pragma once
29 
30 #ifdef __cplusplus
31 extern "C"
32 {
33 #endif
34 /*!*****************************************************************************
35  * \brief Dump raw firmware logs from all detected Quadra devices
36  *
37  * This function enumerates all detected Quadra cards in the system,
38  * mmaps each card's BAR4, and dumps per-core logs to files in the specified output directory.
39  * It summarizes success and captures partial failures across multiple devices.
40  *
41  * \param[in] outdir Directory to write log file outputs (use "." for current directory)
42  * \param[in] core_reset_log whether to get core reset log
43  *
44  * \return 0 if all device logs were dumped successfully,
45  * 1 if no Quadra devices were found,
46  * 2 if one or more logs failed to dump but some succeeded,
47  * <0 for unexpected fatal/internal errors.
48  ******************************************************************************/
49 #if defined(__linux__)
50 LIB_API int ni_rsrc_log_dump(const char *outdir, bool core_reset_log);
51 #endif
52 
53 #ifdef __cplusplus
54 }
55 #endif
LIB_API
#define LIB_API
Definition: ni_libxcoder_dynamic_loading.h:54