iRtcDrv2.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 IRTCDRV2_H_
#define IRTCDRV2_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
/* ========================================================================== */
/*                          Doxygen                                           */
/* ========================================================================== */
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include "firmware/icss_pn_rtcx.h"
#include "PN_Handle.h"
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define SHADOW_LIST 0
 
#define ACTIVE_LIST 1
/* currently we support 8 PPM split into two blocks (NO_PPM/2)*/
#define HALFSIZE    4
 
typedef enum
{
    BUFF1 = 0,  
    BUFF2,      
    BUFF3,      
    NOBUFF      
} buffLocks;
/* ========================================================================== */
/*                            Global Variables                                */
/* ========================================================================== */
uint32_t pRtcConfig;        
uint32_t ocmcBaseAddress;   
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
typedef struct listIndex
{
    uint8_t redP2;      
    uint8_t green;      
    uint8_t greenP2;    
    uint8_t end;        
} t_listIndex;
 
 
typedef struct rtcMemBuff
{
    uint8_t
    *addr[3];        /*/< triple buffer start addresses - fixed after init - ARM view*/
    uint16_t
    regbase;        /*/< 16 bit PRU base address of tripple buffer addresses - CPM only*/
    uint8_t     slotUsed;       /*/< true if this slot is allocated*/
} t_rtcMemBuff;
 
typedef struct ppmBlock
{
    uint8_t
    *blockStart;             /*/< block start address (physical mem)*/
    t_rtcMemBuff
    slots[HALFSIZE];        /*/< each buffer can have maximum of 4 slots*/
} t_ppmBlock;
 
typedef struct cpmBlock
{
    uint8_t
    *blockStart;             /*/< block start address (physical mem)*/
    t_rtcMemBuff    slots[NO_CPM];          /*/< single buffer takes all CPM*/
} t_cpmBlock;
 
 
typedef struct rtcPacket
{
    uint32_t
    frameOffset;    /*/< frame send offset (0 indicates green PPM packet!)*/
    t_rtcMemBuff    *pBuffer;       /*/< keep full buffer mem object pointer*/
    uint16_t        frameId;        /*/< main identifier for all PPM/CPM*/
    uint16_t        length;         /*/< length of packet (without space for CRC)*/
    uint16_t        reduRatio;      /*/< reduction ratio (green or red)*/
    uint16_t        phase;          /*/< assigned phase*/
    uint8_t         type;           /*/< CPM or PPM packet*/
    uint8_t         port;           /*/< where we want to sent to (PORT1 or PORT2)*/
    uint8_t
    crGroup;        /*/< the group we belong too (1-8, 0 not defined)*/
    uint8_t
    lIndex;         /*/< current index in descriptor list (0xFF = invalid)*/
    uint8_t         isActive;       /*/< store activation state*/
    uint8_t         block;          /*/< PPM only: store the buffer block number*/
    uint8_t         next;           /*/< tripple buffer NEXT index*/
    uint8_t         last;           /*/< tripple buffer LAST index*/
    uint8_t         validLast;      /*/< new valid LAST buffer available (=1)*/
    uint8_t
    proc;           /*/< tripple buffer PROC index -previously "buffIndex"*/
    void           *userRef; /*/< Reference for Application data"*/
} t_rtcPacket;
 
typedef struct descList
{
    uint32_t *pDescs[2];            
    uint8_t  *rtc_index_ptr[2];     
    uint8_t
    *pActive;            
    uint8_t
    *pStatus;            
    uint8_t    *pEvent;             
    uint16_t  redFID;           
    uint8_t size;               
    uint8_t   shadow;               
    t_rtcPacket
    *lInitiate;   
    uint8_t mrpFlag;            
    uint8_t listToggleReq;     
} t_descList;
 
typedef struct cfgPN
{
    t_rtcPacket
    cpmPkts[NO_CPM];    /*/< All CPM pkt config object internal to driver*/
    t_rtcPacket
    ppmPkts[NO_PPM];    /*/< All PPM pkt config object internal to driver*/
    uint16_t
    maxCpmSize;         /*/< maximum allowed data size for each CPM - incl overhead*/
    uint16_t
    maxPpmSize;         /*/< maximum allowed data size for each PPM - incl overhead*/
    uint8_t         cfgAR;              /*/< number of configured ARs*/
} t_cfgPN;
 
/* ========================================================================== */
/*                       Function Declarations                                */
/* ========================================================================== */
 
int32_t PN_cfgRtcMem(PN_Handle pnHandle, uint8_t ar, uint16_t size);
 
int32_t PN_deCfgRtcMem(PN_Handle pnHandle);
 
int32_t PN_initPacket(t_rtcPacket *pPkt, uint8_t type);
 
int32_t PN_allocPkt(PN_Handle pnHandle, t_rtcPacket **pPkt, uint8_t type);
 
int32_t PN_freePkt(t_rtcPacket *pPkt);
 
int32_t PN_insPpmList(PN_Handle pnHandle, t_rtcPacket *ppmPkt, uint8_t legMode);
 
int32_t PN_delPmList(PN_Handle pnHandle, t_rtcPacket *pmPkt);
 
int32_t PN_insCpmList(PN_Handle pnHandle, t_rtcPacket *cpmPkt);
 
int32_t PN_setCpmState(PN_Handle pnHandle, t_rtcPacket *pPkt, uint8_t val);
 
int32_t PN_setPpmState(PRUICSS_HwAttrs const *pruicssHwAttrs,
                       t_rtcPacket *pPkt);
 
int32_t PN_chgPpmBuffer(PN_Handle pnHandle, t_rtcPacket *ppmPkt);
 
t_cfgPN *PN_getConfig(void);
 
typedef void (*pnCallBack_t)(void *arg, uint8_t arg2);
 
int32_t PN_initRtcDrv(PN_Handle pnHandle);
 
int32_t PN_getList(t_descList **pList, uint8_t dir);
 
int32_t PN_clearList(PN_Handle pnHandle, uint8_t list);
 
int32_t PN_resetARlink(PRUICSS_HwAttrs const *pruicssHwAttrs,
                       uint8_t ARgroup, uint8_t pmNum, uint8_t dir);
 
int32_t PN_cpmBuffLock(PRUICSS_HwAttrs const *pruicssHwAttrs,
                       uint8_t pos, buffLocks buff);
 
void PN_registerPpmCall(PN_Handle pnHandle, pnCallBack_t callBack);
 
void PN_registerCpmCall(PN_Handle pnHandle, pnCallBack_t callBack);
 
void PN_registerStatCall(PN_Handle pnHandle, pnCallBack_t callBack);
 
typedef enum
{
    NOINIT,         
    READY,          
    SENDPPM,        
    ABORT           
} tLegStates;
typedef void (*pnLegCallBack_t)(void *arg, void *arg2);
 
typedef void (*pnDrvThreadSafe_t)(void);
 
 
void PN_registerSetState(PN_Handle pnHandle, pnLegCallBack_t callBack);
 
void PN_registerSetPkt(PN_Handle pnHandle, pnLegCallBack_t callBack);
void PN_registerThreadsafeFunc(PN_Handle pnHandle, pnDrvThreadSafe_t callBackEnt, pnDrvThreadSafe_t callBackExt);
 
 
void PN_clearPruIRQ(PRUICSS_HwAttrs const *pruicssHwAttrs,
                    uint8_t irq_num);      /* event clearing*/
 
 
int32_t PN_setBaseClock(PN_Handle pnHandle, uint16_t factor);
 
void PN_setFSODeviationComp(PRUICSS_HwAttrs const *pruicssHwAttrs, uint16_t fso_comp_val);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* IRTCDRV2_H_ */