AM64x INDUSTRIAL COMMUNICATIONS SDK  2025.00.00
iRtcDrv.h File Reference

Go to the source code of this file.

Data Structures

struct  t_ppmDesc
 

Macros

#define PN_RTCDRV_ERR_BASE_CODE   (-100)
 
#define PN_ERR_INVALID_CPM_INDEX   (PN_RTCDRV_ERR_BASE_CODE - 1)
 
#define PN_ERR_INVALID_PPM_INDEX   (PN_RTCDRV_ERR_BASE_CODE - 2)
 
#define PN_ERR_INVALID_CPM_AR_GROUP   (PN_RTCDRV_ERR_BASE_CODE - 3)
 
#define PN_ERR_INVALID_PPM_AR_GROUP   (PN_RTCDRV_ERR_BASE_CODE - 4)
 
#define PN_ERR_RESET_AR_LINK   (PN_RTCDRV_ERR_BASE_CODE - 5)
 
#define PN_ERR_INVALID_AR_GROUP   (PN_RTCDRV_ERR_BASE_CODE - 6)
 
#define PN_ERR_WRITE_PPM_DESC   (PN_RTCDRV_ERR_BASE_CODE - 7)
 
#define PN_ERR_NULL_PPM_DESC   (PN_RTCDRV_ERR_BASE_CODE - 8)
 
#define PN_ERR_NULL_CPM_DESC   (PN_RTCDRV_ERR_BASE_CODE - 9)
 
#define PN_ERR_INVALID_CLK_FACTOR   (PN_RTCDRV_ERR_BASE_CODE - 10)
 
#define PN_ERR_NULL_DESC_LIST   (PN_RTCDRV_ERR_BASE_CODE - 11)
 
#define PN_ERR_NULL_SHADOW_LIST   (PN_RTCDRV_ERR_BASE_CODE - 12)
 
#define PN_ERR_LIST_TOGGLE_PENDING   (PN_RTCDRV_ERR_BASE_CODE - 13)
 
#define PN_ERR_SETUP_ISR   (PN_RTCDRV_ERR_BASE_CODE - 14)
 
#define PN_ERR_RTC_INIT_DONE   (PN_RTCDRV_ERR_BASE_CODE - 15)
 
#define PN_ERR_INVALID_LIST_INDEX   (PN_RTCDRV_ERR_BASE_CODE - 16)
 
#define DESC_WORD_LENGTH   4
 

Functions

struct __attribute__ ((packed)) cpmDesc
 
uint32_t PN_allCpmKnown (PN_Handle pnHandle)
 
void PN_resetCpmPorts (PN_Handle pnHandle)
 
void PN_setCpmPort (PN_Handle pnHandle, t_rtcPacket *pID)
 
int32_t PN_togglePpmList (PN_Handle pnHandle, t_rtcPacket *pktID, uint8_t ppmMrpPortShift)
 
int32_t PN_writePpmDesc (PN_Handle pnHandle, t_rtcPacket *pPkt, uint8_t pos)
 
int32_t PN_writeCpmDesc (PN_Handle pnHandle, t_rtcPacket *pPkt, uint8_t pos)
 
int32_t PN_readPpmDesc (PN_Handle pnHandle, t_ppmDesc *pDesc, uint8_t pos, uint8_t act)
 
int32_t PN_readCpmDesc (PN_Handle pnHandle, t_cpmDesc *pDesc, uint8_t pos)
 
int32_t PN_setIndexInt (PN_Handle pnHandle, t_listIndex *index)
 
int8_t PN_getLastCpmBuffIndex (PN_Handle pnHandle, uint8_t pos)
 
int32_t PN_getIndexInt (t_listIndex *index)
 
int32_t PN_emptyList (t_descList *pList)
 
int32_t PN_writeSortedList (PN_Handle pnHandle, t_rtcPacket *pPkts)
 
int8_t PN_getDhtStatusEvent (PN_Handle pnHandle, t_rtcPacket **pktID)
 
int8_t PN_getListToggleStatusEvent (PN_Handle pnHandle, t_rtcPacket **pktID)
 
int32_t PN_getShadowIndex (PRUICSS_HwAttrs const *pruicssHwAttrs, uint8_t lType)
 
int32_t PN_getPmStatus (PRUICSS_HwAttrs const *pruicssHwAttrs, uint8_t dir, uint8_t numPm)
 
int32_t PN_setPPMARlink (PRUICSS_HwAttrs const *pruicssHwAttrs, uint8_t ARgroup, uint8_t PpmNum)
 
int32_t PN_setCPMARlink (PRUICSS_HwAttrs const *pruicssHwAttrs, uint8_t ARgroup, uint8_t CpmNum)
 
int32_t PN_setCpmDHT (PRUICSS_HwAttrs const *pruicssHwAttrs, t_rtcPacket *cpmPkt, uint16_t dht)
 Sets the Data hold timer timeout value for a given descriptor. More...
 
void PN_clearMrpFlag (PN_Handle pnHandle)
 Clears the mrpFlag in ppmList data structure. More...
 
void PN_setListToggleReq (PN_Handle pnHandle, uint8_t enable)
 Sets or clears the listToggleReq flag in ppmList data structure. More...
 

Variables

 t_cpmDesc
 

Macro Definition Documentation

◆ DESC_WORD_LENGTH

#define DESC_WORD_LENGTH   4

Function Documentation

◆ PN_clearMrpFlag()

void PN_clearMrpFlag ( PN_Handle  pnHandle)

Clears the mrpFlag in ppmList data structure.

Parameters
[in]pnHandleProfinet Handle

◆ PN_setListToggleReq()

void PN_setListToggleReq ( PN_Handle  pnHandle,
uint8_t  enable 
)

Sets or clears the listToggleReq flag in ppmList data structure.

Parameters
[in]pnHandleProfinet Handle
[in]enableIt clears or sets the listToggleReq flag valid values are 0 and 1