tsip.h File Reference

Telecom Serial Interface Port (TSIP) sub-system API and Data Definitions. More...

#include <stdint.h>
#include <stdlib.h>
#include <ti/csl/csl_tsip.h>
#include "tsip_cfg.h"
#include "tsipver.h"

Data Structures

struct  tsipSizeInfo_t
 TSIP Size Configuration Structure. More...
struct  tsipConfigDir_t
 TSIP Initialization config structure specific to Tx/Rx directions. More...
struct  tsipConfig_t
 TSIP Initialization configuration structure. More...
struct  tsipTsControlDir_t
 TSIP timeslot run-time configuration structure specific to Tx/Rx directions. More...
struct  tsipTsControl_t
 TSIP timeslot run-time configuration structure. More...

Defines

#define tsip_N_BUFS_SHARED   5
 Define the maximum number of buffers the module can request common to all the TSIP ports.
#define tsip_N_BUFS_PORT   1
 Define the maximum number of buffers the module can request for individual TSIP ports.
TSIPLLD Function Return Codes

Error codes returned by TSIPLLD API functions.

#define tsip_OK   0
#define tsip_FAIL   -10
#define tsip_ERR_CONFIG   -11
#define tsip_NO_PORTS_AVAILABLE   -12
#define tsip_INVALID_TSIP_PORT_ID   -13
#define tsip_TX_RX_ALREADY_ENABLED   -14
#define tsip_TDMU_DMATCU_ALREADY_ENABLED   -15
#define tsip_TIMESLOT_ALREADY_ENABLED   -16
#define tsip_NO_FREE_TIMESLOT   -17

Typedefs

typedef int tsipReturn_t
 The return type for module functions.
typedef void * Tsip_DrvHandle
 Specification of Tsip_DrvHandle.
typedef void * Tsip_PortHandle
 Specification of Tsip_PortHandle.
typedef int16_t tsipData_t

Functions

tsipReturn_t Tsip_getBufferReqShared (tsipSizeInfo_t *sizeCfg, int sizes[], int aligns[])
 Tsip_getBufferReqShared returns the memory requirements for the TSIP driver which is shared by all the TSIP ports.
tsipReturn_t Tsip_getBufferReqPort (tsipSizeInfo_t *sizeCfg, int sizes[], int aligns[])
 Tsip_getBufferReqPort returns the memory requirements for the TSIP driver which is specific to individual TSIP ports.
tsipReturn_t Tsip_createShared (tsipConfig_t *cfg, void *bases[], Tsip_DrvHandle *pHandle)
 Tsip_createShared creates the TSIP driver instance and performs common initialization.
tsipReturn_t Tsip_createPort (Tsip_DrvHandle handle, tsipConfig_t *cfg, void *bases[], Tsip_PortHandle *portHandle)
 Tsip_createPort initializes individual ports of the TSIP driver.
tsipReturn_t Tsip_enablePortChannel (Tsip_DrvHandle handle, Tsip_PortHandle portHandle, int16_t txCh, int16_t rxCh)
 Tsip_enablePortChannel Enables Transmit and Receive channels on a TSIP port.
tsipReturn_t Tsip_closeShared (Tsip_DrvHandle handle, void *bases[])
 Tsip_closeShared decativates the shared portion of the TSIP driver instance.
tsipReturn_t Tsip_closePort (Tsip_PortHandle portHandle, void *bases[])
 Tsip_closePort decativates the per port portion of the TSIP driver instance.
tsipReturn_t Tsip_timeslotConfig (Tsip_DrvHandle handle, tsipTsControl_t *ctl)
 Tsip_timeslotConfig performs run-time configuration change of timeslots.
tsipReturn_t Tsip_getCallout (Tsip_DrvHandle handle, tsipTsControl_t *ctl)
 Tsip_getCallout queries the TSIP timeslot callout along with the context.
tsipReturn_t Tsip_setCallout (Tsip_DrvHandle handle, tsipTsControl_t *ctl)
 Tsip_setCallout changes the TSIP timeslot callout and its context.
tsipReturn_t Tsip_configPhase (Tsip_DrvHandle handle, tsipTsControl_t *ctl)
 Tsip_configPhase configures the desired stagger phase of a TSIP timeslot.
int16_t Tsip_getTxDmaPos (void *cxt)
 TSIP_getTxDmaPos gets Tx DMA position.
void Tsip_superFrameIsr (Tsip_PortHandle portHandle)
 Tsip_superFrameIsr is the ISR function for super-frame interrupts.
uint32_t Tsip_getVersion (void)
 Tsip_getVersion returns the TSIP LLD version information.
const char * Tsip_getVersionStr (void)
 Tsip_getVersionStr returns the TSIP LLD version string.

Detailed Description

Telecom Serial Interface Port (TSIP) sub-system API and Data Definitions.

path ti/drv/tsip/tsip.h


Copyright 2012, Texas Instruments Incorporated