ListMP.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_ListMP__include
#define ti_ipc_ListMP__include

#include <ti/ipc/SharedRegion.h>
#include <ti/ipc/GateMP.h>

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

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

#define ListMP_S_BUSY            2

#define ListMP_S_ALREADYSETUP    1

#define ListMP_S_SUCCESS         0

#define ListMP_E_FAIL           -1

#define ListMP_E_INVALIDARG     -2

#define ListMP_E_MEMORY         -3

#define ListMP_E_ALREADYEXISTS  -4

#define ListMP_E_NOTFOUND       -5

#define ListMP_E_TIMEOUT        -6

#define ListMP_E_INVALIDSTATE   -7

#define ListMP_E_OSFAILURE      -8

#define ListMP_E_RESOURCE       -9

#define ListMP_E_RESTART        -10

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

typedef struct ListMP_Object *ListMP_Handle;

typedef struct ListMP_Elem {
    volatile SharedRegion_SRPtr next;
    volatile SharedRegion_SRPtr prev;
} ListMP_Elem;

typedef struct ListMP_Params {
    GateMP_Handle gate;
    Ptr sharedAddr;
    String name;
    UInt16 regionId;
} ListMP_Params;

/* =============================================================================
 *  ListMP Module-wide Functions
 * =============================================================================
 */

Void ListMP_Params_init(ListMP_Params *params);

ListMP_Handle ListMP_create(const ListMP_Params *params);

Int ListMP_close(ListMP_Handle *handlePtr);

Int ListMP_delete(ListMP_Handle *handlePtr);

Int ListMP_open(String name, ListMP_Handle *handlePtr);

Int ListMP_openByAddr(Ptr sharedAddr, ListMP_Handle *handlePtr);

SizeT ListMP_sharedMemReq(const ListMP_Params *params);

/* =============================================================================
 *  ListMP Per-instance Functions
 * =============================================================================
 */

Bool ListMP_empty(ListMP_Handle handle);

GateMP_Handle ListMP_getGate(ListMP_Handle handle);

Ptr ListMP_getHead(ListMP_Handle handle);

Ptr ListMP_getTail(ListMP_Handle handle);

Int ListMP_insert(ListMP_Handle handle,
                  ListMP_Elem *newElem,
                  ListMP_Elem *curElem);

Ptr ListMP_next(ListMP_Handle handle, ListMP_Elem *elem);

Ptr ListMP_prev(ListMP_Handle handle, ListMP_Elem *elem);

Int ListMP_putHead(ListMP_Handle handle, ListMP_Elem *elem);

Int ListMP_putTail(ListMP_Handle handle, ListMP_Elem *elem);

Int ListMP_remove(ListMP_Handle handle, ListMP_Elem *elem);

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

#endif /* ti_ipc_ListMP__include */