clk.h

ST5100 driver files for ST chipset

/*****************************************************************************

File Name   : clk.h

Description : CLKRV header

COPYRIGHT (C) STMicroelectronics 2005.

*****************************************************************************/

#ifndef __TT_CLK_H
#define __TT_CLK_H

#include "stclkrv.h"

/*=========================================================================
    Structure and Type Definitions
=========================================================================== */

typedef struct
{
    ST_DeviceName_t        DeviceName;
    STCLKRV_Handle_t       *Handle_p;
    EVT_DeviceId_t         EVTDeviceId;
    PTI_DeviceId_t         PTIDeviceId;
} CLKRV_DeviceHandle_t;

typedef enum
{
    CLKRV_PCM = 0,
    CLKRV_HD = 1,
	CLKRV_SD = 2,
    CLKRV_MAXCLOCK = 3
} CLKRV_ClockId_t;

/*=========================================================================
    Global Variables
=========================================================================== */

extern CLKRV_DeviceHandle_t ClkrvDeviceHandle[];

/*=========================================================================
    Global definitions
=========================================================================== */

#define CLKRV_GET_HANDLE(h,id) (ClkrvDeviceHandle[(h)].Handle_p[(id)])
#define CLKRV_GET_DEVICENAME(h) (ClkrvDeviceHandle[(h)].DeviceName)
#define CLKRV_GET_EVTDEVICEID(h) (ClkrvDeviceHandle[(h)].EVTDeviceId)
#define CLKRV_GET_PTIDEVICEID(h) (ClkrvDeviceHandle[(h)].PTIDeviceId)
#define CLKRV_HANDLE_NULL (STCLKRV_Handle_t)NULL

#define STC_SOURCE_PCR 		STCLKRV_STC_SOURCE_PCR

/*=========================================================================
    Global function declarations
=========================================================================== */

ST_ErrorCode_t CLKRV_Close( CLKRV_DeviceId_t DeviceId, CLKRV_HandleId_t HandleId );
ST_ErrorCode_t CLKRV_Disable( CLKRV_DeviceId_t DeviceId, CLKRV_HandleId_t HandleId );
ST_ErrorCode_t CLKRV_Enable( CLKRV_DeviceId_t DeviceId, CLKRV_HandleId_t HandleId );
ST_ErrorCode_t CLKRV_GetSTC( CLKRV_DeviceId_t DeviceId, CLKRV_HandleId_t HandleId, U32 *STCvalue );
ST_ErrorCode_t CLKRV_Init( CLKRV_DeviceId_t DeviceId );
ST_ErrorCode_t CLKRV_InvDecodeClk( CLKRV_DeviceId_t DeviceId, CLKRV_HandleId_t HandleId );
ST_ErrorCode_t CLKRV_Open( CLKRV_DeviceId_t DeviceId, CLKRV_HandleId_t HandleId );
ST_ErrorCode_t CLKRV_Close( CLKRV_DeviceId_t DeviceId, CLKRV_HandleId_t HandleId );
ST_ErrorCode_t CLKRV_SetPCRSource( CLKRV_DeviceId_t DeviceId, CLKRV_HandleId_t DeviceId,
                                   PTI_ProcessStreamId_t PTI_ProcessStreamId );
ST_ErrorCode_t CLKRV_SetSTCSource( CLKRV_DeviceId_t DeviceId, CLKRV_HandleId_t HandleId,
                                   STCLKRV_STCSource_t STCSource);
ST_ErrorCode_t CLKRV_SetSTCOffset( CLKRV_DeviceId_t DeviceId, CLKRV_HandleId_t HandleId, 
								   S32 STC_Offset);
ST_ErrorCode_t CLKRV_Term( CLKRV_DeviceId_t DeviceId, BOOL ForceTerminate );

BOOL           CLKRV_InitCommand( void );

#endif

/* EOF */