ires.h

Go to the documentation of this file.

/*
 * Copyright (c) 2006-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 IRES_
#define IRES_



#ifdef __cplusplus
extern "C" {
#endif

#include "ires_common.h"

typedef enum IRES_YieldResourceType {
    IRES_ALL = 0,                       
    IRES_SCRATCHMEMORY,                 
    IRES_SCRATCHDMA,                    
    IRES_RESOURCEHANDLE                 
} IRES_YieldResourceType;

typedef Void (*IRES_ContextSaveFxn)(IALG_Handle algHandle, Void *contextArgs);
typedef Void (*IRES_ContextRestoreFxn)
        (IALG_Handle algHandle, Void *contextArgs);

typedef struct IRES_YieldContext {

    IALG_Handle                algHandle;

    IRES_Handle                resourceHandle;

    IRES_ContextSaveFxn        contextSave;

    IRES_ContextRestoreFxn      contextRestore;

    Void                        *contextArgs;

} IRES_YieldContext;


typedef IRES_YieldContext *IRES_YieldContextHandle;
typedef Void *IRES_YieldArgs;

typedef Void (*IRES_YieldFxn)(IRES_YieldResourceType resourceType,
    IRES_YieldContextHandle algYieldContext, IRES_YieldArgs yieldArgs);

typedef struct IRES_Fxns {

    Void *implementationId;

    IRES_Status (*getResourceDescriptors)(IALG_Handle handle,
        IRES_ResourceDescriptor *resourceDescriptors);

    Int32 (*numResourceDescriptors)(IALG_Handle handle);

    IRES_Status (*initResources)(IALG_Handle handle,
            IRES_ResourceDescriptor * resourceDescriptor,
            IRES_YieldFxn yieldFxn, IRES_YieldArgs yieldArgs);

    IRES_Status (*reinitResources)(IALG_Handle handle,
            IRES_ResourceDescriptor * resourceDescriptor,
            IRES_YieldFxn yieldFxn, IRES_YieldArgs yieldArgs);

    IRES_Status (*deinitResources)(IALG_Handle handle,
            IRES_ResourceDescriptor * resourceDescriptor);

    IRES_Status (*activateResource)(IALG_Handle handle,
            IRES_Handle resourceHandle);

    IRES_Status (*activateAllResources)(IALG_Handle handle);

    IRES_Status (*deactivateResource)(IALG_Handle handle,
            IRES_Handle resourceHandle);

     IRES_Status (*deactivateAllResources)(IALG_Handle handle);

} IRES_Fxns;

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


#endif  /* IRES_ */