SharedRegion.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2015 Texas Instruments Incorporated - http://www.ti.com
 * All rights reserved.
 *
 * 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.
 */
#ifndef ti_ipc_SharedRegion__include
#define ti_ipc_SharedRegion__include


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

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

#define SharedRegion_S_BUSY             2

#define SharedRegion_S_ALREADYSETUP     1

#define SharedRegion_S_SUCCESS          0

#define SharedRegion_E_FAIL             -1

#define SharedRegion_E_INVALIDARG       -2

#define SharedRegion_E_MEMORY           -3

#define SharedRegion_E_ALREADYEXISTS    -4

#define SharedRegion_E_NOTFOUND         -5

#define SharedRegion_E_TIMEOUT          -6

#define SharedRegion_E_INVALIDSTATE     -7

#define SharedRegion_E_OSFAILURE        -8

#define SharedRegion_E_RESOURCE         -9

#define SharedRegion_E_RESTART          -10

/* =============================================================================
 *  Macros
 * =============================================================================
 */

#define SharedRegion_INVALIDREGIONID    (0xFFFF)

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

typedef Bits32 SharedRegion_SRPtr;

typedef struct SharedRegion_Entry {
    Ptr base;
    SizeT len;
    UInt16 ownerProcId;
    Bool isValid;
    Bool cacheEnable;
    SizeT cacheLineSize;
    Bool createHeap;
    String name;
} SharedRegion_Entry;


/* =============================================================================
 *  SharedRegion Module-wide Functions
 * =============================================================================
 */

Int SharedRegion_clearEntry(UInt16 regionId);

Void SharedRegion_entryInit(SharedRegion_Entry *entry);

SizeT SharedRegion_getCacheLineSize(UInt16 regionId);

Int SharedRegion_getEntry(UInt16 regionId, SharedRegion_Entry *entry);

SharedRegion_Entry *SharedRegion_getEntryPtr(UInt16 regionId);

Ptr SharedRegion_getHeap(UInt16 regionId);

UInt16 SharedRegion_getId(Ptr addr);

UInt16 SharedRegion_getIdByName(String name);

UInt16 SharedRegion_getNumRegions(Void);

Ptr SharedRegion_getPtr(SharedRegion_SRPtr srptr);

SharedRegion_SRPtr SharedRegion_getSRPtr(Ptr addr, UInt16 regionId);

Bool SharedRegion_isCacheEnabled(UInt16 regionId);

Int SharedRegion_setEntry(UInt16 regionId, SharedRegion_Entry *entry);

Bool SharedRegion_translateEnabled(Void);

SharedRegion_SRPtr SharedRegion_invalidSRPtr(Void);

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

#endif /* ti_ipc_SharedRegion__include */