|
|
| void CSL_RAC_GCCP_disable | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId | |||
| ) |
=============================================================================
CSL_RAC_GCCP_disable
Description This function disables the corresponding Generic Correlation Co-Processor (GCCP) by writing 0x1 into the RAC_GCCP_SEQ_ENA register.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to configure.
gccpId - Which GCCP to de-activate.
Return Value
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Pre Condition
None
Post Condition
This operation modifies the RAC_GCCP_SEQ_ENA register. The GCCP Sequencer is then disabled.
Writes
GCCP2_CFG_GCCP_SEQ_ENA_ENABLE=0
Example
Uint8 gccpId = 0;
...
CSL_RAC_GCCP_disable (hRac, gccpId);
...
| void CSL_RAC_GCCP_enable | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId | |||
| ) |
============================================================================
CSL_RAC_GCCP_enable
Description This function enables the corresponding Generic Correlation Co-Processor (GCCP) by writing 0x1 into the RAC_GCCP_SEQ_ENA register.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to configure.
gccpId - Which GCCP to activate.
Return Value
None
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation modifies the RAC_GCCP_SEQ_ENA register. The GCCP Sequencer is then enabled.
Writes
GCCP2_CFG_GCCP_SEQ_ENA_ENABLE=1
Example
Uint8 gccpId = 0;
...
CSL_RAC_GCCP_enable (hRac, gccpId);
...
| Uint16 CSL_RAC_GCCP_getActiveCycles | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId | |||
| ) |
=============================================================================
CSL_RAC_GCCP_getActiveCycles
Description This function returns the number of active cycles in the previous iteration.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to read.
gccpId - Which GCCP settings to retrieve.
Return Value Uint16
The number of active cycles
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This function reads the RAC_GCCP_SEQ_ACT register.
Reads
GCCP2_CFG_GCCP_SEQ_ACT_ACT_COUNT
Example
Uint8 gccpId = 0;
Uint16 actCycles;
...
actCycles = CSL_RAC_GCCP_getActiveCycles (hRac, gccpId);
...
| Uint32 CSL_RAC_GCCP_getCgtEntry | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId, | |||
| Uint8 | entryId | |||
| ) |
=============================================================================
CSL_RAC_GCCP_getCgtEntry
Description This function reads one of the RAC_GCCP_CGT registers.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to read.
gccpId - Which GCCP CGT to configure.
entryId - Which entry to configure.
partY - Value to write into the register.
Return Value None
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation returns the Y part for the given GCCP and entry ID.
Reads
GCCP2_CFG_CGT_Y_PART
Example
Uint8 gccpId = 0;
Uint8 entryId = 1;
Uint32 cgtEntry;
...
cgtEntry = CSL_RAC_GCCP_getCgtEntry (hRac, gccpId, entryId);
| void CSL_RAC_GCCP_getCycleOverflowStatus | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId, | |||
| CSL_RAC_GCCP_cycleOverflowStatus * | cycleOverflowStatus | |||
| ) |
=============================================================================
CSL_RAC_GCCP_getCycleOverflowStatus
Description This function returns the last active TRM entry status before the sequencer received a start-of-iteration command and stopped executing remaining active tasks.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to read.
gccpId - Which GCCP to get status from.
Return Value
The last active TRM address before a Cycle overflow
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This function reads the RAC_GCCP_CYC_OVER register.
Reads
GCCP2_CFG_GCCP_CYC_OVER_ITE_NB, GCCP2_CFG_GCCP_CYC_OVER_CYC_OVER_FLG, GCCP2_CFG_GCCP_CYC_OVER_PAGE_IDX, GCCP2_CFG_GCCP_CYC_OVER_TASK_IDX
Example
Uint8 gccpId = 0;
CSL_RAC_GCCP_cycleOverflowStatus ovFlwStatus;
...
CSL_RAC_GCCP_getCycleOverflowStatus (hRac, gccpId, &ovFlwStatus);
| void CSL_RAC_GCCP_getFifoOverflowStatus | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId, | |||
| CSL_RAC_GCCP_fifoOverflowStatus * | fifoOverflowStatus | |||
| ) |
=============================================================================
CSL_RAC_GCCP_getFifoOverflowStatus
Description This function returns the last active TRM status address.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to read.
gccpId - Which GCCP to get status from.
fifoOverflowStatus - Structure to return the status in
Return Value
The last active TRM address before a FIFO overflow
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This function reads the RAC_GCCP_FIFO_OVER register.
Reads
GCCP2_CFG_GCCP_FIFO_OVER_ITE_NB, GCCP2_CFG_GCCP_FIFO_OVER_FIFO_ID, GCCP2_CFG_GCCP_FIFO_OVER_CYC_OVER_FLG, GCCP2_CFG_GCCP_FIFO_OVER_PAGE_IDX, GCCP2_CFG_GCCP_FIFO_OVER_TASK_IDX
Example
Uint8 gccpId = 0;
CSL_RAC_GCCP_fifoOverflowStatus ovFlwStatus;
...
CSL_RAC_GCCP_getFifoOverflowStatus (hRac, gccpId, &ovFlwStatus);
| Uint32 CSL_RAC_GCCP_getHighPrioControlLevel | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId | |||
| ) |
=============================================================================
CSL_RAC_GCCP_getHighPrioControlLevel
Description This function returns the High Priority Control component level of the output queue for a given GCCP ID.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to read.
gccpId - Which GCCP status to read.
Return Value Uint32
The current value of the level
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation reads the corresponding RAC_GCCP_HCQ_CURR_LVL register.
Reads
GCCP2_CFG_HCQ_CURR_LVL_CURR_LVL
Example
Uint8 gccpId = 0;
Uint32 ctrlLvl;
ctrlLvl = CSL_RAC_GCCP_getHighPrioControlLevel (hRac, gccpId);
...
| Uint32 CSL_RAC_GCCP_getHighPrioControlWatermark | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId | |||
| ) |
=============================================================================
CSL_RAC_GCCP_getHighPrioControlWatermark
Description This function reads the High Priority Control component water-mark of the output queue for a given GCCP ID.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to read.
gccpId - Which GCCP status to read.
Return Value Uint32
The current value of the water-mark
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation reads the corresponding RAC_GCCP_HCQ_WTMK_LVL register. The register is reset with the current level value.
Reads
GCCP2_CFG_HCQ_WTMK_LVL_WATERMARK
Example
Uint8 gccpId = 0;
Uint32 ctrlWtrMrk;
...
ctrlWtrMrk = CSL_RAC_GCCP_getHighPrioControlWatermark (hRac, gccpId);
| Uint32 CSL_RAC_GCCP_getHighPrioDataLevel | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId | |||
| ) |
=============================================================================
CSL_RAC_GCCP_getHighPrioDataLevel
Description This function returns the High Priority Data component level of the output queue for a given GCCP ID.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to read.
gccpId - Which GCCP status to read.
Return Value Uint32
The current value of the level
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation reads the corresponding RAC_GCCP_HDQ_CURR_LVL register.
Reads
GCCP2_CFG_HDQ_CURR_LVL_CURR_LVL
Example
Uint8 gccpId = 0;
Uint32 dataLvl;
...
dataLvl = CSL_RAC_GCCP_getHighPrioDataLevel (hRac, gccpId);
| Uint32 CSL_RAC_GCCP_getHighPrioDataWatermark | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId | |||
| ) |
=============================================================================
CSL_RAC_GCCP_getHighPrioDataWatermark
Description This function reads the High Priority Data component water-mark of the output queue for a given GCCP ID.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to read.
gccpId - Which GCCP status to read.
Return Value Uint16
Current value of the water-mark
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation reads the corresponding RAC_GCCP_HDQ_WTMK_LVL register. The register is reset with the current level value.
Reads
GCCP2_CFG_HDQ_WTMK_LVL_WATERMARK
Example
Uint8 gccpId = 0;
Uint32 dataWtrMark;
...
dataWtrMark = CSL_RAC_GCCP_getHighPrioDataWatermark (hRac, gccpId);
| Uint32 CSL_RAC_GCCP_getLowPrioControlLevel | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId | |||
| ) |
=============================================================================
CSL_RAC_GCCP_getLowPrioControlLevel
Description This function returns the Low Priority Control component level of the output queue for a given GCCP ID.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to read.
gccpId - Which GCCP status to read.
Return Value Uint32
The current value of the level
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation reads the corresponding RAC_GCCP_LCQ_CURR_LVL register.
Reads
GCCP2_CFG_LCQ_CURR_LVL_CURR_LVL
Example
Uint8 gccpId = 0;
Uint32 ctrlLvl;
ctrlLvl = CSL_RAC_GCCP_getLowPrioControlLevel (hRac, gccpId);
...
| Uint32 CSL_RAC_GCCP_getLowPrioControlWatermark | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId | |||
| ) |
=============================================================================
CSL_RAC_GCCP_getLowPrioControlWatermark
Description This function reads the Low Priority Control component water-mark of the output queue for a given GCCP ID.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to read.
gccpId - Which GCCP status to read.
Return Value Uint32
The current value of the water-mark
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation reads the corresponding RAC_GCCP_LCQ_WTMK_LVL register. The register is reset with the current level value.
Reads
GCCP2_CFG_LCQ_WTMK_LVL_WATERMARK
Example
Uint8 gccpId = 0;
Uint32 ctrlWtrMrk;
...
ctrlWtrMrk = CSL_RAC_GCCP_getLowPrioControlWatermark (hRac, gccpId);
| Uint32 CSL_RAC_GCCP_getLowPrioDataLevel | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId | |||
| ) |
=============================================================================
CSL_RAC_GCCP_getLowPrioDataLevel
Description This function returns the Low Priority Data component level of the output queue for a given GCCP ID.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to read.
gccpId - Which GCCP status to read.
Return Value Uint32
The current value of the level
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation reads the corresponding RAC_GCCP_LDQ_CURR_LVL register.
Reads
GCCP2_CFG_LDQ_CURR_LVL_CURR_LVL
Example
Uint8 gccpId = 0;
Uint32 dataLvl;
...
dataLvl = CSL_RAC_GCCP_getLowPrioDataLevel (hRac, gccpId);
| Uint32 CSL_RAC_GCCP_getLowPrioDataWatermark | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId | |||
| ) |
=============================================================================
CSL_RAC_GCCP_getLowPrioDataWatermark
Description This function reads the Low Priority Data component water-mark of the output queue for a given GCCP ID.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to read.
gccpId - Which GCCP status to read.
Return Value Uint32
The current value of the water-mark
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation reads the corresponding RAC_GCCP_LDQ_WTMK_LVL register. The register is reset with the current level value.
Reads
GCCP2_CFG_LDQ_WTMK_LVL_WATERMARK
Example
Uint8 gccpId = 0;
Uint32 dataWtrMark;
...
dataWtrMark = CSL_RAC_GCCP_getLowPrioDataWatermark (hRac, gccpId);
| Uint32 CSL_RAC_GCCP_getPrtEntry | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId, | |||
| Uint8 | entryId, | |||
| Uint8 | wordId | |||
| ) |
=============================================================================
CSL_RAC_GCCP_getPrtEntry
Description This function reads one of the RAC_GCCP_PRT registers.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to read.
gccpId - Which GCCP PRT to configure.
entryId - Which entry to configure.
wordId - Which slot to configure.
format - Value to insert into the register.
Return Value None
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation returns the slot format for the given slot ID.
Reads
GCCP2_CFG_PRT_W0; GCCP2_CFG_PRT_W1; GCCP2_CFG_PRT_W2; GCCP2_CFG_PRT_W3; GCCP2_CFG_PRT_W4
Example
Uint8 gccpId = 0;
Uint8 entryId = 1;
Uint8 wordId = 2;
Uint32 prtEntry;
...
prtEntry = CSL_RAC_GCCP_getPrtEntry (hRac, gccpId, entryId, wordId);
| void CSL_RAC_GCCP_getReadTime | ( | CSL_RAC_Handle | hRac, | |
| CSL_RAC_FE_Timestamp_req * | timestamp | |||
| ) |
=============================================================================
CSL_RAC_GCCP_getReadTime
Description This function reads the GCCP[0] read timestamp register.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to read.
timestamp - structure with timestamp parameters.
Return Value
None
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation reads the content of the GCCP[0] read timestamp register.
Reads
RAC2_DATA_FE_TIME_CHIP, RAC2_DATA_FE_TIME_SLOT, RAC2_DATA_FE_TIME_FRAME
Example
CSL_RAC_FE_Timestamp_req timeStamp;
...
CSL_RAC_GCCP_getReadTime (hRac, &timeStamp);
...
| Uint16 CSL_RAC_GCCP_getSequencerCycles | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId | |||
| ) |
=============================================================================
CSL_RAC_GCCP_getSequencerCycles
Description This function returns the number of sequencer-used cycles in the previous iteration.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to read.
gccpId - Which GCCP to configure.
Return Value Uint16
The number of sequencer cycles
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This function reads the RAC_GCCP_SEQ_CYC register.
Reads
GCCP2_CFG_GCCP_SEQ_CYC_SEQ_COUNT
Example
Uint8 gccpId = 0;
Uint16 seqCycles;
...
seqCycles = CSL_RAC_GCCP_getSequencerCycles (hRac, gccpId);
...
| void CSL_RAC_GCCP_resetHighPriorityQueue | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId | |||
| ) |
=============================================================================
CSL_RAC_GCCP_resetHighPriorityQueue
Description This function resets the High Priority Output Queue of the corresponding GCCP by writing into the RAC_GCCP_FIFO_RESET register.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to reset.
gccpId - Which GCCP FIFO to reset.
Return Value
None
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation modifies the RAC_GCCP_FIFO_RESET register. The GCCP High Priority Output Queue is reset.
Writes
GCCP2_CFG_GCCP_FIFO_RESET_HIGH_RESET=1
Example
Uint8 gccpId = 0;
...
CSL_RAC_GCCP_resetHighPriorityQueue (hRac, gccpId);
...
| void CSL_RAC_GCCP_resetLowPriorityQueue | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId | |||
| ) |
=============================================================================
CSL_RAC_GCCP_resetLowPriorityQueue
Description This function resets the Low Priority Output Queue of the corresponding GCCP by writing into the RAC_GCCP_FIFO_RESET register.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to reset.
gccpId - Which GCCP FIFO to reset.
Return Value
None
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation modifies the RAC_GCCP_FIFO_RESET register. The GCCP Low Priority Output Queue is reset.
Writes
GCCP2_CFG_GCCP_FIFO_RESET_LOW_RESET=1
Example
Uint8 gccpId = 0;
...
CSL_RAC_GCCP_resetLowPriorityQueue (hRac, gccpId);
...
| void CSL_RAC_GCCP_setCgtEntry | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId, | |||
| Uint8 | entryId, | |||
| Uint32 | partY | |||
| ) |
============================================================================= *
CSL_RAC_GCCP_setCgtEntry
Description This function configures the Code Generation Table by writing into one of the RAC_GCCP_CGT registers.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to configure.
gccpId - Which GCCP CGT to configure.
entryId - Which entry to configure.
partY - Value to write into the register.
Return Value None
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation modifies one of the RAC_GCCP_CGT register.
Writes
GCCP2_CFG_CGT_Y_PART
Example
Uint8 gccpId = 0;
Uint8 entryId = 1;
Uint32 partY = 0;
...
CSL_RAC_GCCP_setCgtEntry (hRac, gccpId, entryId, partY);
| void CSL_RAC_GCCP_setIctEntry | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId, | |||
| Uint8 | entryId, | |||
| Int8 | coeff0, | |||
| Int8 | coeff1, | |||
| Int8 | coeff2, | |||
| Int8 | coeff3 | |||
| ) |
=============================================================================
CSL_RAC_GCCP_setIctEntry
Description This function configures the Interpolation Coefficients Table by writing into one of the RAC_ICT registers.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to configure.
gccpId - Which GCCP status to read.
entryId - Which GCCP ICT to configure. It ranges from 0 to 4.
coeff0 - Value to set into the coefficient #0 field. It should range from -64 to 64
coeff1 - Value to set into the coefficient #1 field. It should range from -64 to 64
coeff2 - Value to set into the coefficient #2 field. It should range from -64 to 64
coeff3 - Value to set into the coefficient #3 field. It should range from -64 to 64
Return Value None
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation modifies the RAC_GCCP_ICT register.
Writes
GCCP2_CFG_INT_COEF_COEFF0, GCCP2_CFG_INT_COEF_COEFF1, GCCP2_CFG_INT_COEF_COEFF2, GCCP2_CFG_INT_COEF_COEFF3
Example
Uint8 gccpId = 0;
Uint8 entryId = 1;
Int8 coeff0, coeff1, coeff2, coeff3;
...
// Configuring ICT in by-pass mode
coeff0 = 0;
coeff1 = 64;
coeff2 = 0;
coeff3 = 0;
CSL_RAC_GCCP_setIctEntry (hRac, gccpId, entryId, coeff0, coeff1, coeff2, coeff3);
| void CSL_RAC_GCCP_setPrtEntry | ( | CSL_RAC_Handle | hRac, | |
| Uint8 | gccpId, | |||
| Uint8 | entryId, | |||
| Uint8 | wordId, | |||
| Uint32 | format | |||
| ) |
=============================================================================
CSL_RAC_GCCP_setPrtEntry
Description This function configures the Pilot Rotation Table by writing into one of the RAC_GCCP_PRT registers.
Arguments
hRac - RAC instance handle returned by successful CSL_RAC_open (). Indicates which RAC to configure.
gccpId - Which GCCP PRT to configure.
entryId - Which entry to configure.
partY - Which word to configure.
format - Value to insert into the register.
Return Value None
Pre Condition
CSL_RAC_open () must be called to retrieve a valid handle before calling this API.
Post Condition
This operation modifies one of the RAC_GCCP_PRT register.
Writes
GCCP2_CFG_PRT_W0; GCCP2_CFG_PRT_W1; GCCP2_CFG_PRT_W2; GCCP2_CFG_PRT_W3; GCCP2_CFG_PRT_W4
Example
Uint8 gccpId = 0;
Uint8 entryId = 1;
Uint8 wordId = 2;
Uint32 format = 0;
...
CSL_RAC_GCCP_setPrtEntry (hRac, gccpId, entryId, wordId, format);