csl_tsip.h File Reference

This is the main header file for the TSIP Module which defines all the data structures and exported API. More...

#include <ti/csl/soc.h>
#include <ti/csl/csl_types.h>
#include <ti/csl/csl_error.h>
#include <ti/csl/cslr_tsip.h>

Typedefs

typedef volatile CSL_TsipRegs * CSL_TsipHandle
 This is the handle to the TSIP instance.

Enumerations

enum  CSL_TsipTestModeSelect { CSL_TSIP_TESTMODE_DATA_LOOPBACK = 0, CSL_TSIP_TESTMODE_LINK_LOOPBACK = 1 }
enum  CSL_TsipDataRate { CSL_TSIP_DATARATE_8M = 0, CSL_TSIP_DATARATE_16M = 1, CSL_TSIP_DATARATE_32M = 2 }
enum  CSL_TsipPri {
  CSL_TSIP_PRI_0 = 0, CSL_TSIP_PRI_1 = 1, CSL_TSIP_PRI_2 = 2, CSL_TSIP_PRI_3 = 3,
  CSL_TSIP_PRI_4 = 4, CSL_TSIP_PRI_5 = 5, CSL_TSIP_PRI_6 = 6, CSL_TSIP_PRI_7 = 7
}
enum  CSL_TsipClkm { CSL_TSIP_CLKM_DBL = 0, CSL_TSIP_CLKM_SGL = 1 }
enum  CSL_TsipFramecount { CSL_TSIP_FRAMECOUNT_1 = 0, CSL_TSIP_FRAMECOUNT_256 = 255 }
enum  CSL_TsipFramesize { CSL_TSIP_FRAMESIZE_1 = 0, CSL_TSIP_FRAMESIZE_128 = 127 }
enum  CSL_TsipTimeslot { CSL_TSIP_TIMESLOT_DISABLED = 0, CSL_TSIP_TIMESLOT_LINEAR = 1, CSL_TSIP_TIMESLOT_ULAW = 2, CSL_TSIP_TIMESLOT_ALAW = 3 }
enum  CSL_TsipClkSrc { CSL_TSIP_CLKSRC_A = 0, CSL_TSIP_CLKSRC_B = 1 }
enum  CSL_TsipClkp { CSL_TSIP_CLKP_RISING = 0, CSL_TSIP_CLKP_FALLING = 1 }
enum  CSL_TsipEndian { CSL_TSIP_ENDIAN_LITTLE = 0, CSL_TSIP_ENDIAN_BIG = 1 }
enum  CSL_TsipFsyncp { CSL_TSIP_FSYNCP_ALOW = 0, CSL_TSIP_FSYNCP_AHIGH = 1 }
enum  CSL_TsipDlyCtrl { CSL_TSIP_DLY_CTRL_DISABLE = 0, CSL_TSIP_DLY_CTRL_ENABLE = 1 }
enum  CSL_TsipInt { CSL_TSIP_INT_ACK = 0, CSL_TSIP_INT_DLY = 1, CSL_TSIP_INT_ACKORDLY = 2, CSL_TSIP_INT_ACKNDLY = 3 }
enum  CSL_TsipXmtDis { CSL_TSIP_XMTDIS_HIGHIMP = 0, CSL_TSIP_XMTDIS_LOW = 2, CSL_TSIP_XMTDIS_HIGH = 3 }
enum  CSL_TsipClkd { CSL_TSIP_CLKD_REDUN = 0, CSL_TSIP_CLKD_DUAL = 1 }
enum  CSL_TsipChst { CSL_TSIP_CHST_INACTIVE = 0, CSL_TSIP_CHST_AACTIVE = 1, CSL_TSIP_CHST_BACTIVE = 2 }
enum  CSL_TsipEmu { CSL_TSIP_EMU_STOP = 0, CSL_TSIP_EMU_TX_STOP = 1, CSL_TSIP_EMU_FREERUN = 2 }

Functions

CSL_TsipHandle CSL_tsipOpen (Int32 instNum)

Detailed Description

This is the main header file for the TSIP Module which defines all the data structures and exported API.

============================================================================
(C) Copyright 2008, 2009, 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.


Function Documentation

CSL_TsipHandle CSL_tsipOpen ( Int32  instNum  ) 

============================================================================
CSL_tsipOpen

Description
This API opens the TSIP controller instance. This should always be the first call to the CSL TSIP Functional layer. The handle which is returned from this call should be passed in all subsequent CSL API's.

Return Value
CSL_TsipHandle - Handle to the TSIP Module
0 - Error.

Pre Condition
None

Post Condition
None

Modifies
None

Example

        CSL_TsipHandle   hnd;
        ...
        hnd = CSL_tsipOpen (CSL_TSIP_0);    // Opens TSIP Instance 0
        ...
     

===========================================================================


Copyright 2012, Texas Instruments Incorporated