iRtcDrv.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef IRTCDRV_H_
#define IRTCDRV_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include "iRtcDrv2.h"
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#ifdef RTC_DEBUG
void newLogPkt(uint32_t msg);
 
typedef enum
{
    INSPPM,
    INSCPM,
    DELPM
} eDebugAPI;
#endif
 
#define DESC_WORD_LENGTH 4
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
#ifndef DOXYGEN
__attribute__((packed))
#endif
cpmDesc         /* CPM*/
{
    uint16_t
    FrameReference;         
    uint16_t
    FrameLength;            
    uint16_t
    FrameDataPointer;       
    uint8_t FrameIndex;                 
    uint8_t   FrameFlags2;              
    uint16_t
    FrameId;                
    uint8_t   FrameFlags1;              
    uint8_t Reserved;                   
    uint16_t
    RR;                     
    uint16_t
    Phase;                  
} t_cpmDesc;
 
typedef struct  ppmDesc         /* PPM*/
{
    uint16_t
    FrameReference;         
    uint16_t
    FrameLength;            
    uint32_t
    FrameSendOffset;        
    uint16_t
    FrameId;                
    uint8_t   FrameFlags1;              
    uint8_t FrameIndex;                 
    uint16_t
    RR;                     
    uint16_t
    Phase;                  
} t_ppmDesc;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
#ifdef MRP_SUPPORT
 
/* @pre MRP_SUPPORT defined*/
uint32_t PN_allCpmKnown(PN_Handle pnHandle);
void PN_resetCpmPorts(PN_Handle pnHandle);
 
void PN_setCpmPort(PN_Handle pnHandle, t_rtcPacket *pID);
#endif /*MRP_SUPPORT*/
 
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);
 
 
int8_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,
                     uint16_t dht, uint8_t pos);
 
void PN_clearMrpFlag(PN_Handle pnHandle);
void PN_setListToggleReq(PN_Handle pnHandle, uint8_t enable);
 
 
#endif /* IRTCDRV_H_ */