csl_srioAux.h File Reference

This is the SRIO Auxilary Header File which exposes the various CSL Functional Layer API's to configure the SRIO Module. More...

#include <ti/csl/soc.h>
#include <ti/csl/csl_srio.h>

Functions

CSL_IDEF_INLINE void CSL_SRIO_GetPID (CSL_SrioHandle hSrio, Uint32 *pid)
CSL_IDEF_INLINE void CSL_SRIO_EnablePeripheral (CSL_SrioHandle hSrio)
CSL_IDEF_INLINE void CSL_SRIO_DisablePeripheral (CSL_SrioHandle hSrio)
CSL_IDEF_INLINE void CSL_SRIO_SetMAUSwappingMode (CSL_SrioHandle hSrio, Uint8 mode)
CSL_IDEF_INLINE void CSL_SRIO_GetMAUSwappingMode (CSL_SrioHandle hSrio, Uint8 *mode)
CSL_IDEF_INLINE void CSL_SRIO_SetLSUSwappingMode (CSL_SrioHandle hSrio, Uint8 mode)
CSL_IDEF_INLINE void CSL_SRIO_GetLSUSwappingMode (CSL_SrioHandle hSrio, Uint8 *mode)
CSL_IDEF_INLINE void CSL_SRIO_EnablePromiscuous (CSL_SrioHandle hSrio)
CSL_IDEF_INLINE void CSL_SRIO_DisablePromiscuous (CSL_SrioHandle hSrio)
CSL_IDEF_INLINE Bool CSL_SRIO_IsPromiscuous (CSL_SrioHandle hSrio)
CSL_IDEF_INLINE void CSL_SRIO_SetAMUSwappingMode (CSL_SrioHandle hSrio, Uint8 mode)
CSL_IDEF_INLINE void CSL_SRIO_GetAMUSwappingMode (CSL_SrioHandle hSrio, Uint8 *mode)
CSL_IDEF_INLINE void CSL_SRIO_SetBootComplete (CSL_SrioHandle hSrio, Uint8 bootCompleteFlag)
CSL_IDEF_INLINE void CSL_SRIO_GetBootComplete (CSL_SrioHandle hSrio, Uint8 *bootCompleteFlag)
CSL_IDEF_INLINE void CSL_SRIO_SetTXURXUSwappingMode (CSL_SrioHandle hSrio, Uint8 mode)
CSL_IDEF_INLINE void CSL_SRIO_GetTXURXUSwappingMode (CSL_SrioHandle hSrio, Uint8 *mode)
CSL_IDEF_INLINE void CSL_SRIO_EnableAutomaticPriorityPromotion (CSL_SrioHandle hSrio)
CSL_IDEF_INLINE void CSL_SRIO_DisableAutomaticPriorityPromotion (CSL_SrioHandle hSrio)
CSL_IDEF_INLINE Bool CSL_SRIO_IsAutomaticPriorityPromotionEnabled (CSL_SrioHandle hSrio)
CSL_IDEF_INLINE void CSL_SRIO_SetTxCreditThreshold (CSL_SrioHandle hSrio, Uint8 priority, Uint8 credit)
CSL_IDEF_INLINE void CSL_SRIO_GetTxCreditThreshold (CSL_SrioHandle hSrio, Uint8 priority, Uint8 *credit)
CSL_IDEF_INLINE void CSL_SRIO_SetTransactionPriority (CSL_SrioHandle hSrio, Uint8 priority)
CSL_IDEF_INLINE void CSL_SRIO_GetTransactionPriority (CSL_SrioHandle hSrio, Uint8 *priority)
CSL_IDEF_INLINE void CSL_SRIO_SetPrescalarSelect (CSL_SrioHandle hSrio, Uint8 prescalarSelect)
CSL_IDEF_INLINE void CSL_SRIO_GetPrescalarSelect (CSL_SrioHandle hSrio, Uint8 *prescalarSelect)
CSL_IDEF_INLINE void CSL_SRIO_SetResponseCRF (CSL_SrioHandle hSrio, Uint8 value)
CSL_IDEF_INLINE void CSL_SRIO_GetResponseCRF (CSL_SrioHandle hSrio, Uint8 *value)
CSL_IDEF_INLINE void CSL_SRIO_SetRXUWatermark (CSL_SrioHandle hSrio, Uint8 value)
CSL_IDEF_INLINE void CSL_SRIO_GetRXUWatermark (CSL_SrioHandle hSrio, Uint8 *value)
CSL_IDEF_INLINE void CSL_SRIO_SetSysClkSel (CSL_SrioHandle hSrio, Uint8 value)
CSL_IDEF_INLINE void CSL_SRIO_GetSysClkSel (CSL_SrioHandle hSrio, Uint8 *value)
CSL_IDEF_INLINE void CSL_SRIO_SetLoopbackMode (CSL_SrioHandle hSrio, Uint8 portNum)
CSL_IDEF_INLINE void CSL_SRIO_SetNormalMode (CSL_SrioHandle hSrio, Uint8 portNum)
CSL_IDEF_INLINE Bool CSL_SRIO_IsLoopbackMode (CSL_SrioHandle hSrio, Uint8 portNum)
CSL_IDEF_INLINE void CSL_SRIO_EnableCOS (CSL_SrioHandle hSrio)
CSL_IDEF_INLINE void CSL_SRIO_DisableCOS (CSL_SrioHandle hSrio)
CSL_IDEF_INLINE Bool CSL_SRIO_IsCOSEnabled (CSL_SrioHandle hSrio)
CSL_IDEF_INLINE void CSL_SRIO_GlobalEnable (CSL_SrioHandle hSrio)
CSL_IDEF_INLINE void CSL_SRIO_GlobalDisable (CSL_SrioHandle hSrio)
CSL_IDEF_INLINE Bool CSL_SRIO_IsSRIOEnabled (CSL_SrioHandle hSrio)
CSL_IDEF_INLINE void CSL_SRIO_EnableBlock (CSL_SrioHandle hSrio, Uint16 blockNumber)
CSL_IDEF_INLINE void CSL_SRIO_DisableBlock (CSL_SrioHandle hSrio, Uint16 blockNumber)
CSL_IDEF_INLINE Bool CSL_SRIO_IsSRIOBlockEnabled (CSL_SrioHandle hSrio, Uint16 blockNumber)
CSL_IDEF_INLINE void CSL_SRIO_SetDeviceID (CSL_SrioHandle hSrio, Uint8 index, Uint8 NodeId8bit, Uint16 NodeId16bit)
CSL_IDEF_INLINE void CSL_SRIO_GetDeviceID (CSL_SrioHandle hSrio, Uint8 index, Uint8 *NodeId8bit, Uint16 *NodeId16bit)
CSL_IDEF_INLINE void CSL_SRIO_SetPacketForwarding (CSL_SrioHandle hSrio, Uint8 index, Uint16 low16bitDeviceID, Uint16 up16bitDeviceID, Uint8 low8bitDeviceID, Uint8 up8bitDeviceID, Uint8 outPort)
CSL_IDEF_INLINE void CSL_SRIO_GetPacketForwarding (CSL_SrioHandle hSrio, Uint8 index, Uint16 *low16bitDeviceID, Uint16 *up16bitDeviceID, Uint8 *low8bitDeviceID, Uint8 *up8bitDeviceID, Uint8 *outPort)
CSL_IDEF_INLINE void CSL_SRIO_GetDoorbellPendingInterrupt (CSL_SrioHandle hSrio, Uint8 port, Uint16 *doorbellStatus)
CSL_IDEF_INLINE void CSL_SRIO_ClearDoorbellPendingInterrupt (CSL_SrioHandle hSrio, Uint8 port, Uint16 doorbellInterrupt)
CSL_IDEF_INLINE void CSL_SRIO_GetLSUPendingInterrupt (CSL_SrioHandle hSrio, Uint32 *lsuStatus1, Uint32 *lsuStatus2)
CSL_IDEF_INLINE void CSL_SRIO_ClearLSUPendingInterrupt (CSL_SrioHandle hSrio, Uint32 lsuInterrupt1, Uint32 lsuInterrupt2)
CSL_IDEF_INLINE void CSL_SRIO_ClearLSU0PendingInterrupt (CSL_SrioHandle hSrio, Uint32 lsuInterrupt)
CSL_IDEF_INLINE void CSL_SRIO_GetErrorPendingInterrupt (CSL_SrioHandle hSrio, Uint32 *errStatus)
CSL_IDEF_INLINE void CSL_SRIO_ClearErrorPendingInterrupt (CSL_SrioHandle hSrio, Uint32 errStatus)
CSL_IDEF_INLINE void CSL_SRIO_GetAMUPendingInterrupt (CSL_SrioHandle hSrio, Uint16 *amuIntrStatus)
CSL_IDEF_INLINE void CSL_SRIO_ClearAMUPendingInterrupt (CSL_SrioHandle hSrio, Uint16 amuIntrStatus)
CSL_IDEF_INLINE void CSL_SRIO_RouteDoorbellInterrupts (CSL_SrioHandle hSrio, Uint8 regNum, Uint8 doorBellBit, Uint8 destination)
CSL_IDEF_INLINE void CSL_SRIO_RouteLSUInterrupts (CSL_SrioHandle hSrio, Uint8 lsuIntrReq, Uint8 destination)
CSL_IDEF_INLINE void CSL_SRIO_RouteErrorInterrupts (CSL_SrioHandle hSrio, Uint8 errIntrReq, Uint8 destination)
CSL_IDEF_INLINE void CSL_SRIO_RouteAMUInterrupts (CSL_SrioHandle hSrio, Uint8 amuIntr, Uint8 destination)
CSL_IDEF_INLINE void CSL_SRIO_GetDoorbellRoute (CSL_SrioHandle hSrio, Uint8 *routeInfo)
CSL_IDEF_INLINE void CSL_SRIO_SetDoorbellRoute (CSL_SrioHandle hSrio, Uint8 routeInfo)
CSL_IDEF_INLINE void CSL_SRIO_GetInterruptStatusDecode (CSL_SrioHandle hSrio, Uint8 intrDst, Uint32 *status)
CSL_IDEF_INLINE void CSL_SRIO_EnableInterruptPacing (CSL_SrioHandle hSrio, Uint8 destination)
CSL_IDEF_INLINE void CSL_SRIO_DisableInterruptPacing (CSL_SrioHandle hSrio, Uint8 destination)
CSL_IDEF_INLINE void CSL_SRIO_SetInterruptPacing (CSL_SrioHandle hSrio, Uint8 destination, Uint32 rate)
CSL_IDEF_INLINE void CSL_SRIO_GetInterruptRate (CSL_SrioHandle hSrio, Uint8 destination, Uint32 *rate)
CSL_IDEF_INLINE void CSL_SRIO_SetType11PSInfo (Uint32 psInfo[2], Uint16 dstId, Uint16 srcId, Uint8 mbox, Uint8 letter, Uint8 tt, Uint8 ssize, Uint8 retryCount)
CSL_IDEF_INLINE void CSL_SRIO_ExtractType11PSInfo (Uint32 psInfo[2], Uint16 *dstId, Uint16 *srcId, Uint8 *mbox, Uint8 *letter, Uint8 *tt, Uint8 *pri, Uint8 *cc)
CSL_IDEF_INLINE void CSL_SRIO_MapMessageToQueue (CSL_SrioHandle hSrio, Uint8 index, SRIO_MESSAGE *ptrMessage, Uint16 queueId)
CSL_IDEF_INLINE void CSL_SRIO_GetMessageToQueueMapping (CSL_SrioHandle hSrio, Uint8 index, SRIO_MESSAGE *ptrMessage, Uint16 *queueId)
CSL_IDEF_INLINE void CSL_SRIO_SetType9PSInfo (Uint32 psInfo[2], Uint16 dstId, Uint16 srcId, Uint8 cos, Uint8 cosMask, Uint8 tt, Uint16 streamId)
CSL_IDEF_INLINE void CSL_SRIO_ExtractType9PSInfo (Uint32 psInfo[2], Uint16 *dstId, Uint16 *srcId, Uint8 *cos, Uint8 *cc, Uint8 *tt, Uint8 *pri, Uint16 *streamId)
CSL_IDEF_INLINE void CSL_SRIO_MapType9MessageToQueue (CSL_SrioHandle hSrio, Uint8 index, SRIO_TYPE9_MESSAGE *ptrMessage, Uint16 queueId)
CSL_IDEF_INLINE void CSL_SRIO_GetType9MessageToQueueMapping (CSL_SrioHandle hSrio, Uint8 index, SRIO_TYPE9_MESSAGE *ptrMessage, Uint16 *queueId)
CSL_IDEF_INLINE void CSL_SRIO_MapAMUPrivIdToSourceId (CSL_SrioHandle hSrio, Uint8 privId, Uint8 srcId)
CSL_IDEF_INLINE void CSL_SRIO_GetAMUPrivIdToSourceIdMapping (CSL_SrioHandle hSrio, Uint8 privId, Uint8 *srcId)
CSL_IDEF_INLINE void CSL_SRIO_MapVBUSPriorityToRIO (CSL_SrioHandle hSrio, Uint8 vbusPriority, Uint8 priority)
CSL_IDEF_INLINE void CSL_SRIO_GetVBUSPriorityToRIOMapping (CSL_SrioHandle hSrio, Uint8 vbusPriority, Uint8 *priority)
CSL_IDEF_INLINE void CSL_SRIO_GetAMUErrorCaptureInfo (CSL_SrioHandle hSrio, Uint32 *transAddress, Uint8 *privId, Uint8 *mstID, Uint16 *doorbellInfo)
CSL_IDEF_INLINE void CSL_SRIO_SetAMUWindow (CSL_SrioHandle hSrio, Uint8 index, SRIO_AMU_WINDOW *amuWindow)
CSL_IDEF_INLINE void CSL_SRIO_GetAMUWindow (CSL_SrioHandle hSrio, Uint8 index, SRIO_AMU_WINDOW *amuWindow)
CSL_IDEF_INLINE void CSL_SRIO_SetAMUPane (CSL_SrioHandle hSrio, Uint8 index, SRIO_AMU_PANE *amuPane)
CSL_IDEF_INLINE void CSL_SRIO_GetAMUPane (CSL_SrioHandle hSrio, Uint8 index, SRIO_AMU_PANE *amuPane)
CSL_IDEF_INLINE void CSL_SRIO_SetAMUFlowMask (CSL_SrioHandle hSrio, Uint16 flowMask)
CSL_IDEF_INLINE void CSL_SRIO_GetAMUFlowMask (CSL_SrioHandle hSrio, Uint16 *flowMask)
CSL_IDEF_INLINE void CSL_SRIO_SetLSUTransfer (CSL_SrioHandle hSrio, Uint8 lsu, SRIO_LSU_TRANSFER *lsuTransfer)
CSL_IDEF_INLINE void CSL_SRIO_SetLSUReg0 (CSL_SrioHandle hSrio, Uint8 lsu, Uint32 rapidIOMSB)
CSL_IDEF_INLINE void CSL_SRIO_SetLSUReg1 (CSL_SrioHandle hSrio, Uint8 lsu, Uint32 rapidIOLSB)
CSL_IDEF_INLINE void CSL_SRIO_SetLSUReg2 (CSL_SrioHandle hSrio, Uint8 lsu, Uint32 dspAddress)
CSL_IDEF_INLINE void CSL_SRIO_SetLSUReg3 (CSL_SrioHandle hSrio, Uint8 lsu, Uint32 byteCount, Uint8 doorbellValid)
CSL_IDEF_INLINE void CSL_SRIO_SetLSUReg4 (CSL_SrioHandle hSrio, Uint8 lsu, Uint16 dstId, Uint8 srcIdMap, Uint8 idSize, Uint8 outPortId, Uint8 priority, Uint8 xambs, Uint8 supGoodInt, Uint8 intRequest)
CSL_IDEF_INLINE void CSL_SRIO_SetLSUReg5 (CSL_SrioHandle hSrio, Uint8 lsu, Uint8 ttype, Uint8 ftype, Uint8 hopCount, Uint16 doorbellInfo)
CSL_IDEF_INLINE Bool CSL_SRIO_IsLSUFull (CSL_SrioHandle hSrio, Uint8 lsu)
CSL_IDEF_INLINE Bool CSL_SRIO_IsLSUBusy (CSL_SrioHandle hSrio, Uint8 lsu)
CSL_IDEF_INLINE void CSL_SRIO_GetLSUContextTransaction (CSL_SrioHandle hSrio, Uint8 lsu, Uint8 *context, Uint8 *transID)
CSL_IDEF_INLINE void CSL_SRIO_CancelLSUTransaction (CSL_SrioHandle hSrio, Uint8 lsu, Uint8 privID)
CSL_IDEF_INLINE void CSL_SRIO_RestartLSUTransaction (CSL_SrioHandle hSrio, Uint8 lsu)
CSL_IDEF_INLINE void CSL_SRIO_FlushLSUTransaction (CSL_SrioHandle hSrio, Uint8 lsu, Uint8 srcIDMap)
CSL_IDEF_INLINE void CSL_SRIO_SetLSUShadowRegs (CSL_SrioHandle hSrio, Uint32 shadowGrp0, Uint32 shadowGrp1)
CSL_IDEF_INLINE void CSL_SRIO_GetLSUShadowRegs (CSL_SrioHandle hSrio, Uint8 index, Uint8 *count)
CSL_IDEF_INLINE void CSL_SRIO_EnableSrcIDInterrupts (CSL_SrioHandle hSrio, Uint8 index)
CSL_IDEF_INLINE void CSL_SRIO_DisableSrcIDInterrupts (CSL_SrioHandle hSrio, Uint8 index)
CSL_IDEF_INLINE void CSL_SRIO_SetTimeoutCnt (CSL_SrioHandle hSrio, Uint8 timeoutCnt)
CSL_IDEF_INLINE void CSL_SRIO_GetTimeoutCnt (CSL_SrioHandle hSrio, Uint8 *timeoutCnt)
CSL_IDEF_INLINE void CSL_SRIO_GetLSUCompletionCode (CSL_SrioHandle hSrio, Uint8 lsu, Uint8 transID, Uint8 *compCode, Uint8 *contextBit)
CSL_IDEF_INLINE void CSL_SRIO_SetLSUFlowMask (CSL_SrioHandle hSrio, Uint8 lsu, Uint16 flowMask)
CSL_IDEF_INLINE void CSL_SRIO_GetLSUFlowMask (CSL_SrioHandle hSrio, Uint8 lsu, Uint16 *flowMask)
CSL_IDEF_INLINE void CSL_SRIO_SetSupervisorPerms (CSL_SrioHandle hSrio, Uint16 supervisor16ID, Uint8 supervisor8ID)
CSL_IDEF_INLINE void CSL_SRIO_GetSupervisorPerms (CSL_SrioHandle hSrio, Uint16 *supervisor16ID, Uint8 *supervisor8ID)
CSL_IDEF_INLINE void CSL_SRIO_SetFlowControl (CSL_SrioHandle hSrio, Uint8 flowControlIdx, Uint8 tt, Uint16 dstID)
CSL_IDEF_INLINE void CSL_SRIO_GetFlowControl (CSL_SrioHandle hSrio, Uint8 flowControlIdx, Uint8 *tt, Uint16 *dstID)
CSL_IDEF_INLINE void CSL_SRIO_SetTxCPPIFlowMask (CSL_SrioHandle hSrio, Uint8 txCPPI, Uint16 flowMask)
CSL_IDEF_INLINE void CSL_SRIO_GetTxCPPIFlowMask (CSL_SrioHandle hSrio, Uint8 txCPPI, Uint16 *flowMask)
CSL_IDEF_INLINE void CSL_SRIO_SetTxQueueSchedInfo (CSL_SrioHandle hSrio, Uint8 txQueue, Uint8 portNum, Uint8 crf)
CSL_IDEF_INLINE void CSL_SRIO_GetTxQueueSchedInfo (CSL_SrioHandle hSrio, Uint8 txQueue, Uint8 *portNum, Uint8 *priority, Uint8 *crf)
CSL_IDEF_INLINE void CSL_SRIO_SetTxGarbageCollectionInfo (CSL_SrioHandle hSrio, Uint16 qidLength, Uint16 qidTimeout, Uint16 qidRetry, Uint16 qidTransErr, Uint16 qidProg, Uint16 qidSsize)
CSL_IDEF_INLINE void CSL_SRIO_GetTxGarbageCollectionInfo (CSL_SrioHandle hSrio, Uint16 *qidLength, Uint16 *qidTimeout, Uint16 *qidRetry, Uint16 *qidTransErr, Uint16 *qidProg, Uint16 *qidSsize)
CSL_IDEF_INLINE void CSL_SRIO_GetQMBaseAddress (CSL_SrioHandle hSrio, Uint8 qmIndex, Uint32 *qmBaseAddress)
CSL_IDEF_INLINE void CSL_SRIO_SetQMBaseAddress (CSL_SrioHandle hSrio, Uint8 qmIndex, Uint32 qmBaseAddress)

Detailed Description

This is the SRIO Auxilary Header File which exposes the various CSL Functional Layer API's to configure the SRIO Module.

============================================================================
(C) Copyright 2008-2011, Texas Instruments, Inc.

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.


Copyright 2012, Texas Instruments Incorporated