GateMP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2013, Texas Instruments Incorporated
 * 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_GateMP__include
#define ti_ipc_GateMP__include

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

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

#define GateMP_S_BUSY               2

#define GateMP_S_ALREADYSETUP       1

#define GateMP_S_SUCCESS            0

#define GateMP_E_FAIL              -1

#define GateMP_E_INVALIDARG        -2

#define GateMP_E_MEMORY            -3

#define GateMP_E_ALREADYEXISTS     -4

#define GateMP_E_NOTFOUND          -5

#define GateMP_E_TIMEOUT           -6

#define GateMP_E_INVALIDSTATE      -7

#define GateMP_E_OSFAILURE         -8

#define GateMP_E_RESOURCE          -9

#define GateMP_E_RESTART           -10

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

typedef enum GateMP_LocalProtect {
    GateMP_LocalProtect_NONE      = 0,
    GateMP_LocalProtect_INTERRUPT = 1,
    GateMP_LocalProtect_TASKLET   = 2,
    GateMP_LocalProtect_THREAD    = 3,
    GateMP_LocalProtect_PROCESS   = 4
} GateMP_LocalProtect;


typedef enum GateMP_RemoteProtect {
    GateMP_RemoteProtect_NONE     = 0,
    GateMP_RemoteProtect_SYSTEM   = 1,
    GateMP_RemoteProtect_CUSTOM1  = 2,
    GateMP_RemoteProtect_CUSTOM2  = 3
} GateMP_RemoteProtect;

typedef struct GateMP_Object *GateMP_Handle;

typedef struct GateMP_Params {
    String name;
    UInt16 regionId;
    Ptr sharedAddr;
    GateMP_LocalProtect localProtect;
    GateMP_RemoteProtect remoteProtect;
} GateMP_Params;

/* =============================================================================
 *  GateMP Module-wide Functions
 * =============================================================================
 */

Int GateMP_close(GateMP_Handle *handlePtr);

GateMP_Handle GateMP_create(const GateMP_Params *params);

Int GateMP_delete(GateMP_Handle *handlePtr);

GateMP_Handle GateMP_getDefaultRemote(Void);

GateMP_LocalProtect GateMP_getLocalProtect(GateMP_Handle handle);

GateMP_RemoteProtect GateMP_getRemoteProtect(GateMP_Handle handle);

Int GateMP_open(String name, GateMP_Handle *handlePtr);

Int GateMP_openByAddr(Ptr sharedAddr, GateMP_Handle *handlePtr);

Void GateMP_Params_init(GateMP_Params *params);

SizeT GateMP_sharedMemReq(const GateMP_Params *params);

/* =============================================================================
 *  GateMP Per-instance Functions
 * =============================================================================
 */

IArg GateMP_enter(GateMP_Handle handle);

Void GateMP_leave(GateMP_Handle handle, IArg key);

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