Data Structures | Typedefs | Enumerations
FFTC Higher Layer Data Structures
FFTC Higher Layer Data Structures & APIs

Data Structures

struct  _Fftc_DeviceCfg
 Fftc_DeviceCfg. More...
struct  _Fftc_BlockInfo
 Fftc_BlockInfo. More...
struct  _Fftc_BlockResult
 Fftc_BlockResult. More...
struct  _Fftc_Result
 Fftc_Result. More...
struct  _Fftc_CppiDescCfg
 Fftc_CppiDescCfg. More...
struct  _Fftc_InterruptCfg
 Fftc_InterruptCfg. More...
struct  _Fftc_DrvCfg
 Fftc_DrvCfg. More...
struct  _Fftc_TxCfg
 Fftc_TxCfg. More...
struct  _Fftc_RxCfg
 Fftc_RxCfg. More...
struct  _Fftc_DestQRegCfg
 Fftc_DestQRegCfg. More...
struct  _Fftc_ScalingShiftingRegCfg
 Fftc_ScalingShiftingRegCfg. More...
struct  _Fftc_CyclicPrefixRegCfg
 Fftc_CyclicPrefixRegCfg. More...
struct  _Fftc_ControlRegCfg
 Fftc_ControlRegCfg. More...
struct  _Fftc_FreqShiftRegCfg
 Fftc_FreqShiftRegCfg. More...
struct  _Fftc_QLocalCfg
 Fftc_QLocalCfg. More...
struct  _Fftc_GlobalCfg
 Fftc_GlobalCfg. More...
struct  _Fftc_ControlHdr
 Fftc_ControlHdr. More...
struct  _Fftc_QLocalCfgParams
 Fftc_QLocalCfgParams. More...
struct  _Fftc_PeripheralIdParams
 Fftc_PeripheralIdParams. More...
struct  _Fftc_EmulationControlParams
 Fftc_EmulationControlParams. More...
struct  _Fftc_ErrorParams
 Fftc_ErrorParams. More...
struct  _Fftc_ControlStatusReg
 Fftc_ControlStatusReg. More...
struct  _Fftc_PktSizeStatusReg
 Fftc_PktSizeStatusReg. More...
struct  _Fftc_TagStatusReg
 Fftc_TagStatusReg. More...

Typedefs

typedef void * Fftc_DrvHandle
 Fftc_DrvHandle.
typedef void * Fftc_TxHandle
 Fftc_TxHandle.
typedef void * Fftc_RxHandle
 Fftc_RxHandle.
typedef void * Fftc_RequestHandle
 Fftc_RequestHandle.
typedef void * Fftc_ResultHandle
 Fftc_ResultHandle.
typedef int32_t Fftc_RetVal
 Fftc_RetVal.
typedef struct _Fftc_DeviceCfg Fftc_DeviceCfg
 Fftc_DeviceCfg.
typedef struct _Fftc_BlockInfo Fftc_BlockInfo
 Fftc_BlockInfo.
typedef struct _Fftc_BlockResult Fftc_BlockResult
 Fftc_BlockResult.
typedef struct _Fftc_Result Fftc_Result
 Fftc_Result.
typedef struct _Fftc_CppiDescCfg Fftc_CppiDescCfg
 Fftc_CppiDescCfg.
typedef struct _Fftc_InterruptCfg Fftc_InterruptCfg
 Fftc_InterruptCfg.
typedef struct _Fftc_DrvCfg Fftc_DrvCfg
 Fftc_DrvCfg.
typedef struct _Fftc_TxCfg Fftc_TxCfg
 Fftc_TxCfg.
typedef struct _Fftc_RxCfg Fftc_RxCfg
 Fftc_RxCfg.
typedef struct _Fftc_DestQRegCfg Fftc_DestQRegCfg
 Fftc_DestQRegCfg.
typedef struct
_Fftc_ScalingShiftingRegCfg 
Fftc_ScalingShiftingRegCfg
 Fftc_ScalingShiftingRegCfg.
typedef struct
_Fftc_CyclicPrefixRegCfg 
Fftc_CyclicPrefixRegCfg
 Fftc_CyclicPrefixRegCfg.
typedef struct _Fftc_ControlRegCfg Fftc_ControlRegCfg
 Fftc_ControlRegCfg.
typedef struct
_Fftc_FreqShiftRegCfg 
Fftc_FreqShiftRegCfg
 Fftc_FreqShiftRegCfg.
typedef struct _Fftc_QLocalCfg Fftc_QLocalCfg
 Fftc_QLocalCfg.
typedef struct _Fftc_GlobalCfg Fftc_GlobalCfg
 Fftc_GlobalCfg.
typedef struct _Fftc_ControlHdr Fftc_ControlHdr
 Fftc_ControlHdr.
typedef struct
_Fftc_QLocalCfgParams 
Fftc_QLocalCfgParams
 Fftc_QLocalCfgParams.
typedef struct
_Fftc_PeripheralIdParams 
Fftc_PeripheralIdParams
 Fftc_PeripheralIdParams.
typedef struct
_Fftc_EmulationControlParams 
Fftc_EmulationControlParams
 Fftc_EmulationControlParams.
typedef struct _Fftc_ErrorParams Fftc_ErrorParams
 Fftc_ErrorParams.
typedef struct
_Fftc_ControlStatusReg 
Fftc_ControlStatusReg
 Fftc_ControlStatusReg.
typedef struct
_Fftc_PktSizeStatusReg 
Fftc_PktSizeStatusReg
 Fftc_PktSizeStatusReg.
typedef struct _Fftc_TagStatusReg Fftc_TagStatusReg
 Fftc_TagStatusReg.

Enumerations

enum  Fftc_DFTMode { Fftc_DFTMode_IDFT = 0, Fftc_DFTMode_DFT = 1 }
 Fftc_DFTMode. More...
enum  Fftc_ZeroPadMode { Fftc_ZeroPadMode_ADD = 0, Fftc_ZeroPadMode_MULTIPLY = 1 }
 Fftc_ZeroPadMode. More...
enum  Fftc_FreqShiftDir { Fftc_FreqShiftDir_PLUS = 0, Fftc_FreqShiftDir_MINUS = 1 }
 Fftc_FreqShiftDir. More...
enum  Fftc_FreqShiftIndex { Fftc_FreqShiftIndex_16384 = 0, Fftc_FreqShiftIndex_12288 = 1 }
 Fftc_FreqShiftIndex. More...
enum  Fftc_QueueId { Fftc_QueueId_0 = 0, Fftc_QueueId_1 = 1, Fftc_QueueId_2 = 2, Fftc_QueueId_3 = 3 }
 Fftc_QueueId. More...

Typedef Documentation

Fftc_BlockInfo.

Structure to specify/hold the DFT block size information relevant to an FFTC request/result.

Fftc_BlockResult.

Structure to hold the FFT/IFT result on a per DFT block basis.

Fftc_ControlHdr.

Configuration structure that can be used by the application/driver to setup a FFTC control header using the LLD APIs.

Fftc_ControlRegCfg.

Structure to specify/hold the FFTC Queue X Control Register configuration info for a given FFTC queue.

Fftc_ControlStatusReg.

Structure to hold the contents of Block X Control Status Register.

Fftc_CppiDescCfg.

Structure to specify the CPPI descriptor configuration for a FFTC free queue used to hold pre-allocated buffers.

Fftc_CyclicPrefixRegCfg.

Structure to specify/hold the FFTC Queue X Cyclic Prefix Register configuration info for a given FFTC queue.

Fftc_DestQRegCfg.

Structure to specify/hold the CPPI Destination queue information stored in the FFTC hardware's Queue X Destination Queue Register for a given FFTC queue.

Fftc_DeviceCfg.

FFTC device (SoC) specific information.

Holds all the SoC specific info for any given FFTC peripheral instance.

typedef struct _Fftc_DrvCfg Fftc_DrvCfg

Fftc_DrvCfg.

FFTC Driver configuration.

Holds all the application's descriptor configuration required by the driver at Init time.

typedef void* Fftc_DrvHandle

Fftc_DrvHandle.

FFTC driver handle.

Fftc_EmulationControlParams.

Configuration structure that can be used to setup the FFTC Emulation Control Parameters.

Fftc_ErrorParams.

Configuration structure that can be used to hold/setup the FFTC Emulation Control Parameters.

Fftc_FreqShiftRegCfg.

Structure to specify/hold the FFTC Queue X LTE Frequency Shift Register configuration info for a given FFTC queue.

Fftc_GlobalCfg.

FFTC Global configuration structure to be used to hold/specify the configuration for the FFTC Configuration Register.

Fftc_InterruptCfg.

Interrupt configuration parameters.

Holds Driver defined QMSS accumulator configuration.

An QM interrupt is generated when either of the following conditions is met:

(1) With Pacing enabled ('bEnablePacing' = 1), when there is at least one result entry available and the pacing timer configured in 'pacingFrequency' expires.

(2) With Pacing disabled ('bEnablePacing' = 0), when the number of result entries accumulated equals the threshold configured here in 'intThreshold'.

Fftc_PeripheralIdParams.

Configuration structure that can be used to setup the FFTC Peripheral ID Register.

Fftc_PktSizeStatusReg.

Structure to hold the contents of Block X Packet Size Status Register.

Fftc_QLocalCfg.

Structure to specify/hold the queue specific configuration for a given FFTC queue.

Fftc_QLocalCfgParams.

Configuration structure that is used by the FFTC LLD *internally* to format the FFTC queue configuration provided by an application/driver to an acceptable format by the FFT Hardware.

typedef void* Fftc_RequestHandle

Fftc_RequestHandle.

FFTC Request object handle.

typedef struct _Fftc_Result Fftc_Result

Fftc_Result.

Structure to hold the FFT/IFFT result.

typedef void* Fftc_ResultHandle

Fftc_ResultHandle.

FFTC Result object handle.

typedef int32_t Fftc_RetVal

Fftc_RetVal.

Holds the various error codes reported by the FFTC driver.

Please refer to FFTC_RETVAL_* definitions for the various error codes reported by this driver.

typedef struct _Fftc_RxCfg Fftc_RxCfg

Fftc_RxCfg.

FFTC Receive Object configuration.

Holds Rx specific configuration. Rx Objects are to be created and used by FFTC driver users to receive FFT results from the engine.

typedef void* Fftc_RxHandle

Fftc_RxHandle.

FFTC Rx object handle.

Fftc_ScalingShiftingRegCfg.

Structure to specify/hold the FFTC Queue X Scaling and Shifting Register configuration info for a given FFTC queue.

Fftc_TagStatusReg.

Structure to hold the contents of Block X Tag Status Register.

typedef struct _Fftc_TxCfg Fftc_TxCfg

Fftc_TxCfg.

FFTC Transmit configuration.

Used to specify the Tx characteristics of an application that wishes to submit FFT requests using the driver.

typedef void* Fftc_TxHandle

Fftc_TxHandle.

FFTC Tx object handle.


Enumeration Type Documentation

Fftc_DFTMode.

Enumeration for specifying the DFT/IDFT selection.

Enumerator:
Fftc_DFTMode_IDFT 

IDFT/IFFT mode

Fftc_DFTMode_DFT 

DFT/FFT mode

Fftc_FreqShiftDir.

Enumeration for specifying the LTE Frequency Shift Direction, 0 for -1 and 1 for +1.

Enumerator:
Fftc_FreqShiftDir_PLUS 

LTE Frequency Shift Direction - Plus

Fftc_FreqShiftDir_MINUS 

LTE Frequency Shift Direction - Minus

Fftc_FreqShiftIndex.

Enumeration for specifying the LTE Frequency Shift Table Index, M. There are only 2 valid values in the table, i.e., 8192 * 2 (16384) and 6144 * 2 (12288). Set to 0 for M = 16384, and 1 for M = 12288.

Enumerator:
Fftc_FreqShiftIndex_16384 

LTE Frequency Shift Index - 8192 * 2

Fftc_FreqShiftIndex_12288 

LTE Frequency Shift Index - 6144 * 2

Fftc_QueueId.

Enumeration for specifying the 4 FFTC CPPI/QM Queues.

Enumerator:
Fftc_QueueId_0 

FFTC Tx Queue 0

Fftc_QueueId_1 

FFTC Tx Queue 1

Fftc_QueueId_2 

FFTC Tx Queue 2

Fftc_QueueId_3 

FFTC Tx Queue 3

Fftc_ZeroPadMode.

Enumeration for specifying the zero pad mode.

Enumerator:
Fftc_ZeroPadMode_ADD 

Addition Mode

Fftc_ZeroPadMode_MULTIPLY 

Multiplication Mode


Copyright 2014, Texas Instruments Incorporated