/***************************************************************************
 *     Copyright (c) 2002, Broadcom Corporation
 *     All Rights Reserved
 *     Confidential Property of Broadcom Corporation
 *
 *  THIS SOFTWARE MAY ONLY BE USED SUBJECT TO AN EXECUTED SOFTWARE LICENSE
 *  AGREEMENT  BETWEEN THE USER AND BROADCOM.  YOU HAVE NO RIGHT TO USE OR
 *  EXPLOIT THIS MATERIAL EXCEPT SUBJECT TO THE TERMS OF SUCH AN AGREEMENT.
 *
 * This file was based upon: /SetTop/syslib/pvrlib/7115/pvrlib_rec.h@@Irvine_HDDemo_Devel/11
 *
 * $brcm_Workfile: bpvrlib_rec.h $
 * $brcm_Revision: Hydra_Software_Devel/11 $
 * $brcm_Date: 1/24/05 6:09p $
 *
 * Module Description:
 *
 * Revision History:
 *
 * $brcm_Log: /magnum/syslib/pvrlib/bpvrlib_rec.h $
 * 
 * Hydra_Software_Devel/11   1/24/05 6:09p marcusk
 * PR13896: Added new function to support scd formats.
 * 
 * Hydra_Software_Devel/10   4/12/04 10:28p vsilyaev
 * PR10546: Added function BPVRlib_Rec_GetEvents;
 * Fixed bug with not clearing out p_overflow.
 * 
 * Hydra_Software_Devel/9   1/21/04 4:43p marcusk
 * PR8927: Fixed to work with latest version of XPT porting interface.
 * Validate channel number.
 * 
 * Hydra_Software_Devel/8   1/10/04 10:47a marcusk
 * PR8927: Fixed playback isses.
 * 
 * Hydra_Software_Devel/7   12/29/03 3:59p marcusk
 * PR9117: Updated with changes required to support interrupt ids rather
 * than strings.
 * 
 * Hydra_Software_Devel/6   12/19/03 3:52p marcusk
 * PR8927: Updated to use xpt record handle allocated by higher level
 * software.
 * 
 * Hydra_Software_Devel/5   12/12/03 2:03p dlwin
 * PR 8970: Change naming convention to conform to Magnum
 * 
 * Hydra_Software_Devel/4   12/11/03 4:00p marcusk
 * PR8936: Updated to use new APIs.
 * 
 * Hydra_Software_Devel/3   12/10/03 2:25p marcusk
 * PR8927: Record syslib now compiles.
 * 
 * Hydra_Software_Devel/2   12/10/03 11:07a marcusk
 * PR 8927: Initial magnum version (not compiled yet)
 * 
 ***************************************************************************/

/*================== Module Overview =====================================

This module implements the record functionality for pvr using an intermediate
ring buffer. It features a programmable buffer location, buffer size, and number
of descriptors. It also supports a constant stream by dynamically adding buffers
into the transport record hardware.

The following general overview describes the record algorithm:
  
 1.0 Allocate
 
   - The number of descriptors and buffer address are passed as parameters
   - The ring buffer manager is allocated
   - Array of descriptors is allocated (all descriptors are added to free list)
 
 1.1 Configure Record
 
   - Data transport PIDs are enabled and configured
   - Record parameters are configured (including decryption/encryption, etc)
   - Record pid channel bitmap is enabled
   - SCT record parameters should be set
 
 1.2 Start Record (SCT record channel should be started first if required)
 
   - Ring buffer manager is reset
   - Entire buffer is divided evenly between all descriptors.
	  Descriptors are filled in and added to record hardware and hardware list
   - Record hardware is started
 
 1.3 Get Data (not re-entrant for same record channel)
 
   - Buffer address and size is requested from the ring buffer manager
   (this step may block if there is no data available)
   (blocking is disabled if the record channel is stopped)
   - Data is copied unsigned char specified buffer
   - Ring buffer read offset is updated
   - If current read offset is large enough to accomidate descriptor
	  bfr size, the decriptor is removed from free list and 
	  added back into record hardware and hardware list.
   - The amount of data copied from record channel is returned
   - Overflow status is returned
 
 (Alternate to 1.3)
 1.3.1 Request to Get Data (steps 1.3.x not re-entrant for same record channel)
 
   - Buffer address and size is requested from the ring buffer manager
   (this step may block if there is no space available)
   (blocking is disabled if the record channel is stopped)
   - Overflow status is returned
 
 1.3.2 Data is copied from specified buffer by calling code
 
 1.3.3 Read pointer is updated
   - Ring buffer read offset is updated
   - If current read offset is large enough to accomidate descriptor
	  bfr size, the decriptor is removed from free list and 
	  added back into record hardware and hardware list.
 
 1.4 Check for Hardware Data Complete
 
   - First descriptor is removed from hardware list
   - Event is triggered signaling removal of descriptor
   - Ring buffer write offset is updated
   - Event is triggered signaling addition of data into ring buffer
   - Descriptor is added to free list
   - Check if next descriptor has also completed (repeat process if necessary)
 
 1.5 Stop Record
 
   - Record hardware is stopped
   - Wait for record done interrupt to occur if we are stopping a transport record channel
	  (sct channels are slaved to the transport channel)
	  (Data complete interrupt handler updates read pointer based upon what 
	  data is recorded after stop occurs)
   - All left over descriptors are moved from hw to the free list
   - Any blocking calls are released (future calls are not allowed to block)
   - Additional get data function call should be called to get remaining
	  data from record.
 
 1.6 Free
 
   - Free descriptor buffer
   - Free ring buffer manager
 
========================================================================*/

#ifndef __BPVRLIB_REC_H__
#define __BPVRLIB_REC_H__

#include "bxpt_record.h"

#ifdef __cplusplus
extern "C" {
#endif

/* 
Summary:
This callback is compatible with the standard 'c' memcpy routine.
It is used to copy data between a user buffer and the ring
buffer during a pvr_recordGetData() function call.
*/
typedef void *(*BPVRlib_Rec_CopyMemoryCb)( void *, const void *, size_t ); 

/* 
Summary:
This handle is used to store the context of a pvr record.
*/
typedef struct BPVRlib_Rec_P_Handle *BPVRlib_Rec_Handle;

/* 
Summary:
This structure is used to store various statistics that can
be used to monitor and debug a record that is in progress.
Note: All stats are reset when the record is started or flushed! 
*/
typedef struct
{
	uint32_t	numBytesRecorded;	/* Number of bytes recorded by hardware */
	uint32_t	numBytesRemoved;	/* Number of bytes removed from the ring buffer by software */
	size_t		bfrSize;			/* Total buffer size */
	uint32_t	readOffset;			/* Current read offset */
	uint32_t	writeOffset;		/* Current write offset */
	uint32_t	numFreeDesc;		/* Current number of free descriptors */
	uint32_t	numInHwDesc;		/* Current number of descriptors being processed by hardware */
	uint32_t	numDesc;			/* Total number of descriptors */
	uint32_t	numDescAdded;		/* Number of descriptors added in to hardware */
	uint32_t	numDescCompleted;	/* Number of descriptors completed by hardware */
	uint32_t	numOverFlows;		/* Number of times the hardware has reached the end of its descriptor list */
	uint32_t	numBufferBlocks;	/* Number of times blocking has occurred due to buffer resources */
	uint32_t	numTimeouts;		/* Number of times blocking has failed due to a timeout */
	uint32_t	maxBfrDepth;		/* Maximum number of bytes stored in buffer */
} BPVRlib_Rec_Stats;

/* 
	The BPVRlib_Rec_Events structure is used to return various events used by the record module.
	Those events could be latter useful when application useed nonblocking flavor of record
*/
typedef struct BPVRlib_Rec_Events
{
	BKNI_EventHandle	descEvent;		/* Event used to signal when descriptor is added to free list */
	BKNI_EventHandle	finishedEvent;	/* Event used to signal when the record has finished */
} BPVRlib_Rec_Events;


/****************************************************************
Summary:
This function allocates the resources required for a 
record.  

Description:
This includes a ring buffer manager,
descriptor list, etc.  The record ring buffer is evenly
divided between the number of descriptors.  This requires
the size of the buffer to be cleanly divisable (on a 32 bit
boundary) by the number of requested descriptors.
The pvrMemCopyCb parameter only needs to be valid
if the BPVRlib_Rec_GetData() function is going to be
used.

See also:
BPVRlib_Rec_Close(), BPVRlib_Rec_Start(), BPVRlib_Rec_GetData()
****************************************************************/
BERR_Code BPVRlib_Rec_Open(
					BPVRlib_Rec_Handle *pRecHandle, 	/* [out] context handle */
					BXPT_Handle xptHandle,				/* XPT handle */
					BXPT_Record_Handle xptRecHandle,	/* XPT record handle */
					BMEM_Handle memHandle,				/* Mem handle */
					BINT_Handle intHandle,				/* Int handle */
					BXPT_ChanType chanType,				/* Record channel type */
					unsigned chanNum,						/* record channel number */
					uint8_t *p_bfr, 					/* pointer to buffer that should be used for record ring buffer, 0 to allocate the buffer internally */
					size_t bfrSize,					/* size of record ring buffer (in bytes) */
					uint32_t numDesc,					/* number of descriptors to use  */
					BPVRlib_Rec_CopyMemoryCb copyMemCb	/* function pointer for memory copies (optional) */
					);

/****************************************************************
Summary:
This function frees any resources used by a record
channel.
****************************************************************/
BERR_Code BPVRlib_Rec_Close( 
				BPVRlib_Rec_Handle recHandle 		/* context handle */
				);

/****************************************************************
Summary:
This function returns events used by the record module
****************************************************************/
BERR_Code BPVRlib_Rec_GetEvents( 
	BPVRlib_Rec_Handle recHandle,	/* context handle*/
	BPVRlib_Rec_Events *events    /* events would be returned in this structure */ 
	);


/****************************************************************
Summary:
This function starts a record channel.
****************************************************************/
BERR_Code BPVRlib_Rec_Start( 
				BPVRlib_Rec_Handle recHandle		/* context handle */
				);

/****************************************************************
Summary:
This function checks if any data has been recorded
into the ring buffer.  If not, it can optionally block
until data is recorded, or return immediately.  When
data is in the record buffer, it is copied (using the
memcpy funtion pointer passed in pvr_recordAllocate)
to the destination buffer.  The function always returns
when ANY amount of data is available, ie the destination
buffer will not always be filled, so make sure to
check the *p_bfrSize when this function returns!
****************************************************************/
BERR_Code BPVRlib_Rec_GetData( 
				BPVRlib_Rec_Handle recHandle,	/* context handle */
				uint8_t *p_bfr,				/* [out,sizeof(*p_bfrSize)] pointer to destination buffer */
				size_t *p_bfrSize,		/* [in,out] size of destination buffer (in bytes), returns number of bytes actually copied */ 
				bool block,					/* false (do not block), true (block until data is available) */
				bool *p_overflow			/* [out] returns 1 if record overflow has occurred */
				);

/****************************************************************
Summary:
This function checks if any data has been recorded
into the ring buffer.  If not, it can optionally block
until data is recorded, or return immediately.  When
data is in the record buffer, the address and size 
of the valid data is returned.  It is up to the
calling code to copy data from this location and
update the read pointer for the record channel
using the BPVRlib_Rec_UpdateReadPointer() function.
****************************************************************/
BERR_Code BPVRlib_Rec_GetDataRequest( 
				BPVRlib_Rec_Handle recHandle,	/* context handle */
				uint8_t **pp_bfr, 				/* [out] returns pointer to the start of valid data */
				size_t *p_bfrSize,			/* [out] returns size of the valid data (in bytes) */ 
				bool block						/* 0 (do not block), 1 (block until data is available) */
				);

/****************************************************************
Summary:
This function updates the read pointer for the
record ring buffer.  It is used to notify the ring
buffer when data has been copied out of the buffer and
this space can be re-used for new record data.
NOTE: The p_overflow variable will not be reset
when there is not an overflow.  It is up to the calling
function to set this variable to false BEFORE calling
this function!
****************************************************************/
BERR_Code BPVRlib_Rec_UpdateReadPointer( 
				BPVRlib_Rec_Handle recHandle,	/* context handle */
				size_t bytesRead,				/* number of bytes that have been read from ring buffer */
				bool block,						/* not currently used */
				bool *p_overflow				/* [out] returns true if record overflow has occurred */
				);

/****************************************************************
Summary:
This function stops a record channel and waits for
the record done interrupt to occur.  After the stop
function is called, don't forget to remove the last 
remains of the record from the ring buffer!
****************************************************************/
BERR_Code BPVRlib_Rec_Stop( 
				BPVRlib_Rec_Handle recHandle	/* context handle */
				);

/****************************************************************
Summary:
This function returns the number of valid bytes in the
ring buffer (already recorded by hardware).
****************************************************************/
void BPVRlib_Rec_GetBufferDepth( 
				BPVRlib_Rec_Handle recHandle,	/* context handle */
				size_t *p_bfrDepth			/* [out] number of valid bytes in the ring buffer */ 
				);

/****************************************************************
Summary:
This function sets the maximum timeout value allowed when
waiting for buffer space or descriptors to become available.
INFINITE is used by default and is the recommended value.
****************************************************************/
void BPVRlib_Rec_SetTimeout( 
				BPVRlib_Rec_Handle recHandle,	/* context handle */
				uint32_t numMsec				/* timeout value in msec */
				);

/****************************************************************
Summary:
This function returns the current timeout value
used when waiting for buffer space or descriptors
to become available.
****************************************************************/
void BPVRlib_Rec_GetTimeout( 
				BPVRlib_Rec_Handle recHandle,	/* context handle */
				uint32_t *p_numMsec 			/* [out] returns current timeout value in msec */
				);

/****************************************************************
Summary:
This function returns various record channel statistics.
****************************************************************/
BERR_Code BPVRlib_Rec_GetStats( 
				BPVRlib_Rec_Handle recHandle,	/* context handle */
				BPVRlib_Rec_Stats *p_stats 		/* [out] this structure is filled with statistics */
				);

/****************************************************************
Summary:
This function sets the format of a SCD record channel.

Description:
This function is only valid for a BXPT_ChanType_eScd type of
record channel.  It is ignored for other types of record channels.
****************************************************************/
void BPVRlib_Rec_SetIndexType( 
	BPVRlib_Rec_Handle recHandle,	/* context handle */
	BXPT_IndexTable indexType		/* type of index data to record (default is BXPT_IndexTable_eStartCode4Word) */
	);

#ifdef __cplusplus
}
#endif

#endif