NvPSD.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2025 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 NVPSD_H
#define NVPSD_H
 
#include "pss_protocol.h"
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum NvPSDErr
{
    NVPSD_SUCCESS, 
    NVPSD_FAIL,    
    NVPSD_NO_RSP   
} NvPSDErr;
 
typedef enum NvPSDEndpoint_t
{
    NVPSD_PSS,
    NVPSD_CLIENT
}NvPSDEndpoint;
 
typedef struct NvPSDCallbacks
{
    NvPSDErr (*processDecisionRequest)(const DecisionRequest* request, DecisionResponse* response);
    NvPSDErr (*publishDecisionResponse)(const DecisionResponse* response);
    NvPSDErr (*notifyShutdownRequest)(void);
} NvPSDCallbacks;
 
 
typedef struct NvPSDCtx* NvPSDCtx_t ;
 
NvPSDCtx* NvPSDCreateContext();
 
 
NvPSDErr NvPSDInitialize(NvPSDCtx* ctx, const char* writeChannel, const char* readChannel,
                        const char* criticalWriteChannel, const char* criticalReadChannel,
                        NvPSDEndpoint endpoint);
 
NvPSDErr NvPSDRegisterCallbacks(NvPSDCtx* ctx, NvPSDCallbacks* callbacks);
 
NvPSDErr NvPSDStart(NvPSDCtx* ctx);
 
/*
 *  @brief Receive a DecisionRequest and send a DecisionResponse.
 *  @description  This function is used by PSD to receive a DecisionRequest, process it, and send back a DecisionResponse.
 *
 *  @param[in] ctx Pointer to the NvPSD context.
 *  @param[in] request A const reference to a DecisionRequest as input.
 *  @param[in] response A non-const reference to a DecisionResponse to store the result.
 *
 *  @return NvPSDErr Return an error code indicating whether the processing and communication were successful.
 */
NvPSDErr NvPSDProcessDecisionRequest(NvPSDCtx* ctx, const DecisionRequest* request, DecisionResponse* response);
 
NvPSDErr NvPSDStop(NvPSDCtx* ctx);
 
NvPSDErr NvPSDExit(NvPSDCtx* ctx);
 
void NvPSDDestroyContext(NvPSDCtx* ctx);
 
// Functions for exchanging heartbeat messages
// Functions to update Configuration Data
 
#ifdef __cplusplus
}
#endif
 
#endif