chnldefs.h File Reference

---

Detailed Description

Defines data types and structures used by CHNL component.

============================================================================

Path:

/gpp/inc/usr/

Version:

1.65.02.09 ============================================================================

Copyright:

Copyright (C) 2002-2012, Texas Instruments Incorporated - https://www.ti.com/

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. ============================================================================

#include <dsplink.h>
#include <procdefs.h>

Include dependency graph for chnldefs.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ChannelAttrs_tag
struct	ChannelIOInfo_tag
Defines
#define	MAX_ALLOC_BUFFERS   1000u
	Maximum number of buffers that can be allocated through CHNL_AllocateBuffer. ============================================================================.
#define	MAX_CHANNELS   16u
	Maximum number of channels that can be created for each DSP. ============================================================================.
#define	IS_VALID_CHNLID(dspId, chnlId)   FALSE
Typedefs
ChannelAttrs
Channel Attributes. ============================================================================ Parameters: endianism Endiannism information currently not used. mode Mode of channel (Input or output). size Size of data sent on channel (16 bits or 32 bits). ============================================================================
typedef struct ChannelAttrs_tag	ChannelAttrs
ChannelIOInfo
Information for adding or reclaiming a IO request. ============================================================================ Parameters: buffer Buffer pointer. size Size of buffer. arg Argument to receive or send. ============================================================================
typedef struct ChannelIOInfo_tag	ChannelIOInfo
Enumerations
ChannelMode
Mode of a channel. ============================================================================ Parameters: ChannelMode_Input Indicates the channel as an Input channel (from DSP to GPP). ChannelMode_Output Indicates the channel as an Output channel (from GPP to DSP). ============================================================================
enum	ChannelMode {   ChannelMode_Input = 0x1u,   ChannelMode_Output = 0x2u }
ChannelDataSize
Width of data being sent on channel. ============================================================================ Parameters: ChannelDataSize_16bits Indicates the data to be transferred through the channel as 16 bit data. ChannelDataSize_32bits Indicates the data to be transferred through the channel as 32 bit data. ============================================================================
enum	ChannelDataSize {   ChannelDataSize_16bits = 1u,   ChannelDataSize_32bits = 2u }

---

Define Documentation

#define MAX_ALLOC_BUFFERS   1000u

Maximum number of buffers that can be allocated through CHNL_AllocateBuffer. ============================================================================.

============================================================================

Constant:

MAX_ALLOC_BUFFERS

#define MAX_CHANNELS   16u

Maximum number of channels that can be created for each DSP. ============================================================================.

============================================================================

Constant:

MAX_CHANNELS

#define IS_VALID_CHNLID	(		dspId,
			chnlId
	)		FALSE

---

Typedef Documentation

typedef struct ChannelAttrs_tag ChannelAttrs

typedef struct ChannelIOInfo_tag ChannelIOInfo

---

Enumeration Type Documentation

enum ChannelMode

Enumerator:

ChannelMode_Input
ChannelMode_Output

enum ChannelDataSize

Enumerator:

ChannelDataSize_16bits
ChannelDataSize_32bits