rman.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.
 *
 */
#ifndef ti_sdo_fc_rman__RMAN_
#define ti_sdo_fc_rman__RMAN_

#define ti_sdo_fc_ires_NOPROTOCOLREV

#ifdef __cplusplus
extern "C" {
#endif


#include <ti/xdais/ires.h>
#include <ti/sdo/fc/ires/iresman.h>

#define RMAN_MODNAME  "ti.sdo.fc.rman"

#define RMAN_GTNAME  "ti.sdo.fc.rman"

#define RMAN_PROTOCOLNAMESIZE 200

typedef struct Sem_Obj * RMAN_SemHandle;

typedef IRES_YieldArgs (* ti_sdo_fc_rman_RMAN_YieldArgsFxn)
    (Int scratchId, Bool yieldFlag);

typedef struct RMAN_Params {

    short numRegistries;

    IRESMAN_PersistentAllocFxn * allocFxn;

    IRESMAN_PersistentFreeFxn * freeFxn;

    IRES_YieldFxn yieldFxn;

    Bool yieldSamePriority;

} RMAN_Params;

extern __FAR__ RMAN_Params RMAN_PARAMS;

extern __FAR__ IRESMAN_Fxns * RMAN_TABLE[];

extern __FAR__ short RMAN_FREE_ENTRIES[];

extern __FAR__ short RMAN_numRegistryEntries;

extern __FAR__ IRESMAN_Fxns ** RMAN_registryEntries;

extern __FAR__ IRESMAN_Params ** RMAN_registryResmanArgs;

extern __FAR__ unsigned int ** RMAN_iresVTable;

extern __FAR__ unsigned int ti_sdo_fc_rman_RMAN_MAXALGS;

extern UInt32 ti_sdo_fc_rman_RMAN_ipcKey;

extern ti_sdo_fc_rman_RMAN_YieldArgsFxn ti_sdo_fc_rman_RMAN_setYieldArgs;

IRES_Status RMAN_init(Void);


IRES_Status RMAN_exit(Void);


IRES_Status RMAN_register(IRESMAN_Fxns * resmanFxns, IRESMAN_Params * initArgs);


IRES_Status RMAN_unregister(IRESMAN_Fxns * resmanFxns);

IRES_Status RMAN_assignResources(IALG_Handle algHandle, IRES_Fxns * resFxns,
    Int scratchGroupId);


IRES_Status RMAN_allocateResources(Int requestId,
    IRES_ResourceDescriptor * resDesc, Int numResources, Int scratchGroupId);


IRES_Status RMAN_freeResources(IALG_Handle algHandle, IRES_Fxns * resFxns, Int
    scratchGroupId);

IRES_Status RMAN_freeAllocatedResources (Int requestId,
        IRES_ResourceDescriptor *resDesc, Int numResources, Int scratchGroupId);

IRES_Status RMAN_activateResource(IALG_Handle algHandle,
    IRES_Handle resourceHandle, IRES_Fxns * resFxns, Int scratchGroupId);

IRES_Status RMAN_activateAllResources(IALG_Handle algHandle,
    IRES_Fxns * resFxns, Int scratchGroupId);

IRES_Status RMAN_deactivateResource(IALG_Handle algHandle,
    IRES_Handle resourceHandle, IRES_Fxns * resFxns, Int scratchGroupId);

IRES_Status RMAN_deactivateAllResources(IALG_Handle algHandle,
    IRES_Fxns * resFxns, Int scratchGroupId);


void RMAN_yield(IRES_YieldResourceType resource,
    IRES_YieldContextHandle algYieldContext, IRES_YieldArgs yieldArgs);


#ifdef __cplusplus
}
#endif /* extern "C" */

#endif