STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
DSI Exported Macros
Collaboration diagram for DSI Exported Macros:

Macros

#define __HAL_DSI_RESET_HANDLE_STATE(__HANDLE__)
 Reset DSI handle state.
 
#define __HAL_DSI_ENABLE(__HANDLE__)
 Enables the DSI host.
 
#define __HAL_DSI_DISABLE(__HANDLE__)
 Disables the DSI host.
 
#define __HAL_DSI_WRAPPER_ENABLE(__HANDLE__)
 Enables the DSI wrapper.
 
#define __HAL_DSI_WRAPPER_DISABLE(__HANDLE__)
 Disable the DSI wrapper.
 
#define __HAL_DSI_PLL_ENABLE(__HANDLE__)
 Enables the DSI PLL.
 
#define __HAL_DSI_PLL_DISABLE(__HANDLE__)
 Disables the DSI PLL.
 
#define __HAL_DSI_REG_ENABLE(__HANDLE__)
 Enables the DSI regulator.
 
#define __HAL_DSI_REG_DISABLE(__HANDLE__)
 Disables the DSI regulator.
 
#define __HAL_DSI_GET_FLAG(__HANDLE__, __FLAG__)
 Get the DSI pending flags.
 
#define __HAL_DSI_CLEAR_FLAG(__HANDLE__, __FLAG__)
 Clears the DSI pending flags.
 
#define __HAL_DSI_ENABLE_IT(__HANDLE__, __INTERRUPT__)
 Enables the specified DSI interrupts.
 
#define __HAL_DSI_DISABLE_IT(__HANDLE__, __INTERRUPT__)
 Disables the specified DSI interrupts.
 
#define __HAL_DSI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
 Checks whether the specified DSI interrupt source is enabled or not.
 

Detailed Description

Macro Definition Documentation

◆ __HAL_DSI_RESET_HANDLE_STATE

#define __HAL_DSI_RESET_HANDLE_STATE ( __HANDLE__)

#include <stm32f4xx_hal_dsi.h>

Value:
((__HANDLE__)->State = HAL_DSI_STATE_RESET)
@ HAL_DSI_STATE_RESET

Reset DSI handle state.

Parameters
__HANDLE__DSI handle
Return values
None

Definition at line 942 of file stm32f4xx_hal_dsi.h.

◆ __HAL_DSI_ENABLE

#define __HAL_DSI_ENABLE ( __HANDLE__)

#include <stm32f4xx_hal_dsi.h>

Value:
do { \
__IO uint32_t tmpreg = 0x00U; \
SET_BIT((__HANDLE__)->Instance->CR, DSI_CR_EN);\
/* Delay after an DSI Host enabling */ \
tmpreg = READ_BIT((__HANDLE__)->Instance->CR, DSI_CR_EN);\
UNUSED(tmpreg); \
} while(0U)

Enables the DSI host.

Parameters
__HANDLE__DSI handle
Return values
None.

Definition at line 950 of file stm32f4xx_hal_dsi.h.

Referenced by HAL_DSI_Init(), and HAL_DSI_Start().

◆ __HAL_DSI_DISABLE

#define __HAL_DSI_DISABLE ( __HANDLE__)

#include <stm32f4xx_hal_dsi.h>

Value:
do { \
__IO uint32_t tmpreg = 0x00U; \
CLEAR_BIT((__HANDLE__)->Instance->CR, DSI_CR_EN);\
/* Delay after an DSI Host disabling */ \
tmpreg = READ_BIT((__HANDLE__)->Instance->CR, DSI_CR_EN);\
UNUSED(tmpreg); \
} while(0U)

Disables the DSI host.

Parameters
__HANDLE__DSI handle
Return values
None.

Definition at line 963 of file stm32f4xx_hal_dsi.h.

Referenced by HAL_DSI_DeInit(), HAL_DSI_Init(), and HAL_DSI_Stop().

◆ __HAL_DSI_WRAPPER_ENABLE

#define __HAL_DSI_WRAPPER_ENABLE ( __HANDLE__)

#include <stm32f4xx_hal_dsi.h>

Value:
do { \
__IO uint32_t tmpreg = 0x00U; \
SET_BIT((__HANDLE__)->Instance->WCR, DSI_WCR_DSIEN);\
/* Delay after an DSI wrapper enabling */ \
tmpreg = READ_BIT((__HANDLE__)->Instance->WCR, DSI_WCR_DSIEN);\
UNUSED(tmpreg); \
} while(0U)

Enables the DSI wrapper.

Parameters
__HANDLE__DSI handle
Return values
None.

Definition at line 976 of file stm32f4xx_hal_dsi.h.

Referenced by HAL_DSI_Start().

◆ __HAL_DSI_WRAPPER_DISABLE

#define __HAL_DSI_WRAPPER_DISABLE ( __HANDLE__)

#include <stm32f4xx_hal_dsi.h>

Value:
do { \
__IO uint32_t tmpreg = 0x00U; \
CLEAR_BIT((__HANDLE__)->Instance->WCR, DSI_WCR_DSIEN);\
/* Delay after an DSI wrapper disabling*/ \
tmpreg = READ_BIT((__HANDLE__)->Instance->WCR, DSI_WCR_DSIEN);\
UNUSED(tmpreg); \
} while(0U)

Disable the DSI wrapper.

Parameters
__HANDLE__DSI handle
Return values
None.

Definition at line 989 of file stm32f4xx_hal_dsi.h.

Referenced by HAL_DSI_DeInit(), and HAL_DSI_Stop().

◆ __HAL_DSI_PLL_ENABLE

#define __HAL_DSI_PLL_ENABLE ( __HANDLE__)

#include <stm32f4xx_hal_dsi.h>

Value:
do { \
__IO uint32_t tmpreg = 0x00U; \
SET_BIT((__HANDLE__)->Instance->WRPCR, DSI_WRPCR_PLLEN);\
/* Delay after an DSI PLL enabling */ \
tmpreg = READ_BIT((__HANDLE__)->Instance->WRPCR, DSI_WRPCR_PLLEN);\
UNUSED(tmpreg); \
} while(0U)

Enables the DSI PLL.

Parameters
__HANDLE__DSI handle
Return values
None.

Definition at line 1002 of file stm32f4xx_hal_dsi.h.

Referenced by HAL_DSI_ExitULPM(), HAL_DSI_ExitULPMData(), and HAL_DSI_Init().

◆ __HAL_DSI_PLL_DISABLE

#define __HAL_DSI_PLL_DISABLE ( __HANDLE__)

#include <stm32f4xx_hal_dsi.h>

Value:
do { \
__IO uint32_t tmpreg = 0x00U; \
CLEAR_BIT((__HANDLE__)->Instance->WRPCR, DSI_WRPCR_PLLEN);\
/* Delay after an DSI PLL disabling */ \
tmpreg = READ_BIT((__HANDLE__)->Instance->WRPCR, DSI_WRPCR_PLLEN);\
UNUSED(tmpreg); \
} while(0U)

Disables the DSI PLL.

Parameters
__HANDLE__DSI handle
Return values
None.

Definition at line 1015 of file stm32f4xx_hal_dsi.h.

Referenced by HAL_DSI_DeInit(), and HAL_DSI_EnterULPM().

◆ __HAL_DSI_REG_ENABLE

#define __HAL_DSI_REG_ENABLE ( __HANDLE__)

#include <stm32f4xx_hal_dsi.h>

Value:
do { \
__IO uint32_t tmpreg = 0x00U; \
SET_BIT((__HANDLE__)->Instance->WRPCR, DSI_WRPCR_REGEN);\
/* Delay after an DSI regulator enabling */ \
tmpreg = READ_BIT((__HANDLE__)->Instance->WRPCR, DSI_WRPCR_REGEN);\
UNUSED(tmpreg); \
} while(0U)

Enables the DSI regulator.

Parameters
__HANDLE__DSI handle
Return values
None.

Definition at line 1028 of file stm32f4xx_hal_dsi.h.

Referenced by HAL_DSI_Init().

◆ __HAL_DSI_REG_DISABLE

#define __HAL_DSI_REG_DISABLE ( __HANDLE__)

#include <stm32f4xx_hal_dsi.h>

Value:
do { \
__IO uint32_t tmpreg = 0x00U; \
CLEAR_BIT((__HANDLE__)->Instance->WRPCR, DSI_WRPCR_REGEN);\
/* Delay after an DSI regulator disabling */ \
tmpreg = READ_BIT((__HANDLE__)->Instance->WRPCR, DSI_WRPCR_REGEN);\
UNUSED(tmpreg); \
} while(0U)

Disables the DSI regulator.

Parameters
__HANDLE__DSI handle
Return values
None.

Definition at line 1041 of file stm32f4xx_hal_dsi.h.

Referenced by HAL_DSI_DeInit().

◆ __HAL_DSI_GET_FLAG

#define __HAL_DSI_GET_FLAG ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_dsi.h>

Value:
((__HANDLE__)->Instance->WISR & (__FLAG__))

Get the DSI pending flags.

Parameters
__HANDLE__DSI handle.
__FLAG__Get the specified flag. This parameter can be any combination of the following values:
  • DSI_FLAG_TE : Tearing Effect Interrupt Flag
  • DSI_FLAG_ER : End of Refresh Interrupt Flag
  • DSI_FLAG_BUSY : Busy Flag
  • DSI_FLAG_PLLLS: PLL Lock Status
  • DSI_FLAG_PLLL : PLL Lock Interrupt Flag
  • DSI_FLAG_PLLU : PLL Unlock Interrupt Flag
  • DSI_FLAG_RRS : Regulator Ready Flag
  • DSI_FLAG_RR : Regulator Ready Interrupt Flag
Return values
Thestate of FLAG (SET or RESET).

Definition at line 1064 of file stm32f4xx_hal_dsi.h.

Referenced by HAL_DSI_EnterULPM(), HAL_DSI_EnterULPMData(), HAL_DSI_ExitULPM(), HAL_DSI_ExitULPMData(), HAL_DSI_Init(), and HAL_DSI_IRQHandler().

◆ __HAL_DSI_CLEAR_FLAG

#define __HAL_DSI_CLEAR_FLAG ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_dsi.h>

Value:
((__HANDLE__)->Instance->WIFCR = (__FLAG__))

Clears the DSI pending flags.

Parameters
__HANDLE__DSI handle.
__FLAG__specifies the flag to clear. This parameter can be any combination of the following values:
  • DSI_FLAG_TE : Tearing Effect Interrupt Flag
  • DSI_FLAG_ER : End of Refresh Interrupt Flag
  • DSI_FLAG_PLLL : PLL Lock Interrupt Flag
  • DSI_FLAG_PLLU : PLL Unlock Interrupt Flag
  • DSI_FLAG_RR : Regulator Ready Interrupt Flag
Return values
None

Definition at line 1078 of file stm32f4xx_hal_dsi.h.

Referenced by HAL_DSI_IRQHandler().

◆ __HAL_DSI_ENABLE_IT

#define __HAL_DSI_ENABLE_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_dsi.h>

Value:
((__HANDLE__)->Instance->WIER |= (__INTERRUPT__))

Enables the specified DSI interrupts.

Parameters
__HANDLE__DSI handle.
__INTERRUPT__specifies the DSI interrupt sources to be enabled. This parameter can be any combination of the following values:
  • DSI_IT_TE : Tearing Effect Interrupt
  • DSI_IT_ER : End of Refresh Interrupt
  • DSI_IT_PLLL: PLL Lock Interrupt
  • DSI_IT_PLLU: PLL Unlock Interrupt
  • DSI_IT_RR : Regulator Ready Interrupt
Return values
None

Definition at line 1092 of file stm32f4xx_hal_dsi.h.

Referenced by HAL_DSI_ConfigAdaptedCommandMode().

◆ __HAL_DSI_DISABLE_IT

#define __HAL_DSI_DISABLE_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_dsi.h>

Value:
((__HANDLE__)->Instance->WIER &= ~(__INTERRUPT__))

Disables the specified DSI interrupts.

Parameters
__HANDLE__DSI handle
__INTERRUPT__specifies the DSI interrupt sources to be disabled. This parameter can be any combination of the following values:
  • DSI_IT_TE : Tearing Effect Interrupt
  • DSI_IT_ER : End of Refresh Interrupt
  • DSI_IT_PLLL: PLL Lock Interrupt
  • DSI_IT_PLLU: PLL Unlock Interrupt
  • DSI_IT_RR : Regulator Ready Interrupt
Return values
None

Definition at line 1106 of file stm32f4xx_hal_dsi.h.

◆ __HAL_DSI_GET_IT_SOURCE

#define __HAL_DSI_GET_IT_SOURCE ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_dsi.h>

Value:
((__HANDLE__)->Instance->WIER & (__INTERRUPT__))

Checks whether the specified DSI interrupt source is enabled or not.

Parameters
__HANDLE__DSI handle
__INTERRUPT__specifies the DSI interrupt source to check. This parameter can be one of the following values:
  • DSI_IT_TE : Tearing Effect Interrupt
  • DSI_IT_ER : End of Refresh Interrupt
  • DSI_IT_PLLL: PLL Lock Interrupt
  • DSI_IT_PLLU: PLL Unlock Interrupt
  • DSI_IT_RR : Regulator Ready Interrupt
Return values
Thestate of INTERRUPT (SET or RESET).

Definition at line 1120 of file stm32f4xx_hal_dsi.h.

Referenced by HAL_DSI_IRQHandler().