Functions
CSL_TAC_SGCP_FUNCTION

Functions

void CSL_TAC_SGCP_enable (Uint8 sgcpId)
void CSL_TAC_SGCP_disable (Uint8 sgcpId)
Uint16 CSL_TAC_SGCP_getActiveCycles (Uint8 sgcpId)
Uint16 CSL_TAC_SGCP_getSequencerCycles (Uint8 sgcpId)
void CSL_TAC_SGCP_getReadTime (CSL_TAC_SGCP_Timestamp_req *timestamp)
void CSL_TAC_SGCP_getCycleOverflowStatus (Uint8 sgcpId, CSL_TAC_SGCP_cycleOverflowStatus *cycleOverflowStatus)
void CSL_TAC_SGCP_resetCycleOverflowStatus (Uint8 sgcpId)
void CSL_TAC_SGCP_getSymbolBuffMissStatus (Uint8 sgcpId, CSL_TAC_SGCP_symbolBuffMissStatus *symBuffMissStatus)
void CSL_TAC_SGCP_resetSymbolBuffMissStatus (Uint8 sgcpId)
void CSL_TAC_SGCP_getFIFOOverflowStatus (Uint8 sgcpId, CSL_TAC_SGCP_fifoOverflowStatus *fifoOverflowStatus)
void CSL_TAC_SGCP_resetFIFOOverflowStatus (Uint8 sgcpId)
Uint32 CSL_TAC_SGCP_getFetchQLevel (Uint8 sgcpId)
Uint32 CSL_TAC_SGCP_getFetchQWatermark (Uint8 sgcpId)
void CSL_TAC_SGCP_resetFetchQueue (Uint8 sgcpId)
Uint32 CSL_TAC_SGCP_getCPMQLevel (Uint8 sgcpId)
Uint32 CSL_TAC_SGCP_getCPMQWatermark (Uint8 sgcpId)
void CSL_TAC_SGCP_resetCPMQueue (Uint8 sgcpId)
Uint32 CSL_TAC_SGCP_getWarningQLevel (Uint8 sgcpId)
Uint32 CSL_TAC_SGCP_getWarningQWatermark (Uint8 sgcpId)
void CSL_TAC_SGCP_resetWarningQueue (Uint8 sgcpId)

Function Documentation

void CSL_TAC_SGCP_disable ( Uint8  sgcpId)


CSL_TAC_SGCP_disable

Description
This function disables a Spreader Group Co-Processor (SGCP) identified by sgcpId.

Arguments

    sgcpId          Which SGCP to disable.
    

Return Value
None

Pre Condition
None

Post Condition
The SGCP Sequencer is disabled.

Writes
SGCP_CFG_SGCP_SEQ_ENA_ENABLE=0

Example

    // Disable SGCP 0
    CSL_TAC_SGCP_disable(0);

    // Disable SGCP 1
    CSL_TAC_SGCP_disable(1);
    
void CSL_TAC_SGCP_enable ( Uint8  sgcpId)


CSL_TAC_SGCP_enable

Description
This function enables a Spreader Group Co-Processor (SGCP) identified by sgcpId.

Arguments

    sgcpId          Which SGCP to enable.
    

Return Value
None

Pre Condition
None

Post Condition
The SGCP Sequencer is enabled.

Writes
SGCP_CFG_SGCP_SEQ_ENA_ENABLE=1

Example

    // Enable SGCP 0
    CSL_TAC_SGCP_enable(0);

    // Enable SGCP 1
    CSL_TAC_SGCP_enable(1);
    
Uint16 CSL_TAC_SGCP_getActiveCycles ( Uint8  sgcpId)


CSL_TAC_SGCP_getActiveCycles

Description
This function returns the number of active cycles in the previous iteration.

Arguments

    sgcpId          Which SGCP to get status from.
    

Return Value
The number of active cycles

Pre Condition
None

Post Condition
None

Reads
SGCP_CFG_SGCP_SEQ_ACT_ACT_COUNT

Example

    Uint16  actCycles;

    // Get the Active cycles for SGCP 0
    actCycles = CSL_TAC_SGCP_getActiveCycles(0);

    // Get the Active cycles for SGCP 1
    actCycles = CSL_TAC_SGCP_getActiveCycles(1);
    
Uint32 CSL_TAC_SGCP_getCPMQLevel ( Uint8  sgcpId)


CSL_TAC_SGCP_getCPMQLevel

Description
This function returns the Code Power Measurement Transaction Queue Current Level for a given SGCP ID.

Arguments

    sgcpId          Which SGCP CPM queue current level to read.
    

Return Value
The current value of the level

Pre Condition
None

Post Condition
None

Reads
SGCP_CFG_CTQ_CURR_LVL_CURR_LVL

Example

    Uint16  level;

    // Get the Queue Level for SGCP 0
    level = CSL_TAC_SGCP_getCPMQLevel(0);
    ...

    // Get the Queue Level for SGCP 1
    level = CSL_TAC_SGCP_getCPMQLevel(1);
    ...
    
Uint32 CSL_TAC_SGCP_getCPMQWatermark ( Uint8  sgcpId)


CSL_TAC_SGCP_getCPMQWatermark

Description
This function returns the Code Power Measurement Transaction Queue Water Mark for a given SGCP ID.

Arguments

    sgcpId          Which SGCP CPM queue water mark to read.
    

Return Value
The highest level of the queue.

Pre Condition
None

Post Condition
Reading of this register resets the value to the current level.

Reads
SGCP_CFG_CTQ_WTMK_LVL_WATERMARK

Example

    Uint16  level;

    // Get the Queue Level for SGCP 0
    level = CSL_TAC_SGCP_getCPMQWatermark(0);
    ...

    // Get the Queue Level for SGCP 1
    level = CSL_TAC_SGCP_getCPMQWatermark(1);
    ...
    
void CSL_TAC_SGCP_getCycleOverflowStatus ( Uint8  sgcpId,
CSL_TAC_SGCP_cycleOverflowStatus *  cycleOverflowStatus 
)


CSL_TAC_SGCP_getCycleOverflowStatus

Description
This function returns the task and page Ids that form the SRM ID that was last active.

Arguments

    sgcpId              Which SGCP to get status from.

    cycleOverflowStatus Structure with cycle over flow parameters.
    

Return Value
None

Pre Condition
None

Post Condition
None

Reads
SGCP_CFG_SGCP_CYC_OVER_ITE_NB, SGCP_CFG_SGCP_CYC_OVER_CYC_OVER_FLG, SGCP_CFG_SGCP_CYC_OVER_PAGE_IDX, SGCP_CFG_SGCP_CYC_OVER_TASK_IDX

Example

    CSL_TAC_SGCP_cycleOverflowStatus  cycleOverflowStatus;

    ...
    // Get the status for SGCP 0
    CSL_TAC_SGCP_getCycleOverflowStatus(0, &cycleOverflowStatus);
    ...

    // Get the status for SGCP 1
    CSL_TAC_SGCP_getCycleOverflowStatus(1, &cycleOverflowStatus);
    ...
    
Uint32 CSL_TAC_SGCP_getFetchQLevel ( Uint8  sgcpId)


CSL_TAC_SGCP_getFetchQLevel

Description
This function returns the Fetching Transaction Queue Current Level for a given SGCP ID.

Arguments

    sgcpId          Which SGCP Fetching queue current level to read.
    

Return Value
The current value of the level

Pre Condition
None

Post Condition
None

Reads
SGCP_CFG_FTQ_CURR_LVL_CURR_LVL

Example

    Uint16  level;

    // Get the Queue Level for SGCP 0
    level = CSL_TAC_SGCP_getFetchQLevel(0);
    ...

    // Get the Queue Level for SGCP 1
    level = CSL_TAC_SGCP_getFetchQLevel(1);
    ...
    
Uint32 CSL_TAC_SGCP_getFetchQWatermark ( Uint8  sgcpId)


CSL_TAC_SGCP_getFetchQWatermark

Description
This function returns the Fetching Transaction Queue Water Mark for a given SGCP ID.

Arguments

    sgcpId          Which SGCP Fetching queue water mark to read.
    

Return Value
The highest level of the queue.

Pre Condition
None

Post Condition
Reading of this register resets the value to the current level.

Reads
SGCP_CFG_FTQ_WTMK_LVL_WATERMARK

Example

    Uint16  level;

    // Get the Queue Level for SGCP 0
    level = CSL_TAC_SGCP_getFetchQWatermark(0);
    ...

    // Get the Queue Level for SGCP 1
    level = CSL_TAC_SGCP_getFetchQWatermark(1);
    ...
    
void CSL_TAC_SGCP_getFIFOOverflowStatus ( Uint8  sgcpId,
CSL_TAC_SGCP_fifoOverflowStatus *  fifoOverflowStatus 
)


CSL_TAC_SGCP_getFIFOOverflowStatus

Description
This function returns the task and page Ids that form the SRM ID. This is the active task that tried to write into a full FIFO.

Arguments

    sgcpId              Which SGCP to get status from.

    fifoOverflowStatus  Structure with FIFO over flow parameters
    

Return Value
None

Pre Condition
None

Post Condition
None

Reads
SGCP_CFG_SGCP_FIFO_OVER_ITE_NB, SGCP_CFG_SGCP_FIFO_OVER_FIFO_ID, SGCP_CFG_SGCP_FIFO_OVER_CYC_OVER_FLG, SGCP_CFG_SGCP_FIFO_OVER_PAGE_IDX, SGCP_CFG_SGCP_FIFO_OVER_TASK_IDX

Example

    CSL_TAC_SGCP_fifoOverflowStatus  fifoOverflowStatus;

    ...
    // Get the status for SGCP 0
    CSL_TAC_SGCP_getFIFOOverflowStatus(0, &fifoOverflowStatus);
    ...

    // Get the status for SGCP 1
    CSL_TAC_SGCP_getFIFOOverflowStatus(1, &fifoOverflowStatus);
    ...
    
void CSL_TAC_SGCP_getReadTime ( CSL_TAC_SGCP_Timestamp_req *  timestamp)


CSL_TAC_SGCP_getReadTime

Description
This function reads the SGCP 0 read timestamp register.

Arguments

    timestamp       Structure with timestamp parameters.
    

Return Value
None

Pre Condition
None

Post Condition
None

Reads
SGCP_CFG_SGCP_RD_SYS_TIME_CHIP_NB, SGCP_CFG_SGCP_RD_SYS_TIME_SLOT_NB, SGCP_CFG_SGCP_RD_SYS_TIME_FRAME_NB

Example

    CSL_TAC_SGCP_Timestamp_req  timestamp;

    ...
    CSL_TAC_SGCP_getReadTime(&timestamp);
    ...
    
Uint16 CSL_TAC_SGCP_getSequencerCycles ( Uint8  sgcpId)


CSL_TAC_SGCP_getSequencerCycles

Description
This function returns the number of sequencer-used cycles in the previous iteration.

Arguments

    sgcpId          Which SGCP to get status from.
    

Return Value
The number of cycles consumed by the sequencer.

Pre Condition
None

Post Condition
None

Reads
SGCP_CFG_SGCP_SEQ_CYC_SEQ_COUNT

Example

    Uint16  seqCycles;

    // Get the Sequencer used cycles for SGCP 0
    seqCycles = CSL_TAC_SGCP_getSequencerCycles(0);

    // Get the Sequencer used cycles for SGCP 1
    seqCycles = CSL_TAC_SGCP_getSequencerCycles(1);
    
void CSL_TAC_SGCP_getSymbolBuffMissStatus ( Uint8  sgcpId,
CSL_TAC_SGCP_symbolBuffMissStatus *  symBuffMissStatus 
)


CSL_TAC_SGCP_getSymbolBuffMissStatus

Description
This function returns the task and page Ids that form the SRM ID. This is the symbol input buffer location where the write miss error occured.

Arguments

    sgcpId              Which SGCP to get status from.

    symBuffMissStatus   Structure with symbol buffer miss parameters
    

Return Value
None

Pre Condition
None

Post Condition
None

Reads
SGCP_CFG_SGCP_IB_MISS_ITE_NB, SGCP_CFG_SGCP_IB_MISS_WR_MISS, SGCP_CFG_SGCP_IB_MISS_PAGE_IDX, SGCP_CFG_SGCP_IB_MISS_TASK_IDX

Example

    CSL_TAC_SGCP_symbolBuffMissStatus  symBuffMissStatus;

    ...
    // Get the status for SGCP 0
    CSL_TAC_SGCP_getSymbolBuffMissStatus(0, &symBuffMissStatus);
    ...

    // Get the status for SGCP 1
    CSL_TAC_SGCP_getSymbolBuffMissStatus(1, &symBuffMissStatus);
    ...
    
Uint32 CSL_TAC_SGCP_getWarningQLevel ( Uint8  sgcpId)


CSL_TAC_SGCP_getWarningQLevel

Description
This function returns the Warning Transaction Queue Current Level for a given SGCP ID.

Arguments

    sgcpId          Which SGCP warning queue current level to read.
    

Return Value
The current value of the level

Pre Condition
None

Post Condition
None

Reads
SGCP_CFG_WTQ_CURR_LVL_CURR_LVL

Example

    Uint16  level;

    // Get the Queue Level for SGCP 0
    level = CSL_TAC_SGCP_getWarningQLevel(0);
    ...

    // Get the Queue Level for SGCP 1
    level = CSL_TAC_SGCP_getWarningQLevel(1);
    ...
    
Uint32 CSL_TAC_SGCP_getWarningQWatermark ( Uint8  sgcpId)


CSL_TAC_SGCP_getWarningQWatermark

Description
This function returns the Warning Transaction Queue Water Mark for a given SGCP ID.

Arguments

    sgcpId          Which SGCP warning queue water mark to read.
    

Return Value
The highest level of the queue.

Pre Condition
None

Post Condition
Reading of this register resets the value to the current level.

Reads
SGCP_CFG_WTQ_WTMK_LVL_WATERMARK

Example

    Uint16  level;

    // Get the Queue Level for SGCP 0
    level = CSL_TAC_SGCP_getWarningQWatermark(0);
    ...

    // Get the Queue Level for SGCP 1
    level = CSL_TAC_SGCP_getWarningQWatermark(1);
    ...
    
void CSL_TAC_SGCP_resetCPMQueue ( Uint8  sgcpId)


CSL_TAC_SGCP_resetCPMQueue

Description
This function resets the Code Power Measurement Queue of the corresponding SGCP by writing into the TAC_SGCP_FIFO_RESET register.

Arguments

    sgcpId          Which SGCP's FIFO to reset.
    

Return Value
None

Pre Condition
None

Post Condition
None

Writes
SGCP_CFG_SGCP_FIFO_RESET_CPM_RESET=1

Affects
SGCP_CFG_CTQ_WTMK_LVL_WATERMARK=0, SGCP_CFG_CTQ_CURR_LVL_CURR_LVL=0, SGCP_CFG_SGCP_FIFO_RESET_CPM_RESET=0

Example

    ...
    // Reset the Queue for SGCP 0
    CSL_TAC_SGCP_resetCPMQueue(0);
    ...

    // Reset the Queue for SGCP 1
    CSL_TAC_SGCP_resetCPMQueue(1);
    ...
    
void CSL_TAC_SGCP_resetCycleOverflowStatus ( Uint8  sgcpId)


CSL_TAC_SGCP_resetCycleOverflowStatus

Description
This function resets the Cycle overflow error status.

Arguments

    sgcpId              Which SGCP's error status to reset.
    

Return Value
None

Pre Condition
None

Post Condition
None

Writes
SGCP_CFG_SGCP_CYC_OVER_CYC_OVER_FLG=1

Affects
SGCP_CFG_SGCP_CYC_OVER_CYC_OVER_FLG=0

Example

    CSL_TAC_SGCP_cycleOverflowStatus  cycleOverflowStatus;

    ...
    // Get the status for SGCP 0
    CSL_TAC_SGCP_getCycleOverflowStatus(0, &cycleOverflowStatus);

    if (cycleOverflowStatus.overflowFlag)
    {
        CSL_TAC_SGCP_resetFIFOOverflowStatus(0);
    }

    // Get the status for SGCP 1
    CSL_TAC_SGCP_getCycleOverflowStatus(1, &cycleOverflowStatus);

    if (cycleOverflowStatus.overflowFlag)
    {
        CSL_TAC_SGCP_resetFIFOOverflowStatus(1);
    }
    
void CSL_TAC_SGCP_resetFetchQueue ( Uint8  sgcpId)


CSL_TAC_SGCP_resetFetchQueue

Description
This function resets the Fetch Queue of the corresponding SGCP by writing into the TAC_SGCP_FIFO_RESET register.

Arguments

    sgcpId          Which SGCP's FIFO to reset.
    

Return Value
None

Pre Condition
None

Post Condition
None

Writes
SGCP_CFG_SGCP_FIFO_RESET_FETCH_RESET=1

Affects
SGCP_CFG_FTQ_WTMK_LVL_WATERMARK=0, SGCP_CFG_FTQ_CURR_LVL_CURR_LVL=0, SGCP_CFG_SGCP_FIFO_RESET_FETCH_RESET=0

Example

    ...
    // Reset the Queue for SGCP 0
    CSL_TAC_SGCP_resetFetchQueue(0);
    ...

    // Reset the Queue for SGCP 1
    CSL_TAC_SGCP_resetFetchQueue(1);
    ...
    
void CSL_TAC_SGCP_resetFIFOOverflowStatus ( Uint8  sgcpId)


CSL_TAC_SGCP_resetFIFOOverflowStatus

Description
This function resets the FIFO overflow error status.

Arguments

    sgcpId              Which SGCP's error status to reset.
    

Return Value
None

Pre Condition
None

Post Condition
None

Writes
SGCP_CFG_SGCP_FIFO_OVER_CYC_OVER_FLG=1

Affects
SGCP_CFG_SGCP_FIFO_OVER_CYC_OVER_FLG=0

Example

    CSL_TAC_SGCP_fifoOverflowStatus  fifoOverflowStatus;

    ...
    // Get the status for SGCP 0
    CSL_TAC_SGCP_getFIFOOverflowStatus(0, &fifoOverflowStatus);

    if (fifoOverflowStatus.overflowFlag)
    {
        CSL_TAC_SGCP_resetFIFOOverflowStatus(0);
    }

    // Get the status for SGCP 1
    CSL_TAC_SGCP_getFIFOOverflowStatus(1, &fifoOverflowStatus);

    if (fifoOverflowStatus.overflowFlag)
    {
        CSL_TAC_SGCP_resetFIFOOverflowStatus(1);
    }
    


CSL_TAC_SGCP_resetSymbolBuffMissStatus

Description
This function resets the Symbol Buffer Miss error status.

Arguments

    sgcpId              Which SGCP's error status to reset.
    

Return Value
None

Pre Condition
None

Post Condition
None

Writes
SGCP_CFG_SGCP_IB_MISS_WR_MISS=1

Affects
SGCP_CFG_SGCP_IB_MISS_WR_MISS=0

Example

    CSL_TAC_SGCP_symbolBuffMissStatus  symBuffMissStatus;

    ...
    // Get the status for SGCP 0
    CSL_TAC_SGCP_getSymbolBuffMissStatus(0, &symBuffMissStatus);

    if (symBuffMissStatus.writeMissFlag)
    {
        CSL_TAC_SGCP_resetSymbolBuffMissStatus(0);
    }

    // Get the status for SGCP 1
    CSL_TAC_SGCP_getSymbolBuffMissStatus(1, &symBuffMissStatus);

    if (symBuffMissStatus.writeMissFlag)
    {
        CSL_TAC_SGCP_resetSymbolBuffMissStatus(1);
    }
    
void CSL_TAC_SGCP_resetWarningQueue ( Uint8  sgcpId)


CSL_TAC_SGCP_resetWarningQueue

Description
This function resets the Warning Queue of the corresponding SGCP by writing into the TAC_SGCP_FIFO_RESET register.

Arguments

    sgcpId          Which SGCP's FIFO to reset.
    

Return Value
None

Pre Condition
None

Post Condition
None

Writes
SGCP_CFG_SGCP_FIFO_RESET_WARN_RESET=1

Affects
SGCP_CFG_WTQ_WTMK_LVL_WATERMARK=0, SGCP_CFG_WTQ_CURR_LVL_CURR_LVL=0, SGCP_CFG_SGCP_FIFO_RESET_WARN_RESET=0

Example

    ...
    // Reset the Queue for SGCP 0
    CSL_TAC_SGCP_resetWarningQueue(0);
    ...

    // Reset the Queue for SGCP 1
    CSL_TAC_SGCP_resetWarningQueue(1);
    ...
    

Copyright 2014, Texas Instruments Incorporated