1 /** \file bufferPool.h 2 * \brief This file include private definitions for the buffer pool object 3 * \author Ronen Kalish 4 * \date 05-December-2005 5 */ 6 7 /**************************************************************************** 8 **+-----------------------------------------------------------------------+** 9 **| |** 10 **| Copyright(c) 1998 - 2008 Texas Instruments. All rights reserved. |** 11 **| All rights reserved. |** 12 **| |** 13 **| Redistribution and use in source and binary forms, with or without |** 14 **| modification, are permitted provided that the following conditions |** 15 **| are met: |** 16 **| |** 17 **| * Redistributions of source code must retain the above copyright |** 18 **| notice, this list of conditions and the following disclaimer. |** 19 **| * Redistributions in binary form must reproduce the above copyright |** 20 **| notice, this list of conditions and the following disclaimer in |** 21 **| the documentation and/or other materials provided with the |** 22 **| distribution. |** 23 **| * Neither the name Texas Instruments nor the names of its |** 24 **| contributors may be used to endorse or promote products derived |** 25 **| from this software without specific prior written permission. |** 26 **| |** 27 **| THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |** 28 **| "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |** 29 **| LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |** 30 **| A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |** 31 **| OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |** 32 **| SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |** 33 **| LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |** 34 **| DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |** 35 **| THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |** 36 **| (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |** 37 **| OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |** 38 **| |** 39 **+-----------------------------------------------------------------------+** 40 ****************************************************************************/ 41 42 #include "osTIType.h" 43 #include "bufferPoolApi.h" 44 45 #ifndef __BUFFER_POOL_H__ 46 #define __BUFFER_POOL_H__ 47 48 /** \struct bufferPool__t 49 * \brief This structure comprise the buffer pool object.\n 50 */ 51 typedef struct 52 { 53 TI_HANDLE hOS; /**< handle to the OS object */ 54 TI_HANDLE hReport; /**< handle to the report object */ 55 UINT32 numberOfBuffers; /**< The total number of buffers allocated for this pool */ 56 UINT32 bufferSize; /**< The size of buffers in this pool */ 57 bufferPool_buffer_t firstBuffer; /**< memory block holding all buffers */ 58 bufferPool_buffer_t firstFreeBuffer; /**< pointer to the first free buffer */ 59 #ifdef TI_DBG 60 bufferPoolDbg_t bufferPoolDbg; /**< debug information */ 61 #endif /* TI_DBG */ 62 } bufferPool_t; 63 64 #endif /* __BUFFER_POOL_H__ */ 65 66