stbhwini.h File Reference

Header file - Function prototype for init function. More...

Go to the source code of this file.

Typedefs
typedef enum e_hw_subt_control	E_HW_SUBT_CONTROL_MASK

Enumerations
enum	e_hw_subt_control { HW_SUBT_NONE = 0, HW_SUBT_EBU = 1, HW_SUBT_DVB = 2 }
enum	E_HW_STANDBY_STATE { HW_STANDBY_ON, HW_STANDBY_ACTIVE, HW_STANDBY_PASSIVE, HW_STANDBY_LOWPOWER }
enum	E_HW_WAKEUP_TYPE { HW_WAKEUP_UNKNOWN = 0, HW_WAKEUP_TIMER, HW_WAKEUP_USER }

Functions
void	STB_HWInitialise (E_HW_SUBT_CONTROL_MASK hw_subt)
	Initialise the platform layer by calling the platform layer initialisation functions that are appropriate for this platform. More...
BOOLEAN	STB_HWSetStandbyState (E_HW_STANDBY_STATE state)
	Used to transition the system between the various standby states. It's assumed that the system can move to any state from any of the other states. More...
E_HW_STANDBY_STATE	STB_HWGetStandbyState (void)
	Returns the current standby state of the system. STANDBY_LOWPOWER should never be returned by this function because in this state DVBCore is assumed not to be active. More...
void	STB_HWSetWakeUpTime (U16BIT mjd, U16BIT year, U8BIT month, U8BIT day, U8BIT hours, U8BIT minutes, U32BIT time_in_mins)
	Used to set the wake up time for when the system is going to be put into the low power standby state. Not all the supplied parameters are expected to be used, just those that are needed by the system to ensure the system wakes up at the required time. More...
E_HW_WAKEUP_TYPE	STB_HWGetWakeUpType (void)
	Returns what caused the system to be powered on. This is used to work out what to do after being powered on (e.g. if due to user interaction then the system needs to enter the HW_STANDBY_ON state, whereas if it's due to the wake up timer then the system needs to work out what it needs to be do next, which may be to start a recording for a PVR type system, in which case it will enter the HW_STANDBY_ACTIVE state). More...
void	STB_HWEnterStandby (void)
	Perform any operations required before entering standby. More...
void	STB_HWLeaveStandby (void)
	Perform any operations required when coming out of standby. More...

Detailed Description

Header file - Function prototype for init function.

Date

20/06/2002

Function Documentation

void STB_HWEnterStandby

(

void

)

Perform any operations required before entering standby.

Deprecated:

This function is no longer used by DVBCore; STB_HWSetStandbyState is used instead.

E_HW_STANDBY_STATE STB_HWGetStandbyState

(

void

)

Returns the current standby state of the system. STANDBY_LOWPOWER should never be returned by this function because in this state DVBCore is assumed not to be active.

Returns

current standby state

E_HW_WAKEUP_TYPE STB_HWGetWakeUpType

(

void

)

Returns what caused the system to be powered on. This is used to work out what to do after being powered on (e.g. if due to user interaction then the system needs to enter the HW_STANDBY_ON state, whereas if it's due to the wake up timer then the system needs to work out what it needs to be do next, which may be to start a recording for a PVR type system, in which case it will enter the HW_STANDBY_ACTIVE state).

Returns

the cause of the power on

void STB_HWInitialise

(

E_HW_SUBT_CONTROL_MASK

hw_subt

)

Initialise the platform layer by calling the platform layer initialisation functions that are appropriate for this platform.

Parameters

hw_subt

The subtitling mode mask, indicates which types of subtitles are required

void STB_HWLeaveStandby

(

void

)

Perform any operations required when coming out of standby.

Deprecated:

This function is no longer used by DVBCore; STB_HWSetStandbyState is used instead.

BOOLEAN STB_HWSetStandbyState

(

E_HW_STANDBY_STATE

state

)

Used to transition the system between the various standby states. It's assumed that the system can move to any state from any of the other states.

Parameters

state

state the system is requesting to move to

Returns

TRUE if the system has or will move to the requested state, FALSE otherwise

void STB_HWSetWakeUpTime	(	U16BIT	mjd,
		U16BIT	year,
		U8BIT	month,
		U8BIT	day,
		U8BIT	hours,
		U8BIT	minutes,
		U32BIT	time_in_mins
	)

Used to set the wake up time for when the system is going to be put into the low power standby state. Not all the supplied parameters are expected to be used, just those that are needed by the system to ensure the system wakes up at the required time.

Parameters

mjd	wake up date in Modified Julian Date format
year	the year in full (e.g. 2016) the system is to wake up
month	month number (January=1, December=12) the system is to wake up
day	day number (1 to 28, 29, 30 or 31) the system is to wake up
hours	time in hours (0 to 23) the system is to wake up
minutes	time in minutes (0 to 59) the system is to wake up
time_in_mins	the time in minutes from the current date/time to the wake up time