RingIOShm.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 RINGIOSHM_H_
#define RINGIOSHM_H_

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

#if defined (__cplusplus)
extern "C" {
#endif
/* =============================================================================
 *  All success and failure codes for the module
 * =============================================================================
 */

#define RingIOShm_MODULEID               (0x3bff)

/* =============================================================================
 *  All success and failure codes for the module
 * =============================================================================
 */

#define RingIOShm_E_INVALIDARG   RingIO_E_INVALIDARG 

#define RingIOShm_E_INVALIDSTATE RingIO_E_INVALIDSTATE

#define RingIOShm_E_BADVERSION   RingIO_E_BADVERSION

#define RingIOShm_E_FAIL         RingIO_E_FAIL

#define RingIOShm_E_MEMORY       RingIO_E_MEMORY

#define RingIOShm_E_OSFAILURE    RingIO_E_OSFAILURE

#define RingIOShm_E_BUFWRAP      RingIO_E_BUFWRAP

#define RingIOShm_E_BUFEMPTY     RingIO_E_BUFEMPTY

#define RingIOShm_E_BUFFULL      RingIO_E_BUFFULL

#define RingIOShm_E_PENDINGDATA  RingIO_E_PENDINGDATA

#define RingIOShm_E_VARIABLEATTRIBUTE   RingIO_E_VARIABLEATTRIBUTE

#define RingIOShm_E_WRONGSTATE          RingIO_E_WRONGSTATE

#define RingIOShm_E_INVALIDPROCID    RingIO_E_INVALIDPROCID

#define RingIOShm_E_INVALIDCONTEXT   RingIO_E_INVALIDCONTEXT

#define RingIOShm_S_SUCCESS        RingIO_S_SUCCESS

#define RingIOShm_S_ALREADYSETUP RingIO_S_ALREADYSETUP

#define RingIOShm_S_PENDINGATTRIBUTE    RingIO_S_PENDINGATTRIBUTE


/* =============================================================================
 * Structures & Enums
 * =============================================================================
 */
typedef struct RingIOShm_Params_Tag {
     RingIO_Params commonParams;
     UInt16     ctrlRegionId;
     UInt16     dataRegionId;
     UInt16     attrRegionId;
     Ptr         ctrlSharedAddr;
     Ptr         dataSharedAddr;
     UInt32      dataSharedAddrSize;
     UInt32      footBufSize;
     Ptr         attrSharedAddr;
     UInt32      attrSharedAddrSize;
     GateMP_Handle gateHandle;
     GateMP_LocalProtect  localProtect;
     GateMP_RemoteProtect remoteProtect;
     UInt16        remoteProcId;
} RingIOShm_Params;

/* =============================================================================
 * APIs
 * =============================================================================
 */
Void RingIOShm_Params_init (Void * params);

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


#endif /* RINGIOSHM_H_ */