TSIP LLD Functions
[TSIP LLD Module API]

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.

Function Documentation

tsipReturn_t Tsip_closePort ( Tsip_PortHandle  portHandle,
void *  bases[] 
)

Tsip_closePort decativates the per port portion of the TSIP driver instance.

This function deactivates the TSIP driver instance specific to individual TSIP ports, all the aoociated memory buffers can be freed after this call.

Parameters:
[in] portHandle Handle for the TSIP port
[out] bases Array of the memory buffer base addresses
Return values:
Value Function Return Values
tsipReturn_t Tsip_closeShared ( Tsip_DrvHandle  handle,
void *  bases[] 
)

Tsip_closeShared decativates the shared portion of the TSIP driver instance.

This function deactivates the TSIP driver instance common to all the TSIP ports, all the aoociated memory buffers can be freed after this call.

Parameters:
[in] handle The TSIP LLD instance identifier
[out] bases Array of the memory buffer base addresses
Return values:
Value Function Return Values
tsipReturn_t Tsip_configPhase ( Tsip_DrvHandle  handle,
tsipTsControl_t ctl 
)

Tsip_configPhase configures the desired stagger phase of a TSIP timeslot.

This function is used to configure the desired stagger phase of a TSIP timeslot

Parameters:
[in] handle The driver instance handle
[in] ctl The run-time control structure
Return values:
Value Function Return Values
Precondition:
A driver and port instance must be created, timeslot configuration must be done
tsipReturn_t Tsip_createPort ( Tsip_DrvHandle  handle,
tsipConfig_t cfg,
void *  bases[],
Tsip_PortHandle portHandle 
)

Tsip_createPort initializes individual ports of the TSIP driver.

This function initializes the TSIP driver specific to individual TSIP ports based on user configuration

Parameters:
[in] handle The TSIP LLD instance identifier
[in,out] cfg Configuration information: out for cfg->hwId, and in for others
[in] bases Array of the memory buffer base addresses
[out] portHandle Instance handle for the TSIP port. This is a pointer to an initialized instance structure.
Return values:
Value Function Return Values
Precondition:
A driver instance must be created via calling Tsip_createShared()
tsipReturn_t Tsip_createShared ( tsipConfig_t cfg,
void *  bases[],
Tsip_DrvHandle pHandle 
)

Tsip_createShared creates the TSIP driver instance and performs common initialization.

This function initializes the TSIP driver common to all the TSIP ports based on user configuration

Parameters:
[in] cfg Configuration information
[in] bases Array of the memory buffer base addresses
[out] pHandle Instance handle. This is a pointer to an initialized instance structure.
Return values:
Value Function Return Values
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.

TSIP transmit and receive channel is enabled for a TSIP port

Parameters:
[in] handle The TSIP LLD instance identifier
[in] portHandle Instance handle for the TSIP port
[in] txCh Transmit DMA channel number
[in] rxCh Receive DMA channel number
Return values:
Value Function Return Values
Precondition:
A driver and port instance must be created
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.

This function returns the per port memory buffer requirements in terms of the size and alignment array.

Parameters:
[in] sizeCfg Size configuration information
[out] sizes Array of size requirements
[out] aligns Array of alignment requirements
Return values:
Value Function Return Values
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.

This function returns the memory buffer requirements common to all the TSIP ports, in terms of the size and alignment array.

Parameters:
[in] sizeCfg Size configuration information
[out] sizes Array of size requirements
[out] aligns Array of alignment requirements
Return values:
Value Function Return Values
tsipReturn_t Tsip_getCallout ( Tsip_DrvHandle  handle,
tsipTsControl_t ctl 
)

Tsip_getCallout queries the TSIP timeslot callout along with the context.

This function is used to get the current TSIP timeslot callout function along with the context used by the callout

Parameters:
[in] handle The driver instance handle
[in,out] ctl The run-time control structure
Return values:
Value Function Return Values
Precondition:
A driver and port instance must be created, timeslot configuration must be done
int16_t Tsip_getTxDmaPos ( void *  cxt  ) 

TSIP_getTxDmaPos gets Tx DMA position.

This function is used to get the position of transmit DMA position, i.e., the index of the last consumed sample in DMA buffer

Parameters:
[in] cxt Timeslot context pointer which is returned after calling Tsip_timeslotConfig()
Return values:
The index of the last consumed sample in the DMA buffer
Precondition:
A driver and port instance must be created, timeslot configuration must be done
uint32_t Tsip_getVersion ( void   ) 

Tsip_getVersion returns the TSIP LLD version information.

This function is used to get the version information of the TSIP LLD in 0xAABBCCDD format. where Arch (AA); API Changes (BB); Major (CC); Minor (DD)

Return values:
32-bit version information
const char* Tsip_getVersionStr ( void   ) 

Tsip_getVersionStr returns the TSIP LLD version string.

This function is used to get the version string of the TSIP LLD.

Return values:
Version string
tsipReturn_t Tsip_setCallout ( Tsip_DrvHandle  handle,
tsipTsControl_t ctl 
)

Tsip_setCallout changes the TSIP timeslot callout and its context.

This function is used to change the TSIP timeslot callout function as well as the context used by the callout

Parameters:
[in] handle The driver instance handle
[in] ctl The run-time control structure
Return values:
Value Function Return Values
Precondition:
A driver and port instance must be created, timeslot configuration must be done
void Tsip_superFrameIsr ( Tsip_PortHandle  portHandle  ) 

Tsip_superFrameIsr is the ISR function for super-frame interrupts.

This function is used as the ISR function for super-frame interrupts

Parameters:
[in] portHandle The TSIP port instance handle
Return values:
Value Function Return Values
Precondition:
A driver instance must be created
tsipReturn_t Tsip_timeslotConfig ( Tsip_DrvHandle  handle,
tsipTsControl_t ctl 
)

Tsip_timeslotConfig performs run-time configuration change of timeslots.

This function is used to run-time configure a TSIP timeslot. New configuration parameters are passed in through the control structure.

Parameters:
[in] handle The driver instance handle
[in,out] ctl The run-time control structure: out for ctl->txTsContext, in for others
Return values:
Value Function Return Values
Precondition:
A driver and port instance must be created

Copyright 2012, Texas Instruments Incorporated