DSI Exported Functions

Modules
	Initialization and Configuration functions
	Initialization and Configuration functions.
	IO operation functions
	IO operation functions.
	Peripheral Control functions
	Peripheral Control functions.
	Peripheral State and Errors functions
	Peripheral State and Errors functions.
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.
HAL_StatusTypeDef	HAL_DSI_DeInit (DSI_HandleTypeDef *hdsi)
	De-initializes the DSI peripheral registers to their default reset values.
void	HAL_DSI_MspInit (DSI_HandleTypeDef *hdsi)
	Initializes the DSI MSP.
void	HAL_DSI_MspDeInit (DSI_HandleTypeDef *hdsi)
	De-initializes the DSI MSP.
void	HAL_DSI_IRQHandler (DSI_HandleTypeDef *hdsi)
	Handles DSI interrupt request.
void	HAL_DSI_TearingEffectCallback (DSI_HandleTypeDef *hdsi)
	Tearing Effect DSI callback.
void	HAL_DSI_EndOfRefreshCallback (DSI_HandleTypeDef *hdsi)
	End of Refresh DSI callback.
void	HAL_DSI_ErrorCallback (DSI_HandleTypeDef *hdsi)
	Operation Error DSI callback.
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.
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.
HAL_StatusTypeDef	HAL_DSI_SetGenericVCID (DSI_HandleTypeDef *hdsi, uint32_t VirtualChannelID)
	Configure the Generic interface read-back Virtual Channel ID.
HAL_StatusTypeDef	HAL_DSI_ConfigVideoMode (DSI_HandleTypeDef *hdsi, DSI_VidCfgTypeDef *VidCfg)
	Select video mode and configure the corresponding parameters.
HAL_StatusTypeDef	HAL_DSI_ConfigAdaptedCommandMode (DSI_HandleTypeDef *hdsi, DSI_CmdCfgTypeDef *CmdCfg)
	Select adapted command mode and configure the corresponding parameters.
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.
HAL_StatusTypeDef	HAL_DSI_ConfigFlowControl (DSI_HandleTypeDef *hdsi, uint32_t FlowControl)
	Configure the flow control parameters.
HAL_StatusTypeDef	HAL_DSI_ConfigPhyTimer (DSI_HandleTypeDef *hdsi, DSI_PHY_TimerTypeDef *PhyTimers)
	Configure the DSI PHY timer parameters.
HAL_StatusTypeDef	HAL_DSI_ConfigHostTimeouts (DSI_HandleTypeDef *hdsi, DSI_HOST_TimeoutTypeDef *HostTimeouts)
	Configure the DSI HOST timeout parameters.
HAL_StatusTypeDef	HAL_DSI_Start (DSI_HandleTypeDef *hdsi)
	Start the DSI module.
HAL_StatusTypeDef	HAL_DSI_Stop (DSI_HandleTypeDef *hdsi)
	Stop the DSI module.
HAL_StatusTypeDef	HAL_DSI_Refresh (DSI_HandleTypeDef *hdsi)
	Refresh the display in command mode.
HAL_StatusTypeDef	HAL_DSI_ColorMode (DSI_HandleTypeDef *hdsi, uint32_t ColorMode)
	Controls the display color mode in Video mode.
HAL_StatusTypeDef	HAL_DSI_Shutdown (DSI_HandleTypeDef *hdsi, uint32_t Shutdown)
	Control the display shutdown in Video mode.
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
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
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)
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)
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)
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)
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)
HAL_StatusTypeDef	HAL_DSI_PatternGeneratorStart (DSI_HandleTypeDef *hdsi, uint32_t Mode, uint32_t Orientation)
	Start test pattern generation.
HAL_StatusTypeDef	HAL_DSI_PatternGeneratorStop (DSI_HandleTypeDef *hdsi)
	Stop test pattern generation.
HAL_StatusTypeDef	HAL_DSI_SetSlewRateAndDelayTuning (DSI_HandleTypeDef *hdsi, uint32_t CommDelay, uint32_t Lane, uint32_t Value)
	Set Slew-Rate And Delay Tuning.
HAL_StatusTypeDef	HAL_DSI_SetLowPowerRXFilter (DSI_HandleTypeDef *hdsi, uint32_t Frequency)
	Low-Power Reception Filter Tuning.
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.
HAL_StatusTypeDef	HAL_DSI_SetLanePinsConfiguration (DSI_HandleTypeDef *hdsi, uint32_t CustomLane, uint32_t Lane, FunctionalState State)
	Custom lane pins configuration.
HAL_StatusTypeDef	HAL_DSI_SetPHYTimings (DSI_HandleTypeDef *hdsi, uint32_t Timing, FunctionalState State, uint32_t Value)
	Set custom timing for the PHY.
HAL_StatusTypeDef	HAL_DSI_ForceTXStopMode (DSI_HandleTypeDef *hdsi, uint32_t Lane, FunctionalState State)
	Force the Clock/Data Lane in TX Stop Mode.
HAL_StatusTypeDef	HAL_DSI_ForceRXLowPower (DSI_HandleTypeDef *hdsi, FunctionalState State)
	Force LP Receiver in Low-Power Mode.
HAL_StatusTypeDef	HAL_DSI_ForceDataLanesInRX (DSI_HandleTypeDef *hdsi, FunctionalState State)
	Force Data Lanes in RX Mode after a BTA.
HAL_StatusTypeDef	HAL_DSI_SetPullDown (DSI_HandleTypeDef *hdsi, FunctionalState State)
	Enable a pull-down on the lanes to prevent from floating states when unused.
HAL_StatusTypeDef	HAL_DSI_SetContentionDetectionOff (DSI_HandleTypeDef *hdsi, FunctionalState State)
	Switch off the contention detection on data lanes.
uint32_t	HAL_DSI_GetError (DSI_HandleTypeDef *hdsi)
	Return the DSI error code.
HAL_StatusTypeDef	HAL_DSI_ConfigErrorMonitor (DSI_HandleTypeDef *hdsi, uint32_t ActiveErrors)
	Enable the error monitor flags.
HAL_DSI_StateTypeDef	HAL_DSI_GetState (DSI_HandleTypeDef *hdsi)
	Return the DSI state.

---

Function Documentation

HAL_StatusTypeDef HAL_DSI_ColorMode	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	ColorMode
	)

Controls the display color mode in Video mode.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
ColorMode	Color mode (full or 8-colors). This parameter can be any value of DSI_Color_Mode

Return values:

HAL

status

Definition at line 1520 of file stm32f4xx_hal_dsi.c.

References assert_param, __DSI_HandleTypeDef::Instance, and IS_DSI_COLOR_MODE.

HAL_StatusTypeDef HAL_DSI_ConfigAdaptedCommandMode	(	DSI_HandleTypeDef *	hdsi,
		DSI_CmdCfgTypeDef *	CmdCfg
	)

Select adapted command mode and configure the corresponding parameters.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
CmdCfg	pointer to a DSI_CmdCfgTypeDef structure that contains the DSI command mode configuration parameters

Return values:

HAL

status

Definition at line 1193 of file stm32f4xx_hal_dsi.c.

References __HAL_DSI_ENABLE_IT, assert_param, DSI_CmdCfgTypeDef::AutomaticRefresh, DSI_CmdCfgTypeDef::ColorCoding, DSI_CmdCfgTypeDef::CommandSize, DSI_CmdCfgTypeDef::DEPolarity, DSI_IT_ER, DSI_IT_TE, DSI_CmdCfgTypeDef::HSPolarity, __DSI_HandleTypeDef::Instance, IS_DSI_AUTOMATIC_REFRESH, IS_DSI_COLOR_CODING, IS_DSI_DE_POLARITY, IS_DSI_HSYNC_POLARITY, IS_DSI_TE_ACK_REQUEST, IS_DSI_TE_POLARITY, IS_DSI_TE_SOURCE, IS_DSI_VS_POLARITY, IS_DSI_VSYNC_POLARITY, DSI_CmdCfgTypeDef::TEAcknowledgeRequest, DSI_CmdCfgTypeDef::TearingEffectPolarity, DSI_CmdCfgTypeDef::TearingEffectSource, DSI_CmdCfgTypeDef::VirtualChannelID, DSI_CmdCfgTypeDef::VSPolarity, and DSI_CmdCfgTypeDef::VSyncPol.

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.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
LPCmd	pointer to a DSI_LPCmdTypeDef structure that contains the DSI command transmission mode configuration parameters

Return values:

HAL

status

Definition at line 1264 of file stm32f4xx_hal_dsi.c.

References DSI_LPCmdTypeDef::AcknowledgeRequest, assert_param, __DSI_HandleTypeDef::Instance, IS_DSI_ACK_REQUEST, IS_DSI_LP_DLW, IS_DSI_LP_DSR0P, IS_DSI_LP_DSW0P, IS_DSI_LP_DSW1P, IS_DSI_LP_GLW, IS_DSI_LP_GSR0P, IS_DSI_LP_GSR1P, IS_DSI_LP_GSR2P, IS_DSI_LP_GSW0P, IS_DSI_LP_GSW1P, IS_DSI_LP_GSW2P, IS_DSI_LP_MRDP, DSI_LPCmdTypeDef::LPDcsLongWrite, DSI_LPCmdTypeDef::LPDcsShortReadNoP, DSI_LPCmdTypeDef::LPDcsShortWriteNoP, DSI_LPCmdTypeDef::LPDcsShortWriteOneP, DSI_LPCmdTypeDef::LPGenLongWrite, DSI_LPCmdTypeDef::LPGenShortReadNoP, DSI_LPCmdTypeDef::LPGenShortReadOneP, DSI_LPCmdTypeDef::LPGenShortReadTwoP, DSI_LPCmdTypeDef::LPGenShortWriteNoP, DSI_LPCmdTypeDef::LPGenShortWriteOneP, DSI_LPCmdTypeDef::LPGenShortWriteTwoP, and DSI_LPCmdTypeDef::LPMaxReadPacket.

HAL_StatusTypeDef HAL_DSI_ConfigErrorMonitor	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	ActiveErrors
	)

Enable the error monitor flags.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
ActiveErrors	indicates which error interrupts will be enabled. This parameter can be any combination of DSI_Error_Data_Type.

Return values:

HAL

status

Definition at line 496 of file stm32f4xx_hal_dsi.c.

References DSI_ERROR_ACK_MASK, DSI_ERROR_CRC_MASK, DSI_ERROR_ECC_MASK, DSI_ERROR_EOT_MASK, DSI_ERROR_GEN_MASK, DSI_ERROR_OVF_MASK, DSI_ERROR_PHY_MASK, DSI_ERROR_PSE_MASK, DSI_ERROR_RX_MASK, DSI_ERROR_TX_MASK, __DSI_HandleTypeDef::ErrorMsk, HAL_DSI_ERROR_ACK, HAL_DSI_ERROR_CRC, HAL_DSI_ERROR_ECC, HAL_DSI_ERROR_EOT, HAL_DSI_ERROR_GEN, HAL_DSI_ERROR_OVF, HAL_DSI_ERROR_PHY, HAL_DSI_ERROR_PSE, HAL_DSI_ERROR_RX, HAL_DSI_ERROR_TX, and __DSI_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_DSI_ConfigFlowControl	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	FlowControl
	)

Configure the flow control parameters.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
FlowControl	flow control feature(s) to be enabled. This parameter can be any combination of DSI_FlowControl.

Return values:

HAL

status

Definition at line 1327 of file stm32f4xx_hal_dsi.c.

References assert_param, DSI_FLOW_CONTROL_ALL, __DSI_HandleTypeDef::Instance, and IS_DSI_FLOW_CONTROL.

HAL_StatusTypeDef HAL_DSI_ConfigHostTimeouts	(	DSI_HandleTypeDef *	hdsi,
		DSI_HOST_TimeoutTypeDef *	HostTimeouts
	)

Configure the DSI HOST timeout parameters.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
HostTimeouts	DSI_HOST_TimeoutTypeDef structure that contains the DSI host timeout parameters

Return values:

HAL

status

Definition at line 1399 of file stm32f4xx_hal_dsi.c.

References DSI_HOST_TimeoutTypeDef::BTATimeout, DSI_HOST_TimeoutTypeDef::HighSpeedReadTimeout, DSI_HOST_TimeoutTypeDef::HighSpeedTransmissionTimeout, DSI_HOST_TimeoutTypeDef::HighSpeedWritePrespMode, DSI_HOST_TimeoutTypeDef::HighSpeedWriteTimeout, __DSI_HandleTypeDef::Instance, DSI_HOST_TimeoutTypeDef::LowPowerReadTimeout, DSI_HOST_TimeoutTypeDef::LowPowerReceptionTimeout, DSI_HOST_TimeoutTypeDef::LowPowerWriteTimeout, and DSI_HOST_TimeoutTypeDef::TimeoutCkdiv.

HAL_StatusTypeDef HAL_DSI_ConfigPhyTimer	(	DSI_HandleTypeDef *	hdsi,
		DSI_PHY_TimerTypeDef *	PhyTimers
	)

Configure the DSI PHY timer parameters.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
PhyTimers	DSI_PHY_TimerTypeDef structure that contains the DSI PHY timing parameters

Return values:

HAL

status

Definition at line 1353 of file stm32f4xx_hal_dsi.c.

References DSI_PHY_TimerTypeDef::ClockLaneHS2LPTime, DSI_PHY_TimerTypeDef::ClockLaneLP2HSTime, DSI_PHY_TimerTypeDef::DataLaneHS2LPTime, DSI_PHY_TimerTypeDef::DataLaneLP2HSTime, DSI_PHY_TimerTypeDef::DataLaneMaxReadTime, __DSI_HandleTypeDef::Instance, and DSI_PHY_TimerTypeDef::StopWaitTime.

HAL_StatusTypeDef HAL_DSI_ConfigVideoMode	(	DSI_HandleTypeDef *	hdsi,
		DSI_VidCfgTypeDef *	VidCfg
	)

Select video mode and configure the corresponding parameters.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
VidCfg	pointer to a DSI_VidCfgTypeDef structure that contains the DSI video mode configuration parameters

Return values:

HAL

status

Definition at line 1043 of file stm32f4xx_hal_dsi.c.

References assert_param, DSI_VidCfgTypeDef::ColorCoding, DSI_VidCfgTypeDef::DEPolarity, DSI_RGB666, DSI_VidCfgTypeDef::FrameBTAAcknowledgeEnable, DSI_VidCfgTypeDef::HorizontalBackPorch, DSI_VidCfgTypeDef::HorizontalLine, DSI_VidCfgTypeDef::HorizontalSyncActive, DSI_VidCfgTypeDef::HSPolarity, __DSI_HandleTypeDef::Instance, IS_DSI_COLOR_CODING, IS_DSI_DE_POLARITY, IS_DSI_FBTAA, IS_DSI_HSYNC_POLARITY, IS_DSI_LOOSELY_PACKED, IS_DSI_LP_COMMAND, IS_DSI_LP_HBP, IS_DSI_LP_HFP, IS_DSI_LP_VACTIVE, IS_DSI_LP_VBP, IS_DSI_LP_VFP, IS_DSI_LP_VSYNC, IS_DSI_VIDEO_MODE_TYPE, IS_DSI_VSYNC_POLARITY, DSI_VidCfgTypeDef::LooselyPacked, DSI_VidCfgTypeDef::LPCommandEnable, DSI_VidCfgTypeDef::LPHorizontalBackPorchEnable, DSI_VidCfgTypeDef::LPHorizontalFrontPorchEnable, DSI_VidCfgTypeDef::LPLargestPacketSize, DSI_VidCfgTypeDef::LPVACTLargestPacketSize, DSI_VidCfgTypeDef::LPVerticalActiveEnable, DSI_VidCfgTypeDef::LPVerticalBackPorchEnable, DSI_VidCfgTypeDef::LPVerticalFrontPorchEnable, DSI_VidCfgTypeDef::LPVerticalSyncActiveEnable, DSI_VidCfgTypeDef::Mode, DSI_VidCfgTypeDef::NullPacketSize, DSI_VidCfgTypeDef::NumberOfChunks, DSI_VidCfgTypeDef::PacketSize, DSI_VidCfgTypeDef::VerticalActive, DSI_VidCfgTypeDef::VerticalBackPorch, DSI_VidCfgTypeDef::VerticalFrontPorch, DSI_VidCfgTypeDef::VerticalSyncActive, DSI_VidCfgTypeDef::VirtualChannelID, and DSI_VidCfgTypeDef::VSPolarity.

HAL_StatusTypeDef HAL_DSI_DeInit

(

DSI_HandleTypeDef *

hdsi

)

De-initializes the DSI peripheral registers to their default reset values.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

HAL

status

Definition at line 438 of file stm32f4xx_hal_dsi.c.

References __HAL_DSI_DISABLE, __HAL_DSI_PLL_DISABLE, __HAL_DSI_REG_DISABLE, __HAL_DSI_WRAPPER_DISABLE, __DSI_HandleTypeDef::ErrorCode, HAL_DSI_ERROR_NONE, HAL_DSI_MspDeInit(), HAL_DSI_STATE_BUSY, HAL_DSI_STATE_RESET, __DSI_HandleTypeDef::Instance, __DSI_HandleTypeDef::MspDeInitCallback, and __DSI_HandleTypeDef::State.

void HAL_DSI_EndOfRefreshCallback

(

DSI_HandleTypeDef *

hdsi

)

End of Refresh DSI callback.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

None

Definition at line 945 of file stm32f4xx_hal_dsi.c.

Referenced by HAL_DSI_Init(), HAL_DSI_IRQHandler(), and HAL_DSI_UnRegisterCallback().

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)

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

HAL

status

Definition at line 1932 of file stm32f4xx_hal_dsi.c.

References __HAL_DSI_PLL_DISABLE, __HAL_RCC_DSI_CONFIG, DSI_ONE_DATA_LANE, DSI_TIMEOUT_VALUE, DSI_TWO_DATA_LANES, HAL_GetTick(), __DSI_HandleTypeDef::Instance, and RCC_DSICLKSOURCE_PLLR.

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)

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

HAL

status

Definition at line 1800 of file stm32f4xx_hal_dsi.c.

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

void HAL_DSI_ErrorCallback

(

DSI_HandleTypeDef *

hdsi

)

Operation Error DSI callback.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

None

Definition at line 960 of file stm32f4xx_hal_dsi.c.

Referenced by HAL_DSI_Init(), HAL_DSI_IRQHandler(), and HAL_DSI_UnRegisterCallback().

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)

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

HAL

status

Definition at line 2004 of file stm32f4xx_hal_dsi.c.

References __HAL_DSI_GET_FLAG, __HAL_DSI_PLL_ENABLE, __HAL_RCC_DSI_CONFIG, DSI_FLAG_PLLLS, DSI_ONE_DATA_LANE, DSI_TIMEOUT_VALUE, DSI_TWO_DATA_LANES, HAL_Delay(), HAL_GetTick(), __DSI_HandleTypeDef::Instance, and RCC_DSICLKSOURCE_DSIPHY.

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)

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

HAL

status

Definition at line 1863 of file stm32f4xx_hal_dsi.c.

References DSI_ONE_DATA_LANE, DSI_TIMEOUT_VALUE, DSI_TWO_DATA_LANES, HAL_Delay(), HAL_GetTick(), and __DSI_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_DSI_ForceDataLanesInRX	(	DSI_HandleTypeDef *	hdsi,
		FunctionalState	State
	)

Force Data Lanes in RX Mode after a BTA.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
State	ENABLE or DISABLE

Return values:

HAL

status

Definition at line 2600 of file stm32f4xx_hal_dsi.c.

References assert_param, and __DSI_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_DSI_ForceRXLowPower	(	DSI_HandleTypeDef *	hdsi,
		FunctionalState	State
	)

Force LP Receiver in Low-Power Mode.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
State	ENABLE or DISABLE

Return values:

HAL

status

Definition at line 2575 of file stm32f4xx_hal_dsi.c.

References assert_param, and __DSI_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_DSI_ForceTXStopMode	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	Lane,
		FunctionalState	State
	)

Force the Clock/Data Lane in TX Stop Mode.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
Lane	select between clock or data lanes. This parameter can be any value of DSI_Lane_Group
State	ENABLE or DISABLE

Return values:

HAL

status

Definition at line 2533 of file stm32f4xx_hal_dsi.c.

References assert_param, DSI_CLOCK_LANE, DSI_DATA_LANES, __DSI_HandleTypeDef::Instance, and IS_DSI_LANE_GROUP.

uint32_t HAL_DSI_GetError

(

DSI_HandleTypeDef *

hdsi

)

Return the DSI error code.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

DSI	Error Code

Definition at line 2705 of file stm32f4xx_hal_dsi.c.

References __DSI_HandleTypeDef::ErrorCode.

HAL_DSI_StateTypeDef HAL_DSI_GetState

(

DSI_HandleTypeDef *

hdsi

)

Return the DSI state.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

HAL

state

Definition at line 2694 of file stm32f4xx_hal_dsi.c.

References __DSI_HandleTypeDef::State.

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.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
PLLInit	pointer to a DSI_PLLInitTypeDef structure that contains the PLL Clock structure definition for the DSI.

Return values:

HAL

status

Definition at line 303 of file stm32f4xx_hal_dsi.c.

References __HAL_DSI_GET_FLAG, __HAL_DSI_PLL_ENABLE, __HAL_DSI_REG_ENABLE, assert_param, DSI_InitTypeDef::AutomaticClockLaneControl, DSI_FLAG_PLLLS, DSI_FLAG_RRS, DSI_TIMEOUT_VALUE, __DSI_HandleTypeDef::EndOfRefreshCallback, __DSI_HandleTypeDef::ErrorCallback, __DSI_HandleTypeDef::ErrorCode, __DSI_HandleTypeDef::ErrorMsk, HAL_DSI_EndOfRefreshCallback(), HAL_DSI_ERROR_NONE, HAL_DSI_ErrorCallback(), HAL_DSI_MspInit(), HAL_DSI_STATE_BUSY, HAL_DSI_STATE_READY, HAL_DSI_STATE_RESET, HAL_DSI_TearingEffectCallback(), HAL_GetTick(), HSE_VALUE, __DSI_HandleTypeDef::Init, __DSI_HandleTypeDef::Instance, IS_DSI_AUTO_CLKLANE_CONTROL, IS_DSI_NUMBER_OF_LANES, IS_DSI_PLL_IDF, IS_DSI_PLL_NDIV, IS_DSI_PLL_ODF, __DSI_HandleTypeDef::MspInitCallback, DSI_InitTypeDef::NumberOfLanes, DSI_PLLInitTypeDef::PLLIDF, DSI_PLLInitTypeDef::PLLNDIV, DSI_PLLInitTypeDef::PLLODF, __DSI_HandleTypeDef::State, __DSI_HandleTypeDef::TearingEffectCallback, and DSI_InitTypeDef::TXEscapeCkdiv.

void HAL_DSI_IRQHandler

(

DSI_HandleTypeDef *

hdsi

)

Handles DSI interrupt request.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

HAL

status

Definition at line 809 of file stm32f4xx_hal_dsi.c.

References __HAL_DSI_CLEAR_FLAG, __HAL_DSI_GET_FLAG, __HAL_DSI_GET_IT_SOURCE, DSI_ERROR_ACK_MASK, DSI_ERROR_CRC_MASK, DSI_ERROR_ECC_MASK, DSI_ERROR_EOT_MASK, DSI_ERROR_GEN_MASK, DSI_ERROR_OVF_MASK, DSI_ERROR_PHY_MASK, DSI_ERROR_PSE_MASK, DSI_ERROR_RX_MASK, DSI_ERROR_TX_MASK, DSI_FLAG_ER, DSI_FLAG_TE, DSI_IT_ER, DSI_IT_TE, __DSI_HandleTypeDef::EndOfRefreshCallback, __DSI_HandleTypeDef::ErrorCallback, __DSI_HandleTypeDef::ErrorCode, __DSI_HandleTypeDef::ErrorMsk, HAL_DSI_EndOfRefreshCallback(), HAL_DSI_ERROR_ACK, HAL_DSI_ERROR_CRC, HAL_DSI_ERROR_ECC, HAL_DSI_ERROR_EOT, HAL_DSI_ERROR_GEN, HAL_DSI_ERROR_NONE, HAL_DSI_ERROR_OVF, HAL_DSI_ERROR_PHY, HAL_DSI_ERROR_PSE, HAL_DSI_ERROR_RX, HAL_DSI_ERROR_TX, HAL_DSI_ErrorCallback(), HAL_DSI_TearingEffectCallback(), __DSI_HandleTypeDef::Instance, and __DSI_HandleTypeDef::TearingEffectCallback.

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

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
ChannelID	Virtual channel ID.
Mode	DSI long packet data type. This parameter can be any value of DSI_LONG_WRITE_PKT_Data_Type.
NbParams	Number of parameters.
Param1	DSC command or first generic parameter. This parameter can be any value of DSI_DCS_Command or a generic command code
ParametersTable	Pointer to parameter values table.

Return values:

HAL

status

Definition at line 1612 of file stm32f4xx_hal_dsi.c.

References assert_param, DSI_ConfigPacketHeader(), DSI_TIMEOUT_VALUE, HAL_GetTick(), __DSI_HandleTypeDef::Instance, and IS_DSI_LONG_WRITE_PACKET_TYPE.

void HAL_DSI_MspDeInit

(

DSI_HandleTypeDef *

hdsi

)

De-initializes the DSI MSP.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

None

Definition at line 594 of file stm32f4xx_hal_dsi.c.

Referenced by HAL_DSI_DeInit(), and HAL_DSI_UnRegisterCallback().

void HAL_DSI_MspInit

(

DSI_HandleTypeDef *

hdsi

)

Initializes the DSI MSP.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

None

Definition at line 579 of file stm32f4xx_hal_dsi.c.

Referenced by HAL_DSI_Init(), and HAL_DSI_UnRegisterCallback().

HAL_StatusTypeDef HAL_DSI_PatternGeneratorStart	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	Mode,
		uint32_t	Orientation
	)

Start test pattern generation.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
Mode	Pattern generator mode This parameter can be one of the following values: 0 : Color bars (horizontal or vertical) 1 : BER pattern (vertical only)
Orientation	Pattern generator orientation This parameter can be one of the following values: 0 : Vertical color bars 1 : Horizontal color bars

Return values:

HAL

status

Definition at line 2106 of file stm32f4xx_hal_dsi.c.

References __DSI_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_DSI_PatternGeneratorStop

(

DSI_HandleTypeDef *

hdsi

)

Stop test pattern generation.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

HAL

status

Definition at line 2130 of file stm32f4xx_hal_dsi.c.

References __DSI_HandleTypeDef::Instance.

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)

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
ChannelNbr	Virtual channel ID
Array	pointer to a buffer to store the payload of a read back operation.
Size	Data size to be read (in byte).
Mode	DSI read packet data type. This parameter can be any value of DSI_SHORT_READ_PKT_Data_Type.
DCSCmd	DCS get/read command.
ParametersTable	Pointer to parameter values table.

Return values:

HAL

status

Definition at line 1699 of file stm32f4xx_hal_dsi.c.

References assert_param, DSI_ConfigPacketHeader(), DSI_DCS_SHORT_PKT_READ, DSI_GEN_SHORT_PKT_READ_P0, DSI_GEN_SHORT_PKT_READ_P1, DSI_GEN_SHORT_PKT_READ_P2, DSI_MAX_RETURN_PKT_SIZE, DSI_ShortWrite(), DSI_TIMEOUT_VALUE, HAL_GetTick(), __DSI_HandleTypeDef::Instance, and IS_DSI_READ_PACKET_TYPE.

HAL_StatusTypeDef HAL_DSI_Refresh

(

DSI_HandleTypeDef *

hdsi

)

Refresh the display in command mode.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

HAL

status

Definition at line 1498 of file stm32f4xx_hal_dsi.c.

References __DSI_HandleTypeDef::Instance.

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.

Parameters:

hdsi	dsi handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_DSI_TEARING_EFFECT_CB_ID Tearing Effect Callback ID HAL_DSI_ENDOF_REFRESH_CB_ID End Of Refresh Callback ID HAL_DSI_ERROR_CB_ID Error Callback ID HAL_DSI_MSPINIT_CB_ID MspInit callback ID HAL_DSI_MSPDEINIT_CB_ID MspDeInit callback ID
pCallback	pointer to the Callback function

Return values:

status

Definition at line 618 of file stm32f4xx_hal_dsi.c.

References __DSI_HandleTypeDef::EndOfRefreshCallback, __DSI_HandleTypeDef::ErrorCallback, __DSI_HandleTypeDef::ErrorCode, HAL_DSI_ENDOF_REFRESH_CB_ID, HAL_DSI_ERROR_CB_ID, HAL_DSI_ERROR_INVALID_CALLBACK, HAL_DSI_MSPDEINIT_CB_ID, HAL_DSI_MSPINIT_CB_ID, HAL_DSI_STATE_READY, HAL_DSI_STATE_RESET, HAL_DSI_TEARING_EFFECT_CB_ID, __DSI_HandleTypeDef::MspDeInitCallback, __DSI_HandleTypeDef::MspInitCallback, __DSI_HandleTypeDef::State, and __DSI_HandleTypeDef::TearingEffectCallback.

HAL_StatusTypeDef HAL_DSI_SetContentionDetectionOff	(	DSI_HandleTypeDef *	hdsi,
		FunctionalState	State
	)

Switch off the contention detection on data lanes.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
State	ENABLE or DISABLE

Return values:

HAL

status

Definition at line 2650 of file stm32f4xx_hal_dsi.c.

References assert_param, and __DSI_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_DSI_SetGenericVCID	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	VirtualChannelID
	)

Configure the Generic interface read-back Virtual Channel ID.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
VirtualChannelID	Virtual channel ID

Return values:

HAL

status

Definition at line 1020 of file stm32f4xx_hal_dsi.c.

References __DSI_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_DSI_SetLanePinsConfiguration	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	CustomLane,
		uint32_t	Lane,
		FunctionalState	State
	)

Custom lane pins configuration.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
CustomLane	Function to be applied on selected lane. This parameter can be any value of DSI_CustomLane
Lane	select between clock or data lane 0 or data lane 1. This parameter can be any value of DSI_Lane_Select
State	ENABLE or DISABLE

Return values:

HAL

status

Definition at line 2299 of file stm32f4xx_hal_dsi.c.

References assert_param, DSI_CLK_LANE, DSI_DATA_LANE0, DSI_DATA_LANE1, DSI_INVERT_HS_SIGNAL, DSI_SWAP_LANE_PINS, __DSI_HandleTypeDef::Instance, IS_DSI_CUSTOM_LANE, and IS_DSI_LANE.

HAL_StatusTypeDef HAL_DSI_SetLowPowerRXFilter	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	Frequency
	)

Low-Power Reception Filter Tuning.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
Frequency	cutoff frequency of low-pass filter at the input of LPRX

Return values:

HAL

status

Definition at line 2247 of file stm32f4xx_hal_dsi.c.

References __DSI_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_DSI_SetPHYTimings	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	Timing,
		FunctionalState	State,
		uint32_t	Value
	)

Set custom timing for the PHY.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
Timing	PHY timing to be adjusted. This parameter can be any value of DSI_PHY_Timing
State	ENABLE or DISABLE
Value	Custom value of the timing

Return values:

HAL

status

Definition at line 2386 of file stm32f4xx_hal_dsi.c.

References assert_param, DSI_TCLK_POST, DSI_TCLK_PREPARE, DSI_TCLK_ZERO, DSI_THS_EXIT, DSI_THS_PREPARE, DSI_THS_TRAIL, DSI_THS_ZERO, DSI_TLPX_CLK, DSI_TLPX_DATA, __DSI_HandleTypeDef::Instance, and IS_DSI_PHY_TIMING.

HAL_StatusTypeDef HAL_DSI_SetPullDown	(	DSI_HandleTypeDef *	hdsi,
		FunctionalState	State
	)

Enable a pull-down on the lanes to prevent from floating states when unused.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
State	ENABLE or DISABLE

Return values:

HAL

status

Definition at line 2625 of file stm32f4xx_hal_dsi.c.

References assert_param, and __DSI_HandleTypeDef::Instance.

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.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
State	ENABLE or DISABLE

Return values:

HAL

status

Definition at line 2270 of file stm32f4xx_hal_dsi.c.

References assert_param, and __DSI_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_DSI_SetSlewRateAndDelayTuning	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	CommDelay,
		uint32_t	Lane,
		uint32_t	Value
	)

Set Slew-Rate And Delay Tuning.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
CommDelay	Communication delay to be adjusted. This parameter can be any value of DSI_Communication_Delay
Lane	select between clock or data lanes. This parameter can be any value of DSI_Lane_Group
Value	Custom value of the slew-rate or delay

Return values:

HAL

status

Definition at line 2155 of file stm32f4xx_hal_dsi.c.

References assert_param, DSI_CLOCK_LANE, DSI_DATA_LANES, DSI_HS_DELAY, DSI_SLEW_RATE_HSTX, DSI_SLEW_RATE_LPTX, __DSI_HandleTypeDef::Instance, IS_DSI_COMMUNICATION_DELAY, and IS_DSI_LANE_GROUP.

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

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
ChannelID	Virtual channel ID.
Mode	DSI short packet data type. This parameter can be any value of DSI_SHORT_WRITE_PKT_Data_Type.
Param1	DSC command or first generic parameter. This parameter can be any value of DSI_DCS_Command or a generic command code.
Param2	DSC parameter or second generic parameter.

Return values:

HAL

status

Definition at line 1577 of file stm32f4xx_hal_dsi.c.

References assert_param, DSI_ShortWrite(), and IS_DSI_SHORT_WRITE_PACKET_TYPE.

HAL_StatusTypeDef HAL_DSI_Shutdown	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	Shutdown
	)

Control the display shutdown in Video mode.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.
Shutdown	Shut-down (Display-ON or Display-OFF). This parameter can be any value of DSI_ShutDown

Return values:

HAL

status

Definition at line 1546 of file stm32f4xx_hal_dsi.c.

References assert_param, __DSI_HandleTypeDef::Instance, and IS_DSI_SHUT_DOWN.

HAL_StatusTypeDef HAL_DSI_Start

(

DSI_HandleTypeDef *

hdsi

)

Start the DSI module.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

HAL

status

Definition at line 1452 of file stm32f4xx_hal_dsi.c.

References __HAL_DSI_ENABLE, and __HAL_DSI_WRAPPER_ENABLE.

HAL_StatusTypeDef HAL_DSI_Stop

(

DSI_HandleTypeDef *

hdsi

)

Stop the DSI module.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

HAL

status

Definition at line 1475 of file stm32f4xx_hal_dsi.c.

References __HAL_DSI_DISABLE, and __HAL_DSI_WRAPPER_DISABLE.

void HAL_DSI_TearingEffectCallback

(

DSI_HandleTypeDef *

hdsi

)

Tearing Effect DSI callback.

Parameters:

hdsi	pointer to a DSI_HandleTypeDef structure that contains the configuration information for the DSI.

Return values:

None

Definition at line 930 of file stm32f4xx_hal_dsi.c.

Referenced by HAL_DSI_Init(), HAL_DSI_IRQHandler(), and HAL_DSI_UnRegisterCallback().

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.

Parameters:

hdsi	dsi handle
CallbackID	ID of the callback to be unregistered This parameter can be one of the following values: HAL_DSI_TEARING_EFFECT_CB_ID Tearing Effect Callback ID HAL_DSI_ENDOF_REFRESH_CB_ID End Of Refresh Callback ID HAL_DSI_ERROR_CB_ID Error Callback ID HAL_DSI_MSPINIT_CB_ID MspInit callback ID HAL_DSI_MSPDEINIT_CB_ID MspDeInit callback ID

Return values:

status

Definition at line 712 of file stm32f4xx_hal_dsi.c.

References __DSI_HandleTypeDef::EndOfRefreshCallback, __DSI_HandleTypeDef::ErrorCallback, __DSI_HandleTypeDef::ErrorCode, HAL_DSI_ENDOF_REFRESH_CB_ID, HAL_DSI_EndOfRefreshCallback(), HAL_DSI_ERROR_CB_ID, HAL_DSI_ERROR_INVALID_CALLBACK, HAL_DSI_ErrorCallback(), HAL_DSI_MspDeInit(), HAL_DSI_MSPDEINIT_CB_ID, HAL_DSI_MspInit(), HAL_DSI_MSPINIT_CB_ID, HAL_DSI_STATE_READY, HAL_DSI_STATE_RESET, HAL_DSI_TEARING_EFFECT_CB_ID, HAL_DSI_TearingEffectCallback(), __DSI_HandleTypeDef::MspDeInitCallback, __DSI_HandleTypeDef::MspInitCallback, __DSI_HandleTypeDef::State, and __DSI_HandleTypeDef::TearingEffectCallback.