STM32F479xx HAL User Manual
Data Structures | Modules | Typedefs | Enumerations | Functions
DSI
STM32F4xx_HAL_Driver

DSI HAL module driver. More...

Data Structures

struct  DSI_InitTypeDef
 DSI Init Structure definition. More...
struct  DSI_PLLInitTypeDef
 DSI PLL Clock structure definition. More...
struct  DSI_VidCfgTypeDef
 DSI Video mode configuration. More...
struct  DSI_CmdCfgTypeDef
 DSI Adapted command mode configuration. More...
struct  DSI_LPCmdTypeDef
 DSI command transmission mode configuration. More...
struct  DSI_PHY_TimerTypeDef
 DSI PHY Timings definition. More...
struct  DSI_HOST_TimeoutTypeDef
 DSI HOST Timeouts definition. More...
struct  __DSI_HandleTypeDef
 DSI Handle Structure definition. More...

Modules

 DSI Exported Constants
 DSI Exported Macros
 DSI Exported Functions
 DSI Private Types
 DSI Private Defines
 DSI Private Variables
 DSI Private Constants
 DSI Private Macros
 DSI Private Functions Prototypes
 DSI Private Functions

Typedefs

typedef struct __DSI_HandleTypeDef DSI_HandleTypeDef
 DSI Handle Structure definition.
typedef void(* pDSI_CallbackTypeDef )(DSI_HandleTypeDef *hdsi)
 HAL DSI Callback pointer definition.

Enumerations

enum  HAL_DSI_StateTypeDef {
  HAL_DSI_STATE_RESET = 0x00U, HAL_DSI_STATE_READY = 0x01U, HAL_DSI_STATE_ERROR = 0x02U, HAL_DSI_STATE_BUSY = 0x03U,
  HAL_DSI_STATE_TIMEOUT = 0x04U
}
 DSI States Structure definition. More...
enum  HAL_DSI_CallbackIDTypeDef {
  HAL_DSI_MSPINIT_CB_ID = 0x00U, HAL_DSI_MSPDEINIT_CB_ID = 0x01U, HAL_DSI_TEARING_EFFECT_CB_ID = 0x02U, HAL_DSI_ENDOF_REFRESH_CB_ID = 0x03U,
  HAL_DSI_ERROR_CB_ID = 0x04U
}
 HAL DSI Callback ID enumeration definition. More...

Functions

static void DSI_ConfigPacketHeader (DSI_TypeDef *DSIx, uint32_t ChannelID, uint32_t DataType, uint32_t Data0, uint32_t Data1)
 Generic DSI packet header configuration.
static HAL_StatusTypeDef DSI_ShortWrite (DSI_HandleTypeDef *hdsi, uint32_t ChannelID, uint32_t Mode, uint32_t Param1, uint32_t Param2)
 write short DCS or short Generic command

Detailed Description

DSI HAL module driver.


Typedef Documentation

DSI Handle Structure definition.

typedef void(* pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi)

HAL DSI Callback pointer definition.

pointer to an DSI callback function

Definition at line 346 of file stm32f4xx_hal_dsi.h.


Enumeration Type Documentation

HAL DSI Callback ID enumeration definition.

Enumerator:
HAL_DSI_MSPINIT_CB_ID 

DSI MspInit callback ID

HAL_DSI_MSPDEINIT_CB_ID 

DSI MspDeInit callback ID

HAL_DSI_TEARING_EFFECT_CB_ID 

DSI Tearing Effect Callback ID

HAL_DSI_ENDOF_REFRESH_CB_ID 

DSI End Of Refresh Callback ID

HAL_DSI_ERROR_CB_ID 

DSI Error Callback ID

Definition at line 332 of file stm32f4xx_hal_dsi.h.

DSI States Structure definition.

Enumerator:
HAL_DSI_STATE_RESET 
HAL_DSI_STATE_READY 
HAL_DSI_STATE_ERROR 
HAL_DSI_STATE_BUSY 
HAL_DSI_STATE_TIMEOUT 

Definition at line 291 of file stm32f4xx_hal_dsi.h.


Function Documentation

static void DSI_ConfigPacketHeader ( DSI_TypeDef *  DSIx,
uint32_t  ChannelID,
uint32_t  DataType,
uint32_t  Data0,
uint32_t  Data1 
) [static]

Generic DSI packet header configuration.

Parameters:
DSIxPointer to DSI register base
ChannelIDVirtual channel ID of the header packet
DataTypePacket data type of the header packet This parameter can be any value of :
  • DSI_SHORT_WRITE_PKT_Data_Type
  • DSI_LONG_WRITE_PKT_Data_Type
  • DSI_SHORT_READ_PKT_Data_Type
  • DSI_MAX_RETURN_PKT_SIZE
Data0Word count LSB
Data1Word count MSB
Return values:
None

Definition at line 223 of file stm32f4xx_hal_dsi.c.

Referenced by HAL_DSI_LongWrite(), and HAL_DSI_Read().

static HAL_StatusTypeDef DSI_ShortWrite ( DSI_HandleTypeDef hdsi,
uint32_t  ChannelID,
uint32_t  Mode,
uint32_t  Param1,
uint32_t  Param2 
) [static]

write short DCS or short Generic command

Parameters:
hdsipointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
ChannelIDVirtual channel ID.
ModeDSI short packet data type. This parameter can be any value of
  • DSI_SHORT_WRITE_PKT_Data_Type.
Param1DSC command or first generic parameter. This parameter can be any value of
  • DSI_DCS_Command or a generic command code.
Param2DSC parameter or second generic parameter.
Return values:
HALstatus

Definition at line 246 of file stm32f4xx_hal_dsi.c.

References DSI_TIMEOUT_VALUE, HAL_GetTick(), and __DSI_HandleTypeDef::Instance.

Referenced by HAL_DSI_Read(), and HAL_DSI_ShortWrite().