vicdiagnostics.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2022-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 *
 * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
 * property and proprietary rights in and to this material, related
 * documentation and any modifications thereto. Any use, reproduction,
 * disclosure or distribution of this material and related documentation
 * without an express license agreement from NVIDIA CORPORATION or
 * its affiliates is strictly prohibited.
 */
 
 
#ifndef VICDIAGNOSTICS_H
#define VICDIAGNOSTICS_H
 
#include "nvmedia_core.h"
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
#define VICDIAGNOSTICS_VERSION_MAJOR   1
 
#define VICDIAGNOSTICS_VERSION_MINOR   0
 
#define VICDIAGNOSTICS_VERSION_PATCH   1
 
typedef struct
{
    uint32_t numDiagnosticsParameters;
 
    uint32_t maxRegisteredSyncs;
 
    uint32_t flags;
 
} VicDiagnosticsAttributes;
 
typedef uint32_t VicDiagnosticsParameters;
 
typedef struct
{
    uint64_t operationId;
} VicDiagnosticsResult;
 
NvMediaStatus
VicDiagnosticsGetVersion(NvMediaVersion * const version);
 
typedef struct VicDiagnostics VicDiagnostics;
 
NvMediaStatus
VicDiagnosticsCreate(VicDiagnostics ** const handle,
                     VicDiagnosticsAttributes const * const attr);
 
NvMediaStatus
VicDiagnosticsDestroy(VicDiagnostics const * const handle);
 
NvMediaStatus
VicDiagnosticsGetParameters(VicDiagnostics const * const handle,
                            VicDiagnosticsParameters * const params);
 
#define VICDIAGNOSTICS_TASK_STATUS_CHECKSUM_MISMATCH 41u
 
NvMediaStatus
VicDiagnosticsExecute(VicDiagnostics const * const handle,
                      VicDiagnosticsParameters const params,
                      VicDiagnosticsResult * const result);
 
NvMediaStatus
VicDiagnosticsGetNumTests(VicDiagnostics const * const handle,
                          uint32_t * const numTests);
 
NvMediaStatus
VicDiagnosticsSetTest(VicDiagnostics const * const handle,
                      VicDiagnosticsParameters const params,
                      uint32_t const testId);
 
 
//
// Version History
//
// Version 1.0 August 10, 2022
// - Initial release
//
// Version 1.0.1 September 2, 2022
// - Always treat parameters handle value 0 as invalid
//
 
#ifdef __cplusplus
}
#endif
 
#endif // VICDIAGNOSTICS_H