pss_daemon.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 PSS_DAEMON_H
#define PSS_DAEMON_H
 
#include "pss_protocol.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum NvPSSDStatus_t
{
    NVPSSD_SUCCESS=0,
    NVPSSD_FAIL
}NvPSSDErr;
 
/*
 *  @brief Register a PSS client.
 *  @description This function allows a client to register with the PSS, specifying which sensor it will be monitoring.
 *
 *  @param clientId A unique identifier for the client/sensor.
 *
 *  @return A boolean indicating whether the registration was successful.
 */
NvPSSDErr NvPSSRegisterPSSClient(uint32_t* clientId);
 
/*
 *  @brief Terminate a PSS client.
 *  @description This function allows a client to unregister from the PSS, typically when it's shutting down or no longer needs to monitor sensor.
 *
 *  @param clientId The ID of the client to be terminated.
 *
 *  @return A boolean indicating whether the client was successfully terminated.
 */
NvPSSDErr NvPSSTerminatePSSClient(const uint32_t clientId);
 
/*
 *  @brief Report a safety event.
 *  @dexcription Clients use this function to report safety events to the PSS when they detect potential hazards.
 *
 *  @param clientId The ID of the client reporting the event.
 *  @param event A SafetyEvent structure containing details about the detected safety event.
 *
 *  @return A boolean indicating whether the event was successfully reported.
 */
NvPSSDErr NvPSSReportSafetyEvent(const uint32_t clientId, const SafetyEvent* event);
 
/*
 *  @brief Report a sensor failure.
 *  @description Clients use this function to inform the PSS about sensor failures, which could affect the overall system safety assessment.
 *
 *  @param clientId The ID of the client reporting the sensor failure.
 *  @return A boolean indicating whether the sensor failure was successfully reported.
 */
NvPSSDErr NvPSSReportSensorFailure(const uint32_t clientId);
 
// Functions for exchanging heartbeat messages
// Callbacks for receiving SW/HW error reports
// Functions to log to PSB
// Functions to update Configuration Data
 
#ifdef __cplusplus
}
#endif
 
#endif