hdintc.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_hdintc_HDINTC_
#define ti_sdo_fc_hdintc_HDINTC_



#ifdef __cplusplus
extern "C" {
#endif

#include <ti/xdais/ialg.h>
#include <ti/xdais/xdas.h>

#define HDINTC_GTNAME "ti.sdo.fc.hdintc"  
#define HDINTC_SOK             0  
#define HDINTC_EOUTOFMEMORY   -1  
#define HDINTC_EFAIL          -2  


typedef struct HDINTC_Params {

     int interruptVectorId_0;

     int interruptVectorId_1;

    int hdvicpInterruptEventNo_0;

    int hdvicpInterruptEventNo_1;

    int biosInterruptVectorId_0;

    int biosInterruptVectorId_1;

    int biosInterruptEventNo_0;

    int biosInterruptEventNo_1;
    
} HDINTC_Params;


extern HDINTC_Params HDINTC_PARAMS;

/*---------------------------------------------------------------------------*/
/*  Dummy structure for HDVICP handle. Currently not at all used by the      */
/*  algorithm except for passing it with hdvicp calls.                       */
/*---------------------------------------------------------------------------*/
typedef struct hdvicpAppHandle
{
    /*-----------------------------------*/
    /* handle size useful when extended  */
    /*-----------------------------------*/
    XDAS_UInt32    handleSize;

    /*-----------------------------------*/
    /*  process-Id                       */
    /*-----------------------------------*/
    XDAS_UInt32    processId;

    /*-----------------------------------*/
    /* application specific information  */
    /*-----------------------------------*/
    void*       info;

} HDVICP_Obj;

typedef HDVICP_Obj* HDVICP_Handle;

/*===========================================================================*/
/*
 *@brief  This is the top level function on the gem side, which sets the 
 *        interrupt configuration for the interrupts received from ARM968.
 *        In effect, this function currently sets the global function ptr   
 *        to the actual MB processing decode function that needs to be called
 *        from the interrupt service routine.
 *
 *@param  handle                      Algorithm handle
 *
 *@param  hdvicpHandle                void pointer to the hdvicp handle.
 *
 *@param  (*ISRfunctionptr)(handle)   Function pointer to the MB pair 
 *                                    processing function of the algorithm.
 *
 *@return none
 *
 *@note   This function will be called from the algorithm but the
 *        implementation will lie in the application.
 */
/*===========================================================================*/
void HDVICP_configure(IALG_Handle handle, 
                      void * hdvicpHandle, 
                      void (*ISRfunctionptr)(IALG_Handle handle));

/*===========================================================================*/
/*
 *@brief  This is the top level function on the gem side, which implements
 *        the hdvicp_wait(). Current implementation allows GEM to wait on a 
 *        global intc flag which will be 1 as long as one frame is not 
 *        completed.
 *
 *@param  hdvicpHandle      void pointer to the hdvicp handle.
 *
 *@return none
 *
 *@note   As per XDM, this function will be called from the algorithm but the
 *        implementation will lie in the application.
 */
/*===========================================================================*/
void HDVICP_wait (void * hdvicpHandle);

/*===========================================================================*/
/*
 *@brief  This is the top level function on the gem side, which implements
 *        the hdvicp_done(). Current implementation allows GEM to set a 
 *        global intc flag to 0 to come out of hdvicp_wait() as soon as one 
 *        frame is completed.
 *
 *@param  hdvicpHandle      void pointer to the hdvicp handle.
 *
 *@return none
 *
 *@note   As per XDM, this function will be called from the algorithm but the
 *        implementation will lie in the application.
 */
/*===========================================================================*/
void HDVICP_done (void * hdvicpHandle);

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


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

 */