# Mcbsp_ChanParams_t Struct Reference

McBSP channel setup params. More...

`#include <mcbsp_drv.h>`

## Data Fields

uint32_t | wordWidth
void * | userLoopJobBuffer
uint16_t | userLoopJobLength
Mcbsp_GblErrCallback | gblCbk
void * | edmaHandle
uint32_t | edmaEventQue
uint32_t | hwiNumber
Mcbsp_BufferFormat | dataFormat
Bool | enableHwFifo
Mcbsp_DataConfig * | chanConfig
Mcbsp_ClkSetup * | clkSetup
Mcbsp_McrSetup * | multiChanCtrl
uint32_t | chanEnableMask [4]

## Detailed Description

McBSP channel setup params.

This structure holds configuration to be used for creating a channel of the Mcbsp. These parameters need to be specified during the creation of the channel.

## Field Documentation

Mcbsp_DataConfig* Mcbsp_ChanParams_t::chanConfig

settings to configure the TX or RX hardware sections

uint32_t Mcbsp_ChanParams_t::chanEnableMask[4]

Mask of the channels to be enabled or disabled

Mcbsp_ClkSetup* Mcbsp_ChanParams_t::clkSetup

clock setup for the RX or the TX section

Mcbsp_BufferFormat Mcbsp_ChanParams_t::dataFormat

Format of the application supplied buffer

uint32_t Mcbsp_ChanParams_t::edmaEventQue

EDMA event queue to be used by the channel

void* Mcbsp_ChanParams_t::edmaHandle

Handle to the EDMA Driver

Bool Mcbsp_ChanParams_t::enableHwFifo

Option to enable/disable the Hardware FIFO

Mcbsp_GblErrCallback Mcbsp_ChanParams_t::gblCbk

callback required when global error occurs - must be callable * directly from the ISR context

uint32_t Mcbsp_ChanParams_t::hwiNumber

Variable to specify the Hwi number to be used by the driver

Mcbsp_McrSetup* Mcbsp_ChanParams_t::multiChanCtrl

multiple channel control settings

void* Mcbsp_ChanParams_t::userLoopJobBuffer

Buffer to be transferred when the loop job is running.

uint16_t Mcbsp_ChanParams_t::userLoopJobLength

Number of bytes of the userloopjob buffer for each slot Please note that this is no. of bytes and this should be pre-calcuated properly for word width of slot - Please refer the wordWidth of this structure

uint32_t Mcbsp_ChanParams_t::wordWidth

This parameter informs the driver what is the width word (not * slot) and this help driver indirectly to decided no. of bytes to * be transfered for each slot- This is very * important parameter - in case of invalid value default value * driver will assume is 32

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

- mcbsp_drv.h

Copyright 2012, Texas Instruments Incorporated