|
STM32F769I-Discovery BSP User Manual
|
stm32f769i_discovery_lcd.h
Go to the documentation of this file.
00001 /** 00002 ****************************************************************************** 00003 * @file stm32f769i_discovery_lcd.h 00004 * @author MCD Application Team 00005 * @version V2.0.0 00006 * @date 30-December-2016 00007 * @brief This file contains the common defines and functions prototypes for 00008 * the stm32469i_discovery_lcd.c driver. 00009 ****************************************************************************** 00010 * @attention 00011 * 00012 * <h2><center>© COPYRIGHT(c) 2016 STMicroelectronics</center></h2> 00013 * 00014 * Redistribution and use in source and binary forms, with or without modification, 00015 * are permitted provided that the following conditions are met: 00016 * 1. Redistributions of source code must retain the above copyright notice, 00017 * this list of conditions and the following disclaimer. 00018 * 2. Redistributions in binary form must reproduce the above copyright notice, 00019 * this list of conditions and the following disclaimer in the documentation 00020 * and/or other materials provided with the distribution. 00021 * 3. Neither the name of STMicroelectronics nor the names of its contributors 00022 * may be used to endorse or promote products derived from this software 00023 * without specific prior written permission. 00024 * 00025 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00026 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00027 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00028 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 00029 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 00030 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 00031 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 00032 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 00033 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 00034 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00035 * 00036 ****************************************************************************** 00037 */ 00038 00039 /* Define to prevent recursive inclusion -------------------------------------*/ 00040 #ifndef __STM32F769I_DISCOVERY_LCD_H 00041 #define __STM32F769I_DISCOVERY_LCD_H 00042 00043 #ifdef __cplusplus 00044 extern "C" { 00045 #endif 00046 00047 /* Includes ------------------------------------------------------------------*/ 00048 /* Include LCD component Driver */ 00049 00050 /* Include OTM8009A LCD Driver IC driver code */ 00051 #include "../Components/otm8009a/otm8009a.h" 00052 /* Include ADV7533 HDMI Driver IC driver code */ 00053 #include "../Components/adv7533/adv7533.h" 00054 00055 /* Include SDRAM Driver */ 00056 #include "stm32f769i_discovery_sdram.h" 00057 #include "stm32f769i_discovery.h" 00058 00059 #include "../../../Utilities/Fonts/fonts.h" 00060 00061 #include <string.h> /* use of memset() */ 00062 00063 /** @addtogroup BSP 00064 * @{ 00065 */ 00066 00067 /** @addtogroup STM32F769I_DISCOVERY 00068 * @{ 00069 */ 00070 00071 /** @addtogroup STM32F769I_DISCOVERY_LCD 00072 * @{ 00073 */ 00074 00075 /** @defgroup STM32F769I_DISCOVERY_LCD_Exported_Constants STM32F769I DISCOVERY LCD Exported Constants 00076 * @{ 00077 */ 00078 #define BSP_LCD_DMA2D_IRQHandler DMA2D_IRQHandler 00079 #define BSP_LCD_DSI_IRQHandler DSI_IRQHandler 00080 #define BSP_LCD_LTDC_IRQHandler LTDC_IRQHandler 00081 #define BSP_LCD_LTDC_ER_IRQHandler LTDC_ER_IRQHandler 00082 00083 00084 #define LCD_LayerCfgTypeDef LTDC_LayerCfgTypeDef 00085 /** 00086 * @brief LCD FB_StartAddress 00087 */ 00088 #define LCD_FB_START_ADDRESS ((uint32_t)0xC0000000) 00089 00090 /** @brief Maximum number of LTDC layers 00091 */ 00092 #define LTDC_MAX_LAYER_NUMBER ((uint32_t) 2) 00093 00094 /** @brief LTDC Background layer index 00095 */ 00096 #define LTDC_ACTIVE_LAYER_BACKGROUND ((uint32_t) 0) 00097 00098 /** @brief LTDC Foreground layer index 00099 */ 00100 #define LTDC_ACTIVE_LAYER_FOREGROUND ((uint32_t) 1) 00101 00102 /** @brief Number of LTDC layers 00103 */ 00104 #define LTDC_NB_OF_LAYERS ((uint32_t) 2) 00105 00106 /** @brief LTDC Default used layer index 00107 */ 00108 #define LTDC_DEFAULT_ACTIVE_LAYER LTDC_ACTIVE_LAYER_FOREGROUND 00109 00110 /** 00111 * @brief LCD status structure definition 00112 */ 00113 #define LCD_OK 0x00 00114 #define LCD_ERROR 0x01 00115 #define LCD_TIMEOUT 0x02 00116 00117 /** 00118 * @brief LCD Display OTM8009A DSI Virtual Channel ID 00119 */ 00120 #define LCD_OTM8009A_ID ((uint32_t) 0) 00121 00122 /** 00123 * @brief HDMI ADV7533 DSI Virtual Channel ID 00124 */ 00125 #define HDMI_ADV7533_ID ((uint32_t) 0) 00126 00127 /** 00128 * @brief HDMI Foramt 00129 */ 00130 #define HDMI_FORMAT_720_480 ((uint8_t) 0x00) /*720_480 format choice of HDMI display */ 00131 #define HDMI_FORMAT_720_576 ((uint8_t) 0x01) /*720_576 format choice of HDMI display*/ 00132 00133 /** 00134 * @brief LCD color definitions values 00135 * in ARGB8888 format. 00136 */ 00137 00138 /** @brief Blue value in ARGB8888 format 00139 */ 00140 #define LCD_COLOR_BLUE ((uint32_t) 0xFF0000FF) 00141 00142 /** @brief Green value in ARGB8888 format 00143 */ 00144 #define LCD_COLOR_GREEN ((uint32_t) 0xFF00FF00) 00145 00146 /** @brief Red value in ARGB8888 format 00147 */ 00148 #define LCD_COLOR_RED ((uint32_t) 0xFFFF0000) 00149 00150 /** @brief Cyan value in ARGB8888 format 00151 */ 00152 #define LCD_COLOR_CYAN ((uint32_t) 0xFF00FFFF) 00153 00154 /** @brief Magenta value in ARGB8888 format 00155 */ 00156 #define LCD_COLOR_MAGENTA ((uint32_t) 0xFFFF00FF) 00157 00158 /** @brief Yellow value in ARGB8888 format 00159 */ 00160 #define LCD_COLOR_YELLOW ((uint32_t) 0xFFFFFF00) 00161 00162 /** @brief Light Blue value in ARGB8888 format 00163 */ 00164 #define LCD_COLOR_LIGHTBLUE ((uint32_t) 0xFF8080FF) 00165 00166 /** @brief Light Green value in ARGB8888 format 00167 */ 00168 #define LCD_COLOR_LIGHTGREEN ((uint32_t) 0xFF80FF80) 00169 00170 /** @brief Light Red value in ARGB8888 format 00171 */ 00172 #define LCD_COLOR_LIGHTRED ((uint32_t) 0xFFFF8080) 00173 00174 /** @brief Light Cyan value in ARGB8888 format 00175 */ 00176 #define LCD_COLOR_LIGHTCYAN ((uint32_t) 0xFF80FFFF) 00177 00178 /** @brief Light Magenta value in ARGB8888 format 00179 */ 00180 #define LCD_COLOR_LIGHTMAGENTA ((uint32_t) 0xFFFF80FF) 00181 00182 /** @brief Light Yellow value in ARGB8888 format 00183 */ 00184 #define LCD_COLOR_LIGHTYELLOW ((uint32_t) 0xFFFFFF80) 00185 00186 /** @brief Dark Blue value in ARGB8888 format 00187 */ 00188 #define LCD_COLOR_DARKBLUE ((uint32_t) 0xFF000080) 00189 00190 /** @brief Light Dark Green value in ARGB8888 format 00191 */ 00192 #define LCD_COLOR_DARKGREEN ((uint32_t) 0xFF008000) 00193 00194 /** @brief Light Dark Red value in ARGB8888 format 00195 */ 00196 #define LCD_COLOR_DARKRED ((uint32_t) 0xFF800000) 00197 00198 /** @brief Dark Cyan value in ARGB8888 format 00199 */ 00200 #define LCD_COLOR_DARKCYAN ((uint32_t) 0xFF008080) 00201 00202 /** @brief Dark Magenta value in ARGB8888 format 00203 */ 00204 #define LCD_COLOR_DARKMAGENTA ((uint32_t) 0xFF800080) 00205 00206 /** @brief Dark Yellow value in ARGB8888 format 00207 */ 00208 #define LCD_COLOR_DARKYELLOW ((uint32_t) 0xFF808000) 00209 00210 /** @brief White value in ARGB8888 format 00211 */ 00212 #define LCD_COLOR_WHITE ((uint32_t) 0xFFFFFFFF) 00213 00214 /** @brief Light Gray value in ARGB8888 format 00215 */ 00216 #define LCD_COLOR_LIGHTGRAY ((uint32_t) 0xFFD3D3D3) 00217 00218 /** @brief Gray value in ARGB8888 format 00219 */ 00220 #define LCD_COLOR_GRAY ((uint32_t) 0xFF808080) 00221 00222 /** @brief Dark Gray value in ARGB8888 format 00223 */ 00224 #define LCD_COLOR_DARKGRAY ((uint32_t) 0xFF404040) 00225 00226 /** @brief Black value in ARGB8888 format 00227 */ 00228 #define LCD_COLOR_BLACK ((uint32_t) 0xFF000000) 00229 00230 /** @brief Brown value in ARGB8888 format 00231 */ 00232 #define LCD_COLOR_BROWN ((uint32_t) 0xFFA52A2A) 00233 00234 /** @brief Orange value in ARGB8888 format 00235 */ 00236 #define LCD_COLOR_ORANGE ((uint32_t) 0xFFFFA500) 00237 00238 /** @brief Transparent value in ARGB8888 format 00239 */ 00240 #define LCD_COLOR_TRANSPARENT ((uint32_t) 0xFF000000) 00241 00242 /** 00243 * @brief LCD default font 00244 */ 00245 #define LCD_DEFAULT_FONT Font24 00246 00247 /** 00248 * @brief Possible values of 00249 * pixel data format (ie color coding) transmitted on DSI Data lane in DSI packets 00250 */ 00251 00252 #define LCD_DSI_PIXEL_DATA_FMT_RBG888 DSI_RGB888 /*!< DSI packet pixel format chosen is RGB888 : 24 bpp */ 00253 #define LCD_DSI_PIXEL_DATA_FMT_RBG565 DSI_RGB565 /*!< DSI packet pixel format chosen is RGB565 : 16 bpp */ 00254 00255 /** 00256 * @} 00257 */ 00258 00259 /** @defgroup STM32F769I_DISCOVERY_LCD_Exported_Types STM32F769I DISCOVERY LCD Exported Types 00260 * @{ 00261 */ 00262 00263 /** 00264 * @brief LCD Drawing main properties 00265 */ 00266 typedef struct 00267 { 00268 uint32_t TextColor; /*!< Specifies the color of text */ 00269 uint32_t BackColor; /*!< Specifies the background color below the text */ 00270 sFONT *pFont; /*!< Specifies the font used for the text */ 00271 00272 } LCD_DrawPropTypeDef; 00273 00274 /** 00275 * @brief LCD Drawing point (pixel) geometric definition 00276 */ 00277 typedef struct 00278 { 00279 int16_t X; /*!< geometric X position of drawing */ 00280 int16_t Y; /*!< geometric Y position of drawing */ 00281 00282 } Point; 00283 00284 /** 00285 * @brief Pointer on LCD Drawing point (pixel) geometric definition 00286 */ 00287 typedef Point * pPoint; 00288 00289 /** 00290 * @brief LCD drawing Line alignment mode definitions 00291 */ 00292 typedef enum 00293 { 00294 CENTER_MODE = 0x01, /*!< Center mode */ 00295 RIGHT_MODE = 0x02, /*!< Right mode */ 00296 LEFT_MODE = 0x03 /*!< Left mode */ 00297 00298 } Text_AlignModeTypdef; 00299 00300 00301 /** 00302 * @brief LCD_OrientationTypeDef 00303 * Possible values of Display Orientation 00304 */ 00305 typedef enum 00306 { 00307 LCD_ORIENTATION_PORTRAIT = 0x00, /*!< Portrait orientation choice of LCD screen */ 00308 LCD_ORIENTATION_LANDSCAPE = 0x01, /*!< Landscape orientation choice of LCD screen */ 00309 LCD_ORIENTATION_INVALID = 0x02 /*!< Invalid orientation choice of LCD screen */ 00310 } LCD_OrientationTypeDef; 00311 00312 /** 00313 * @} 00314 */ 00315 00316 /** @defgroup STM32F769I_DISCOVERY_LCD_Exported_Macro STM32F769I DISCOVERY LCD Exported Macro 00317 * @{ 00318 */ 00319 00320 /** @addtogroup STM32F769I_DISCOVERY_LCD_Exported_Functions 00321 * @{ 00322 */ 00323 uint8_t BSP_LCD_Init(void); 00324 uint8_t BSP_LCD_InitEx(LCD_OrientationTypeDef orientation); 00325 uint8_t BSP_LCD_HDMIInitEx(uint8_t format); 00326 00327 void BSP_LCD_MspDeInit(void); 00328 void BSP_LCD_MspInit(void); 00329 void BSP_LCD_Reset(void); 00330 00331 uint32_t BSP_LCD_GetXSize(void); 00332 uint32_t BSP_LCD_GetYSize(void); 00333 void BSP_LCD_SetXSize(uint32_t imageWidthPixels); 00334 void BSP_LCD_SetYSize(uint32_t imageHeightPixels); 00335 00336 void BSP_LCD_LayerDefaultInit(uint16_t LayerIndex, uint32_t FB_Address); 00337 void BSP_LCD_SetTransparency(uint32_t LayerIndex, uint8_t Transparency); 00338 void BSP_LCD_SetLayerAddress(uint32_t LayerIndex, uint32_t Address); 00339 void BSP_LCD_SetColorKeying(uint32_t LayerIndex, uint32_t RGBValue); 00340 void BSP_LCD_ResetColorKeying(uint32_t LayerIndex); 00341 void BSP_LCD_SetLayerWindow(uint16_t LayerIndex, uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height); 00342 00343 void BSP_LCD_SelectLayer(uint32_t LayerIndex); 00344 void BSP_LCD_SetLayerVisible(uint32_t LayerIndex, FunctionalState State); 00345 00346 void BSP_LCD_SetTextColor(uint32_t Color); 00347 uint32_t BSP_LCD_GetTextColor(void); 00348 void BSP_LCD_SetBackColor(uint32_t Color); 00349 uint32_t BSP_LCD_GetBackColor(void); 00350 void BSP_LCD_SetFont(sFONT *fonts); 00351 sFONT *BSP_LCD_GetFont(void); 00352 00353 uint32_t BSP_LCD_ReadPixel(uint16_t Xpos, uint16_t Ypos); 00354 void BSP_LCD_DrawPixel(uint16_t Xpos, uint16_t Ypos, uint32_t pixel); 00355 void BSP_LCD_Clear(uint32_t Color); 00356 void BSP_LCD_ClearStringLine(uint32_t Line); 00357 void BSP_LCD_DisplayStringAtLine(uint16_t Line, uint8_t *ptr); 00358 void BSP_LCD_DisplayStringAt(uint16_t Xpos, uint16_t Ypos, uint8_t *Text, Text_AlignModeTypdef Mode); 00359 void BSP_LCD_DisplayChar(uint16_t Xpos, uint16_t Ypos, uint8_t Ascii); 00360 00361 void BSP_LCD_DrawHLine(uint16_t Xpos, uint16_t Ypos, uint16_t Length); 00362 void BSP_LCD_DrawVLine(uint16_t Xpos, uint16_t Ypos, uint16_t Length); 00363 void BSP_LCD_DrawLine(uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2); 00364 void BSP_LCD_DrawRect(uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height); 00365 void BSP_LCD_DrawCircle(uint16_t Xpos, uint16_t Ypos, uint16_t Radius); 00366 void BSP_LCD_DrawPolygon(pPoint Points, uint16_t PointCount); 00367 void BSP_LCD_DrawEllipse(int Xpos, int Ypos, int XRadius, int YRadius); 00368 void BSP_LCD_DrawBitmap(uint32_t Xpos, uint32_t Ypos, uint8_t *pbmp); 00369 00370 void BSP_LCD_FillRect(uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height); 00371 void BSP_LCD_FillCircle(uint16_t Xpos, uint16_t Ypos, uint16_t Radius); 00372 void BSP_LCD_FillPolygon(pPoint Points, uint16_t PointCount); 00373 void BSP_LCD_FillEllipse(int Xpos, int Ypos, int XRadius, int YRadius); 00374 00375 void BSP_LCD_DisplayOn(void); 00376 void BSP_LCD_DisplayOff(void); 00377 void BSP_LCD_SetBrightness(uint8_t BrightnessValue); 00378 00379 /** 00380 * @} 00381 */ 00382 00383 /** @defgroup STM32F769I_DISCOVERY_LCD_Exported_Variables STM32F769I DISCOVERY LCD Exported Variables 00384 * @{ 00385 */ 00386 00387 /* @brief DMA2D handle variable */ 00388 extern DMA2D_HandleTypeDef hdma2d_discovery; 00389 00390 /** 00391 * @} 00392 */ 00393 00394 /** 00395 * @} 00396 */ 00397 00398 /** 00399 * @} 00400 */ 00401 00402 /** 00403 * @} 00404 */ 00405 00406 /** 00407 * @} 00408 */ 00409 00410 #ifdef __cplusplus 00411 } 00412 #endif 00413 00414 #endif /* __STM32F769I_DISCOVERY_LCD_H */ 00415 00416 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Generated on Fri Dec 30 2016 18:30:07 for STM32F769I-Discovery BSP User Manual by
1.7.6.1