fsi_tx.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_TX_H
#define FSI_TX_H
 
 
#if defined (SOC_AM64X) || defined (SOC_AM243X)
#define FSI_TX_BUFFER_ACCESS_64BIT
#endif
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <drivers/hw_include/cslr_fsi_tx.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Macros & Typedefs                              */
/* ========================================================================== */
 
typedef uint32_t FSI_TxEnumType;
 
#define FSI_TX_EVT_FRAME_DONE       ((uint16_t)0x1U)
 
#define FSI_TX_EVT_BUF_UNDERRUN     ((uint16_t)0x2U)
 
#define FSI_TX_EVT_BUF_OVERRUN      ((uint16_t)0x4U)
 
#define FSI_TX_EVT_PING_TIMEOUT     ((uint16_t)0x8U)
 
#define FSI_TX_EVT_PING_HW_TRIG     ((uint16_t)0x8U)
 
#define FSI_TX_EVTMASK              ((uint16_t)0xFU)
 
#define FSI_TX_MAX_NUM_EXT_TRIGGERS ((uint16_t)0x20U)
 
#define FSI_TX_INT2_CTRL_S          ((uint16_t)0x8U)
 
typedef uint32_t FSI_TxSubmoduleInReset;
 
#define FSI_TX_MASTER_CORE_RESET             ((uint32_t)0x0U)
 
#define FSI_TX_CLOCK_RESET                   ((uint32_t)0x1U)
 
#define FSI_TX_PING_TIMEOUT_CNT_RESET        ((uint32_t)0x2U)
 
typedef uint32_t FSI_TxStartMode;
 
#define FSI_TX_START_FRAME_CTRL              ((uint32_t)0x0U)
 
#define FSI_TX_START_EXT_TRIG                ((uint32_t)0x1U)
 
#define FSI_TX_START_FRAME_CTRL_OR_UDATA_TAG ((uint32_t)0x2U)
 
typedef uint32_t FSI_TxClkSel;
 
#define FSI_TX_CLK_SEL0                   ((uint32_t)0x0U)
 
#define FSI_TX_CLK_SEL1                   ((uint32_t)0x1U)
 
typedef uint32_t FSI_FrameTag;
 
#define FSI_FRAME_TAG0              ((uint32_t)0x0U)
 
#define FSI_FRAME_TAG1              ((uint32_t)0x1U)
 
#define FSI_FRAME_TAG2              ((uint32_t)0x2U)
 
#define FSI_FRAME_TAG3              ((uint32_t)0x3U)
 
#define FSI_FRAME_TAG4              ((uint32_t)0x4U)
 
#define FSI_FRAME_TAG5              ((uint32_t)0x5U)
 
#define FSI_FRAME_TAG6              ((uint32_t)0x6U)
 
#define FSI_FRAME_TAG7              ((uint32_t)0x7U)
 
#define FSI_FRAME_TAG8              ((uint32_t)0x8U)
 
#define FSI_FRAME_TAG9              ((uint32_t)0x9U)
 
#define FSI_FRAME_TAG10             ((uint32_t)0xAU)
 
#define FSI_FRAME_TAG11             ((uint32_t)0xBU)
 
#define FSI_FRAME_TAG12             ((uint32_t)0xCU)
 
#define FSI_FRAME_TAG13             ((uint32_t)0xDU)
 
#define FSI_FRAME_TAG14             ((uint32_t)0xEU)
 
#define FSI_FRAME_TAG15             ((uint32_t)0xFU)
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t FSI_sendTxFlush(uint32_t base);
 
int32_t FSI_stopTxFlush(uint32_t base);
 
int32_t FSI_selectTxPLLClock(uint32_t base, FSI_TxClkSel clkSel);
 
int32_t FSI_enableTxClock(uint32_t base, uint16_t preScaleValue);
 
int32_t FSI_disableTxClock(uint32_t base);
 
int32_t FSI_setTxDataWidth(uint32_t base, FSI_DataWidth dataWidth);
 
int32_t FSI_enableTxSPIMode(uint32_t base);
 
int32_t FSI_disableTxSPIMode(uint32_t base);
 
int32_t FSI_setTxStartMode(uint32_t base, FSI_TxStartMode txStartMode);
 
int32_t FSI_setTxPingTimeoutMode(uint32_t base, FSI_PingTimeoutMode pingTimeoutMode);
 
int32_t FSI_setTxExtFrameTrigger(uint32_t base, uint16_t extInputNum);
 
int32_t FSI_enableTxCRCForceError(uint32_t base);
 
int32_t FSI_disableTxCRCForceError(uint32_t base);
 
int32_t FSI_setTxECCComputeWidth(uint32_t base, FSI_ECCComputeWidth eccComputeWidth);
 
int32_t FSI_setTxFrameType(uint32_t base, FSI_FrameType frameType);
 
int32_t FSI_setTxSoftwareFrameSize(uint32_t base, uint16_t nWords);
 
int32_t FSI_startTxTransmit(uint32_t base);
 
int32_t FSI_setTxFrameTag(uint32_t base, FSI_FrameTag frameTag);
 
int32_t FSI_setTxUserDefinedData(uint32_t base, uint16_t userDefData);
 
int32_t FSI_setTxBufferPtr(uint32_t base, uint16_t bufPtrOff);
 
int32_t FSI_getTxBufferPtr(uint32_t base, uint16_t *pBufPtrLoc);
 
int32_t FSI_getTxWordCount(uint32_t base, uint16_t *pWordCnt);
 
int32_t FSI_enableTxPingTimer(uint32_t     base,
                                     uint32_t     refValue,
                                     FSI_FrameTag pingFrameTag);
 
int32_t FSI_setTxPingTag(uint32_t base, FSI_FrameTag frameTag);
 
int32_t FSI_disableTxPingTimer(uint32_t base);
 
int32_t FSI_enableTxExtPingTrigger(uint32_t base, uint16_t extTrigSel);
 
int32_t FSI_disableTxExtPingTrigger(uint32_t base);
 
int32_t FSI_getTxCurrentPingTimeoutCounter(uint32_t  base,
                                                  uint32_t *pPingToCnt);
 
int32_t FSI_lockTxCtrl(uint32_t base);
 
int32_t FSI_getTxEventStatus(uint32_t base, uint16_t *pEvtFlags);
 
int32_t FSI_forceTxEvents(uint32_t base, uint16_t evtFlags);
 
int32_t FSI_clearTxEvents(uint32_t base, uint16_t evtFlags);
 
int32_t FSI_enableTxUserCRC(uint32_t base, uint16_t userCRCValue);
 
int32_t FSI_disableTxUserCRC(uint32_t base);
 
int32_t FSI_setTxECCdata(uint32_t base, uint32_t data);
 
int32_t FSI_getTxECCValue(uint32_t base, uint16_t *pEccVal);
 
int32_t FSI_enableTxInterrupt(uint32_t         base,
                                     FSI_InterruptNum intNum,
                                     uint16_t         intFlags);
 
int32_t FSI_disableTxInterrupt(uint32_t         base,
                                      FSI_InterruptNum intNum,
                                      uint16_t         intFlags);
 
int32_t FSI_getTxBufferAddress(uint32_t base, uint32_t *pBufAddr);
 
int32_t FSI_resetTxModule(uint32_t base, FSI_TxSubmoduleInReset submodule);
 
int32_t FSI_clearTxModuleReset(uint32_t base, FSI_TxSubmoduleInReset submodule);
 
int32_t FSI_writeTxBuffer(uint32_t        base,
                          const uint16_t *pArray,
                          uint16_t        length,
                          uint16_t        bufOffset);
 
int32_t FSI_performTxInitialization(uint32_t base, uint16_t prescalar);
 
int32_t FSI_executeTxFlushSequence(uint32_t base, uint16_t prescalar);
 
#ifdef __cplusplus
}
#endif
 
#endif