# Tcp3d_InitParams Struct Reference
[TCP3D Driver Data Structures]

TCP3D Driver Initialization parameters structure. More...

`#include <tcp3d_drv.h>`

## Data Fields

uint8_t | instNum
uint32_t | maxCodeBlocks
uint8_t | coreID
Tcp3d_CtrlParams | ctrlParams
CSL_Tcp3d_cfgRegs * | tcp3dCfgRegs
Tcp3d_Config | pingConfig
Tcp3d_Config | pongConfig
EDMA3_DRV_Handle | edmaHnd
uint32_t | edmaRegionId
uint32_t | pingCh [TCP3D_DRV_MAX_CH_PER_PATH]
uint32_t | pongCh [TCP3D_DRV_MAX_CH_PER_PATH]
uint32_t | linkCh [TCP3D_DRV_MAX_LINK_CH]
uint32_t | notificationEventNum

## Detailed Description

TCP3D Driver Initialization parameters structure.

## Field Documentation

uint8_t Tcp3d_InitParams::coreID

Core Index value [0,1,2,3]. Used for traslating local L2 addresses into global addresses used in the EDMA transfers.

Tcp3d_CtrlParams Tcp3d_InitParams::ctrlParams

Control parameters for TCP3 decoder. All the elements in this structure must be filled with the required values with which the driver is intended to run.

They are used to set the MODE, ENDIAN and EXECUTE control registers and also to control the driver code based on the configuration information like mode & double buffer.

EDMA3_DRV_Handle Tcp3d_InitParams::edmaHnd

EDMA3 LLD Driver handle used in the driver to call EDMA LLD driver funcitons.

uint32_t Tcp3d_InitParams::edmaRegionId

EDMA3 shadow region ID through which all the resources are allocated.

uint8_t Tcp3d_InitParams::instNum

TCP3D Peripheral instance number to setup. Possible values are CSL_TCP3D_A or CSL_TCP3D_B.

uint32_t Tcp3d_InitParams::linkCh[TCP3D_DRV_MAX_LINK_CH]

Link Channels Array.

Total physical channels required is given by the define TCP3D_DRV_MAX_LINK_CH.

Note:
  It is required that all these link channels be consecutive in their PaRAM memory.

uint32_t Tcp3d_InitParams::maxCodeBlocks

Maximum code blocks for which the driver resources will be configured. This value is required to configure some parameters.

uint32_t Tcp3d_InitParams::notificationEventNum

CP_INTC0 input event used for the output notification.

uint32_t Tcp3d_InitParams::pingCh[TCP3D_DRV_MAX_CH_PER_PATH]

Ping Channels Array. First channel must be "0" since it is tied to the event (REVT0) generated from TCP3D and used for reading outputs from the decoder memory. Total physical channels required is given by the define TCP3D_DRV_MAX_CH_PER_PATH.

This arrary could be accesssed with the index values provided as define names starting with TCP3D_DRV_CH_IDX. This is useful for the application when it needs to setup a callback with specific Channel (TCC).

Tcp3d_Config Tcp3d_InitParams::pingConfig

Start addresses of PING (P0) memory area of TCP3 Decoder and the assiciated REVT channel number will be provided here. This structure values must be filled with appropriate addresses depending on the decoder instance.

uint32_t Tcp3d_InitParams::pongCh[TCP3D_DRV_MAX_CH_PER_PATH]

Pong Channels Array. First channel must be "1" since it is tied to the event (REVT1) generated from TCP3D and used for reading outputs from the decoder memory.

Total physical channels required is given by the define TCP3D_DRV_MAX_CH_PER_PATH.

This arrary could be accesssed with the index values provided as define names starting with TCP3D_DRV_CH_IDX. This is useful for the application when it needs to setup a callback with specific Channel (TCC).

Tcp3d_Config Tcp3d_InitParams::pongConfig

Start addresses of PONG (P1) memory area of TCP3 Decoderand the assiciated REVT channel number will be provided here. This structure values must be filled with appropriate addresses depending on the decoder instance.

CSL_Tcp3d_cfgRegs* Tcp3d_InitParams::tcp3dCfgRegs

TCP3 decoder configuration registers start address. This is used only in the init function to start the TCP3 decoder state machine by writing into the control registers with the correct configuration values.

The documentation for this struct was generated from the following file:

- tcp3d_drv.h

Copyright 2012, Texas Instruments Incorporated