NvPSSCom.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 _NVPSS_COM_H_
#define _NVPSS_COM_H_
 
#include <stdint.h>
 
#include "NvPSSErr.h"
 
#define MAX_DATA_SIZE 2048
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum NvPSSComCmd_t
{
    START_PSS,        
    PSS_RDY,          
    PSS_NOT_RDY,      
    FLOW_RATE,        
    FLOW_RATE_ACK,    
    DATA,             
    DATA_ACK,         
    BAD_DATA,         
    BAD_DATA_ACK,     
    CRC_MISMATCH,     
    PAUSE,            
    PAUSE_ACK,        
    RESUME,           
    RESUME_ACK,       
    BYE,              
    BYE_ACK,          
    BAD_RESPONSE,     
    PING,             
    PING_ACK          
} NvPSSComCmd;
 
typedef struct NvPSSComPacket_t
{
    uint32_t pktSrNo;
    NvPSSComCmd cmd;     
    uint32_t size;       
    uint8_t data[MAX_DATA_SIZE]; 
    uint32_t ackSrNo;
    uint64_t checksum;     
} NvPSSComPacket;
 
typedef struct NvPSSComDataSrcCallbacks
{
    NvPSSComErr (*onDataRequest)(NvPSSComPacket* pkt); 
    NvPSSComErr (*onPause)(void);         
    NvPSSComErr (*onResume)(void);        
    NvPSSComErr (*onStop)(void);           
} NvPSSComDataSrcCallbacks;
 
typedef struct NvPSSComDataSinkCallbacks
{
    NvPSSComErr (*onDataAvailable)(NvPSSComPacket* pkt); 
    NvPSSComErr (*onFlowRateChange)(uint8_t flowRate); 
    NvPSSComErr (*onStop)(void);             
} NvPSSComDataSinkCallbacks;
 
 
typedef struct NvPSSComCtx* NvPSSComCtx_t ;
 
NvPSSComCtx* NvPSSComCreateContext();
 
NvPSSComErr NvPSSComDataSrcInit(NvPSSComCtx* ctx, const char* writeChannel, const char* readChannel);
 
 
NvPSSComErr NvPSSComDataSinkInit(NvPSSComCtx* ctx, const char* writeChannel, const char* readChannel );
 
 
NvPSSComErr NvPSSDataSrcRegisterCallbacks(NvPSSComCtx* ctx, NvPSSComDataSrcCallbacks* srcCallbacks);
 
NvPSSComErr NvPSSDataSinkRegisterCallbacks(NvPSSComCtx* ctx, NvPSSComDataSinkCallbacks* sinkCallbacks);
 
NvPSSComErr NvPSSComStart(NvPSSComCtx* ctx);
 
NvPSSComErr NvPSSComSetFlowRate(NvPSSComCtx* ctx, uint8_t flowRate);
 
NvPSSComErr NvPSSComPushData(NvPSSComCtx* ctx, NvPSSComPacket* pkt);
 
NvPSSComErr NvPSSComPause(NvPSSComCtx* ctx);
 
NvPSSComErr NvPSSComResume(NvPSSComCtx* ctx);
 
NvPSSComErr NvPSSComStop(NvPSSComCtx* ctx);
 
NvPSSComErr NvPSSComDataSrcExit(NvPSSComCtx* ctx);
 
NvPSSComErr NvPSSComDataSinkExit(NvPSSComCtx* ctx);
 
void NvPSSComDestroyContext(NvPSSComCtx* ctx);
 
 
#ifdef __cplusplus
}
#endif
 
#endif //_NVPSS_COM_H_