sma_pool.h File Reference

---

Detailed Description

Defines the exported interface of the SMAPOOL - Shared Memory Allocator POOL.

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

Path:

/dsp/inc/

Version:

1.65.01.06 ============================================================================

Copyright:

Copyright (C) 2002-2009, 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 sma_pool.h:

Go to the source code of this file.

Data Structures
struct	SMAPOOL_Params_tag
Typedefs
SMAPOOL_Params
Parameters required for initialization of the SMA pool. ============================================================================ Parameters: poolId ID of the pool being opened. exactMatchReq Flag indicating while allocating /freeing exact size match has to be performed for buffers. ============================================================================
typedef struct SMAPOOL_Params_tag	SMAPOOL_Params
SMAPOOL_FXNS
Declaration of the function table interface for the SMA pool. ============================================================================ ============================================================================
#define	SMAPOOL_exit   FXN_F_nop
	Performs global finalization of the SMA pool. This function currently is not required to perform any finalization and hence is defined to the NOP function.
const POOL_Fxns	SMAPOOL_FXNS
Void	SMAPOOL_init ()
	Performs global initialization of the SMA pool.

---

Define Documentation

#define SMAPOOL_exit   FXN_F_nop

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

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

Function:

SMAPOOL_exit

Parameters:

None

Returns:

None

Precondition:

None

Postcondition:

None

See also:

SMAPOOL_init () ============================================================================

---

Typedef Documentation

typedef struct SMAPOOL_Params_tag SMAPOOL_Params

---

Function Documentation

Void SMAPOOL_init

(

)

Performs global initialization of the SMA pool.

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

Function:

SMAPOOL_init

Parameters:

None

Returns:

None

Precondition:

None

Postcondition:

None

See also:

SMAPOOL_exit ============================================================================

---

Variable Documentation

const POOL_Fxns SMAPOOL_FXNS