FrameQ_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 FRAMEQ_SHMEM_H
#define FRAMEQ_SHMEM_H

#include <ti/ipc/GateMP.h>

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

/* =============================================================================
 * Macros & defines
 * =============================================================================
 */

typedef FrameQ_Config           FrameQ_ShMem_Config ;

/* =============================================================================
 * Structures & Enums
 * =============================================================================
 */

typedef struct FrameQ_ShMem_Params_tag {
    FrameQ_CreateParams commonCreateParams;
    GateMP_Handle         gate;
    GateMP_LocalProtect localProtect;
    GateMP_RemoteProtect remoteProtect;
     Ptr                sharedAddr;
    UInt32              sharedAddrSize;
    UInt32 regionId;
    UInt32              numReaders;
    UInt32              numQueues;
    UInt32              cpuAccessFlags;
    String frameQBufMgrName;
    Ptr frameQBufMgrSharedAddr;
} FrameQ_ShMem_Params;


typedef struct FrameQ_ShMem_OpenParams_tag {
    FrameQ_CommonOpenParams commonOpenParams;
}FrameQ_ShMem_OpenParams;


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

void
FrameQ_ShMem_Params_init(FrameQ_ShMem_Params * params);

UInt32
FrameQ_ShMem_sharedMemReq (const FrameQ_ShMem_Params * params);

/*
 *  @brief      Get the default configuration for the FrameQ_ShMem module.
 *
 *              This function can be called by the application to get their
 *              configuration parameter to FrameQ_setup filled in by
 *              the FrameQ module with the default parameters. If the
 *              user does not wish to make any change in the default parameters,
 *              this API is not required to be called.
 *
 *  @param      cfg  Pointer to the FrameQ module configuration
 *                         structure in which the default config is to be
 *                         returned.
 *
 *  @sa         FrameQ_setup
 */
Void FrameQ_ShMem_getConfig(FrameQ_ShMem_Config *cfg);

/*
 *  @brief      Setup the FrameQ module.
 *
 *              This function sets up the FrameQ module. This function
 *              must be called before any other instance-level APIs can be
 *              invoked.
 *              Module-level configuration needs to be provided to this
 *              function. If the user wishes to change some specific config
 *              parameters, then FrameQ_getConfig can be called to get
 *              the configuration filled with the default values. After this,
 *              only the required configuration values can be changed. If the
 *              user does not wish to make any change in the default parameters,
 *              the application can simply call FrameQ_setup with NULL
 *              parameters. The default parameters would get automatically used.
 *
 *  @param      cfg   Optional FrameQ module configuration. If provided
 *                    as NULL, default configuration is used.
 *
 *  @sa         FrameQ_destroy, FrameQ_getConfig
 */
Int32
FrameQ_ShMem_setup (FrameQ_ShMem_Config * cfg);

/*
 *  ======== FrameQ_ShMem_destroy ========
 *  API to finalize the module.
 */
Int32
FrameQ_ShMem_destroy (void);

#if defined (__cplusplus)
}
#endif


#endif /* FRAMEQ_SHMEM_H */