NvPSB.h File Reference

#include <string>

Go to the source code of this file.

Enumerations
enum	NvPSBEndpoint { NVPSB_PSS_SOURCE , NVPSB_PSS_SINK , NVPSB_PSS_DAEMON , NVPSB_PSD_CLIENT }
enum	NvPSBLogLevel {   NVPSB_LOG_EMERG , NVPSB_LOG_ALERT , NVPSB_LOG_CRIT , NVPSB_LOG_ERR ,   NVPSB_LOG_WARNING , NVPSB_LOG_NOTICE , NVPSB_LOG_INFO , NVPSB_LOG_DEBUG }
enum	NvPSBErr { NVPSB_SUCCESS , NVPSB_FAIL , NVPSB_NO_RSP , NVPSB_UNINITIALIZED }
	Enumeration of PSB error codes. More...

Functions
NvPSBErr	NvPSBInitialize (const char *ident, NvPSBEndpoint endpoint)
	Initializes NvPSB. More...
NvPSBErr	NvPSBWriteData (NvPSBLogLevel level, const std::string data, const std::string additionalInfo)
	Writes data via PSB to the secure storage. More...
NvPSBErr	NvPSBExit ()
	Exits NvPSB. More...

Enumeration Type Documentation

NvPSBEndpoint

enum NvPSBEndpoint

Enumerator
NVPSB_PSS_SOURCE
NVPSB_PSS_SINK
NVPSB_PSS_DAEMON
NVPSB_PSD_CLIENT

{
    NVPSB_PSS_SOURCE,
    NVPSB_PSS_SINK,
    NVPSB_PSS_DAEMON,
    NVPSB_PSD_CLIENT
}NvPSBEndpoint;

NvPSBErr

enum NvPSBErr

Enumeration of PSB error codes.

This enumeration defines various error codes that can occur during PSB communication.

Enumerator
NVPSB_SUCCESS	Operation completed successfully.
NVPSB_FAIL	Generic failure.
NVPSB_NO_RSP	No response received.
NVPSB_UNINITIALIZED	Module not initialised before performing action.

{
    NVPSB_SUCCESS, 
    NVPSB_FAIL,    
    NVPSB_NO_RSP,   
    NVPSB_UNINITIALIZED 
} NvPSBErr;

NvPSBLogLevel

enum NvPSBLogLevel

Enumerator
NVPSB_LOG_EMERG
NVPSB_LOG_ALERT
NVPSB_LOG_CRIT
NVPSB_LOG_ERR
NVPSB_LOG_WARNING
NVPSB_LOG_NOTICE
NVPSB_LOG_INFO
NVPSB_LOG_DEBUG

{
    NVPSB_LOG_EMERG, //system is unusable
    NVPSB_LOG_ALERT, //action must be taken immediately
    NVPSB_LOG_CRIT, //critical conditions
    NVPSB_LOG_ERR, //error conditions
    NVPSB_LOG_WARNING, //warning conditions
    NVPSB_LOG_NOTICE, //normal, but significant, condition
    NVPSB_LOG_INFO, //informational message
    NVPSB_LOG_DEBUG //debug-level message
}NvPSBLogLevel;

Function Documentation

NvPSBExit()

NvPSBErr NvPSBExit

(

)

Exits NvPSB.

Returns

NvPSBErr Returns an error code indicating the success or failure of the operation.

NvPSBInitialize()

NvPSBErr NvPSBInitialize	(	const char *	ident,
		NvPSBEndpoint	endpoint
	)

Initializes NvPSB.

This function initializes PSB communication channel to log data.

Parameters

[in]	ident	Name of the channel used for writing data.
[in]	endpoint	Param indicating whether endpoint is PSS SOURCE / SINK / DAEMON or PSD Client

Returns

NvPSBErr Returns an error code indicating the success or failure of the initialization.

NvPSBWriteData()

NvPSBErr NvPSBWriteData	(	NvPSBLogLevel	level,
		const std::string	data,
		const std::string	additionalInfo
	)

Writes data via PSB to the secure storage.

Parameters

level	Logging Level
data	string containing all the data to be written
additionalInfo	string containing additonal data to be written

Returns

NvPSBErr Returns an error code indicating the success or failure of the operation.