Ipc.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_Ipc__include
#define ti_ipc_Ipc__include

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

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

#define Ipc_S_BUSY              (2)

#define Ipc_S_ALREADYSETUP      (1)

#define Ipc_S_SUCCESS           (0)

#define Ipc_E_FAIL             (-1)

#define Ipc_E_INVALIDARG       (-2)

#define Ipc_E_MEMORY           (-3)

#define Ipc_E_ALREADYEXISTS    (-4)

#define Ipc_E_NOTFOUND         (-5)

#define Ipc_E_TIMEOUT          (-6)

#define Ipc_E_INVALIDSTATE     (-7)

#define Ipc_E_OSFAILURE        (-8)

#define Ipc_E_RESOURCE         (-9)

#define Ipc_E_RESTART          (-10)

#define Ipc_E_NOTREADY         (-11)


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

typedef struct {
    Int (*createFxn)(Void);             
    Void (*deleteFxn)(Void);            
    Int (*attachFxn)(UInt16 procId);    
    Int (*detachFxn)(UInt16 procId);    
} Ipc_TransportFactoryFxns;


/* =============================================================================
 *  Ipc Module-wide Functions
 * =============================================================================
 */

Int Ipc_attach(UInt16 remoteProcId);

Int Ipc_clusterConfig(Void);

Int Ipc_detach(UInt16 remoteProcId);

Bool Ipc_isAttached(UInt16 remoteProcId);

Int Ipc_readConfig(UInt16 remoteProcId, UInt32 tag, Ptr cfg, SizeT size);

Int Ipc_start(Void);

Int Ipc_stop(Void);

Int Ipc_transportConfig(Ipc_TransportFactoryFxns *factory);

Int Ipc_writeConfig(UInt16 remoteProcId, UInt32 tag, Ptr cfg, SizeT size);

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

#endif /* ti_ipc_Ipc__include */