Data Structures | Defines | Typedefs | Variables
fftc_pvt.h File Reference

Private Header file with data structure and API declarations for FFTC driver's internal use. More...

#include <fftc_types.h>
#include <ti/drv/fftc/fftc_lld.h>
#include <ti/drv/fftc/include/listlib.h>
#include <ti/drv/qmss/qmss_drv.h>
#include <ti/drv/cppi/cppi_drv.h>
#include <ti/drv/cppi/cppi_desc.h>
#include <ti/csl/csl_cache.h>

Data Structures

struct  _Fftc_TxQInfo
 Fftc_TxQInfo. More...
struct  _Fftc_TxInfo
 Fftc_TxInfo. More...
struct  _Fftc_FlowInfo
 Fftc_FlowInfo. More...
struct  _Fftc_RequestInfo
 Fftc_RequestInfo. More...
struct  _Fftc_RxInfo
 Fftc_RxInfo. More...
struct  _Fftc_RxGlobalInfo
 Fftc_RxGlobalInfo. More...
struct  _Fftc_UserInfo
 Fftc_UserInfo. More...
struct  _Fftc_InstanceInfo
 Fftc_InstanceInfo. More...

Defines

#define FFTC_CPPI_HOST_DESC_SIZE   (32)
 Size of the mandatory portion of the CPPI Host descriptor.
#define FFTC_CPPI_MONOLITHIC_DESC_SIZE   (12)
 Size of the mandatory portion of the CPPI Monolithic descriptor.

Typedefs

typedef struct _Fftc_TxQInfo Fftc_TxQInfo
 Fftc_TxQInfo.
typedef struct _Fftc_TxInfo Fftc_TxInfo
 Fftc_TxInfo.
typedef struct _Fftc_FlowInfo Fftc_FlowInfo
 Fftc_FlowInfo.
typedef struct _Fftc_RequestInfo Fftc_RequestInfo
 Fftc_RequestInfo.
typedef struct _Fftc_RxInfo Fftc_RxInfo
 Fftc_RxInfo.
typedef struct _Fftc_RxGlobalInfo Fftc_RxGlobalInfo
 Fftc_RxGlobalInfo.
typedef struct _Fftc_UserInfo Fftc_UserInfo
 Fftc_UserInfo.
typedef struct _Fftc_InstanceInfo Fftc_InstanceInfo
 Fftc_InstanceInfo.

Variables

Fftc_InstanceInfo Fftc_instanceInfo [FFTC_MAX_NUM_INSTANCES]

Detailed Description

Private Header file with data structure and API declarations for FFTC driver's internal use.

============================================================================
(C) Copyright 2009, Texas Instruments, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


Typedef Documentation

typedef struct _Fftc_FlowInfo Fftc_FlowInfo

Fftc_FlowInfo.

Data structure to hold the current state and configuration of a CPPI Rx flow configured using the driver for a given FFTC peripheral instance.

* Used by FFTC driver internally for book-keeping purposes *

Fftc_InstanceInfo.

Data structure to hold the current state and configuration in driver for each FFTC peripheral instance.

* Used by FFTC driver internally for book-keeping purposes *

Fftc_RequestInfo.

Data structure to hold the results received from ISR for an Rx object.

* Used by FFTC driver internally for book-keeping purposes *

Fftc_RxGlobalInfo.

Data structure to hold the globally accessible info related to a Rx object.

Used to hold the pending requests and results info for all the Rx objects created using the driver.

* Used by FFTC driver internally for book-keeping purposes *

typedef struct _Fftc_RxInfo Fftc_RxInfo

Fftc_RxInfo.

Data structure to hold the globally accessible info related to a Rx object.

Used to hold the pending requests and results info for all the Rx objects created using the driver.

* Used by FFTC driver internally for book-keeping purposes *

typedef struct _Fftc_TxInfo Fftc_TxInfo

Fftc_TxInfo.

Data structure to hold the current state of an FFTC Tx object created using the driver APIs.

* Used by FFTC driver internally for book-keeping purposes *

typedef struct _Fftc_TxQInfo Fftc_TxQInfo

Fftc_TxQInfo.

Data structure to hold the current state and configuration of any given FFTC Transmit queue.

* Used by FFTC driver internally for book-keeping purposes *

typedef struct _Fftc_UserInfo Fftc_UserInfo

Fftc_UserInfo.

Tracks FFTC application specific configuration info obtained from Fftc_open () API.

Data structure to hold the descriptor configuration, FFTC peripheral instance number and other info provided by an application that wishes to use the FFTC driver.

* Used by FFTC driver internally for book-keeping purposes *


Variable Documentation

Tracks info that is maintained by FFTC driver for each of the FFTC peripheral instances.


Copyright 2014, Texas Instruments Incorporated