MultiProc.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_MultiProc__include
#define ti_ipc_MultiProc__include

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

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

#define MultiProc_S_BUSY                 2

#define MultiProc_S_ALREADYSETUP         1

#define MultiProc_S_SUCCESS              0

#define MultiProc_E_FAIL                -1

#define MultiProc_E_INVALIDARG          -2

#define MultiProc_E_MEMORY              -3

#define MultiProc_E_ALREADYEXISTS       -4

#define MultiProc_E_NOTFOUND            -5

#define MultiProc_E_TIMEOUT             -6

#define MultiProc_E_INVALIDSTATE        -7

#define MultiProc_E_OSFAILURE           -8

#define MultiProc_E_RESOURCE            -9

#define MultiProc_E_RESTART             -10

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

#define MultiProc_INVALIDID             (0xFFFF)

/* =============================================================================
 *  MultiProc Module-wide Functions
 * =============================================================================
 */

UInt16 MultiProc_getBaseIdOfCluster(Void);

UInt16 MultiProc_getId(String name);

String MultiProc_getName(UInt16 id);

UInt16 MultiProc_getNumProcessors(Void);

UInt16 MultiProc_getNumProcsInCluster(Void);

UInt16 MultiProc_self(Void);

Int MultiProc_setBaseIdOfCluster(UInt16 baseId);

Int MultiProc_setLocalId(UInt16 id);

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

#endif /* ti_ipc_MultiProc__include */