Collaboration diagram for Memory Interface Functions:

Functions
IFX_INLINE void	IfxCif_generateMiImmediateConfigUpdateSignal (void)
	Function to generate an immediate configuration update signal for the memory interface submodule. More...

IFX_INLINE IfxCif_State	IfxCif_getBaseAddressInitializationEnableState (void)
	Function to query the enabled state of the update signal of the base address and buffer size shadow registers to the programmed register init values. More...

IFX_INLINE uint32	IfxCif_getMiByteCount (void)
	Function to query the number of JPEG or RAW data bytes of the last transmitted frame. More...

IFX_INLINE IfxCif_State	IfxCif_getMiByteSwapEnableState (void)
	Function to query the current state of the change of byte order of the 32 bit output word. More...

IFX_INLINE IfxCif_MiBurstLength	IfxCif_getMiChrominanceBurstLength (void)
	Function to query the currently set burst length for Cb and Cr data. More...

IFX_INLINE IfxCif_MiBurstLength	IfxCif_getMiLuminanceBurstLength (void)
	Function to query the currently set burst length for Y, JPEG, or RAW data. More...

IFX_INLINE IfxCif_MiMainPictureWriteFormat	IfxCif_getMiMainPictureWriteFormat (void)
	Function to query the currently set write format of the main picture path of the memory interface. More...

IFX_INLINE uint32	IfxCif_getMiMainPictureYInitialFillLevelInterruptOffset (void)
	Function to query the filling level that triggers an interrupt of main picture path Y component. More...

IFX_INLINE uint32	IfxCif_getMiMainPictureYInterruptOffset (void)
	Function to query the filling level of the main picture Y component that triggers an interrupt. More...

IFX_INLINE IfxCif_State	IfxCif_getMiOffsetCounterInitializationEnableState (void)
	Function to query the enabled state of the update signal of the offset counter shadow registers. More...

IFX_INLINE void	IfxCif_miSkipPicture (void)
	Function to skip the current or next starting main data path picture. More...

IFX_INLINE void	IfxCif_setMiBaseAddressInitializationEnableState (IfxCif_State state)
	Function to enable or disable the update of the base address and buffer size shadow registers to the programmed register init values (update will be executed either when a forced software update occurs or when an automatic config update signal arrives at the MI input port) More...

IFX_INLINE void	IfxCif_setMiByteSwapEnableState (IfxCif_State enableState)
	Function to enable or disable the change of byte order of the 32 bit output word. More...

IFX_INLINE void	IfxCif_setMiChrominanceBurstLength (IfxCif_MiBurstLength burstLength)
	Function to set the burst length for Cb and Cr data. More...

IFX_INLINE void	IfxCif_setMiMainPictureWriteFormat (IfxCif_MiMainPictureWriteFormat format)
	Function to set the write format of the main picture path of the memory interface. More...

IFX_INLINE void	IfxCif_setMiMainPictureYInitialFillLevelInterruptOffset (uint32 interruptOffset)
	Function to set the filling level to trigger an interrupt for main picture path Y component. More...

IFX_INLINE void	IfxCif_setMiOffsetCounterInitializationEnableState (IfxCif_State state)
	Function to enable or disable the update of the offset counter shadow registers (update will be executed either when a forced software update occurs or when an automatic config update signal arrives at the MI input port) More...

IFX_EXTERN void	IfxCif_clearMiInterrupt (IfxCif_MiInterruptSources interruptSource)
	Function to clear an interrupt. More...

IFX_EXTERN void	IfxCif_clearMiStatus (IfxCif_MiStatusClearSources source)
	Function to clear the status information of one status clear source of the memory interface submodule. More...

IFX_EXTERN uint32	IfxCif_getMainPictureComponentBaseInitAddress (IfxCif_MiMainPicturePathComponents component)
	Function to query the initial base address of the ring buffer of one main picture path component. More...

IFX_EXTERN IfxCif_InterruptTriggeredState	IfxCif_getMaskedMiInterruptTriggeredState (IfxCif_MiInterruptSources interruptSource)
	Function to query the masked state of an interrupt. More...

IFX_EXTERN IfxCif_State	IfxCif_getMiDataPathInputEnableState (IfxCif_MiDataPaths dataPath)
	Function to query the enabled state of one main data path component at the memory interface input. More...

IFX_EXTERN IfxCif_State	IfxCif_getMiDataPathOutputEnableState (IfxCif_MiDataPaths dataPath)
	Function to query the enabled state of one main data path component at the memory interface output. More...

IFX_EXTERN IfxCif_State	IfxCif_getMiFeatureEnableState (IfxCif_MiDataPaths dataPath)
	Function to query the enabled state of a memory interface data path. More...

IFX_EXTERN IfxCif_State	IfxCif_getMiInterruptEnableState (IfxCif_MiInterruptSources interruptSource)
	Function to query the enabled state of an interrupt. More...

IFX_EXTERN uint32	IfxCif_getMiMainPictureComponentBaseAddress (IfxCif_MiMainPicturePathComponents component)
	Function to query the current base address of the ring buffer of one main picture path component. More...

IFX_EXTERN uint32	IfxCif_getMiMainPictureComponentInitSize (IfxCif_MiMainPicturePathComponents component)
	Function to query the initial size of the ring buffer of one main picture path component. More...

IFX_EXTERN uint32	IfxCif_getMiMainPictureComponentInitialOffsetCounter (IfxCif_MiMainPicturePathComponents component)
	Function to query the initial offset counter inside the ring buffer of one main picture path compoent. More...

IFX_EXTERN uint32	IfxCif_getMiMainPictureComponentOffsetCounter (IfxCif_MiMainPicturePathComponents component)
	Function to query the current offset counter within the ring buffer of one main picture path component. More...

IFX_EXTERN uint32	IfxCif_getMiMainPictureComponentOffsetCounterStart (IfxCif_MiMainPicturePathComponents component)
	Function to query the offset counter which points to the start address of the previously processed picture for one main picture path component. More...

IFX_EXTERN uint32	IfxCif_getMiMainPictureComponentSize (IfxCif_MiMainPicturePathComponents component)
	Function to query the current size of the ring buffer of one main picture path component. More...

IFX_EXTERN IfxCif_ErrorState	IfxCif_getMiStatusInformation (IfxCif_MiStatusInformationSources source)
	Function to query the status information of one status information source of the memory interface module. More...

IFX_EXTERN IfxCif_InterruptTriggeredState	IfxCif_getRawMiInterruptTriggeredState (IfxCif_MiInterruptSources interruptSource)
	Function to query the raw state of an interrupt. More...

IFX_EXTERN void	IfxCif_setMiFeatureEnableState (IfxCif_MiDataPaths dataPath, IfxCif_State enableState)
	Function to enable or disable one memory interface data path. More...

IFX_EXTERN void	IfxCif_setMiInterruptEnableState (IfxCif_MiInterruptSources interruptSource, IfxCif_State interruptEnableState)
	Function to enable or disable an interrupt. More...

IFX_EXTERN void	IfxCif_setMiInterruptRequestBit (IfxCif_MiInterruptSources interruptSource)
	Function to set an interrupt request bit (does not necessarily trigger an interrupt) More...

IFX_EXTERN void	IfxCif_setMiLuminanceBurstLength (IfxCif_MiBurstLength burstLength)
	Function to set the burst length for Y, JPEG, or RAW data. More...

IFX_EXTERN void	IfxCif_setMiMainPictureComponentBaseInitAddress (IfxCif_MiMainPicturePathComponents component, Ifx_AddressValue address)
	Function to set the initial base address of the ring buffer for one main picture path component. More...

IFX_EXTERN void	IfxCif_setMiMainPictureComponentInitSize (IfxCif_MiMainPicturePathComponents component, uint32 size)
	Function to set the initial size of the ring buffer for one main picture path component. More...

IFX_EXTERN void	IfxCif_setMiMainPictureComponentInitialOffsetCounter (IfxCif_MiMainPicturePathComponents component, uint32 offsetCounter)
	Function to set the initial offset counter inside the ring buffer for one main picture path component. More...

Detailed Description

Function Documentation

IFX_EXTERN void IfxCif_clearMiInterrupt ( IfxCif_MiInterruptSources interruptSource)

Function to clear an interrupt.

Parameters

interruptSource Source of the interrupt

Returns: None

Definition at line 168 of file IfxCif.c.

IFX_EXTERN void IfxCif_clearMiStatus ( IfxCif_MiStatusClearSources source)

Function to clear the status information of one status clear source of the memory interface submodule.

Parameters

source Status information source for which to clear the status

Returns: None

Definition at line 205 of file IfxCif.c.

IFX_INLINE void IfxCif_generateMiImmediateConfigUpdateSignal ( void )

Function to generate an immediate configuration update signal for the memory interface submodule.

Returns: None

Definition at line 2368 of file IfxCif.h.

Referenced by IfxCif_Cam_startCapture().

IFX_INLINE IfxCif_State IfxCif_getBaseAddressInitializationEnableState ( void )

Function to query the enabled state of the update signal of the base address and buffer size shadow registers to the programmed register init values.

Returns: IfxCif_State_Enabled if update of the base address and buffer size shadow registers is enabled (update will be executed either when a forced software update occurs or when an automatic config update signal arrives at the MI input port), IfxCif_State_Disabled if update of the base address and buffer size shadow registers is disabled

Definition at line 2374 of file IfxCif.h.

IFX_EXTERN uint32 IfxCif_getMainPictureComponentBaseInitAddress ( IfxCif_MiMainPicturePathComponents component)

Function to query the initial base address of the ring buffer of one main picture path component.

Parameters

component Main picture path component for which to query the initial base address

Returns: Initial base address of the main picture path component

Definition at line 1743 of file IfxCif.c.

IFX_EXTERN IfxCif_InterruptTriggeredState IfxCif_getMaskedMiInterruptTriggeredState ( IfxCif_MiInterruptSources interruptSource)

Function to query the masked state of an interrupt.

Parameters

interruptSource Source of the interrupt

Returns: ref IfxCif_InterruptTriggeredState_Triggered if the interrupt request bit is set and the interrupt is enabled, IfxCif_InterruptTriggeredState_Triggered if the interrupt request bit is not set or the interrupt is disabled

Definition at line 1900 of file IfxCif.c.

IFX_INLINE uint32 IfxCif_getMiByteCount ( void )

Function to query the number of JPEG or RAW data bytes of the last transmitted frame.

Returns: Number of JPEG or RAW data bytes of the last transmitted frame (updated at frame end)

Definition at line 2615 of file IfxCif.h.

IFX_INLINE IfxCif_State IfxCif_getMiByteSwapEnableState ( void )

Function to query the current state of the change of byte order of the 32 bit output word.

Returns: IfxCif_State_Enabled if byte swapping is enabled, IfxCif_State_Disabled if byte swapping is disabled

Definition at line 2621 of file IfxCif.h.

IFX_INLINE IfxCif_MiBurstLength IfxCif_getMiChrominanceBurstLength ( void )

Function to query the currently set burst length for Cb and Cr data.

Returns: IfxCif_MiBurstLength_4BeatBursts if 4 bytes are transferred, IfxCif_MiBurstLength_8BeatBursts if 8 bytes are transferred

Definition at line 2627 of file IfxCif.h.

IFX_EXTERN IfxCif_State IfxCif_getMiDataPathInputEnableState ( IfxCif_MiDataPaths dataPath)

Function to query the enabled state of one main data path component at the memory interface input.

Parameters

dataPath Main data path component for which to query the enabled state

Returns: IfxCif_State_Enabled if the main data path component is enabled, IfxCif_State_Disabled if the main data path component is disabled

Definition at line 1970 of file IfxCif.c.

IFX_EXTERN IfxCif_State IfxCif_getMiDataPathOutputEnableState ( IfxCif_MiDataPaths dataPath)

Function to query the enabled state of one main data path component at the memory interface output.

Parameters

dataPath Main data path component for which to query the enabled state

Returns: IfxCif_State_Enabled if the main data path component is enabled, IfxCif_State_Disabled if the main data path component is disabled

Definition at line 1995 of file IfxCif.c.

IFX_EXTERN IfxCif_State IfxCif_getMiFeatureEnableState ( IfxCif_MiDataPaths dataPath)

Function to query the enabled state of a memory interface data path.

Parameters

dataPath Data path to query

Returns: IfxCif_State_Enabled if the memory interface data path is enabled, IfxCif_State_Disabled if the data path is disabled

Definition at line 2020 of file IfxCif.c.

IFX_EXTERN IfxCif_State IfxCif_getMiInterruptEnableState ( IfxCif_MiInterruptSources interruptSource)

Function to query the enabled state of an interrupt.

Parameters

interruptSource Source of the interrupt

Returns: IfxCif_State_Enabled if the interrupt is enabled, IfxCif_State_Disabled if the interrupt is disabled

Definition at line 2045 of file IfxCif.c.

IFX_INLINE IfxCif_MiBurstLength IfxCif_getMiLuminanceBurstLength ( void )

Function to query the currently set burst length for Y, JPEG, or RAW data.

Returns: IfxCif_MiBurstLength_4BeatBursts if 4 bytes are transferred, IfxCif_MiBurstLength_8BeatBursts if 8 bytes are transferred

Definition at line 2633 of file IfxCif.h.

IFX_EXTERN uint32 IfxCif_getMiMainPictureComponentBaseAddress ( IfxCif_MiMainPicturePathComponents component)

Function to query the current base address of the ring buffer of one main picture path component.

Parameters

component Main Picture path component for which to query the base address

Returns: Current base address of the ring buffer of the main picture path component

Definition at line 2086 of file IfxCif.c.

IFX_EXTERN uint32 IfxCif_getMiMainPictureComponentInitialOffsetCounter ( IfxCif_MiMainPicturePathComponents component)

Function to query the initial offset counter inside the ring buffer of one main picture path compoent.

Parameters

component Main picture path component for which to query the initial offset counter

Returns: Initial offset counter value of the main picture path component

Definition at line 2138 of file IfxCif.c.

IFX_EXTERN uint32 IfxCif_getMiMainPictureComponentInitSize ( IfxCif_MiMainPicturePathComponents component)

Function to query the initial size of the ring buffer of one main picture path component.

Parameters

component Main picture path component for which to query the intial size

Returns: Initial size of the main picture path component

Definition at line 2111 of file IfxCif.c.

IFX_EXTERN uint32 IfxCif_getMiMainPictureComponentOffsetCounter ( IfxCif_MiMainPicturePathComponents component)

Function to query the current offset counter within the ring buffer of one main picture path component.

Parameters

component Main picture path component for which to query the offest counter value

Returns: Current offset counter within the ring buffer of the main picture path component

Definition at line 2165 of file IfxCif.c.

IFX_EXTERN uint32 IfxCif_getMiMainPictureComponentOffsetCounterStart ( IfxCif_MiMainPicturePathComponents component)

Function to query the offset counter which points to the start address of the previously processed picture for one main picture path component.

Parameters

component Main picture path component for which to query the offset counter value

Returns: Offset counter value pointing to the start address of the previously processed picture

Definition at line 2190 of file IfxCif.c.

IFX_EXTERN uint32 IfxCif_getMiMainPictureComponentSize ( IfxCif_MiMainPicturePathComponents component)

Function to query the current size of the ring buffer of one main picture path component.

Parameters

component Main Picture path component for which to query the size

Returns: Current size of the ring buffer of the main picture path component

Definition at line 2217 of file IfxCif.c.

IFX_INLINE IfxCif_MiMainPictureWriteFormat IfxCif_getMiMainPictureWriteFormat ( void )

Function to query the currently set write format of the main picture path of the memory interface.

Returns: Currently set write format (one member of IfxCif_MiMainPictureWriteFormat)

Definition at line 2639 of file IfxCif.h.

IFX_INLINE uint32 IfxCif_getMiMainPictureYInitialFillLevelInterruptOffset ( void )

Function to query the filling level that triggers an interrupt of main picture path Y component.

Returns: Filling level that triggers an interrupt

Definition at line 2645 of file IfxCif.h.

IFX_INLINE uint32 IfxCif_getMiMainPictureYInterruptOffset ( void )

Function to query the filling level of the main picture Y component that triggers an interrupt.

Returns: Filling level of the main picture Y component that triggers an interrupt

Definition at line 2653 of file IfxCif.h.

IFX_INLINE IfxCif_State IfxCif_getMiOffsetCounterInitializationEnableState ( void )

Function to query the enabled state of the update signal of the offset counter shadow registers.

Returns: IfxCif_State_Enabled if update of the offset counter shadow registers is enabled (update will be executed either when a forced software update occurs or when an automatic config update signal arrives at the MI input port), IfxCif_State_Disabled if update of the offset counter shadow registers is disabled

Definition at line 2659 of file IfxCif.h.

IFX_EXTERN IfxCif_ErrorState IfxCif_getMiStatusInformation ( IfxCif_MiStatusInformationSources source)

Function to query the status information of one status information source of the memory interface module.

Parameters

source Status information source for which to query the status information

Returns: IfxCif_ErrorState_NoError if the error has occured since the last clear, IfxCif_ErrorState_Error if the error has occured since the last clear

Definition at line 2242 of file IfxCif.c.

IFX_EXTERN IfxCif_InterruptTriggeredState IfxCif_getRawMiInterruptTriggeredState ( IfxCif_MiInterruptSources interruptSource)

Function to query the raw state of an interrupt.

Parameters

interruptSource Source of the interrupt

Returns: IfxCif_InterruptTriggeredState_Triggered if the interrupt request bit is set, IfxCif_InterruptTriggeredState_NotTriggered if the interrupt request bit is not set

Definition at line 2395 of file IfxCif.c.

IFX_INLINE void IfxCif_miSkipPicture ( void )

Function to skip the current or next starting main data path picture.

Returns: None

Definition at line 2726 of file IfxCif.h.

Referenced by IfxCif_Cam_skipPicture().

IFX_INLINE void IfxCif_setMiBaseAddressInitializationEnableState ( IfxCif_State state)

Function to enable or disable the update of the base address and buffer size shadow registers to the programmed register init values (update will be executed either when a forced software update occurs or when an automatic config update signal arrives at the MI input port)

Parameters

state IfxCif_State_Enabled to enable the generation of the update signal, IfxCif_State_Disabled to disable the generation of the update signal

Returns: None

Definition at line 2951 of file IfxCif.h.

IFX_INLINE void IfxCif_setMiByteSwapEnableState ( IfxCif_State enableState)

Function to enable or disable the change of byte order of the 32 bit output word.

Parameters

enableState IfxCif_State_Enabled to enable byte swapping, IfxCif_State_Disabled to disable byte swapping

Returns: None

Definition at line 2957 of file IfxCif.h.

IFX_INLINE void IfxCif_setMiChrominanceBurstLength ( IfxCif_MiBurstLength burstLength)

Function to set the burst length for Cb and Cr data.

Parameters

burstLength Burst length to set

Returns: None

Definition at line 2963 of file IfxCif.h.

IFX_EXTERN void IfxCif_setMiFeatureEnableState	(	IfxCif_MiDataPaths	dataPath,
		IfxCif_State	enableState
	)

Function to enable or disable one memory interface data path.

Parameters

dataPath	Data path to enable or disable
enableState	IfxCif_State_Enabled to enable the data path, IfxCif_State_Disabled to disable the data path

Returns: None

Definition at line 3625 of file IfxCif.c.

Referenced by IfxCif_Cam_disableJpegEncoder(), and IfxCif_Cam_enableJpegEncoder().

IFX_EXTERN void IfxCif_setMiInterruptEnableState	(	IfxCif_MiInterruptSources	interruptSource,
		IfxCif_State	interruptEnableState
	)

Function to enable or disable an interrupt.

Parameters

interruptSource	Source of the interrupt to enable or disable
interruptEnableState	IfxCif_State_Enabled to enable the interrupt, IfxCif_State_Disabled to disable the interrupt

Returns: None

Definition at line 3646 of file IfxCif.c.

IFX_EXTERN void IfxCif_setMiInterruptRequestBit ( IfxCif_MiInterruptSources interruptSource)

Function to set an interrupt request bit (does not necessarily trigger an interrupt)

Parameters

interruptSource Source of the interrupt

Returns: None

Definition at line 3683 of file IfxCif.c.

IFX_EXTERN void IfxCif_setMiLuminanceBurstLength ( IfxCif_MiBurstLength burstLength)

Function to set the burst length for Y, JPEG, or RAW data.

Parameters

burstLength Burst length to set

Returns: None

Definition at line 3720 of file IfxCif.c.

IFX_EXTERN void IfxCif_setMiMainPictureComponentBaseInitAddress	(	IfxCif_MiMainPicturePathComponents	component,
		Ifx_AddressValue	address
	)

Function to set the initial base address of the ring buffer for one main picture path component.

Parameters

component	Main picture path component for which to set the initial base address
address	Base address to set (must be word aligned)

Returns: None

Definition at line 3726 of file IfxCif.c.

IFX_EXTERN void IfxCif_setMiMainPictureComponentInitialOffsetCounter	(	IfxCif_MiMainPicturePathComponents	component,
		uint32	offsetCounter
	)

Function to set the initial offset counter inside the ring buffer for one main picture path component.

Parameters

component	Main picture path component for which to set the initial offest counter
offsetCounter	Offset counter value to set (must be word aligned)

Returns: None

Definition at line 3774 of file IfxCif.c.

IFX_EXTERN void IfxCif_setMiMainPictureComponentInitSize	(	IfxCif_MiMainPicturePathComponents	component,
		uint32	size
	)

Function to set the initial size of the ring buffer for one main picture path component.

Parameters

component	Main picture path component for which to set the initial size
size	Size to set (must be word aligned)

Returns: None

Definition at line 3751 of file IfxCif.c.

IFX_INLINE void IfxCif_setMiMainPictureWriteFormat ( IfxCif_MiMainPictureWriteFormat format)

Function to set the write format of the main picture path of the memory interface.

Parameters

format Format to set

Returns: None

Definition at line 2969 of file IfxCif.h.

IFX_INLINE void IfxCif_setMiMainPictureYInitialFillLevelInterruptOffset ( uint32 interruptOffset)

Function to set the filling level to trigger an interrupt for main picture path Y component.

Parameters

interruptOffset Filling level to set

Returns: None

Definition at line 2975 of file IfxCif.h.

IFX_INLINE void IfxCif_setMiOffsetCounterInitializationEnableState ( IfxCif_State state)

Function to enable or disable the update of the offset counter shadow registers (update will be executed either when a forced software update occurs or when an automatic config update signal arrives at the MI input port)

Parameters

state IfxCif_State_Enabled to enable the generation of the update signal, IfxCif_State_Disabled to disable the generation of the update signal

Returns: None

Definition at line 2983 of file IfxCif.h.

Referenced by IfxCif_Cam_skipPicture(), and IfxCif_Cam_startCapture().