Peripheral Control functions

Peripheral Control functions. More...

Collaboration diagram for Peripheral Control functions:

Functions
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, const 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.

Detailed Description

Peripheral Control functions.

 ===============================================================================
                    ##### Peripheral Control functions #####
 ===============================================================================
    [..]  This section provides functions allowing to:
      (+) Configure the Generic interface read-back Virtual Channel ID
      (+) Select video mode and configure the corresponding parameters
      (+) Configure command transmission mode: High-speed or Low-power
      (+) Configure the flow control
      (+) Configure the DSI PHY timer
      (+) Configure the DSI HOST timeout
      (+) Configure the DSI HOST timeout
      (+) Start/Stop the DSI module
      (+) Refresh the display in command mode
      (+) Controls the display color mode in Video mode
      (+) Control the display shutdown in Video mode
      (+) write short DCS or short Generic command
      (+) write long DCS or long Generic command
      (+) Read command (DCS or generic)
      (+) Enter/Exit the Ultra Low Power Mode on data only (D-PHY PLL running)
      (+) Enter/Exit the Ultra Low Power Mode on data only and clock (D-PHY PLL turned off)
      (+) Start/Stop test pattern generation
      (+) Slew-Rate And Delay Tuning
      (+) Low-Power Reception Filter Tuning
      (+) Activate an additional current path on all lanes to meet the SDDTx parameter
      (+) Custom lane pins configuration
      (+) Set custom timing for the PHY
      (+) Force the Clock/Data Lane in TX Stop Mode
      (+) Force LP Receiver in Low-Power Mode
      (+) Force Data Lanes in RX Mode after a BTA
      (+) Enable a pull-down on the lanes to prevent from floating states when unused
      (+) Switch off the contention detection on data lanes

Function Documentation

HAL_DSI_SetGenericVCID()

HAL_StatusTypeDef HAL_DSI_SetGenericVCID	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	VirtualChannelID )

#include <stm32f4xx_hal_dsi.h>

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 1068 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, HAL_OK, and DSI_HandleTypeDef::Instance.

HAL_DSI_ConfigVideoMode()

HAL_StatusTypeDef HAL_DSI_ConfigVideoMode	(	DSI_HandleTypeDef *	hdsi,
		DSI_VidCfgTypeDef *	VidCfg )

#include <stm32f4xx_hal_dsi.h>

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 1091 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, DSI_VidCfgTypeDef::ColorCoding, DSI_VidCfgTypeDef::DEPolarity, DSI_RGB666, DSI_VidCfgTypeDef::FrameBTAAcknowledgeEnable, HAL_OK, 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_DSI_ConfigAdaptedCommandMode()

HAL_StatusTypeDef HAL_DSI_ConfigAdaptedCommandMode	(	DSI_HandleTypeDef *	hdsi,
		DSI_CmdCfgTypeDef *	CmdCfg )

#include <stm32f4xx_hal_dsi.h>

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 1241 of file stm32f4xx_hal_dsi.c.

References __HAL_DSI_ENABLE_IT, __HAL_LOCK, __HAL_UNLOCK, assert_param, DSI_CmdCfgTypeDef::AutomaticRefresh, DSI_CmdCfgTypeDef::ColorCoding, DSI_CmdCfgTypeDef::CommandSize, DSI_CmdCfgTypeDef::DEPolarity, DSI_IT_ER, DSI_IT_TE, HAL_OK, 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_DSI_ConfigCommand()

HAL_StatusTypeDef HAL_DSI_ConfigCommand	(	DSI_HandleTypeDef *	hdsi,
		DSI_LPCmdTypeDef *	LPCmd )

#include <stm32f4xx_hal_dsi.h>

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 1312 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, DSI_LPCmdTypeDef::AcknowledgeRequest, assert_param, HAL_OK, 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_DSI_ConfigFlowControl()

HAL_StatusTypeDef HAL_DSI_ConfigFlowControl	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	FlowControl )

#include <stm32f4xx_hal_dsi.h>

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 1375 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, HAL_OK, DSI_HandleTypeDef::Instance, and IS_DSI_FLOW_CONTROL.

HAL_DSI_ConfigPhyTimer()

HAL_StatusTypeDef HAL_DSI_ConfigPhyTimer	(	DSI_HandleTypeDef *	hdsi,
		DSI_PHY_TimerTypeDef *	PhyTimers )

#include <stm32f4xx_hal_dsi.h>

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 1401 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, DSI_PHY_TimerTypeDef::ClockLaneHS2LPTime, DSI_PHY_TimerTypeDef::ClockLaneLP2HSTime, DSI_PHY_TimerTypeDef::DataLaneHS2LPTime, DSI_PHY_TimerTypeDef::DataLaneLP2HSTime, DSI_PHY_TimerTypeDef::DataLaneMaxReadTime, HAL_OK, DSI_HandleTypeDef::Instance, and DSI_PHY_TimerTypeDef::StopWaitTime.

HAL_DSI_ConfigHostTimeouts()

HAL_StatusTypeDef HAL_DSI_ConfigHostTimeouts	(	DSI_HandleTypeDef *	hdsi,
		DSI_HOST_TimeoutTypeDef *	HostTimeouts )

#include <stm32f4xx_hal_dsi.h>

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 1448 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, DSI_HOST_TimeoutTypeDef::BTATimeout, HAL_OK, 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_DSI_Start()

HAL_StatusTypeDef HAL_DSI_Start

(

DSI_HandleTypeDef *

hdsi

)

#include <stm32f4xx_hal_dsi.h>

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 1501 of file stm32f4xx_hal_dsi.c.

References __HAL_DSI_ENABLE, __HAL_DSI_WRAPPER_ENABLE, __HAL_LOCK, __HAL_UNLOCK, and HAL_OK.

HAL_DSI_Stop()

HAL_StatusTypeDef HAL_DSI_Stop

(

DSI_HandleTypeDef *

hdsi

)

#include <stm32f4xx_hal_dsi.h>

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 1524 of file stm32f4xx_hal_dsi.c.

References __HAL_DSI_DISABLE, __HAL_DSI_WRAPPER_DISABLE, __HAL_LOCK, __HAL_UNLOCK, and HAL_OK.

HAL_DSI_Refresh()

HAL_StatusTypeDef HAL_DSI_Refresh

(

DSI_HandleTypeDef *

hdsi

)

#include <stm32f4xx_hal_dsi.h>

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 1547 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, HAL_OK, and DSI_HandleTypeDef::Instance.

HAL_DSI_ColorMode()

HAL_StatusTypeDef HAL_DSI_ColorMode	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	ColorMode )

#include <stm32f4xx_hal_dsi.h>

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 1569 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, HAL_OK, DSI_HandleTypeDef::Instance, and IS_DSI_COLOR_MODE.

HAL_DSI_Shutdown()

HAL_StatusTypeDef HAL_DSI_Shutdown	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	Shutdown )

#include <stm32f4xx_hal_dsi.h>

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 1595 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, HAL_OK, DSI_HandleTypeDef::Instance, and IS_DSI_SHUT_DOWN.

HAL_DSI_ShortWrite()

HAL_StatusTypeDef HAL_DSI_ShortWrite	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	ChannelID,
		uint32_t	Mode,
		uint32_t	Param1,
		uint32_t	Param2 )

#include <stm32f4xx_hal_dsi.h>

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 1626 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, DSI_ShortWrite(), and IS_DSI_SHORT_WRITE_PACKET_TYPE.

HAL_DSI_LongWrite()

HAL_StatusTypeDef HAL_DSI_LongWrite	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	ChannelID,
		uint32_t	Mode,
		uint32_t	NbParams,
		uint32_t	Param1,
		const uint8_t *	ParametersTable )

#include <stm32f4xx_hal_dsi.h>

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 1661 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, DSI_ConfigPacketHeader(), DSI_TIMEOUT_VALUE, HAL_GetTick(), HAL_OK, HAL_TIMEOUT, DSI_HandleTypeDef::Instance, and IS_DSI_LONG_WRITE_PACKET_TYPE.

HAL_DSI_Read()

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 )

#include <stm32f4xx_hal_dsi.h>

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 1750 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, 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_ERROR, HAL_GetTick(), HAL_OK, HAL_TIMEOUT, DSI_HandleTypeDef::Instance, and IS_DSI_READ_PACKET_TYPE.

HAL_DSI_EnterULPMData()

HAL_StatusTypeDef HAL_DSI_EnterULPMData

(

DSI_HandleTypeDef *

hdsi

)

#include <stm32f4xx_hal_dsi.h>

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 1866 of file stm32f4xx_hal_dsi.c.

References __HAL_DSI_GET_FLAG, __HAL_LOCK, __HAL_UNLOCK, DSI_FLAG_PLLLS, DSI_ONE_DATA_LANE, DSI_TIMEOUT_VALUE, DSI_TWO_DATA_LANES, HAL_Delay(), HAL_ERROR, HAL_GetTick(), HAL_OK, HAL_TIMEOUT, and DSI_HandleTypeDef::Instance.

HAL_DSI_ExitULPMData()

HAL_StatusTypeDef HAL_DSI_ExitULPMData

(

DSI_HandleTypeDef *

hdsi

)

#include <stm32f4xx_hal_dsi.h>

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 2018 of file stm32f4xx_hal_dsi.c.

References __HAL_DSI_GET_FLAG, __HAL_DSI_PLL_ENABLE, __HAL_LOCK, __HAL_UNLOCK, DSI_FLAG_PLLLS, DSI_ONE_DATA_LANE, DSI_TIMEOUT_VALUE, DSI_TWO_DATA_LANES, HAL_Delay(), HAL_ERROR, HAL_GetTick(), HAL_OK, HAL_TIMEOUT, and DSI_HandleTypeDef::Instance.

HAL_DSI_EnterULPM()

HAL_StatusTypeDef HAL_DSI_EnterULPM

(

DSI_HandleTypeDef *

hdsi

)

#include <stm32f4xx_hal_dsi.h>

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 2194 of file stm32f4xx_hal_dsi.c.

References __HAL_DSI_GET_FLAG, __HAL_DSI_PLL_DISABLE, __HAL_LOCK, __HAL_UNLOCK, DSI_FLAG_PLLLS, DSI_ONE_DATA_LANE, DSI_TIMEOUT_VALUE, DSI_TWO_DATA_LANES, HAL_Delay(), HAL_ERROR, HAL_GetTick(), HAL_OK, HAL_TIMEOUT, and DSI_HandleTypeDef::Instance.

HAL_DSI_ExitULPM()

HAL_StatusTypeDef HAL_DSI_ExitULPM

(

DSI_HandleTypeDef *

hdsi

)

#include <stm32f4xx_hal_dsi.h>

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 2356 of file stm32f4xx_hal_dsi.c.

References __HAL_DSI_GET_FLAG, __HAL_DSI_PLL_ENABLE, __HAL_LOCK, __HAL_UNLOCK, DSI_FLAG_PLLLS, DSI_ONE_DATA_LANE, DSI_TIMEOUT_VALUE, DSI_TWO_DATA_LANES, HAL_Delay(), HAL_ERROR, HAL_GetTick(), HAL_OK, HAL_TIMEOUT, and DSI_HandleTypeDef::Instance.

HAL_DSI_PatternGeneratorStart()

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

#include <stm32f4xx_hal_dsi.h>

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 2549 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, HAL_OK, and DSI_HandleTypeDef::Instance.

HAL_DSI_PatternGeneratorStop()

HAL_StatusTypeDef HAL_DSI_PatternGeneratorStop

(

DSI_HandleTypeDef *

hdsi

)

#include <stm32f4xx_hal_dsi.h>

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 2573 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, HAL_OK, and DSI_HandleTypeDef::Instance.

HAL_DSI_SetSlewRateAndDelayTuning()

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

#include <stm32f4xx_hal_dsi.h>

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 2598 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, DSI_CLOCK_LANE, DSI_DATA_LANES, DSI_HS_DELAY, DSI_SLEW_RATE_HSTX, DSI_SLEW_RATE_LPTX, HAL_ERROR, HAL_OK, DSI_HandleTypeDef::Instance, IS_DSI_COMMUNICATION_DELAY, and IS_DSI_LANE_GROUP.

HAL_DSI_SetLowPowerRXFilter()

HAL_StatusTypeDef HAL_DSI_SetLowPowerRXFilter	(	DSI_HandleTypeDef *	hdsi,
		uint32_t	Frequency )

#include <stm32f4xx_hal_dsi.h>

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 2690 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, HAL_OK, and DSI_HandleTypeDef::Instance.

HAL_DSI_SetSDD()

HAL_StatusTypeDef HAL_DSI_SetSDD	(	DSI_HandleTypeDef *	hdsi,
		FunctionalState	State )

#include <stm32f4xx_hal_dsi.h>

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 2713 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, HAL_OK, and DSI_HandleTypeDef::Instance.

HAL_DSI_SetLanePinsConfiguration()

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

#include <stm32f4xx_hal_dsi.h>

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 2742 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, DSI_CLK_LANE, DSI_DATA_LANE0, DSI_DATA_LANE1, DSI_INVERT_HS_SIGNAL, DSI_SWAP_LANE_PINS, HAL_ERROR, HAL_OK, DSI_HandleTypeDef::Instance, IS_DSI_CUSTOM_LANE, and IS_DSI_LANE.

HAL_DSI_SetPHYTimings()

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

#include <stm32f4xx_hal_dsi.h>

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 2829 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, 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, HAL_OK, DSI_HandleTypeDef::Instance, and IS_DSI_PHY_TIMING.

HAL_DSI_ForceTXStopMode()

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

#include <stm32f4xx_hal_dsi.h>

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 2976 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, DSI_CLOCK_LANE, DSI_DATA_LANES, HAL_ERROR, HAL_OK, DSI_HandleTypeDef::Instance, and IS_DSI_LANE_GROUP.

HAL_DSI_ForceRXLowPower()

HAL_StatusTypeDef HAL_DSI_ForceRXLowPower	(	DSI_HandleTypeDef *	hdsi,
		FunctionalState	State )

#include <stm32f4xx_hal_dsi.h>

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 3018 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, HAL_OK, and DSI_HandleTypeDef::Instance.

HAL_DSI_ForceDataLanesInRX()

HAL_StatusTypeDef HAL_DSI_ForceDataLanesInRX	(	DSI_HandleTypeDef *	hdsi,
		FunctionalState	State )

#include <stm32f4xx_hal_dsi.h>

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 3043 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, HAL_OK, and DSI_HandleTypeDef::Instance.

HAL_DSI_SetPullDown()

HAL_StatusTypeDef HAL_DSI_SetPullDown	(	DSI_HandleTypeDef *	hdsi,
		FunctionalState	State )

#include <stm32f4xx_hal_dsi.h>

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 3068 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, HAL_OK, and DSI_HandleTypeDef::Instance.

HAL_DSI_SetContentionDetectionOff()

HAL_StatusTypeDef HAL_DSI_SetContentionDetectionOff	(	DSI_HandleTypeDef *	hdsi,
		FunctionalState	State )

#include <stm32f4xx_hal_dsi.h>

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 3093 of file stm32f4xx_hal_dsi.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, HAL_OK, and DSI_HandleTypeDef::Instance.