HAL GFXTIM Functions ¶

Initialization and de-initialization functions ¶

group GFXTIM_Exported_Functions_Group1

This subsection provides a set of functions allowing to initialize and de-initialize the GFXTIM peripheral:

Call HAL_GFXTIM_Init() to initialize the GFXTIM handle and associate associate a physical instance.
Call HAL_GFXTIM_DeInit() to de-initialize the GFXTIM handle.

Functions

hal_status_t HAL_GFXTIM_Init ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_t instance ) ¶

Initialize the GFXTIM handle and associate a physical GFXTIM instance.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
instance – Specifies the GFXTIM instance based on hal_gfxtim_t enumeration.

Return values :

HAL_INVALID_PARAM – Invalid parameter when hgfxtim pointer is NULL.
HAL_OK – GFXTIM is successfully initialized.

void HAL_GFXTIM_DeInit ( hal_gfxtim_handle_t * hgfxtim ) ¶

De-initialize the GFXTIM handle.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.

Clock Generator functions ¶

group GFXTIM_Exported_Functions_Group2

This subsection provides a set of functions allowing to manage the clock generator:

Call HAL_GFXTIM_CLKGEN_SetConfigLineFrameClock() to configure the line and frame clock generator.
Call HAL_GFXTIM_CLKGEN_GetConfigLineClock() to get the line clock generator configuration.
Call HAL_GFXTIM_CLKGEN_SetConfigFrameClock() to configure the frame clock generator.
Call HAL_GFXTIM_CLKGEN_GetConfigFrameClock() to get the frame clock generator configuration.
Call HAL_GFXTIM_CLKGEN_ForceReloadCounter() to force reload the clock generator counter(s).
Call HAL_GFXTIM_CLKGEN_EnableLineClkCalibOutput() to enable the line clock calibration output.
Call HAL_GFXTIM_CLKGEN_DisableLineClkCalibOutput() to disable the line clock calibration output.
Call HAL_GFXTIM_CLKGEN_IsEnabledLineClkCalibOutput() to check that line clock calibration output is enabled.
Call HAL_GFXTIM_CLKGEN_EnableFrameClkCalibOutput() to enable the frame clock calibration output.
Call HAL_GFXTIM_CLKGEN_DisableFrameClkCalibOutput() to disable the frame clock calibration output.
Call HAL_GFXTIM_CLKGEN_IsEnabledFrameClkCalibOutput() to check that frame clock calibration output is enabled.

Functions

hal_status_t HAL_GFXTIM_CLKGEN_SetConfigLineFrameClock ( hal_gfxtim_handle_t * hgfxtim , const hal_gfxtim_clkgen_frame_config_t * p_frame_clk_config , const hal_gfxtim_clkgen_line_config_t * p_line_clk_config ) ¶

Configure the line and frame clock generator.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_line_clk_config – Pointer to hal_gfxtim_clkgen_line_config_t configuration structure.
p_frame_clk_config – Pointer to hal_gfxtim_clkgen_frame_config_t configuration structure.

Return values :

HAL_INVALID_PARAM – Invalid parameter when p_line_clk_config and/or p_frame_clk_config pointer are NULL.
HAL_OK – The Clock generator is successfully configured.

void HAL_GFXTIM_CLKGEN_GetConfigLineClock ( const hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_clkgen_line_config_t * p_config ) ¶

Get the line clock generator configuration.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_config – Pointer to hal_gfxtim_clkgen_line_config_t structure that will be filled by the line clock generator configuration.

hal_status_t HAL_GFXTIM_CLKGEN_SetConfigFrameClock ( hal_gfxtim_handle_t * hgfxtim , const hal_gfxtim_clkgen_frame_config_t * p_clk_config ) ¶

Configure the frame clock generator.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_clk_config – Pointer to hal_gfxtim_clkgen_frame_config_t configuration structure.

Return values :

HAL_INVALID_PARAM – Invalid parameter when p_clk_config pointer is NULL.
HAL_OK – The frame clock generator is successfully configured.

void HAL_GFXTIM_CLKGEN_GetConfigFrameClock ( const hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_clkgen_frame_config_t * p_config ) ¶

Get the frame clock generator configuration.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_config – Pointer to hal_gfxtim_clkgen_frame_config_t structure that will be filled by the frame clock generator configuration.

hal_status_t HAL_GFXTIM_CLKGEN_ForceReloadCounter ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_clkgen_counter_t counter ) ¶

Force reload the clock generator counter(s).

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
counter – This parameter is an element of hal_gfxtim_clkgen_counter_t enumeration.

Return values :

HAL_OK – The clcok generator counter is successfully force reloaded.

hal_status_t HAL_GFXTIM_CLKGEN_EnableLineClkCalibOutput ( hal_gfxtim_handle_t * hgfxtim ) ¶

Enable the line clock calibration output.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: HAL_OK – The line clock generator calibration output is successfully enabled.

hal_status_t HAL_GFXTIM_CLKGEN_DisableLineClkCalibOutput ( hal_gfxtim_handle_t * hgfxtim ) ¶

Disable the line clock calibration output.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: HAL_OK – The line clock generator calibration output is successfully disabled.

hal_gfxtim_clkgen_line_clk_calib_status_t HAL_GFXTIM_CLKGEN_IsEnabledLineClkCalibOutput ( hal_gfxtim_handle_t * hgfxtim ) ¶

Check that clock generator line clock calibration output is enabled or disabled.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: hal_gfxtim_clkgen_line_clk_calib_status_t – Line clock calibration output activation.

hal_status_t HAL_GFXTIM_CLKGEN_EnableFrameClkCalibOutput ( hal_gfxtim_handle_t * hgfxtim ) ¶

Enable the frame clock calibration output.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: HAL_OK – The frame clock generator calibration output is successfully enabled.

hal_status_t HAL_GFXTIM_CLKGEN_DisableFrameClkCalibOutput ( hal_gfxtim_handle_t * hgfxtim ) ¶

Disable the frame clock calibration output.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: HAL_OK – The frame clock generator calibration output is successfully disabled.

hal_gfxtim_clkgen_frame_clk_calib_status_t HAL_GFXTIM_CLKGEN_IsEnabledFrameClkCalibOutput ( hal_gfxtim_handle_t * hgfxtim ) ¶

Check that clock generator frame clock calibration output is enabled or disabled.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: hal_gfxtim_clkgen_frame_clk_calib_status_t – Frame clock calibration output activation.

Tearing-effect configuration functions ¶

group GFXTIM_Exported_Functions_Group3

This subsection provides a set of functions allowing to manage the tearing-effect detection:

Call HAL_GFXTIM_SetConfigTearingEffect() to configure the tearing-effect source and polarity.
Call HAL_GFXTIM_GetConfigTearingEffect() to get the tearing-effect configuration.
Call HAL_GFXTIM_EnableTearingEffectIT() to enable the tearing-effect detection interruption.
Call HAL_GFXTIM_DisableTearingEffectIT() to disable the tearing-effect detection interruption.
Call HAL_GFXTIM_IsEnabledTearingEffectIT() to check that tearing-effect detection interruption is enabled.

Functions

hal_status_t HAL_GFXTIM_SetConfigTearingEffect ( hal_gfxtim_handle_t * hgfxtim , const hal_gfxtim_tearing_effect_config_t * p_config ) ¶

Configure the tearing-effect detection.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_config – Pointer to hal_gfxtim_tearing_effect_config_t configuration structure.

Return values :

HAL_INVALID_PARAM – Invalid parameter when p_config pointer is NULL.
HAL_OK – The Tearing-effect is successfully configured.

void HAL_GFXTIM_GetConfigTearingEffect ( const hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_tearing_effect_config_t * p_config ) ¶

Get the tearing-effect detection configuration.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_config – Pointer to hal_gfxtim_tearing_effect_config_t structure that will be filled by the GFXTIM tearing-effect configuration.

hal_status_t HAL_GFXTIM_EnableTearingEffectIT ( hal_gfxtim_handle_t * hgfxtim ) ¶

Enable the tearing-effect detection interruption.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: HAL_OK – The tearing-effect interruption is successfully enabled.

hal_status_t HAL_GFXTIM_DisableTearingEffectIT ( hal_gfxtim_handle_t * hgfxtim ) ¶

Disable the tearing-effect detection interruption.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: HAL_OK – The tearing-effect interruption is successfully disabled.

hal_gfxtim_tearing_effect_it_status_t HAL_GFXTIM_IsEnabledTearingEffectIT ( hal_gfxtim_handle_t * hgfxtim ) ¶

Check that tearing-effect detection interruption is enabled or disabled.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: hal_gfxtim_tearing_effect_it_status_t – Tearing-effect detection interruption activation.

Absolute Timer functions ¶

group GFXTIM_Exported_Functions_Group4

This subsection provides a set of functions allowing to manage the absolute timers:

Call HAL_GFXTIM_ABSTIM_SetLineCompareValue() to set the absolute line compare value.
Call HAL_GFXTIM_ABSTIM_GetLineCompareValue() to get the absolute line compare value.
Call HAL_GFXTIM_ABSTIM_SetLineCounter() to set the absolute line counter value.
Call HAL_GFXTIM_ABSTIM_GetLineCounter() to get the absolute line counter value.
Call HAL_GFXTIM_ABSTIM_SetFrameCompareValue() to set the absolute frame compare value.
Call HAL_GFXTIM_ABSTIM_GetFrameCompareValue() to get the absolute frame compare value.
Call HAL_GFXTIM_ABSTIM_SetFrameCounter() to set the absolute frame counter value.
Call HAL_GFXTIM_ABSTIM_GetFrameCounter() to get the absolute frame counter value.
Call HAL_GFXTIM_ABSTIM_Start() to start the absolute line and/ or frame counter(s).
Call HAL_GFXTIM_ABSTIM_Stop() to stop the absolute line and/ or frame counter(s).
Call HAL_GFXTIM_ABSTIM_Pause() to pause the absolute line and/ or frame counter(s).
Call HAL_GFXTIM_ABSTIM_Resume() to resume the absolute line and/ or frame counter(s).
Call HAL_GFXTIM_ABSTIM_GetCounter() to Get the absolute line and frame counters value simultaneously.

Functions

hal_status_t HAL_GFXTIM_ABSTIM_SetLineCompareValue ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_abstim_line_comp_t line_comp , uint32_t val ) ¶

Set the absolute line compare value.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
line_comp – This parameter is an element of hal_gfxtim_abstim_line_comp_t enumeration.
val – This parameter can be a number between 0x000 and 0xFFF.

Return values :

HAL_OK – Absolute line compare value is successfully configured.

uint32_t HAL_GFXTIM_ABSTIM_GetLineCompareValue ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_abstim_line_comp_t line_comp ) ¶

Get the absolute line compare value.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
line_comp – This parameter is an element of hal_gfxtim_abstim_line_comp_t enumeration.

Return values :

uint32_t – Value of the absolute line compare.

hal_status_t HAL_GFXTIM_ABSTIM_SetLineCounter ( const hal_gfxtim_handle_t * hgfxtim , uint32_t val ) ¶

Set the absolute line counter value.

Note

The value of the absolute line counter can only be set when the absolute line counter is disabled.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
val – This parameter can be a number between 0x000 and 0xFFF.

Return values :

HAL_ERROR – The absolute line counter is already enabled.
HAL_OK – Absolute line counter value is successfully set.

uint32_t HAL_GFXTIM_ABSTIM_GetLineCounter ( hal_gfxtim_handle_t * hgfxtim ) ¶

Get the absolute line counter value.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: uint32_t – Value of the absolute line counter value.

hal_status_t HAL_GFXTIM_ABSTIM_SetFrameCompareValue ( hal_gfxtim_handle_t * hgfxtim , uint32_t val ) ¶

Set the absolute frame compare value.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
val – This parameter can be a number between 0x00000 and 0xFFFFF.

Return values :

HAL_OK – Absolute frame compare is successfully set.

uint32_t HAL_GFXTIM_ABSTIM_GetFrameCompareValue ( hal_gfxtim_handle_t * hgfxtim ) ¶

Get the absolute frame compare value.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: uint32_t – Value of the absolute frame compare value.

hal_status_t HAL_GFXTIM_ABSTIM_SetFrameCounter ( const hal_gfxtim_handle_t * hgfxtim , uint32_t val ) ¶

Start the absolute frame counter value.

Note

The value of the absolute frame counter can only be set when the absolute frame counter is disabled.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
val – This parameter can be a number between 0x000 and 0xFFF.

Return values :

HAL_ERROR – The absolute frame counter is already enabled.
HAL_OK – The Absolute frame counter is successfully set.

uint32_t HAL_GFXTIM_ABSTIM_GetFrameCounter ( hal_gfxtim_handle_t * hgfxtim ) ¶

Get the absolute frame counter value.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: uint32_t – Value of the absolute line counter value.

hal_status_t HAL_GFXTIM_ABSTIM_Start ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_abstim_counter_t counter , uint32_t interrupts ) ¶

Start the absolute timer(s).

Note

The interruptions are activated according to the chosen counter.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
counter – This parameter is an element of hal_gfxtim_abstim_counter_t enumeration.
interrupts – This parameter can be one or a combination of the following values:
- HAL_GFXTIM_NONE_IT : No interruption.
- HAL_GFXTIM_ABSTIM_LINE_COMP1_IT : Absolute line counter compare 1 interruption.
- HAL_GFXTIM_ABSTIM_LINE_COMP2_IT : Absolute line counter compare 2 interruption.
- HAL_GFXTIM_ABSTIM_LINE_COUNT_OVERFLOW_IT : Absolute line counter overflow interruption.
- HAL_GFXTIM_ABSTIM_LINE_ALL_IT : All absolute line counter interruptions.
- HAL_GFXTIM_ABSTIM_FRAME_COMP_IT : Absolute frame counter compare 1 interruption.
- HAL_GFXTIM_ABSTIM_FRAME_COUNT_OVERFLOW_IT: Absolute frame counter overflow interruption.
- HAL_GFXTIM_ABSTIM_FRAME_ALL_IT : All absolute frame counter interruptions.

Return values :

HAL_OK – Absolute timer counter is successfully started.

hal_status_t HAL_GFXTIM_ABSTIM_Stop ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_abstim_counter_t counter ) ¶

Stop the absolute timer(s).

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
counter – This parameter is an element of hal_gfxtim_abstim_counter_t enumeration.

Return values :

HAL_OK – Absolute line counter is successfully stopped.

hal_status_t HAL_GFXTIM_ABSTIM_Pause ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_abstim_counter_t counter ) ¶

Pause the absolute timer(s).

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
counter – This parameter is an element of hal_gfxtim_abstim_counter_t enumeration.

Return values :

HAL_OK – Absolute line counter is successfully paused.

hal_status_t HAL_GFXTIM_ABSTIM_Resume ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_abstim_counter_t counter ) ¶

Resume the absolute timer(s).

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
counter – This parameter is an element of hal_gfxtim_abstim_counter_t enumeration.

Return values :

HAL_OK – Absolute line counter is successfully resumed.

hal_status_t HAL_GFXTIM_ABSTIM_Reset ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_abstim_counter_t counter ) ¶

Force reset the absolute counter(s).

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
counter – This parameter is an element of hal_gfxtim_abstim_counter_t enumeration.

Return values :

HAL_OK – Absolute line counter is successfully resumed.

void HAL_GFXTIM_ABSTIM_GetCounter ( hal_gfxtim_handle_t * hgfxtim , uint32_t * p_frame , uint32_t * p_line ) ¶

Get the absolute line and frame counters value simultaneously.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_frame – Pointer to the absolute frame counter.
p_line – Pointer to the absolute line counter.

Relative Timer functions ¶

group GFXTIM_Exported_Functions_Group5

This subsection provides a set of functions allowing to manage the relative timers:

Call HAL_GFXTIM_RELTIM_StartContinuous() to start the relative frame counter in continuous mode.
Call HAL_GFXTIM_RELTIM_StopContinuous() to stop the relative frame counter in continuous mode.
Call HAL_GFXTIM_RELTIM_SetReloadValue() to set the relative frame counter reload value.
Call HAL_GFXTIM_RELTIM_ForceReload() to force reload the relative frame counter.
Call HAL_GFXTIM_RELTIM_GetCounter() to get the relative frame counter value.
Call HAL_GFXTIM_RELTIM_StartOneShot() to start the relative frame counter in one shot mode.
Call HAL_GFXTIM_RELTIM_PollForOneShot() to poll the relative frame counter for one shot mode.

Functions

hal_status_t HAL_GFXTIM_RELTIM_StartContinuous ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_reltim_counter_t counter , uint32_t autoreload_val , uint32_t interrupt ) ¶

Start the relative frame counter in continuous mode.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
counter – This parameter is an element of hal_gfxtim_reltim_counter_t enumeration.
autoreload_val – Value between 0x0 and 0xFFF.
interrupt – This parameter can be one of the following values:
- HAL_GFXTIM_NONE_IT: No interruption.
- HAL_GFXTIM_RELTIM_COUNT_IT: Relative frame counter interrupt enabled.

Return values :

HAL_OK – Relative frame counter is successfully started in continuous mode.

hal_status_t HAL_GFXTIM_RELTIM_StopContinuous ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_reltim_counter_t counter ) ¶

Stop the relative frame counter in continuous mode.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
counter – This parameter is an element of hal_gfxtim_reltim_counter_t enumeration.

Return values :

HAL_OK – Relative frame counter is successfully stopped.

hal_status_t HAL_GFXTIM_RELTIM_ForceReload ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_reltim_counter_t counter ) ¶

Force reload the relative frame counter.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
counter – This parameter is an element of hal_gfxtim_reltim_counter_t enumeration.

Return values :

HAL_OK – Relative frame counter is successfully reload forced.

hal_status_t HAL_GFXTIM_RELTIM_SetReloadValue ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_reltim_counter_t counter , uint32_t autoreload_val ) ¶

Set the relative frame counter reload value.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
counter – This parameter is an element of hal_gfxtim_reltim_counter_t enumeration.
autoreload_val – This parameter can be a number between 0x000 and 0xFFF.

Return values :

HAL_OK – Relative frame counter is successfully reloaded.

uint32_t HAL_GFXTIM_RELTIM_GetCounter ( const hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_reltim_counter_t counter ) ¶

Get the relative frame counter value.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
counter – This parameter is an element of hal_gfxtim_reltim_counter_t enumeration.

Return values :

uint32_t – Value of the relative frame counter.

hal_status_t HAL_GFXTIM_RELTIM_StartOneShot ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_reltim_counter_t counter , uint32_t autoreload_val , uint32_t interrupt ) ¶

Start the relative frame counter in one shot mode.

Note

The interruptions are activated according to the chosen relative frame counter.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
counter – This parameter is an element of hal_gfxtim_reltim_counter_t enumeration.
autoreload_val – This parameter can be a number between 0x000 and 0xFFF.
interrupt – This parameter can be one of the following values:
- HAL_GFXTIM_NONE_IT: No interruption.
- HAL_GFXTIM_RELTIM_COUNT_IT: Relative frame counter interruption.

Return values :

HAL_OK – Relative frame counter is successfully started in one shot mode.

hal_status_t HAL_GFXTIM_RELTIM_PollForOneShot ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_reltim_counter_t counter , uint32_t timeout_ms ) ¶

Polling the relative frame counter for one shot mode.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
counter – This parameter is an element of hal_gfxtim_reltim_counter_t enumeration.
timeout_ms – Specifies the user timeout in millisecond.

Return values :

HAL_TIMEOUT – User timeout.
HAL_OK – Polling for one shot mode is successfully.

Event Generator functions ¶

group GFXTIM_Exported_Functions_Group6

This subsection provides a set of functions allowing to manage the event generator:

Call HAL_GFXTIM_EVENTGEN_SetConfig() to configure the event generator.
Call HAL_GFXTIM_EVENTGEN_GetConfig() to get the event generator configuration.
Call HAL_GFXTIM_EVENTGEN_Start() to start the event generator.
Call HAL_GFXTIM_EVENTGEN_Stop() to stop the event generator.

Functions

hal_status_t HAL_GFXTIM_EVENTGEN_SetConfig ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_eventgen_event_t event_gen , const hal_gfxtim_eventgen_config_t * p_config ) ¶

Configure the event generator.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
event_gen – This parameter is an element of hal_gfxtim_eventgen_event_t enumeration.
p_config – Pointer to hal_gfxtim_eventgen_config_t structure.

Return values :

HAL_OK – Event generator is successfully configured.

void HAL_GFXTIM_EVENTGEN_GetConfig ( const hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_eventgen_event_t event_gen , hal_gfxtim_eventgen_config_t * p_config ) ¶

Get the event generator configuration.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
event_gen – This parameter is an element of hal_gfxtim_eventgen_event_t enumeration.
p_config – Pointer to hal_gfxtim_eventgen_config_t structure that will be filled by the GFXTIM event generator configuration.

hal_status_t HAL_GFXTIM_EVENTGEN_Start ( const hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_eventgen_event_t event_gen , uint32_t interrupt ) ¶

Start the event generator.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
event_gen – This parameter is an element of hal_gfxtim_eventgen_event_t enumeration.
interrupt – This parameter can be one of the following values:
- HAL_GFXTIM_NONE_IT: No interruption.
- HAL_GFXTIM_EVENTGEN_EVENT_IT: Event Generator interruption.

Return values :

HAL_OK – Event generator is successfully started.

hal_status_t HAL_GFXTIM_EVENTGEN_Stop ( const hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_eventgen_event_t event_gen ) ¶

Stop the event generator.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
event_gen – This parameter is an element of hal_gfxtim_eventgen_event_t enumeration.

Return values :

HAL_OK – Event generator is successfully stopped.

Watchdog counter functions ¶

group GFXTIM_Exported_Functions_Group7

This subsection provides a set of functions allowing to manage the watchdog counter:

Call HAL_GFXTIM_WDG_SetConfig() to configure the watchdog counter.
Call HAL_GFXTIM_WDG_GetConfig() to get the watchdog counter configuration.
Call HAL_GFXTIM_WDG_Start() to start the watchdog counter.
Call HAL_GFXTIM_WDG_Stop() to stop the watchdog counter.
Call HAL_GFXTIM_WDG_Refresh() to refrech the watchdog counter.

Functions

hal_status_t HAL_GFXTIM_WDG_SetConfig ( hal_gfxtim_handle_t * hgfxtim , const hal_gfxtim_wdg_config_t * p_config ) ¶

Configure the GFXTIM watchdog counter.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_config – Pointer to hal_gfxtim_wdg_config_t structure.

Return values :

HAL_OK – Watchdog counter is successfully configured.

void HAL_GFXTIM_WDG_GetConfig ( const hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_wdg_config_t * p_config ) ¶

Get the watchdog counter configuration.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_config – Pointer to hal_gfxtim_wdg_config_t structure that will be filled by the GFXTIM watchdog configuration.

hal_status_t HAL_GFXTIM_WDG_Start ( hal_gfxtim_handle_t * hgfxtim , uint32_t reload_val , uint32_t prealarm_val , uint32_t interrupts ) ¶

Start the GFXTIM watchdog counter.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
reload_val – Value between 0x0 and 0xFFFF.
prealarm_val – Value between 0x0 and 0xFFFF.
interrupts – This parameter can be one or a combination of the following values:
- HAL_GFXTIM_NONE_IT: No interruption.
- HAL_GFXTIM_WDG_ALARM_IT: Watchdog alarm interruption.
- HAL_GFXTIM_WDG_PREALARM_IT: Watchdog pre-alarm interruption.
- HAL_GFXTIM_WDG_ALL_IT: All watchdog interruption.

Return values :

HAL_OK – Watchdog counter is successfully started.

hal_status_t HAL_GFXTIM_WDG_Stop ( hal_gfxtim_handle_t * hgfxtim ) ¶

Stop the watchdog counter.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: HAL_OK – Watchdog counter is successfully stopped.

hal_status_t HAL_GFXTIM_WDG_Refresh ( hal_gfxtim_handle_t * hgfxtim ) ¶

Refresh the GFXTIM watchdog counter.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: HAL_OK – The GFXTIM Watchdog counter is successfully refreshed.

Peripheral State functions ¶

group GFXTIM_Exported_Functions_Group8

This subsection provides a set of functions allowing to retrieve peripheral state:

Call HAL_GFXTIM_GetState() to return the GFXTIM global state.
Call HAL_GFXTIM_CLKGEN_GetState() to return the GFXTIM clock generator state.
Call HAL_GFXTIM_ABSTIM_GetLineState() to return the GFXTIM absolute line state.
Call HAL_GFXTIM_ABSTIM_GetFrameState() to return the GFXTIM absolute frame state.
Call HAL_GFXTIM_RELTIM_GetState() to return the GFXTIM relative frame state.
Call HAL_GFXTIM_WDG_GetState() to return the GFXTIM watchdog state.

Functions

hal_gfxtim_state_t HAL_GFXTIM_GetState ( const hal_gfxtim_handle_t * hgfxtim ) ¶

Get the GFXTIM current global state.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: hal_gfxtim_state_t – Global state.

hal_gfxtim_clkgen_state_t HAL_GFXTIM_CLKGEN_GetState ( const hal_gfxtim_handle_t * hgfxtim ) ¶

Get the GFXTIM clock generator state.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: hal_gfxtim_clkgen_state_t – Clock generator state.

hal_gfxtim_abstim_line_state_t HAL_GFXTIM_ABSTIM_GetLineState ( const hal_gfxtim_handle_t * hgfxtim ) ¶

Get the GFXTIM absolute line state.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: hal_gfxtim_abstim_line_state_t – Absolute line state.

hal_gfxtim_abstim_frame_state_t HAL_GFXTIM_ABSTIM_GetFrameState ( const hal_gfxtim_handle_t * hgfxtim ) ¶

Get the GFXTIM absolute frame state.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: hal_gfxtim_abstim_frame_state_t – Absolute frame state.

hal_gfxtim_reltim_state_t HAL_GFXTIM_RELTIM_GetState ( const hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_reltim_counter_t counter ) ¶

Get the GFXTIM relative frame state.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
counter – This parameter is an element of hal_gfxtim_reltim_counter_t enumeration.

Return values :

hal_gfxtim_reltim_state_t – Relative frame x (1 or 2) state.

hal_gfxtim_wdg_state_t HAL_GFXTIM_WDG_GetState ( const hal_gfxtim_handle_t * hgfxtim ) ¶

Get the GFXTIM watchdog counter state.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: hal_gfxtim_wdg_state_t – Watchdog counter state.

IRQHandler and Callbacks functions ¶

group GFXTIM_Exported_Functions_Group9

This subsection provides the IRQ handler APIs allowing to handle GFXTIM interruptions and register user Callbacks APIs:

Call HAL_GFXTIM_IRQHandler() to handle all GFXTIM interrupts.
Call HAL_GFXTIM_TearingEffectIRQHandler() to handle only the tearing-effect interrupt.
Call HAL_GFXTIM_ABSTIM_FrameIRQHandler() to handle only the absolute frame interrupts.
Call HAL_GFXTIM_ABSTIM_LineIRQHandler() to handle only the absolute line interrupts.
Call HAL_GFXTIM_RELTIM_IRQHandler() to handle only the relative framed interrupts.
Call HAL_GFXTIM_EVENTGEN_IRQHandler() to handle only the event generator interrupts.
Call HAL_GFXTIM_WDG_IRQHandler() to handle only the GFXTIM watchdog interrupts.
Call HAL_GFXTIM_RegisterTearingEffectCallback() to register the tearing-effect callback.
Call HAL_GFXTIM_ABSTIM_RegisterFCmpCallback() to register the absolute frame counter compare 1 callback.
Call HAL_GFXTIM_ABSTIM_RegisterFCntOverFlowCallback() to register the absolute frame counter overflow callback.
Call HAL_GFXTIM_ABSTIM_RegisterLCmpCallback() to register the absolute line counter compares callback.
Call HAL_GFXTIM_ABSTIM_RegisterLCntOverFlowCallback() to register the absolute line counter overflow callback.
Call HAL_GFXTIM_RELTIM_RegisterFCntReloadCallback() to register the relative frame counter reload callback.
Call HAL_GFXTIM_EVENTGEN_RegisterEventCallback() to register the event generator callback.
Call HAL_GFXTIM_WDG_RegisterAlarmCallback() to register the watchdog alarm callback.
Call HAL_GFXTIM_WDG_RegisterPreAlarmCallback() to register the watchdog pre-alarm callback.

Functions

void HAL_GFXTIM_IRQHandler ( hal_gfxtim_handle_t * hgfxtim ) ¶

Handle the GFXTIM interrupt request.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.

void HAL_GFXTIM_TearingEffectIRQHandler ( hal_gfxtim_handle_t * hgfxtim ) ¶

Handle the GFXTIM tearing-effect interrupt request.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.

void HAL_GFXTIM_ABSTIM_FrameIRQHandler ( hal_gfxtim_handle_t * hgfxtim ) ¶

Handle the GFXTIM absolute frame interrupts request.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.

void HAL_GFXTIM_ABSTIM_LineIRQHandler ( hal_gfxtim_handle_t * hgfxtim ) ¶

Handle the GFXTIM absolute line interrupts request.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.

void HAL_GFXTIM_RELTIM_IRQHandler ( hal_gfxtim_handle_t * hgfxtim ) ¶

Handle the GFXTIM relative frame interrupts request.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.

void HAL_GFXTIM_EVENTGEN_IRQHandler ( hal_gfxtim_handle_t * hgfxtim ) ¶

Handle the GFXTIM event generator interrupts request.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.

void HAL_GFXTIM_WDG_IRQHandler ( hal_gfxtim_handle_t * hgfxtim ) ¶

Handle the GFXTIM watchdog timer interrupts request.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.

void HAL_GFXTIM_TearingEffectCallback ( hal_gfxtim_handle_t * hgfxtim ) ¶

GFXTIM Tearing-effect callback.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.

void HAL_GFXTIM_ABSTIM_FCmpCallback ( hal_gfxtim_handle_t * hgfxtim ) ¶

GFXTIM Absolute frame counter compare callback.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.

void HAL_GFXTIM_ABSTIM_FCntOverFlowCallback ( hal_gfxtim_handle_t * hgfxtim ) ¶

GFXTIM Absolute frame counter overflow callback.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.

void HAL_GFXTIM_ABSTIM_LCmpCallback ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_abstim_line_comp_t line_comp ) ¶

GFXTIM Absolute line counter compares callback.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
line_comp – This parameter is an element of hal_gfxtim_abstim_line_comp_t enumeration.

void HAL_GFXTIM_ABSTIM_LCntOverFlowCallback ( hal_gfxtim_handle_t * hgfxtim ) ¶

GFXTIM Absolute line counter overflow callback.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.

void HAL_GFXTIM_RELTIM_FCntReloadCallback ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_reltim_counter_t counter ) ¶

GFXTIM Relative frame counters reload callback.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
counter – This parameter is an element of hal_gfxtim_reltim_counter_t enumeration.

void HAL_GFXTIM_EVENTGEN_EventCallback ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_eventgen_event_t event_gen ) ¶

GFXTIM Event generator callback.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
event_gen – This parameter is an element of hal_gfxtim_eventgen_event_t enumeration.

void HAL_GFXTIM_WDG_AlarmCallback ( hal_gfxtim_handle_t * hgfxtim ) ¶

GFXTIM Watchdog alarm callback.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.

void HAL_GFXTIM_WDG_PreAlarmCallback ( hal_gfxtim_handle_t * hgfxtim ) ¶

GFXTIM Watchdog pre-alarm callback.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.

hal_status_t HAL_GFXTIM_RegisterTearingEffectCallback ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_cb_t p_callback ) ¶

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_callback – Specifies the tearing effect callback.

Return values :

HAL_INVALID_PARAM – Invalid parameter when p_callback pointer is NULL.
HAL_OK – GFXTIM tearing-effect callback is successfully registered.

hal_status_t HAL_GFXTIM_ABSTIM_RegisterFCmpCallback ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_cb_t p_callback ) ¶

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_callback – Specifies the absolute frame counter compare callback.

Return values :

HAL_INVALID_PARAM – Invalid parameter when p_callback pointer is NULL.
HAL_OK – GFXTIM absolute frame counter compare callback is successfully registered.

hal_status_t HAL_GFXTIM_ABSTIM_RegisterFCntOverFlowCallback ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_cb_t p_callback ) ¶

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_callback – Specifies the absolute frame counter overflow callback.

Return values :

HAL_INVALID_PARAM – Invalid parameter when p_callback pointer is NULL.
HAL_OK – GFXTIM absolute frame counter overflow callback is successfully registered.

hal_status_t HAL_GFXTIM_ABSTIM_RegisterLCmpCallback ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_line_cb_t p_callback ) ¶

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_callback – Specifies the absolute line counter compare callback.

Return values :

HAL_INVALID_PARAM – Invalid parameter when p_callback pointer is NULL.
HAL_OK – GFXTIM absolute line counter compares callback is successfully registered.

hal_status_t HAL_GFXTIM_ABSTIM_RegisterLCntOverFlowCallback ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_cb_t p_callback ) ¶

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_callback – Specifies the absolute line counter overflow callback.

Return values :

HAL_INVALID_PARAM – Invalid parameter when p_callback pointer is NULL.
HAL_OK – GFXTIM absolute line counter overflow callback is successfully registered.

hal_status_t HAL_GFXTIM_RELTIM_RegisterFCntReloadCallback ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_frame_cb_t p_callback ) ¶

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_callback – Specifies the relative frame counter reload callback.

Return values :

HAL_INVALID_PARAM – Invalid parameter when p_callback pointer is NULL.
HAL_OK – GFXTIM relative frame counter reload callback is successfully registered.

hal_status_t HAL_GFXTIM_EVENTGEN_RegisterEventCallback ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_eventgen_cb_t p_callback ) ¶

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_callback – Specifies the event generator callback.

Return values :

HAL_INVALID_PARAM – Invalid parameter when p_callback pointer is NULL.
HAL_OK – GFXTIM event generator callback is successfully registered.

hal_status_t HAL_GFXTIM_WDG_RegisterAlarmCallback ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_cb_t p_callback ) ¶

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_callback – Specifies the watchdog alarm callback.

Return values :

HAL_INVALID_PARAM – Invalid parameter when p_callback pointer is NULL.
HAL_OK – GFXTIM watchdog alarm callback is successfully registered.

hal_status_t HAL_GFXTIM_WDG_RegisterPreAlarmCallback ( hal_gfxtim_handle_t * hgfxtim , hal_gfxtim_cb_t p_callback ) ¶

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_callback – Specifies the watchdog pre-alarm callback.

Return values :

HAL_INVALID_PARAM – Invalid parameter when p_callback pointer is NULL.
HAL_OK – GFXTIM watchdog pre-alarm callback is successfully registered.

Set/Get user data functions ¶

group GFXTIM_Exported_Functions_Group10

This subsection provides a set of functions allowing to manage the user data pointer:

Call HAL_GFXTIM_SetUserData() to set the GFXTIM user data in GFXTIM handle.
Call HAL_GFXTIM_GetUserData() to get the GFXTIM user data from GFXTIM handle.

Functions

void HAL_GFXTIM_SetUserData ( hal_gfxtim_handle_t * hgfxtim , const void * p_user_data ) ¶

Store the user data into the GFXTIM handle.

Parameters :

hgfxtim – Pointer to hal_gfxtim_handle_t structure.
p_user_data – Pointer to the user data.

const void * HAL_GFXTIM_GetUserData ( const hal_gfxtim_handle_t * hgfxtim ) ¶

Retrieve the user data from the GFXTIM handle.

Parameters :: hgfxtim – Pointer to hal_gfxtim_handle_t structure.
Return values :: Pointer – to the user data.