stm32l4xx_hal_dsi.h File Reference

Header file of DSI HAL module. More...

Go to the source code of this file.

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	endif
	ADC handle Structure definition. More...

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

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
HAL_StatusTypeDef	HAL_DSI_Init (DSI_HandleTypeDef *hdsi, DSI_PLLInitTypeDef *PLLInit)
	Initializes the DSI according to the specified parameters in the DSI_InitTypeDef and create the associated handle. More...
HAL_StatusTypeDef	HAL_DSI_DeInit (DSI_HandleTypeDef *hdsi)
	De-initializes the DSI peripheral registers to their default reset values. More...
void	HAL_DSI_MspInit (DSI_HandleTypeDef *hdsi)
	Initializes the DSI MSP. More...
void	HAL_DSI_MspDeInit (DSI_HandleTypeDef *hdsi)
	De-initializes the DSI MSP. More...
void	HAL_DSI_IRQHandler (DSI_HandleTypeDef *hdsi)
	Handles DSI interrupt request. More...
void	HAL_DSI_TearingEffectCallback (DSI_HandleTypeDef *hdsi)
	Tearing Effect DSI callback. More...
void	HAL_DSI_EndOfRefreshCallback (DSI_HandleTypeDef *hdsi)
	End of Refresh DSI callback. More...
void	HAL_DSI_ErrorCallback (DSI_HandleTypeDef *hdsi)
	Operation Error DSI callback. More...
HAL_StatusTypeDef	HAL_DSI_RegisterCallback (DSI_HandleTypeDef *hdsi, HAL_DSI_CallbackIDTypeDef CallbackID, pDSI_CallbackTypeDef pCallback)
	Register a User DSI Callback To be used instead of the weak predefined callback. More...
HAL_StatusTypeDef	HAL_DSI_UnRegisterCallback (DSI_HandleTypeDef *hdsi, HAL_DSI_CallbackIDTypeDef CallbackID)
	Unregister a DSI Callback DSI callabck is redirected to the weak predefined callback. More...
HAL_StatusTypeDef	HAL_DSI_SetGenericVCID (DSI_HandleTypeDef *hdsi, uint32_t VirtualChannelID)
	Configure the Generic interface read-back Virtual Channel ID. More...
HAL_StatusTypeDef	HAL_DSI_ConfigVideoMode (DSI_HandleTypeDef *hdsi, DSI_VidCfgTypeDef *VidCfg)
	Select video mode and configure the corresponding parameters. More...
HAL_StatusTypeDef	HAL_DSI_ConfigAdaptedCommandMode (DSI_HandleTypeDef *hdsi, DSI_CmdCfgTypeDef *CmdCfg)
	Select adapted command mode and configure the corresponding parameters. More...
HAL_StatusTypeDef	HAL_DSI_ConfigCommand (DSI_HandleTypeDef *hdsi, DSI_LPCmdTypeDef *LPCmd)
	Configure command transmission mode: High-speed or Low-power and enable/disable acknowledge request after packet transmission. More...
HAL_StatusTypeDef	HAL_DSI_ConfigFlowControl (DSI_HandleTypeDef *hdsi, uint32_t FlowControl)
	Configure the flow control parameters. More...
HAL_StatusTypeDef	HAL_DSI_ConfigPhyTimer (DSI_HandleTypeDef *hdsi, DSI_PHY_TimerTypeDef *PhyTimers)
	Configure the DSI PHY timer parameters. More...
HAL_StatusTypeDef	HAL_DSI_ConfigHostTimeouts (DSI_HandleTypeDef *hdsi, DSI_HOST_TimeoutTypeDef *HostTimeouts)
	Configure the DSI HOST timeout parameters. More...
HAL_StatusTypeDef	HAL_DSI_Start (DSI_HandleTypeDef *hdsi)
	Start the DSI module. More...
HAL_StatusTypeDef	HAL_DSI_Stop (DSI_HandleTypeDef *hdsi)
	Stop the DSI module. More...
HAL_StatusTypeDef	HAL_DSI_Refresh (DSI_HandleTypeDef *hdsi)
	Refresh the display in command mode. More...
HAL_StatusTypeDef	HAL_DSI_ColorMode (DSI_HandleTypeDef *hdsi, uint32_t ColorMode)
	Controls the display color mode in Video mode. More...
HAL_StatusTypeDef	HAL_DSI_Shutdown (DSI_HandleTypeDef *hdsi, uint32_t Shutdown)
	Control the display shutdown in Video mode. More...
HAL_StatusTypeDef	HAL_DSI_ShortWrite (DSI_HandleTypeDef *hdsi, uint32_t ChannelID, uint32_t Mode, uint32_t Param1, uint32_t Param2)
	write short DCS or short Generic command More...
HAL_StatusTypeDef	HAL_DSI_LongWrite (DSI_HandleTypeDef *hdsi, uint32_t ChannelID, uint32_t Mode, uint32_t NbParams, uint32_t Param1, uint8_t *ParametersTable)
	write long DCS or long Generic command More...
HAL_StatusTypeDef	HAL_DSI_Read (DSI_HandleTypeDef *hdsi, uint32_t ChannelNbr, uint8_t *Array, uint32_t Size, uint32_t Mode, uint32_t DCSCmd, uint8_t *ParametersTable)
	Read command (DCS or generic) More...
HAL_StatusTypeDef	HAL_DSI_EnterULPMData (DSI_HandleTypeDef *hdsi)
	Enter the ULPM (Ultra Low Power Mode) with the D-PHY PLL running (only data lanes are in ULPM) More...
HAL_StatusTypeDef	HAL_DSI_ExitULPMData (DSI_HandleTypeDef *hdsi)
	Exit the ULPM (Ultra Low Power Mode) with the D-PHY PLL running (only data lanes are in ULPM) More...
HAL_StatusTypeDef	HAL_DSI_EnterULPM (DSI_HandleTypeDef *hdsi)
	Enter the ULPM (Ultra Low Power Mode) with the D-PHY PLL turned off (both data and clock lanes are in ULPM) More...
HAL_StatusTypeDef	HAL_DSI_ExitULPM (DSI_HandleTypeDef *hdsi)
	Exit the ULPM (Ultra Low Power Mode) with the D-PHY PLL turned off (both data and clock lanes are in ULPM) More...
HAL_StatusTypeDef	HAL_DSI_PatternGeneratorStart (DSI_HandleTypeDef *hdsi, uint32_t Mode, uint32_t Orientation)
	Start test pattern generation. More...
HAL_StatusTypeDef	HAL_DSI_PatternGeneratorStop (DSI_HandleTypeDef *hdsi)
	Stop test pattern generation. More...
HAL_StatusTypeDef	HAL_DSI_SetSlewRateAndDelayTuning (DSI_HandleTypeDef *hdsi, uint32_t CommDelay, uint32_t Lane, uint32_t Value)
	Set Slew-Rate And Delay Tuning. More...
HAL_StatusTypeDef	HAL_DSI_SetLowPowerRXFilter (DSI_HandleTypeDef *hdsi, uint32_t Frequency)
	Low-Power Reception Filter Tuning. More...
HAL_StatusTypeDef	HAL_DSI_SetSDD (DSI_HandleTypeDef *hdsi, FunctionalState State)
	Activate an additional current path on all lanes to meet the SDDTx parameter defined in the MIPI D-PHY specification. More...
HAL_StatusTypeDef	HAL_DSI_SetLanePinsConfiguration (DSI_HandleTypeDef *hdsi, uint32_t CustomLane, uint32_t Lane, FunctionalState State)
	Custom lane pins configuration. More...
HAL_StatusTypeDef	HAL_DSI_SetPHYTimings (DSI_HandleTypeDef *hdsi, uint32_t Timing, FunctionalState State, uint32_t Value)
	Set custom timing for the PHY. More...
HAL_StatusTypeDef	HAL_DSI_ForceTXStopMode (DSI_HandleTypeDef *hdsi, uint32_t Lane, FunctionalState State)
	Force the Clock/Data Lane in TX Stop Mode. More...
HAL_StatusTypeDef	HAL_DSI_ForceRXLowPower (DSI_HandleTypeDef *hdsi, FunctionalState State)
	Force LP Receiver in Low-Power Mode. More...
HAL_StatusTypeDef	HAL_DSI_ForceDataLanesInRX (DSI_HandleTypeDef *hdsi, FunctionalState State)
	Force Data Lanes in RX Mode after a BTA. More...
HAL_StatusTypeDef	HAL_DSI_SetPullDown (DSI_HandleTypeDef *hdsi, FunctionalState State)
	Enable a pull-down on the lanes to prevent from floating states when unused. More...
HAL_StatusTypeDef	HAL_DSI_SetContentionDetectionOff (DSI_HandleTypeDef *hdsi, FunctionalState State)
	Switch off the contention detection on data lanes. More...
uint32_t	HAL_DSI_GetError (DSI_HandleTypeDef *hdsi)
	Return the DSI error code. More...
HAL_StatusTypeDef	HAL_DSI_ConfigErrorMonitor (DSI_HandleTypeDef *hdsi, uint32_t ActiveErrors)
	Enable the error monitor flags. More...
HAL_DSI_StateTypeDef	HAL_DSI_GetState (DSI_HandleTypeDef *hdsi)
	Return the DSI state. More...

Detailed Description

Header file of DSI HAL module.

Author

MCD Application Team

Attention

© Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32l4xx_hal_dsi.h.