Data Structures

buf_pool.h File Reference


Detailed Description

Defines the exported interface of the buffer pool.

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

Path:
/dsp/inc/
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 <pool.h>
Include dependency graph for buf_pool.h:

Go to the source code of this file.

Data Structures

struct  BUFPOOL_Params_tag

Typedefs

BUFPOOL_Params

Parameters required for initialization of the buffer pool.

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

Parameters:
numBufObjsNumber of entries in the arrays of buffer sizes and numbers in the params structure.
bufSizesArray of sizes of the buffers in the buffer pools. The sizes are in MADUs. This array is of size numBufObjs.
numBuffersArray of number of buffers in all buffer pools. This array is of size numBufObjs.
segIdSegment ID for allocation of the buffers. ============================================================================
typedef struct BUFPOOL_Params_tag BUFPOOL_Params

BUFPOOL_FXNS

Declaration of the function table interface for the buffer pool. ============================================================================

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


#define BUFPOOL_init   FXN_F_nop
 Performs global initialization of the buffer pool. This function currently is not required to perform any initialization and hence is defined to the NOP function.
#define BUFPOOL_exit   FXN_F_nop
 Performs global finalization of the buffer pool. This function currently is not required to perform any finalization and hence is defined to the NOP function.
const POOL_Fxns BUFPOOL_FXNS

Define Documentation

#define BUFPOOL_init   FXN_F_nop

Performs global initialization of the buffer pool. This function currently is not required to perform any initialization and hence is defined to the NOP function.

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

Function:
BUFPOOL_init
Parameters:
None
Returns:
None
Precondition:
None
Postcondition:
None
See also:
BUFPOOL_exit () ============================================================================
#define BUFPOOL_exit   FXN_F_nop

Performs global finalization of the buffer pool. This function currently is not required to perform any finalization and hence is defined to the NOP function.

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

Function:
BUFPOOL_exit
Parameters:
None
Returns:
None
Precondition:
None
Postcondition:
None
See also:
BUFPOOL_init () ============================================================================

Typedef Documentation


Variable Documentation

const POOL_Fxns BUFPOOL_FXNS
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Copyright 2012, Texas Instruments Incorporated