diff options
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_dsi.h')
-rw-r--r-- | bsps/arm/stm32h7/include/stm32h7xx_hal_dsi.h | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_dsi.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_dsi.h index ec36c46371..5a80922a23 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_dsi.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_dsi.h @@ -34,12 +34,14 @@ extern "C" { */ /** @defgroup DSI DSI + * @ingroup RTEMSBSPsARMSTM32H7 * @brief DSI HAL module driver * @{ */ /* Exported types ------------------------------------------------------------*/ /** @defgroup DSI_Exported_Types DSI Exported Types + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @@ -354,9 +356,11 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to /* Exported constants --------------------------------------------------------*/ /** @defgroup DSI_Exported_Constants DSI Exported Constants + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @defgroup DSI_DCS_Command DSI DCS Command + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_ENTER_IDLE_MODE 0x39U @@ -408,6 +412,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_Video_Mode_Type DSI Video Mode Type + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_VID_MODE_NB_PULSES 0U @@ -418,6 +423,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_Color_Mode DSI Color Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_COLOR_MODE_FULL 0x00000000U @@ -427,6 +433,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_ShutDown DSI ShutDown + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_DISPLAY_ON 0x00000000U @@ -436,6 +443,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_Command DSI LP Command + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_COMMAND_DISABLE 0x00000000U @@ -445,6 +453,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_HFP DSI LP HFP + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_HFP_DISABLE 0x00000000U @@ -454,6 +463,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_HBP DSI LP HBP + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_HBP_DISABLE 0x00000000U @@ -463,6 +473,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_VACT DSI LP VACT + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_VACT_DISABLE 0x00000000U @@ -472,6 +483,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_VFP DSI LP VFP + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_VFP_DISABLE 0x00000000U @@ -481,6 +493,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_VBP DSI LP VBP + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_VBP_DISABLE 0x00000000U @@ -490,6 +503,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_VSYNC DSI LP VSYNC + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_VSYNC_DISABLE 0x00000000U @@ -499,6 +513,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_FBTA_acknowledge DSI FBTA Acknowledge + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_FBTAA_DISABLE 0x00000000U @@ -508,6 +523,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_TearingEffectSource DSI Tearing Effect Source + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_TE_DSILINK 0x00000000U @@ -517,6 +533,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_TearingEffectPolarity DSI Tearing Effect Polarity + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_TE_RISING_EDGE 0x00000000U @@ -526,6 +543,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_Vsync_Polarity DSI Vsync Polarity + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_VSYNC_FALLING 0x00000000U @@ -535,6 +553,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_AutomaticRefresh DSI Automatic Refresh + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_AR_DISABLE 0x00000000U @@ -544,6 +563,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_TE_AcknowledgeRequest DSI TE Acknowledge Request + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_TE_ACKNOWLEDGE_DISABLE 0x00000000U @@ -553,6 +573,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_AcknowledgeRequest DSI Acknowledge Request + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_ACKNOWLEDGE_DISABLE 0x00000000U @@ -562,6 +583,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_LPGenShortWriteNoP DSI LP LPGen Short Write NoP + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_GSW0P_DISABLE 0x00000000U @@ -571,6 +593,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_LPGenShortWriteOneP DSI LP LPGen Short Write OneP + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_GSW1P_DISABLE 0x00000000U @@ -580,6 +603,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_LPGenShortWriteTwoP DSI LP LPGen Short Write TwoP + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_GSW2P_DISABLE 0x00000000U @@ -589,6 +613,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_LPGenShortReadNoP DSI LP LPGen Short Read NoP + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_GSR0P_DISABLE 0x00000000U @@ -598,6 +623,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_LPGenShortReadOneP DSI LP LPGen Short Read OneP + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_GSR1P_DISABLE 0x00000000U @@ -607,6 +633,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_LPGenShortReadTwoP DSI LP LPGen Short Read TwoP + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_GSR2P_DISABLE 0x00000000U @@ -616,6 +643,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_LPGenLongWrite DSI LP LPGen LongWrite + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_GLW_DISABLE 0x00000000U @@ -625,6 +653,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_LPDcsShortWriteNoP DSI LP LPDcs Short Write NoP + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_DSW0P_DISABLE 0x00000000U @@ -634,6 +663,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_LPDcsShortWriteOneP DSI LP LPDcs Short Write OneP + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_DSW1P_DISABLE 0x00000000U @@ -643,6 +673,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_LPDcsShortReadNoP DSI LP LPDcs Short Read NoP + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_DSR0P_DISABLE 0x00000000U @@ -652,6 +683,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_LPDcsLongWrite DSI LP LPDcs Long Write + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_DLW_DISABLE 0x00000000U @@ -661,6 +693,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LP_LPMaxReadPacket DSI LP LPMax Read Packet + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LP_MRDP_DISABLE 0x00000000U @@ -670,6 +703,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_HS_PrespMode DSI HS Presp Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_HS_PM_DISABLE 0x00000000U @@ -680,6 +714,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to /** @defgroup DSI_Automatic_Clk_Lane_Control DSI Automatic Clk Lane Control + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_AUTO_CLK_LANE_CTRL_DISABLE 0x00000000U @@ -689,6 +724,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_Number_Of_Lanes DSI Number Of Lanes + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_ONE_DATA_LANE 0U @@ -698,6 +734,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_FlowControl DSI Flow Control + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_FLOW_CONTROL_CRC_RX DSI_PCR_CRCRXE @@ -713,6 +750,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_Color_Coding DSI Color Coding + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_RGB565 0x00000000U /*!< The values 0x00000001 and 0x00000002 can also be used for the RGB565 color mode configuration */ @@ -723,6 +761,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LooselyPacked DSI Loosely Packed + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_LOOSELY_PACKED_ENABLE DSI_LCOLCR_LPE @@ -732,6 +771,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_HSYNC_Polarity DSI HSYNC Polarity + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_HSYNC_ACTIVE_HIGH 0x00000000U @@ -741,6 +781,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_VSYNC_Active_Polarity DSI VSYNC Active Polarity + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_VSYNC_ACTIVE_HIGH 0x00000000U @@ -750,6 +791,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_DATA_ENABLE_Polarity DSI DATA ENABLE Polarity + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_DATA_ENABLE_ACTIVE_HIGH 0x00000000U @@ -759,6 +801,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_PLL_IDF DSI PLL IDF + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_PLL_IN_DIV1 0x00000001U @@ -773,6 +816,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_PLL_ODF DSI PLL ODF + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_PLL_OUT_DIV1 0x00000000U @@ -784,6 +828,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_Flags DSI Flags + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_FLAG_TE DSI_WISR_TEIF @@ -799,6 +844,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_Interrupts DSI Interrupts + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_IT_TE DSI_WIER_TEIE @@ -811,6 +857,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_SHORT_WRITE_PKT_Data_Type DSI SHORT WRITE PKT Data Type + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_DCS_SHORT_PKT_WRITE_P0 0x00000005U /*!< DCS short write, no parameters */ @@ -823,6 +870,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_LONG_WRITE_PKT_Data_Type DSI LONG WRITE PKT Data Type + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_DCS_LONG_PKT_WRITE 0x00000039U /*!< DCS long write */ @@ -832,6 +880,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_SHORT_READ_PKT_Data_Type DSI SHORT READ PKT Data Type + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_DCS_SHORT_PKT_READ 0x00000006U /*!< DCS short read */ @@ -843,6 +892,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_Error_Data_Type DSI Error Data Type + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_DSI_ERROR_NONE 0U @@ -864,6 +914,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_Lane_Group DSI Lane Group + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_CLOCK_LANE 0x00000000U @@ -873,6 +924,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_Communication_Delay DSI Communication Delay + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_SLEW_RATE_HSTX 0x00000000U @@ -883,6 +935,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_CustomLane DSI CustomLane + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_SWAP_LANE_PINS 0x00000000U @@ -892,6 +945,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_Lane_Select DSI Lane Select + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_CLK_LANE 0x00000000U @@ -902,6 +956,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to */ /** @defgroup DSI_PHY_Timing DSI PHY Timing + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_TCLK_POST 0x00000000U @@ -924,6 +979,7 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to /* Exported macros -----------------------------------------------------------*/ /** @defgroup DSI_Exported_Macros DSI Exported Macros + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -1125,9 +1181,11 @@ typedef void (*pDSI_CallbackTypeDef)(DSI_HandleTypeDef *hdsi); /*!< pointer to /* Exported functions --------------------------------------------------------*/ /** @defgroup DSI_Exported_Functions DSI Exported Functions + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @defgroup DSI_Group1 Initialization and Configuration functions + * @ingroup RTEMSBSPsARMSTM32H7 * @brief Initialization and Configuration functions * @{ */ @@ -1147,6 +1205,7 @@ HAL_StatusTypeDef HAL_DSI_UnRegisterCallback(DSI_HandleTypeDef *hdsi, HAL_DSI_Ca */ /** @defgroup DSI_Group2 IO operation functions + * @ingroup RTEMSBSPsARMSTM32H7 * @brief IO operation functions * @{ */ @@ -1159,6 +1218,7 @@ void HAL_DSI_ErrorCallback(DSI_HandleTypeDef *hdsi); */ /** @defgroup DSI_Group3 Peripheral Control functions + * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral Control functions * @{ */ @@ -1219,6 +1279,7 @@ HAL_StatusTypeDef HAL_DSI_SetContentionDetectionOff(DSI_HandleTypeDef *hdsi, Fun */ /** @defgroup DSI_Group4 Peripheral State and Errors functions + * @ingroup RTEMSBSPsARMSTM32H7 * @brief Peripheral State and Errors functions * @{ */ @@ -1238,6 +1299,7 @@ HAL_DSI_StateTypeDef HAL_DSI_GetState(DSI_HandleTypeDef *hdsi); /* Private variables ---------------------------------------------------------*/ /* Private constants ---------------------------------------------------------*/ /** @defgroup DSI_Private_Constants DSI Private Constants + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define DSI_MAX_RETURN_PKT_SIZE (0x00000037U) /*!< Maximum return packet configuration */ @@ -1247,6 +1309,7 @@ HAL_DSI_StateTypeDef HAL_DSI_GetState(DSI_HandleTypeDef *hdsi); /* Private macros ------------------------------------------------------------*/ /** @defgroup DSI_Private_Macros DSI Private Macros + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define IS_DSI_PLL_NDIV(NDIV) ((10U <= (NDIV)) && ((NDIV) <= 125U)) |