FrameQBufMgr_ShMem.h

Go to the documentation of this file.

/* 
 *  ============================================================================
 *
 *  Copyright (c) 2008-2012, Texas Instruments Incorporated
 *
 *  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.
 *  Contact information for paper mail:
 *  Texas Instruments
 *  Post Office Box 655303
 *  Dallas, Texas 75265
 *  Contact information: 
 *  http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm?
 *  DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact
 *  ============================================================================
 *  
 */


#ifndef FRAMEQBUFMGR_SHMEM_H
#define FRAMEQBUFMGR_SHMEM_H

#include <ti/ipc/GateMP.h>
#include <ti/syslink/FrameQBufMgr.h>


#if defined (__cplusplus)
extern "C" {
#endif

/* =============================================================================
 * Macros & defines
 * =============================================================================
 */
#define FrameQBufMgr_ShMem_BUFINTERFACE_SHAREDMEM  FrameQBufMgr_BUFINTERFACE_SHAREDMEM
#define FrameQBufMgr_ShMem_BUFINTERFACE_TILERMEM   FrameQBufMgr_BUFINTERFACE_TILERMEM
#define FrameQBufMgr_ShMem_HDRINTERFACE_SHAREDMEM  FrameQBufMgr_HDRINTERFACE_SHAREDMEM
#define FrameQBufMgr_ShMem_FrameBufParams          FrameQBufMgr_FrameBufParams


/* TODO - are different _internal_ vs _external types necessary? */
typedef FrameQBufMgr_Config           FrameQBufMgr_ShMem_Config ;
/* =============================================================================
 * Structures & Enums
 * =============================================================================
 */

typedef struct FrameQBufMgr_ShMem_Params_tag {
    FrameQBufMgr_CreateParams commonCreateParams;
    GateMP_Handle gate;
    GateMP_LocalProtect localProtect;
    GateMP_RemoteProtect remoteProtect;
    Ptr sharedAddr;
    UInt32 sharedAddrSize;
    UInt32 regionId;
    UInt32 headerInterfaceType;
    UInt32 bufInterfaceType;
    Ptr sharedAddrHdrBuf;
    UInt32 sharedAddrHdrBufSize;
    UInt32 hdrBuf_regionId;
    Ptr sharedAddrFrmBuf;
    UInt32 sharedAddrFrmBufSize;
    UInt32 frmBuf_regionId;
    UInt32 numFreeFramePools;
    UInt32 numFreeFramesInPool[FrameQBufMgr_MAX_POOLS];
    UInt32 numFreeHeaderBufsInPool[FrameQBufMgr_MAX_POOLS];
    UInt32 frameHeaderBufSize[FrameQBufMgr_MAX_POOLS];
    UInt32 numFrameBufsInFrame[FrameQBufMgr_MAX_POOLS];
    FrameQBufMgr_ShMem_FrameBufParams *frameBufParams[FrameQBufMgr_MAX_POOLS];
    UInt32 cpuAccessFlags;
    UInt32 numNotifyEntries;
} FrameQBufMgr_ShMem_Params;

typedef struct FrameQBufMgr_ShMem_OpenParams_tag {
    FrameQBufMgr_CommonOpenParams commonOpenParams;
} FrameQBufMgr_ShMem_OpenParams;

/* =============================================================================
 *  APIs
 * =============================================================================
 */

/* Initialize the FrameQBufMgr module, there would be some default values for
 * the parameters, but if  any change is required, change the cfg before calling
 * this API.
 */
Int32 FrameQBufMgr_ShMem_setup(FrameQBufMgr_ShMem_Config * cfg);


/* Function to destroy(finalize) the FrameQBufMgr module.*/
Int32 FrameQBufMgr_ShMem_destroy(Void);

void FrameQBufMgr_ShMem_Params_init(FrameQBufMgr_ShMem_Params * params);

UInt32
FrameQBufMgr_ShMem_sharedMemReq (const FrameQBufMgr_ShMem_Params * params,
                                 UInt32                    * hdrBufChunkSize,
                                 UInt32                    * frmBufChunkSize);

Int32 FrameQBufMgr_ShMem_getConfig(FrameQBufMgr_ShMem_Config *cfg);


#if defined (__cplusplus)
}
#endif /* defined (__cplusplus) */


#endif /* HEAPBUF_H_0x4CD5 */