iPNLegacy.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 IPNLEGACY_H_
#define IPNLEGACY_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <stdint.h>
#include "iRtcDrv2.h"
#include "iPtcpDrv.h"
#include "PN_Handle.h"
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
#define INTERFACE_MAC 0
 
#define PORT1_MAC     1
 
#define PORT2_MAC     2
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void PN_setHandle(PN_Handle pnHandle);
 
PN_Handle PN_getPnHandle();
 
uint8_t PN_EmacSocMACAddrGet(PN_Handle pnHandle, uint8_t instance,
                             uint8_t *macId);
 
int32_t setStaticFilterTable(const uint8_t *macAddr, uint8_t ctrl,
                             uint8_t portNumber, uint8_t table);
 
int32_t setRtc3PortStatus(uint8_t portNumber, uint8_t status);
 
uint8_t *getLastCpm(t_rtcPacket *pkt);
 
int32_t setRedGuard(uint16_t validLowerFrameId, uint16_t validUpperFrameId);
 
int32_t setMaxLineRxDelay(uint8_t portNumber, int32_t maxLineRxDelayValue);
 
int32_t setMaxBridgeDelay(int32_t maxBridgeDelayValue);
 
int32_t setYellowPeriod(int32_t yellowPeriodTime);
 
int32_t mapPhaseToProfile(int32_t portNumber, int32_t phaseNumber,
                          int32_t profileNumberRx, int32_t profileNumberTx);
 
int32_t setProfile(int32_t portNumber, int32_t profileNumber,
                   int32_t rxSoGValue, int32_t txSoGValue);
 
int32_t setDcpFilterStationName(const uint8_t *dcpNameOfStation,
                                uint8_t lengthOfStationName);
 
int32_t TxPacketOS(const uint8_t *srcAddress, int32_t portNumber,
                   int32_t queuePriority, int32_t lengthOfPacket);
 
int32_t PN_RxPktInfo(int32_t *portNumber, int32_t *queueNumber);
 
int32_t PN_RxPktGet(uint32_t destAddress, int32_t queueNumber, int32_t *port,
                    int32_t *more);
 
uint8_t PN_findMAC(uint8_t *macId);
 
int32_t setCpmDHT(uint16_t dht, uint8_t pos);
 
int32_t setBaseClock(uint16_t factor);
 
int32_t clearList(uint8_t list);
 
int32_t iRtcEnableIsr();
 
int32_t delPmList(t_rtcPacket *pmPkt);
 
int32_t insPpmList(t_rtcPacket *ppmPkt, uint8_t legMode);
 
int32_t insCpmList(t_rtcPacket *cpmPkt);
 
void configureSync0Pin();
 
void ptcpConfigureSyncFwd(ptcpPortStatus_t state);
 
void PN_EmacRegisterProtocolCallback(void *callBackPtr, void *userArg);
 
void PN_EmacRegisterPort0ISRCallback(ICSS_EMAC_CallBack callBack, void *userArg);
 
void PN_EmacRegisterPort1ISRCallback(ICSS_EMAC_CallBack callBack, void *userArg);
 
void PN_purgeTable(uint8_t portNum);
 
int32_t setMrpPortState(uint8_t portNumber, uint8_t pState);
 
int32_t getMrpPortState(uint8_t portNumber, uint8_t *pState);
 
int32_t cfgRtcMem(uint8_t ar, uint16_t size);
 
int32_t allocPkt(t_rtcPacket **pPkt, uint8_t type);
 
void ptcpGetSyncInfo(ptcpSyncInfo_t *syncInfo);
 
void ptcpRegisterDelayUpdateCall(ptcpCallBack_t callBack);
 
void ptcpRegisterSyncStatusCall(ptcpCallBack_t callBack);
 
void ptcpSetPllWindow(uint32_t pllWindowSize);
 
void ptcpSetSyncTimeoutFactor(uint32_t syncTimeoutFactor);
 
void ptcpSetSyncUUID(uint8_t *subdomainUUID);
 
void registerCpmCall(pnCallBack_t callBack);
 
void registerStatCall(pnCallBack_t callBack);
 
uint8_t *relPpmBuff(t_rtcPacket *pkt);
 
int32_t rtcDisableISR();
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* IPNLEGACY_H_ */