Standard Functions

Collaboration diagram for Standard Functions:

Functions
IFX_INLINE void	IfxCif_clearKernelResetState (void)
	Function to clear the kernel reset state. More...
IFX_INLINE uint16	IfxCif_getCifModuleId (void)
	Function to query the CIF module ID. More...
IFX_INLINE IfxCif_PortInputSelection	IfxCif_getCifModulePortInputSelection (void)
	Function to query the port input selection. More...
IFX_INLINE uint8	IfxCif_getCifModuleRevision (void)
	Function to query the CIF module revision. More...
IFX_INLINE uint8	IfxCif_getCifModuleType (void)
	Function to query the CIF module ID. More...
IFX_INLINE IfxCif_State	IfxCif_getClockControlLogicState (void)
	Function to query the clock distribution enabled state. More...
IFX_INLINE IfxCif_DataPathSelectorForMainPath	IfxCif_getDataPathSelectorForMainPath (void)
	Function to query the data path for main path. More...
IFX_INLINE IfxCif_InputInterface	IfxCif_getInputInterface (void)
	Function to query the input interface of the CIF interface. More...
IFX_INLINE IfxCif_State	IfxCif_getIspInputPortSHSyncState (void)
	Function to query the current level of the ISP input port s_hsync (for testing purposes only) More...
IFX_INLINE IfxCif_State	IfxCif_getKernelResetStatus (void)
	Function to query the kernel reset status. More...
IFX_INLINE uint16	IfxCif_getModuleNumber (void)
	Function to query the module number. More...
IFX_INLINE uint8	IfxCif_getModuleRevisionNumber (void)
	Function to query the revision number of the CIF interface. More...
IFX_INLINE IfxCif_State	IfxCif_getModuleState (void)
	Function to query the state of the CIF module. More...
IFX_INLINE uint8	IfxCif_getModuleType (void)
	Function to query the module type. More...
IFX_INLINE IfxCif_YCSplitterChannelMode	IfxCif_getYCSplitterChannelMode (void)
	Function to query the Y/C splitter channel mode. More...
IFX_INLINE void	IfxCif_setClockControlLogicState (IfxCif_State clockControlLogicState)
	Function to enable or disable the clock distribution to all CIF submodules. More...
IFX_INLINE void	IfxCif_setDataPathSelectorForMainPath (IfxCif_DataPathSelectorForMainPath pathSelector)
	Function to set the data path for main path. More...
IFX_INLINE void	IfxCif_setInputInterface (IfxCif_InputInterface interface)
	Function to set the input interface of the CIF interface. More...
IFX_INLINE void	IfxCif_setKernelResetRequestState (IfxCif_State state)
	Function to request a kernel reset or reset the request bit. More...
IFX_INLINE void	IfxCif_setYCSplitterChannelMode (IfxCif_YCSplitterChannelMode mode)
	Function to set the Y/C splitter channel mode. More...
IFX_EXTERN IfxCif_State	IfxCif_getInternalClockMode (IfxCif_Submodules submodule)
	Function to query the clock state of a submodule. More...
IFX_EXTERN IfxCif_State	IfxCif_getKernelResetRequestState (void)
	Function to query the state of the kernel reset request bit. More...
IFX_EXTERN IfxCif_State	IfxCif_getSoftwareResetMode (IfxCif_Submodules submodule)
	Function to query the reset mode of a submodule. More...
IFX_EXTERN void	IfxCif_resetModule (Ifx_CIF_BBB *cifBbb)
	resets CIF kernel More...
IFX_EXTERN void	IfxCif_setInternalClockMode (IfxCif_Submodules submodule, IfxCif_State clockState)
	Function to enable or disable the clock of a submodule. More...
IFX_EXTERN void	IfxCif_setModuleStateRequest (IfxCif_State state)
	Function to request enabling or disabling of the CIF module. More...
IFX_EXTERN void	IfxCif_setSoftwareResetMode (IfxCif_Submodules submodule, IfxCif_State resetMode)
	Function to enable or disable the reset mode of a submodule. More...

Detailed Description

Function Documentation

IFX_INLINE void IfxCif_clearKernelResetState

(

void

)

Function to clear the kernel reset state.

Returns

None

Definition at line 2350 of file IfxCif.h.

IFX_INLINE uint16 IfxCif_getCifModuleId

(

void

)

Function to query the CIF module ID.

Returns

CIF module ID

Definition at line 2380 of file IfxCif.h.

IFX_INLINE IfxCif_PortInputSelection IfxCif_getCifModulePortInputSelection

(

void

)

Function to query the port input selection.

Returns

Always IfxCif_PortInputSelection_PinMapping0

Definition at line 2386 of file IfxCif.h.

IFX_INLINE uint8 IfxCif_getCifModuleRevision

(

void

)

Function to query the CIF module revision.

Returns

CIF module revision

Definition at line 2392 of file IfxCif.h.

IFX_INLINE uint8 IfxCif_getCifModuleType

(

void

)

Function to query the CIF module ID.

Returns

CIF module type

Definition at line 2398 of file IfxCif.h.

IFX_INLINE IfxCif_State IfxCif_getClockControlLogicState

(

void

)

Function to query the clock distribution enabled state.

Returns

IfxCif_State_Enabled if clock distribution is enabled, IfxCif_State_Disabled otherwise

Definition at line 2404 of file IfxCif.h.

IFX_INLINE IfxCif_DataPathSelectorForMainPath IfxCif_getDataPathSelectorForMainPath

(

void

)

Function to query the data path for main path.

Returns

Selector for the main data path (one member of IfxCif_DataPathSelectorForMainPath)

Definition at line 2429 of file IfxCif.h.

IFX_INLINE IfxCif_InputInterface IfxCif_getInputInterface

(

void

)

Function to query the input interface of the CIF interface.

Returns

IfxCif_InputInterface Type of the configured interface

Definition at line 2447 of file IfxCif.h.

IFX_EXTERN IfxCif_State IfxCif_getInternalClockMode

(

IfxCif_Submodules

submodule)

Function to query the clock state of a submodule.

Parameters

submodule

Identifier of the submodule

Returns

IfxCif_State_Enabled if the clock of the submodule is enabled, IfxCif_State_Disabled otherwise

Definition at line 1128 of file IfxCif.c.

IFX_INLINE IfxCif_State IfxCif_getIspInputPortSHSyncState

(

void

)

Function to query the current level of the ISP input port s_hsync (for testing purposes only)

Returns

IfxCif_State_Enabled if s_hsync is high, IfxCif_State_Disabled if s_hsync is low

Definition at line 2507 of file IfxCif.h.

IFX_EXTERN IfxCif_State IfxCif_getKernelResetRequestState

(

void

)

Function to query the state of the kernel reset request bit.

Returns

IfxCif_State_Enabled if the kernel reset requets bit is set, IfxCif_State_Disabled otherwise

Definition at line 1667 of file IfxCif.c.

IFX_INLINE IfxCif_State IfxCif_getKernelResetStatus

(

void

)

Function to query the kernel reset status.

Returns

IfxCif_State_Enabled if kernel reset was executed, IfxCif_State_Disabled otherwise

Definition at line 2609 of file IfxCif.h.

IFX_INLINE uint16 IfxCif_getModuleNumber

(

void

)

Function to query the module number.

Returns

Module number of the CIF interface

Definition at line 2665 of file IfxCif.h.

IFX_INLINE uint8 IfxCif_getModuleRevisionNumber

(

void

)

Function to query the revision number of the CIF interface.

Returns

Revision number of the CIF interface

Definition at line 2671 of file IfxCif.h.

IFX_INLINE IfxCif_State IfxCif_getModuleState

(

void

)

Function to query the state of the CIF module.

Returns

IfxCif_State_Enabled if the module is currently enabled, IfxCif_State_Disabled otherwise

Definition at line 2677 of file IfxCif.h.

Referenced by IfxCif_Cam_init().

IFX_INLINE uint8 IfxCif_getModuleType

(

void

)

Function to query the module type.

Returns

Module type of the CIF interface

Definition at line 2684 of file IfxCif.h.

IFX_EXTERN IfxCif_State IfxCif_getSoftwareResetMode

(

IfxCif_Submodules

submodule)

Function to query the reset mode of a submodule.

Parameters

submodule

Identifier of the submodule

Returns

IfxCif_State_Enabled if the reset mode of the submodule is enabled, IfxCif_State_Disabled otherwise

Definition at line 2537 of file IfxCif.c.

IFX_INLINE IfxCif_YCSplitterChannelMode IfxCif_getYCSplitterChannelMode

(

void

)

Function to query the Y/C splitter channel mode.

Returns

Configured mode of the Y/C splitter (one member of IfxCif_YCSplitterChannelMode)

Definition at line 2708 of file IfxCif.h.

IFX_EXTERN void IfxCif_resetModule

(

Ifx_CIF_BBB *

cifBbb)

resets CIF kernel

Parameters

cifBbb

pointer to CIF_BBB registers

Returns

None

Definition at line 2661 of file IfxCif.c.

IFX_INLINE void IfxCif_setClockControlLogicState

(

IfxCif_State

clockControlLogicState)

Function to enable or disable the clock distribution to all CIF submodules.

Parameters

clockControlLogicState

IfxCif_State_Enabled to enable clock distribution, IfxCif_State_Disabled to disable clock distribution

Returns

None

Definition at line 2732 of file IfxCif.h.

IFX_INLINE void IfxCif_setDataPathSelectorForMainPath

(

IfxCif_DataPathSelectorForMainPath

pathSelector)

Function to set the data path for main path.

Parameters

pathSelector

Selector for the main data path

Returns

None

Definition at line 2739 of file IfxCif.h.

Referenced by IfxCif_Cam_disableJpegEncoder(), and IfxCif_Cam_enableJpegEncoder().

IFX_INLINE void IfxCif_setInputInterface

(

IfxCif_InputInterface

interface)

Function to set the input interface of the CIF interface.

Parameters

interface

Type of interface

Returns

None

Definition at line 2757 of file IfxCif.h.

IFX_EXTERN void IfxCif_setInternalClockMode	(	IfxCif_Submodules	submodule,
		IfxCif_State	clockState
	)

Function to enable or disable the clock of a submodule.

Parameters

submodule	Identifier of the submodule to enable or disable
clockState	IfxCif_State_Enabled to enable the clock, IfxCif_State_Disabled to disable the clock

Returns

None

Definition at line 3154 of file IfxCif.c.

IFX_INLINE void IfxCif_setKernelResetRequestState

(

IfxCif_State

state)

Function to request a kernel reset or reset the request bit.

Parameters

state

IfxCif_State_Enabled to request a reset, IfxCif_State_Disabled to reset the request bit before a reset was performed

Returns

None

Definition at line 2944 of file IfxCif.h.

Referenced by IfxCif_Cam_init().

IFX_EXTERN void IfxCif_setModuleStateRequest

(

IfxCif_State

state)

Function to request enabling or disabling of the CIF module.

Parameters

state

IfxCif_State_Enabled to request the enabling of the module, IfxCif_State_Disabled otherwise

Returns

None

Definition at line 3797 of file IfxCif.c.

IFX_EXTERN void IfxCif_setSoftwareResetMode	(	IfxCif_Submodules	submodule,
		IfxCif_State	resetMode
	)

Function to enable or disable the reset mode of a submodule.

Parameters

submodule	Identifier of the submodule
resetMode	IfxCif_State_Enabled to enable the reset of the submodule, IfxCif_State_Disabled to disable the reset

Returns

None

Definition at line 3901 of file IfxCif.c.

IFX_INLINE void IfxCif_setYCSplitterChannelMode

(

IfxCif_YCSplitterChannelMode

mode)

Function to set the Y/C splitter channel mode.

Parameters

mode	Mode of the Y/C splitter to set

Returns

None

Definition at line 3007 of file IfxCif.h.