RcmServer.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.
 * 
 */


/*
 *  ======== RcmServer.h ========
 *
 */

#ifndef ti_sdo_rcm_RcmServer__include
#define ti_sdo_rcm_RcmServer__include

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



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


// -------- success and failure codes --------

#define RcmServer_S_SUCCESS (0)

#define RcmServer_E_FAIL (-1)

#define RcmServer_E_NOMEMORY (-2)

#define RcmServer_E_SYMBOLNOTFOUND (-3)

#define RcmServer_E_SYMBOLSTATIC (-4)

#define RcmServer_E_SYMBOLTABLEFULL (-5)


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

typedef Int32 (*RcmServer_MsgFxn)(UInt32, UInt32 *);

typedef struct {
    String name;

    RcmServer_MsgFxn addr;

} RcmServer_FxnDesc;

typedef struct {
    Int length;

    RcmServer_FxnDesc *elem;

} RcmServer_FxnDescAry;

typedef struct {
    String name;

    UInt count;

    Thread_Priority priority;

    Int osPriority;

    SizeT stackSize;

    String stackSeg;

} RcmServer_ThreadPoolDesc;

typedef struct {
    Int length;

    RcmServer_ThreadPoolDesc *elem;

} RcmServer_ThreadPoolDescAry;


typedef struct RcmServer_Object_tag *RcmServer_Handle;

typedef struct {
    Thread_Priority priority;

    Int osPriority;

    SizeT stackSize;

    String stackSeg;

    RcmServer_ThreadPoolDesc defaultPool;

    RcmServer_ThreadPoolDescAry workerPools;

    RcmServer_FxnDescAry fxns;

} RcmServer_Params;

typedef struct {
    GateThread_Struct   _f1;
    Ptr                 _f2;
    Ptr                 _f3;
    Ptr                 _f4;
    struct {
        Int     _f1;
        Ptr     _f2;
    }                   _f5;
    Ptr                 _f6[9];
    UInt16              _f7;
    UInt16              _f8;
    Bool                _f9;
    Int                 _f10;
    Ptr                 _f11[4];
    Ptr                 _f12;
} RcmServer_Struct;


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

/*
 *  ======== RcmServer_addSymbol ========
 */
Int RcmServer_addSymbol(
        RcmServer_Handle        handle,
        String                  name,
        RcmServer_MsgFxn        addr,
        UInt32 *                index
    );

/*
 *  ======== RcmServer_construct ========
 */
Int RcmServer_construct(
        RcmServer_Struct *      structPtr,
        String                  name,
        const RcmServer_Params *params
    );

/*
 *  ======== RcmServer_create ========
 */
Int RcmServer_create(
        String                  name,
        RcmServer_Params *      params,
        RcmServer_Handle *      handle
    );

/*
 *  ======== RcmServer_delete ========
 */
Int RcmServer_delete(
        RcmServer_Handle *      handlePtr
    );

/*
 *  ======== RcmServer_destruct ========
 */
Int RcmServer_destruct(
        RcmServer_Struct *      structPtr
    );

/*
 *  ======== RcmServer_exit ========
 */
Void RcmServer_exit(Void);

/*
 *  ======== RcmServer_init ========
 */
Void RcmServer_init(Void);

/*
 *  ======== RcmServer_Params_init ========
 */
Void RcmServer_Params_init(
        RcmServer_Params *      params
    );

/*
 *  ======== RcmServer_removeSymbol ========
 */
Int RcmServer_removeSymbol(
        RcmServer_Handle        handle,
        String                  name
    );

/*
 *  ======== RcmServer_start ========
 */
Int RcmServer_start(
        RcmServer_Handle        handle
    );


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

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

 */