RcmClient.h

Go to the documentation of this file.

/* 
 * Copyright (c) 2012, 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.
 * 
 */


/*
 *  ======== RcmClient.h ========
 *
 */

#ifndef ti_sdo_rcm_RcmClient__include
#define ti_sdo_rcm_RcmClient__include

#include <xdc/runtime/knl/GateThread.h>



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


// -------- status codes --------

#define RcmClient_S_SUCCESS (0)

#define RcmClient_E_FAIL (-1)

#define RcmClient_E_EXECASYNCNOTENABLED (-2)

#define RcmClient_E_EXECFAILED (-3)

#define RcmClient_E_INVALIDHEAPID (-4)

#define RcmClient_E_INVALIDFXNIDX (-5)

#define RcmClient_E_MSGFXNERROR (-6)

#define RcmClient_E_IPCERROR (-7)

#define RcmClient_E_LISTCREATEFAILED (-8)

#define RcmClient_E_LOSTMSG (-9)

#define RcmClient_E_MSGALLOCFAILED (-10)

#define RcmClient_E_MSGQCREATEFAILED (-11)

#define RcmClient_E_MSGQOPENFAILED (-12)

#define RcmClient_E_SERVERERROR (-13)

#define RcmClient_E_SERVERNOTFOUND (-14)

#define RcmClient_E_SYMBOLNOTFOUND (-15)

#define RcmClient_E_NOMEMORY (-16)

#define RcmClient_E_JOBIDNOTFOUND (-17)


// -------- constants and types --------

#define RcmClient_INVALIDFXNIDX ((UInt32)(0xFFFFFFFF))

#define RcmClient_INVALIDHEAPID ((UInt16)(0xFFFF))

#define RcmClient_INVALIDMSGID (0)

#define RcmClient_DEFAULTPOOLID ((UInt16)(0x8000))

#define RcmClient_DISCRETEJOBID (0)

typedef struct RcmClient_Object_tag *RcmClient_Handle;

typedef struct {
    UInt16      poolId;

    UInt16      jobId;

    UInt32      fxnIdx;

    Int32       result;

    UInt32      dataSize;

    UInt32      data[1];

} RcmClient_Message;

typedef Void (*RcmClient_CallbackFxn)(RcmClient_Message *, Ptr);

typedef struct {
    UInt16 heapId;

    Bool callbackNotification;

} RcmClient_Params;

typedef struct {
    xdc_runtime_knl_GateThread_Struct   _f1;
    Ptr                 _f2;
    Ptr                 _f3;
    UInt16              _f4;
    Ptr                 _f5;
    UInt32              _f6;
    Bool                _f7;
    UInt16              _f8;
    Ptr                 _f9;
    Ptr                 _f10;
    Ptr                 _f11;
    Ptr                 _f12;
} RcmClient_Struct;


// -------- functions --------

/*
 *  ======== RcmClient_acquireJobId ========
 */
Int RcmClient_acquireJobId(
        RcmClient_Handle        handle,
        UInt16 *                jobId
    );

/*
 *  ======== RcmClient_addSymbol ========
 */
Int RcmClient_addSymbol(
        RcmClient_Handle        handle,
        String                  name,
        Fxn                     addr,
        UInt32 *                index
    );

/*
 *  ======== RcmClient_alloc ========
 */
Int RcmClient_alloc(
        RcmClient_Handle        handle,
        UInt32                  dataSize,
        RcmClient_Message **    message
    );

/*
 *  ======== RcmClient_checkForError ========
 */
Int RcmClient_checkForError(
        RcmClient_Handle        handle,
        RcmClient_Message **    returnMsg
    );

/*
 *  ======== RcmClient_construct ========
 */
Int RcmClient_construct(
        RcmClient_Struct *      structPtr,
        String                  server,
        const RcmClient_Params *params
    );

/*
 *  ======== RcmClient_create ========
 */
Int RcmClient_create(
        String                  server,
        const RcmClient_Params *params,
        RcmClient_Handle *      handle
    );

/*
 *  ======== RcmClient_delete ========
 */
Int RcmClient_delete(
        RcmClient_Handle *      handlePtr
    );

/*
 *  ======== RcmClient_destruct ========
 */
Int RcmClient_destruct(
        RcmClient_Struct *      structPtr
    );

/*
 *  ======== RcmClient_exec ========
 */
Int RcmClient_exec(
        RcmClient_Handle        handle,
        RcmClient_Message *     cmdMsg,
        RcmClient_Message **    returnMsg
    );

/*
 *  ======== RcmClient_execAsync ========
 */
Int RcmClient_execAsync(
        RcmClient_Handle        handle,
        RcmClient_Message *     cmdMsg,
        RcmClient_CallbackFxn   callback,
        Ptr                     appData
    );

/*
 *  ======== RcmClient_execCmd ========
 */
Int RcmClient_execCmd(
        RcmClient_Handle        handle,
        RcmClient_Message *     cmdMsg
    );

/*
 *  ======== RcmClient_execDpc ========
 */
Int RcmClient_execDpc(
        RcmClient_Handle        handle,
        RcmClient_Message *     cmdMsg,
        RcmClient_Message **    returnMsg
    );

/*
 *  ======== RcmClient_execNoWait ========
 */
Int RcmClient_execNoWait(
        RcmClient_Handle        handle,
        RcmClient_Message *     cmdMsg,
        UInt16 *                msgId
    );

/*
 *  ======== RcmClient_exit ========
 */
Void RcmClient_exit(Void);

/*
 *  ======== RcmClient_free ========
 */
Int RcmClient_free(
        RcmClient_Handle        handle,
        RcmClient_Message *     msg
    );

/*
 *  ======== RcmClient_getSymbolIndex ========
 */
Int RcmClient_getSymbolIndex(
        RcmClient_Handle        handle,
        String                  name,
        UInt32 *                index
    );

/*
 *  ======== RcmClient_init ========
 */
Void RcmClient_init(Void);

/*
 *  ======== RcmClient_Parmas_init ========
 */
Void RcmClient_Params_init(
        RcmClient_Params *      params
    );

/*
 *  ======== RcmClient_releaseJobId ========
 */
Int RcmClient_releaseJobId(
        RcmClient_Handle        handle,
        UInt16                  jobId
    );

/*
 *  ======== RcmClient_removeSymbol ========
 */
Int RcmClient_removeSymbol(
        RcmClient_Handle        handle,
        String                  name
    );

/*
 *  ======== RcmClient_waitUntilDone ========
 */
Int RcmClient_waitUntilDone(
        RcmClient_Handle        handle,
        UInt16                  msgId,
        RcmClient_Message **    returnMsg
    );


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

#endif /* ti_sdo_rcm_RcmClient__include */
/*
 *  @(#) ti.sdo.rcm; 2, 0, 0,3; 4-16-2012 00:03:16; /db/atree/library/trees/fc/fc-q08/src/ xlibrary

 */