HeapMemMP.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_HeapMemMP__include
#define ti_ipc_HeapMemMP__include

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

#include <ti/ipc/GateMP.h>

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

#define HeapMemMP_S_BUSY               2

#define HeapMemMP_S_ALREADYSETUP       1

#define HeapMemMP_S_SUCCESS            0

#define HeapMemMP_E_FAIL              -1

#define HeapMemMP_E_INVALIDARG        -2

#define HeapMemMP_E_MEMORY            -3

#define HeapMemMP_E_ALREADYEXISTS     -4

#define HeapMemMP_E_NOTFOUND          -5

#define HeapMemMP_E_TIMEOUT           -6

#define HeapMemMP_E_INVALIDSTATE      -7

#define HeapMemMP_E_OSFAILURE         -8

#define HeapMemMP_E_RESOURCE          -9

#define HeapMemMP_E_RESTART           -10

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

typedef struct HeapMemMP_Object *HeapMemMP_Handle;

typedef struct HeapMemMP_Params {
    String name;
    UInt16 regionId;
    Ptr sharedAddr;
    SizeT sharedBufSize;
    GateMP_Handle gate;
} HeapMemMP_Params;

typedef struct HeapMemMP_ExtendedStats {
    Ptr   buf;
    SizeT size;
} HeapMemMP_ExtendedStats;

/* =============================================================================
 *  HeapMemMP Module-wide Functions
 * =============================================================================
 */

Int HeapMemMP_close(HeapMemMP_Handle *handlePtr);

HeapMemMP_Handle HeapMemMP_create(const HeapMemMP_Params *params);

Int HeapMemMP_delete(HeapMemMP_Handle *handlePtr);

Int HeapMemMP_open(String name, HeapMemMP_Handle *handlePtr);

Int HeapMemMP_openByAddr(Ptr sharedAddr, HeapMemMP_Handle *handlePtr);

Void HeapMemMP_Params_init(HeapMemMP_Params *params);

SizeT HeapMemMP_sharedMemReq(const HeapMemMP_Params *params);

/* =============================================================================
 *  HeapMemMP Per-instance Functions
 * =============================================================================
 */

Void *HeapMemMP_alloc(HeapMemMP_Handle handle, SizeT size, SizeT align);

Void HeapMemMP_free(HeapMemMP_Handle handle, Ptr block, SizeT size);

Void HeapMemMP_getExtendedStats(HeapMemMP_Handle handle,
                                HeapMemMP_ExtendedStats *stats);

Void HeapMemMP_getStats(HeapMemMP_Handle handle, Ptr stats);

Void HeapMemMP_restore(HeapMemMP_Handle handle);

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