STM32769I_EVAL BSP User Manual: stm32f769i_eval_lcd.h Source File

STM32769I_EVAL BSP

stm32f769i_eval_lcd.h
Go to the documentation of this file.
00001 /**
00002   ******************************************************************************
00003   * @file    stm32f769i_eval_lcd.h
00004   * @author  MCD Application Team
00005   * @version V2.0.1
00006   * @date    06-April-2017
00007   * @brief   This file contains the common defines and functions prototypes for
00008   *          the stm32f769i_eval_lcd.c driver.
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2017 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_EVAL_LCD_H
00041 #define __STM32F769I_EVAL_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 
00053 #if defined(USE_LCD_HDMI)    
00054 /* Include ADV7533 HDMI Driver IC driver code */
00055 #include "../Components/adv7533/adv7533.h"
00056 #endif /* USE_LCD_HDMI */   
00057    
00058 /* Include SDRAM Driver */
00059 #include "stm32f769i_eval_sdram.h"
00060 #include "stm32f769i_eval.h"
00061 
00062 #include "../../../Utilities/Fonts/fonts.h"
00063 
00064 #include <string.h> /* use of memset() */
00065 
00066 /** @addtogroup BSP
00067   * @{
00068   */
00069 
00070 /** @addtogroup STM32F769I_EVAL
00071   * @{
00072   */
00073 
00074 /** @addtogroup STM32F769I_EVAL_LCD
00075   * @{
00076   */
00077 
00078 /** @defgroup STM32F769I_EVAL_LCD_Exported_Constants STM32F769I EVAL LCD Exported Constants
00079   * @{
00080   */
00081 #define BSP_LCD_DMA2D_IRQHandler        DMA2D_IRQHandler
00082 #define BSP_LCD_DSI_IRQHandler          DSI_IRQHandler
00083 #define BSP_LCD_LTDC_IRQHandler         LTDC_IRQHandler
00084 #define BSP_LCD_LTDC_ER_IRQHandler      LTDC_ER_IRQHandler
00085 
00086     
00087 #define LCD_LayerCfgTypeDef    LTDC_LayerCfgTypeDef
00088 /** 
00089   * @brief  LCD FB_StartAddress  
00090   */
00091 #define LCD_FB_START_ADDRESS       ((uint32_t)0xC0000000)
00092    
00093 /** @brief Maximum number of LTDC layers
00094  */
00095 #define LTDC_MAX_LAYER_NUMBER             ((uint32_t) 2)
00096 
00097 /** @brief LTDC Background layer index
00098  */
00099 #define LTDC_ACTIVE_LAYER_BACKGROUND      ((uint32_t) 0)
00100 
00101 /** @brief LTDC Foreground layer index
00102  */
00103 #define LTDC_ACTIVE_LAYER_FOREGROUND      ((uint32_t) 1)
00104 
00105 /** @brief Number of LTDC layers
00106  */
00107 #define LTDC_NB_OF_LAYERS                 ((uint32_t) 2)
00108 
00109 /** @brief LTDC Default used layer index
00110  */
00111 #define LTDC_DEFAULT_ACTIVE_LAYER         LTDC_ACTIVE_LAYER_FOREGROUND
00112 
00113 /** 
00114   * @brief  LCD status structure definition  
00115   */     
00116 #define   LCD_OK         0x00
00117 #define   LCD_ERROR      0x01
00118 #define   LCD_TIMEOUT    0x02
00119 
00120 /** 
00121   * @brief  LCD Display OTM8009A DSI Virtual Channel  ID 
00122   */ 
00123 #define LCD_OTM8009A_ID  ((uint32_t) 0)
00124 
00125 #if defined(USE_LCD_HDMI)    
00126 /** 
00127   * @brief  HDMI ADV7533 DSI Virtual Channel  ID  
00128   */    
00129 #define HDMI_ADV7533_ID  ((uint32_t) 0) 
00130 
00131 /** 
00132   * @brief  HDMI Foramt   
00133   */   
00134 #define HDMI_FORMAT_720_480   ((uint8_t) 0x00) /*720_480 format choice of HDMI display */
00135 #define HDMI_FORMAT_720_576   ((uint8_t) 0x01) /*720_576 format choice of HDMI display*/    
00136 
00137 #endif /* USE_LCD_HDMI */
00138    
00139 /**
00140   * @brief  LCD color definitions values
00141   * in ARGB8888 format.
00142   */
00143 
00144 /** @brief Blue value in ARGB8888 format
00145  */
00146 #define LCD_COLOR_BLUE          ((uint32_t) 0xFF0000FF)
00147 
00148 /** @brief Green value in ARGB8888 format
00149  */
00150 #define LCD_COLOR_GREEN         ((uint32_t) 0xFF00FF00)
00151 
00152 /** @brief Red value in ARGB8888 format
00153  */
00154 #define LCD_COLOR_RED           ((uint32_t) 0xFFFF0000)
00155 
00156 /** @brief Cyan value in ARGB8888 format
00157  */
00158 #define LCD_COLOR_CYAN          ((uint32_t) 0xFF00FFFF)
00159 
00160 /** @brief Magenta value in ARGB8888 format
00161  */
00162 #define LCD_COLOR_MAGENTA       ((uint32_t) 0xFFFF00FF)
00163 
00164 /** @brief Yellow value in ARGB8888 format
00165  */
00166 #define LCD_COLOR_YELLOW        ((uint32_t) 0xFFFFFF00)
00167 
00168 /** @brief Light Blue value in ARGB8888 format
00169  */
00170 #define LCD_COLOR_LIGHTBLUE     ((uint32_t) 0xFF8080FF)
00171 
00172 /** @brief Light Green value in ARGB8888 format
00173  */
00174 #define LCD_COLOR_LIGHTGREEN    ((uint32_t) 0xFF80FF80)
00175 
00176 /** @brief Light Red value in ARGB8888 format
00177  */
00178 #define LCD_COLOR_LIGHTRED      ((uint32_t) 0xFFFF8080)
00179 
00180 /** @brief Light Cyan value in ARGB8888 format
00181  */
00182 #define LCD_COLOR_LIGHTCYAN     ((uint32_t) 0xFF80FFFF)
00183 
00184 /** @brief Light Magenta value in ARGB8888 format
00185  */
00186 #define LCD_COLOR_LIGHTMAGENTA  ((uint32_t) 0xFFFF80FF)
00187 
00188 /** @brief Light Yellow value in ARGB8888 format
00189  */
00190 #define LCD_COLOR_LIGHTYELLOW   ((uint32_t) 0xFFFFFF80)
00191 
00192 /** @brief Dark Blue value in ARGB8888 format
00193  */
00194 #define LCD_COLOR_DARKBLUE      ((uint32_t) 0xFF000080)
00195 
00196 /** @brief Light Dark Green value in ARGB8888 format
00197  */
00198 #define LCD_COLOR_DARKGREEN     ((uint32_t) 0xFF008000)
00199 
00200 /** @brief Light Dark Red value in ARGB8888 format
00201  */
00202 #define LCD_COLOR_DARKRED       ((uint32_t) 0xFF800000)
00203 
00204 /** @brief Dark Cyan value in ARGB8888 format
00205  */
00206 #define LCD_COLOR_DARKCYAN      ((uint32_t) 0xFF008080)
00207 
00208 /** @brief Dark Magenta value in ARGB8888 format
00209  */
00210 #define LCD_COLOR_DARKMAGENTA   ((uint32_t) 0xFF800080)
00211 
00212 /** @brief Dark Yellow value in ARGB8888 format
00213  */
00214 #define LCD_COLOR_DARKYELLOW    ((uint32_t) 0xFF808000)
00215 
00216 /** @brief White value in ARGB8888 format
00217  */
00218 #define LCD_COLOR_WHITE         ((uint32_t) 0xFFFFFFFF)
00219 
00220 /** @brief Light Gray value in ARGB8888 format
00221  */
00222 #define LCD_COLOR_LIGHTGRAY     ((uint32_t) 0xFFD3D3D3)
00223 
00224 /** @brief Gray value in ARGB8888 format
00225  */
00226 #define LCD_COLOR_GRAY          ((uint32_t) 0xFF808080)
00227 
00228 /** @brief Dark Gray value in ARGB8888 format
00229  */
00230 #define LCD_COLOR_DARKGRAY      ((uint32_t) 0xFF404040)
00231 
00232 /** @brief Black value in ARGB8888 format
00233  */
00234 #define LCD_COLOR_BLACK         ((uint32_t) 0xFF000000)
00235 
00236 /** @brief Brown value in ARGB8888 format
00237  */
00238 #define LCD_COLOR_BROWN         ((uint32_t) 0xFFA52A2A)
00239 
00240 /** @brief Orange value in ARGB8888 format
00241  */
00242 #define LCD_COLOR_ORANGE        ((uint32_t) 0xFFFFA500)
00243 
00244 /** @brief Transparent value in ARGB8888 format
00245  */
00246 #define LCD_COLOR_TRANSPARENT   ((uint32_t) 0xFF000000)
00247 
00248 /**
00249   * @brief LCD default font
00250   */
00251 #define LCD_DEFAULT_FONT        Font24
00252     
00253 /**
00254  *  @brief  Possible values of
00255  *  pixel data format (ie color coding) transmitted on DSI Data lane in DSI packets
00256  */
00257 
00258 #define   LCD_DSI_PIXEL_DATA_FMT_RBG888  DSI_RGB888 /*!< DSI packet pixel format chosen is RGB888 : 24 bpp */
00259 #define   LCD_DSI_PIXEL_DATA_FMT_RBG565  DSI_RGB565 /*!< DSI packet pixel format chosen is RGB565 : 16 bpp */
00260 
00261 /**
00262   * @}
00263   */
00264 
00265 /** @defgroup STM32F769I_EVAL_LCD_Exported_Types STM32F769I EVAL LCD Exported Types
00266   * @{
00267   */
00268 
00269 /**
00270 * @brief  LCD Drawing main properties
00271 */
00272 typedef struct
00273 {
00274   uint32_t TextColor; /*!< Specifies the color of text */
00275   uint32_t BackColor; /*!< Specifies the background color below the text */
00276   sFONT    *pFont;    /*!< Specifies the font used for the text */
00277 
00278 } LCD_DrawPropTypeDef;
00279 
00280 /**
00281   * @brief  LCD Drawing point (pixel) geometric definition
00282   */
00283 typedef struct
00284 {
00285   int16_t X; /*!< geometric X position of drawing */
00286   int16_t Y; /*!< geometric Y position of drawing */
00287 
00288 } Point;
00289 
00290 /**
00291   * @brief  Pointer on LCD Drawing point (pixel) geometric definition
00292   */
00293 typedef Point * pPoint;
00294 
00295 /**
00296   * @brief  LCD drawing Line alignment mode definitions
00297   */
00298 typedef enum
00299 {
00300   CENTER_MODE             = 0x01,    /*!< Center mode */
00301   RIGHT_MODE              = 0x02,    /*!< Right mode  */
00302   LEFT_MODE               = 0x03     /*!< Left mode   */
00303 
00304 } Text_AlignModeTypdef;
00305 
00306 
00307 /**
00308  *  @brief LCD_OrientationTypeDef
00309  *  Possible values of Display Orientation
00310  */
00311 typedef enum
00312 {
00313   LCD_ORIENTATION_PORTRAIT  = 0x00, /*!< Portrait orientation choice of LCD screen  */
00314   LCD_ORIENTATION_LANDSCAPE = 0x01, /*!< Landscape orientation choice of LCD screen */
00315   LCD_ORIENTATION_INVALID   = 0x02  /*!< Invalid orientation choice of LCD screen   */
00316 } LCD_OrientationTypeDef;
00317 
00318 /**
00319   * @}
00320   */
00321 
00322 /** @defgroup STM32F769I_EVAL_LCD_Exported_Macro STM32F769I EVAL LCD Exported Macro
00323   * @{
00324   */
00325 /**
00326   * @}
00327   */
00328 /** @addtogroup STM32F769I_EVAL_LCD_Exported_Functions
00329   * @{
00330   */
00331 uint8_t  BSP_LCD_Init(void);
00332 uint8_t  BSP_LCD_InitEx(LCD_OrientationTypeDef orientation);
00333 
00334 #if defined(USE_LCD_HDMI) 
00335 uint8_t  BSP_LCD_HDMIInitEx(uint8_t format);
00336 #endif /* USE_LCD_HDMI */
00337 
00338 void     BSP_LCD_MspDeInit(void);
00339 void     BSP_LCD_MspInit(void);
00340 void     BSP_LCD_Reset(void);
00341 
00342 uint32_t BSP_LCD_GetXSize(void);
00343 uint32_t BSP_LCD_GetYSize(void);
00344 void     BSP_LCD_SetXSize(uint32_t imageWidthPixels);
00345 void     BSP_LCD_SetYSize(uint32_t imageHeightPixels);
00346 
00347 void     BSP_LCD_LayerDefaultInit(uint16_t LayerIndex, uint32_t FB_Address);
00348 void     BSP_LCD_SetTransparency(uint32_t LayerIndex, uint8_t Transparency);
00349 void     BSP_LCD_SetLayerAddress(uint32_t LayerIndex, uint32_t Address);
00350 void     BSP_LCD_SetColorKeying(uint32_t LayerIndex, uint32_t RGBValue);
00351 void     BSP_LCD_ResetColorKeying(uint32_t LayerIndex);
00352 void     BSP_LCD_SetLayerWindow(uint16_t LayerIndex, uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height);
00353 
00354 void     BSP_LCD_SelectLayer(uint32_t LayerIndex);
00355 void     BSP_LCD_SetLayerVisible(uint32_t LayerIndex, FunctionalState State);
00356 
00357 void     BSP_LCD_SetTextColor(uint32_t Color);
00358 uint32_t BSP_LCD_GetTextColor(void);
00359 void     BSP_LCD_SetBackColor(uint32_t Color);
00360 uint32_t BSP_LCD_GetBackColor(void);
00361 void     BSP_LCD_SetFont(sFONT *fonts);
00362 sFONT    *BSP_LCD_GetFont(void);
00363 
00364 uint32_t BSP_LCD_ReadPixel(uint16_t Xpos, uint16_t Ypos);
00365 void     BSP_LCD_DrawPixel(uint16_t Xpos, uint16_t Ypos, uint32_t pixel);
00366 void     BSP_LCD_Clear(uint32_t Color);
00367 void     BSP_LCD_ClearStringLine(uint32_t Line);
00368 void     BSP_LCD_DisplayStringAtLine(uint16_t Line, uint8_t *ptr);
00369 void     BSP_LCD_DisplayStringAt(uint16_t Xpos, uint16_t Ypos, uint8_t *Text, Text_AlignModeTypdef Mode);
00370 void     BSP_LCD_DisplayChar(uint16_t Xpos, uint16_t Ypos, uint8_t Ascii);
00371 
00372 void     BSP_LCD_DrawHLine(uint16_t Xpos, uint16_t Ypos, uint16_t Length);
00373 void     BSP_LCD_DrawVLine(uint16_t Xpos, uint16_t Ypos, uint16_t Length);
00374 void     BSP_LCD_DrawLine(uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2);
00375 void     BSP_LCD_DrawRect(uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height);
00376 void     BSP_LCD_DrawCircle(uint16_t Xpos, uint16_t Ypos, uint16_t Radius);
00377 void     BSP_LCD_DrawPolygon(pPoint Points, uint16_t PointCount);
00378 void     BSP_LCD_DrawEllipse(int Xpos, int Ypos, int XRadius, int YRadius);
00379 void     BSP_LCD_DrawBitmap(uint32_t Xpos, uint32_t Ypos, uint8_t *pbmp);
00380 
00381 void     BSP_LCD_FillRect(uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height);
00382 void     BSP_LCD_FillCircle(uint16_t Xpos, uint16_t Ypos, uint16_t Radius);
00383 void     BSP_LCD_FillPolygon(pPoint Points, uint16_t PointCount);
00384 void     BSP_LCD_FillEllipse(int Xpos, int Ypos, int XRadius, int YRadius);
00385 
00386 void     BSP_LCD_DisplayOff(void);
00387 void     BSP_LCD_DisplayOn(void);
00388 void     BSP_LCD_SetBrightness(uint8_t BrightnessValue);
00389 /**
00390   * @}
00391   */
00392 
00393 /** @defgroup STM32F769I_EVAL_LCD_Exported_Variables STM32F769I EVAL LCD Exported Variables
00394   * @{
00395   */
00396 
00397 /* @brief DMA2D handle variable */
00398 extern DMA2D_HandleTypeDef hdma2d_eval;
00399 
00400 /**
00401   * @}
00402   */
00403 
00404 /**
00405   * @}
00406   */
00407 
00408 /**
00409   * @}
00410   */
00411 
00412 /**
00413   * @}
00414   */
00415 
00416 /**
00417   * @}
00418   */
00419 
00420 #ifdef __cplusplus
00421 }
00422 #endif
00423 
00424 #endif /* __STM32F769I_EVAL_LCD_H */
00425 
00426 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Generated on Thu May 25 2017 11:03:11 for STM32769I_EVAL BSP User Manual by   doxygen 1.7.6.1