fsi_rx.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 FSI_RX_H
#define FSI_RX_H
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <drivers/hw_include/cslr_fsi_rx.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Macros & Typedefs                              */
/* ========================================================================== */
 
typedef uint32_t FSI_RxEnumType;
 
#define FSI_RX_EVT_PING_WD_TIMEOUT  ((uint16_t)0x0001U)
 
#define FSI_RX_EVT_FRAME_WD_TIMEOUT ((uint16_t)0x0002U)
 
#define FSI_RX_EVT_CRC_ERR          ((uint16_t)0x0004U)
 
#define FSI_RX_EVT_TYPE_ERR         ((uint16_t)0x0008U)
 
#define FSI_RX_EVT_EOF_ERR          ((uint16_t)0x0010U)
 
#define FSI_RX_EVT_OVERRUN          ((uint16_t)0x0020U)
 
#define FSI_RX_EVT_FRAME_DONE       ((uint16_t)0x0040U)
 
#define FSI_RX_EVT_UNDERRUN         ((uint16_t)0x0080U)
 
#define FSI_RX_EVT_ERR_FRAME        ((uint16_t)0x0100U)
 
#define FSI_RX_EVT_PING_FRAME       ((uint16_t)0x0200U)
 
#define FSI_RX_EVT_FRAME_OVERRUN    ((uint16_t)0x0400U)
 
#define FSI_RX_EVT_DATA_FRAME       ((uint16_t)0x0800U)
 
#define FSI_RX_EVTMASK              ((uint16_t)0x0FFFU)
 
#define FSI_RX_MAX_DELAY_LINE_VAL   ((uint16_t)0x001FU)
 
typedef uint32_t FSI_RxSubmoduleInReset;
 
#define FSI_RX_MAIN_CORE_RESET    ((uint32_t)0x0U)
 
#define FSI_RX_FRAME_WD_CNT_RESET   ((uint32_t)0x1U)
 
#define FSI_RX_PING_WD_CNT_RESET    ((uint32_t)0x2U)
 
typedef uint32_t FSI_RxDelayTapType;
 
#define FSI_RX_DELAY_CLK            ((uint32_t)0x0U)
 
#define FSI_RX_DELAY_D0             ((uint32_t)0x1U)
 
#define FSI_RX_DELAY_D1             ((uint32_t)0x2U)
 
typedef uint32_t FSI_ExtFrameTriggerSrc;
 
#define FSI_EXT_TRIGSRC_EPWM1_SOCA  ((uint32_t)0x08U)
 
#define FSI_EXT_TRIGSRC_EPWM1_SOCB  ((uint32_t)0x09U)
 
#define FSI_EXT_TRIGSRC_EPWM2_SOCA  ((uint32_t)0x0AU)
 
#define FSI_EXT_TRIGSRC_EPWM2_SOCB  ((uint32_t)0x0BU)
 
#define FSI_EXT_TRIGSRC_EPWM3_SOCA  ((uint32_t)0x0CU)
 
#define FSI_EXT_TRIGSRC_EPWM3_SOCB  ((uint32_t)0x0DU)
 
#define FSI_EXT_TRIGSRC_EPWM4_SOCA  ((uint32_t)0x0EU)
 
#define FSI_EXT_TRIGSRC_EPWM4_SOCB  ((uint32_t)0x0FU)
 
#define FSI_EXT_TRIGSRC_EPWM5_SOCA  ((uint32_t)0x10U)
 
#define FSI_EXT_TRIGSRC_EPWM5_SOCB  ((uint32_t)0x11U)
 
#define FSI_EXT_TRIGSRC_EPWM6_SOCA  ((uint32_t)0x12U)
 
#define FSI_EXT_TRIGSRC_EPWM6_SOCB  ((uint32_t)0x13U)
 
#define FSI_EXT_TRIGSRC_EPWM7_SOCA  ((uint32_t)0x14U)
 
#define FSI_EXT_TRIGSRC_EPWM7_SOCB  ((uint32_t)0x15U)
 
#define FSI_EXT_TRIGSRC_EPWM8_SOCA  ((uint32_t)0x16U)
 
#define FSI_EXT_TRIGSRC_EPWM8_SOCB  ((uint32_t)0x17U)
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t FSI_enableRxInternalLoopback(uint32_t base);
 
int32_t FSI_disableRxInternalLoopback(uint32_t base);
 
int32_t FSI_enableRxSPIPairing(uint32_t base);
 
int32_t FSI_disableRxSPIPairing(uint32_t base);
 
int32_t FSI_setRxDataWidth(uint32_t base, FSI_DataWidth dataWidth);
 
int32_t FSI_enableRxSPIMode(uint32_t base);
 
int32_t FSI_disableRxSPIMode(uint32_t base);
 
int32_t FSI_setRxSoftwareFrameSize(uint32_t base, uint16_t nWords);
 
int32_t FSI_setRxECCComputeWidth(uint32_t base, FSI_ECCComputeWidth eccComputeWidth);
 
int32_t FSI_setRxPingTimeoutMode(uint32_t base, FSI_PingTimeoutMode pingTimeoutMode);
 
int32_t FSI_getRxFrameType(uint32_t base, FSI_FrameType *pFrameType);
 
int32_t FSI_getRxFrameTag(uint32_t base, uint16_t *pFrameTag);
 
int32_t FSI_getRxUserDefinedData(uint32_t base, uint16_t *pUserData);
 
int32_t FSI_getRxEventStatus(uint32_t base, uint16_t *pEvtFlags);
 
 
int32_t FSI_forceRxEvents(uint32_t base, uint16_t evtFlags);
 
int32_t FSI_clearRxEvents(uint32_t base, uint16_t evtFlags);
 
int32_t FSI_getRxReceivedCRC(uint32_t base, uint16_t *pCrcVal);
 
int32_t FSI_getRxComputedCRC(uint32_t base, uint16_t *pCrcVal);
 
int32_t FSI_setRxBufferPtr(uint32_t base, uint16_t bufPtrOff);
 
int32_t FSI_getRxBufferPtr(uint32_t base, uint16_t *pBufPtrLoc);
 
int32_t FSI_getRxWordCount(uint32_t base, uint16_t *pWordCnt);
 
int32_t FSI_enableRxFrameWatchdog(uint32_t base,uint32_t wdRef);
 
int32_t FSI_disableRxFrameWatchdog(uint32_t base);
 
int32_t FSI_getRxFrameWatchdogCounter(uint32_t base, uint32_t *pWdCnt);
 
int32_t FSI_enableRxPingWatchdog(uint32_t base, uint32_t wdRef);
 
int32_t FSI_disableRxPingWatchdog(uint32_t base);
 
int32_t FSI_getRxPingWatchdogCounter(uint32_t base, uint32_t *pWdCnt);
 
int32_t FSI_getRxPingTag(uint32_t base, uint16_t *pPingTag);
 
int32_t FSI_lockRxCtrl(uint32_t base);
 
int32_t FSI_setRxECCData(uint32_t base, uint32_t rxECCdata);
 
int32_t FSI_setRxReceivedECCValue(uint32_t base, uint16_t rxECCvalue);
 
int32_t FSI_getRxECCCorrectedData(uint32_t base, uint32_t *pEccData);
 
int32_t FSI_getRxECCLog(uint32_t base, uint16_t *pEccLog);
 
int32_t FSI_enableRxInterrupt(uint32_t         base,
                              FSI_InterruptNum intNum,
                              uint16_t         intFlags);
 
int32_t FSI_disableRxInterrupt(uint32_t         base,
                               FSI_InterruptNum intNum,
                               uint16_t         intFlags);
 
int32_t FSI_getRxBufferAddress(uint32_t base, uint32_t *pAddr);
 
int32_t FSI_resetRxModule(uint32_t base, FSI_RxSubmoduleInReset submodule);
 
int32_t FSI_clearRxModuleReset(uint32_t base, FSI_RxSubmoduleInReset submodule);
 
int32_t FSI_readRxBuffer(uint32_t  base,
                         uint16_t *pArray,
                         uint16_t  length,
                         uint16_t  bufOffset);
 
int32_t FSI_configRxDelayLine(uint32_t           base,
                              FSI_RxDelayTapType delayTapType,
                              uint16_t           tapValue);
 
int32_t FSI_performRxInitialization(uint32_t base);
 
#ifdef __cplusplus
}
#endif
 
#endif