iPNDrv.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 IPNDRV_H_
#define IPNDRV_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include "PN_Handle.h"
 
/* ========================================================================== */
/*                          Doxygen                                           */
/* ========================================================================== */
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define ERR_STATION_NAME_LENGTH     -1
 
#define ERR_FIRMWARE_VERSION_BAD    -2
 
#define ERR_FIRMWARE_LOAD_FAIL      -3
 
#define ERR_DRIVER_INIT_FAIL        -4
 
#define PRU_IEP_CMP_CFG_EN_SOG_EVENTS   0x000001cf  /*sets cmp0, cmp2/5/6/7*/
 
#define NO_RCV_NO_FWD 0
 
#define RCV_NO_FWD    1
 
#define NO_RCV_FWD    2
 
#define RCV_FWD       3
 
#define OFF                         0
 
#define UP                          2
 
#define RUN                         4
 
#define DISABLED                    0
 
#define BLOCKING                    1
 
#define FORWARDING                  2
 
#ifdef WATCHDOG_SUPPORT
 
#define watchDogExpireDuration      100
#endif
 
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
int32_t PN_initDrv(PN_Handle pnHandle);
 
 void PN_getFirmwareVersion(uint32_t *version_major, uint32_t *version_minor,
                            uint32_t *version_build, uint32_t *version_release_type);
 
 void PN_getFirmwareReleaseInfoAndFeatures(uint32_t *firmware_release_1,
                                           uint32_t *firmware_release_2,
                                           uint32_t *firmware_feature_mask);
 
int32_t PN_setDcpFilterStationName(PRUICSS_HwAttrs const *pruicssHwAttrs,
                                   const uint8_t *dcpNameOfStation,
                                   uint8_t lengthOfStationName);
 
int32_t PN_MRP_setPortState(PRUICSS_HwAttrs const *pruicssHwAttrs,
                            uint8_t portNumber,
                            uint8_t pState);
 
int32_t PN_MRP_getPortState(PRUICSS_HwAttrs const *pruicssHwAttrs,
                            uint8_t portNumber,
                            uint8_t *pState);
 
int32_t PN_mapPhaseToProfile(PRUICSS_HwAttrs const *pruicssHwAttrs, int32_t portNumber, int32_t phaseNumber,
                             int32_t profileNumberRx, int32_t profileNumberTx);
 
 
 
int32_t PN_setMaxLineRxDelay(PRUICSS_HwAttrs const *pruicssHwAttrs, uint8_t portNumber, int32_t maxLineRxDelayValue);
 
int32_t PN_setMaxBridgeDelay(PRUICSS_HwAttrs const *pruicssHwAttrs, int32_t maxBridgeDelayValue);
 
 
int32_t PN_setYellowPeriod(PRUICSS_HwAttrs const *pruicssHwAttrs, int32_t yellowPeriodTime);
 
 
int32_t PN_setProfile(PRUICSS_HwAttrs const *pruicssHwAttrs,
                      int32_t portNumber, int32_t profileNumber, int32_t rxSoGValue,
                      int32_t txSoGValue);
 
void PN_setCompensationValue(PRUICSS_HwAttrs const *pruicssHwAttrs, uint16_t compensationValue);
 
 
int32_t PN_setRedGuard(PRUICSS_HwAttrs const *pruicssHwAttrs,
                       uint16_t validLowerFrameId, uint16_t validUpperFrameId);
 
int32_t PN_setRtc3PortStatus(PRUICSS_HwAttrs const *pruicssHwAttrs, uint8_t portNumber, uint8_t status);
int32_t PN_setStaticFilterTable(PRUICSS_HwAttrs const *pruicssHwAttrs, const uint8_t *macAddr, uint8_t ctrl,
                                uint8_t portNumber, uint8_t table);
#ifdef WATCHDOG_SUPPORT
 
int32_t PN_setWatchDogTimer(PN_Handle pnHandle, int32_t timerPeriod);
 
#endif
 
int32_t PN_loadStaticTable(PRUICSS_HwAttrs const *pruicssHwAttrs,
                           const uint32_t *staticTable,
                           uint8_t staticTableLength,
                           uint8_t staticTableType,
                           uint8_t portNumber);
 
void PN_cpmIsrHandler(void* arg);
void PN_ppmIsrHandler(void* arg);
void PN_dhtIsrHandler(void* arg);
void PN_PTCP_isrHandler(void* arg);
 
#ifdef __cplusplus
}
#endif
 
#endif /* IPNDRV_H_ */