/**********************************************************************************
 *  Copyright (c) 2002 ZORAN Corporation, All Rights Reserved
 *  THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF ZORAN CORPORATION
 *
 *  File: "fef.h"                                            
 *
 * Description:
 * ============
 * Track buffer management (Front End MCU)
 * 
 * Log:
 * ====
 * $Revision: $
 * Last Modified by $Author: $ at $Modtime: $ 
 **********************************************************************************
 * Updates:
 **********************************************************************************
 * $Log: $
 * 
 * 
 *********************************************************************************/
#include "Config.h"		/* Global Configuration - do not remove! */


#ifndef _FEF_H
#define _FEF_H


/*** Include Files ***************************************************************/
#include "Include\SysDefs.h"
#include "Drive\drv_defs.h"
#include "Drive\Zfe\zfe.h"
#include "Drive\Zfe\zfe_mcu_address.h"


/*** Defines *********************************************************************/

/* Gaps between SPT to ECC base pointers */
#define FEF_ECC2STP_GAP_CD						16
#define FEF_ECC2STP_GAP_AFTER_END_SECTOR_CD		1
#define FEF_ECC2STP_GAP_DVD						40
#define FEF_ECC2STP_GAP_AFTER_END_SECTOR_DVD	31
#define FEF_ECC2STP_GAP_KEEP_HEAD_DVD			31


/*** Typedefs ********************************************************************/
typedef enum
{
	FE_MCU_CLIENT_STP,
	FE_MCU_CLIENT_ECC,
	FE_MCU_CLIENT_EDC,
	FE_MCU_CLIENT_BTS
} FE_MCU_CLIENT;


typedef enum
{
	FEF_DVD_FUNCTIONS,
	FEF_CD_FUNCTIONS,
	FEF_MAX_MEDIA_FUNCTIONS
} FEF_MEDIA_FUNCTIONS;


typedef enum
{
	FEF_FLUSH_ON_ABORT_E,
	FEF_FLUSH_ON_ERROR_E,
	FEF_FLUSH_ON_PLAYBACK_FINISHED_E
} FEF_FLUSH_REQ_ET;


typedef struct
{
	void	(*FEF_FifoFullTimer)(UINT8 hTimer);
	void	(*FEF_FifoSkip)(UINT32);
	void	(*FEF_FifoFullIsr)(void);
	void	(*FEF_ProgramNextEcc)(void);
	UINT32	sectorSize;
	UINT16	ifConfigMode;
	UINT16	sectorsInBlock;
} FEF_FUNCTIONS;


/*** Public Functions ************************************************************/

void FEF_Init(DRV_PHY_DISCTYPE_ET media_type);
void FEF_InitFeBuffer(void);
#ifdef FTA_SUPPORT
void FEF_InitFTABuffer(void);
#endif
void FEF_FifoFlush(FEF_FLUSH_REQ_ET request);
#ifdef FTA_SUPPORT
void FEF_FtaFifoFlush(void);
#endif
void FEF_SetStartSector(UINT32 start_psn);
void FEF_SetPlayNumber(int play_number);
void FEF_SetStpToEccGap(UINT8 gap);
void __interrupt FEF_Isr(void);

void FEF_IncCurrentStpShadow(BOOL defect);
void FEF_SetStpToEndSector(UINT32 end_sec);
void FEF_StartEccMonitoring(void);
void FEF_StopEccMonitoring(void);
void FEF_EccFreeze(BOOL freeze);
void FEF_EdcFreeze(BOOL freeze);

UINT32 FEF_GetCurrPos(FE_MCU_CLIENT client);
UINT32 FEF_Psn2Position(UINT32 psn);
UINT32 FEF_Position2Psn(UINT32 curr_pos);
UINT32 FEF_GetStpStartPosition(void);
UINT32 FEF_GetCurrentCDPsn(void);
UINT32 FEF_GetCurrentDVDPsn(void);
UINT32 FEF_GetCurrentStpPsn(BOOL align);

BOOL FEF_IsTrackBufferEmpty(void);
BOOL FEF_Ecc2BtsGapIsAlmostEmpty(void);
BOOL FEF_Edc2BtsGapIsAlmostEmpty(void);

#ifdef READ_BIT_RATE
UINT16 FEF_GetBitRate(void);
#endif

/* FEF virtual table routines */
void FEF_FifoFullTimerDVD(UINT8 hTimer);
void FEF_FifoFullTimerCD(UINT8 hTimer);
void FEF_FifoSkipDVD(UINT32 first_sec);
void FEF_FifoSkipCD(UINT32 first_sec);
void FEF_FifoFullIsrDVD(void);
void FEF_FifoFullIsrCD(void);
void FEF_ProgramNextEccDVD(void);
void FEF_ProgramNextEccCD(void);

/* DVD related routines */
int  FEF_FifoSkipToEndSector(UINT32 end_sec);
void FEF_EdcError(void);
void FEF_HandleEdcError(UINT32 addr , BOOL skip);
BOOL FEF_WaitBts(void);

/* CD related routines */
BOOL FEF_SectorHasDefect(UINT32 addr);
void FEF_SetInitialEccOffsetCD(UINT16 offset);


#endif