ires_hdvicp2.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012 - 2013, 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_hdvicp_IRES_HDVICP2_
#define ti_sdo_fc_ires_hdvicp_IRES_HDVICP2_



#ifdef __cplusplus
extern "C" {
#endif

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

#define IRES_HDVICP2_PROTOCOLNAME       "ti.sdo.fc.ires.hdvicp.hdvicp2"

#define HDVICP2_MODNAME  "ti.sdo.fc.ires.hdvicp2"


#define IRES_HDVICP2_ID_ANY             -2

#define IRES_HDVICP2_ID_LATE_ACQUIRE    -1

#define IRES_HDVICP2_INVALID_ADDR 0xFFFFFFFF

#define IRES_HDVICP2_TIMEOUTFOREVER ((UInt)(-1))

#define IRES_HDVICP2_UNKNOWNLATEACQUIREARG (-1)

/*
 * Note, we wrap the PROTOCOLVERSION in an ifdef so the
 * resource managers and algs get this version data placed in their object
 * files.  Apps, which include rman.h, will have this 'NOPROTOCOLREV' defined.
 */
#ifndef ti_sdo_fc_ires_NOPROTOCOLREV

static IRES_ProtocolRevision IRES_HDVICP2_PROTOCOLREVISION = {1, 0, 0};

#endif

typedef struct IRES_HDVICP2_Obj *IRES_HDVICP2_Handle;


extern unsigned int ti_sdo_fc_ires_hdvicp_HDVICP2_timeoutVal;

typedef IRES_YieldArgs (* ti_sdo_fc_ires_hdvicp_HDVICP2_GetYieldArgsFxn)
        (Int scratchId);

typedef Void (* ti_sdo_fc_ires_hdvicp_HDVICP2_YieldFxn)
        (IRES_YieldResourceType resource, IRES_YieldContextHandle ctxt,
        IRES_YieldArgs args);



typedef struct IRES_HDVICP2_ProtocolArgs {

    IRES_ProtocolArgs base;     
    XDAS_Int32 id;              
} IRES_HDVICP2_ProtocolArgs;

typedef void (*IRES_HDVICP2_CallbackFxn)(IALG_Handle handle, Void * args);

typedef enum IRES_HDVICP2_Status {
    SAMECODEC = 0,          
    SAMECODECTYPE = 1,      
    DIFFERENTCODEC = 2      
} IRES_HDVICP2_Status;


typedef struct  IRES_HDVICP2_Obj {

    IRES_Obj ires;                     
    Void *info;                        
    XDAS_Int32 id;                     
    XDAS_Void *registerBaseAddress;    
    XDAS_Void *memoryBaseAddress;      
    XDAS_Void *resetControlAddress;    
    XDAS_Void (*acquire)(IALG_Handle algHandle,
            struct IRES_HDVICP2_Obj * hdvicpHandle,
            IRES_YieldContext * yieldCtxt, XDAS_UInt32 * hdvicp2Status,
            XDAS_UInt32 *configurationId, XDAS_Int32 lateAcquireArg);

    XDAS_Void (*release)(IALG_Handle algHandle,
            struct IRES_HDVICP2_Obj * hdvicpHandle);

    XDAS_UInt32 (*reacquireIfOwner)(IALG_Handle algHandle,
            struct IRES_HDVICP2_Obj * hdvicpHandle);

    XDAS_Void (*configure)(IALG_Handle algHandle,
            struct IRES_HDVICP2_Obj * hdvicpHandle,
            IRES_HDVICP2_CallbackFxn cbFunctionPtr, XDAS_Void * cbArgs);

    XDAS_UInt32 (*wait)(IALG_Handle algHandle,
            struct IRES_HDVICP2_Obj *hdvicpHandle,
            IRES_YieldContext * yieldCtxt);

    XDAS_Void (*done) (IALG_Handle algHandle,
            struct IRES_HDVICP2_Obj *hdvicpHandle);
    XDAS_UInt32 (*reset)(IALG_Handle algHandle,
            struct IRES_HDVICP2_Obj *hdvicpHandle);

} IRES_HDVICP2_Obj;


typedef struct IRES_HDVICP2_RegisterLayer {

    int size;
    /* TBD */
} IRES_HDVICP2_RegisterLayer;

typedef struct IRES_HDVICP2_Properties {

    int size;
    IRES_HDVICP2_RegisterLayer *globalRegs;      /* Register layer of HDVICP2 */
} IRES_HDVICP2_Properties;

typedef IRES_Status (*ti_sdo_fc_ires_hdvicp_HDVICP2_GetHdvicp2Fxn)
        (XDAS_Int32 *Id, IALG_Handle alg, IRES_HDVICP2_Handle handle);

typedef IRES_Status (*ti_sdo_fc_ires_hdvicp_HDVICP2_FreeHdvicp2Fxn)
       (XDAS_Int32 Id, IALG_Handle alg, IRES_HDVICP2_Handle handle);

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

#endif