iresman.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_ires_IRESMAN_
#define ti_sdo_fc_ires_IRESMAN_


#ifdef __cplusplus
extern "C" {
#endif

#include <ti/xdais/ires_common.h>
#include <ti/xdais/ires.h>

typedef Bool (IRESMAN_PersistentAllocFxn)(IALG_MemRec *memTab, Int numRecs);

typedef Void (IRESMAN_PersistentFreeFxn)(IALG_MemRec *memTab, Int numRecs);


typedef struct IRESMAN_Params {
    Int32 size;         
    IRESMAN_PersistentAllocFxn * allocFxn;

    IRESMAN_PersistentFreeFxn * freeFxn;

} IRESMAN_Params;

typedef struct IRESMAN_Fxns {

    String (*getProtocolName)();

    IRES_ProtocolRevision * (* getProtocolRevision)();

    IRES_Status (* init)(IRESMAN_Params * initArgs);

    IRES_Status (* exit)();

    IRES_Handle (* getHandle)(IALG_Handle algHandle,
            IRES_ResourceDescriptor * resDesc, Int scratchGroupId,
            IRES_Status * status);

    IRES_Status (* freeHandle)(IALG_Handle algHandle,
            IRES_Handle resourceHandle, IRES_ResourceDescriptor * resDesc,
            Int scratchGroupId);

    /* Two new optional APIs */
    Void (* activateResource)(IALG_Handle algHandle, IRES_Fxns * resFxns);

    Void (* deactivateResource)(IALG_Handle algHandle, IRES_Fxns * resFxns);

} IRESMAN_Fxns;

#ifdef __cplusplus
}
#endif

#endif