STM324x9I_EVAL BSP User Manual: stm324x9i_eval_lcd.h Source File

STM32429I/STM32439I/STM32469I/STM32479I EVAL BSP Drivers

stm324x9i_eval_lcd.h
Go to the documentation of this file.
00001 /**
00002   ******************************************************************************
00003   * @file    stm324x9i_eval_lcd.h
00004   * @author  MCD Application Team
00005   * @version V2.2.2
00006   * @date    13-January-2016
00007   * @brief   This file contains the common defines and functions prototypes for
00008   *          the stm324x9i_eval_lcd.c driver.
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2015 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 __STM324x9I_EVAL_LCD_H
00041 #define __STM324x9I_EVAL_LCD_H
00042 
00043 #ifdef __cplusplus
00044  extern "C" {
00045 #endif 
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 /* Include LCD component Driver */
00049 /* LCD integrated within MB1063 */   
00050 #include "../Components/ampire640480/ampire640480.h"
00051 /* LCD integrated within MB1046 */
00052 #include "../Components/ampire480272/ampire480272.h"
00053 
00054 /* Include IOExpander(STMPE811) component Driver */   
00055 #include "../Components/stmpe811/stmpe811.h"
00056    
00057 /* Include SDRAM Driver */
00058 #include "stm324x9i_eval_sdram.h"
00059  
00060 #include "stm324x9i_eval.h"   
00061 #include "../../../Utilities/Fonts/fonts.h"
00062   
00063 /** @addtogroup BSP
00064   * @{
00065   */
00066 
00067 /** @addtogroup STM324x9I_EVAL
00068   * @{
00069   */
00070     
00071 /** @addtogroup STM324x9I_EVAL_LCD
00072   * @{
00073   */ 
00074 
00075 /** @defgroup STM324x9I_EVAL_LCD_Exported_Types STM324x9I EVAL LCD Exported Types
00076   * @{
00077   */  
00078 typedef struct 
00079 { 
00080   uint32_t TextColor; 
00081   uint32_t BackColor;  
00082   sFONT    *pFont;
00083 }LCD_DrawPropTypeDef;   
00084    
00085 typedef struct 
00086 {
00087   int16_t X;
00088   int16_t Y;
00089 }Point, * pPoint; 
00090    
00091 /** 
00092   * @brief  Line mode structures definition  
00093   */ 
00094 typedef enum
00095 {
00096   CENTER_MODE             = 0x01,    /* Center mode */
00097   RIGHT_MODE              = 0x02,    /* Right mode  */
00098   LEFT_MODE               = 0x03     /* Left mode   */
00099 }Text_AlignModeTypdef;
00100 
00101 /**
00102   * @}
00103   */ 
00104 
00105 /** @defgroup STM324x9I_EVAL_LCD_Exported_Constants STM324x9I EVAL LCD Exported Constants
00106   * @{
00107   */ 
00108 #define MAX_LAYER_NUMBER       2
00109 
00110 #define LCD_LayerCfgTypeDef    LTDC_LayerCfgTypeDef
00111 
00112 /** 
00113   * @brief  LCD status structure definition  
00114   */     
00115 #define   LCD_OK         0x00
00116 #define   LCD_ERROR      0x01
00117 #define   LCD_TIMEOUT    0x02
00118 
00119 /** 
00120   * @brief  LCD FB_StartAddress  
00121   */
00122 #define LCD_FB_START_ADDRESS       ((uint32_t)0xC0000000)
00123 
00124 /* The programmed LTDC pixel clock depends on the vertical refresh rate of the panel 60Hz => 25.16MHz and
00125    the LCD/SDRAM bandwidth affected by the several access on the bus and the number of used layers. 
00126    when only one layer is enabled "LCD_MAX_PCLK" can be used and when two layers are enabled simultaneously 
00127    or/and there is several access on the bus "LCD_MIN_PCLK" parameter is recommended */
00128 #define LCD_MAX_PCLK       ((uint8_t)0x00)  
00129 #define LCD_MIN_PCLK       ((uint8_t)0x01)
00130 
00131 /** 
00132   * @brief  LCD color  
00133   */ 
00134 #define LCD_COLOR_BLUE          0xFF0000FF
00135 #define LCD_COLOR_GREEN         0xFF00FF00
00136 #define LCD_COLOR_RED           0xFFFF0000
00137 #define LCD_COLOR_CYAN          0xFF00FFFF
00138 #define LCD_COLOR_MAGENTA       0xFFFF00FF
00139 #define LCD_COLOR_YELLOW        0xFFFFFF00
00140 #define LCD_COLOR_LIGHTBLUE     0xFF8080FF
00141 #define LCD_COLOR_LIGHTGREEN    0xFF80FF80
00142 #define LCD_COLOR_LIGHTRED      0xFFFF8080
00143 #define LCD_COLOR_LIGHTCYAN     0xFF80FFFF
00144 #define LCD_COLOR_LIGHTMAGENTA  0xFFFF80FF
00145 #define LCD_COLOR_LIGHTYELLOW   0xFFFFFF80
00146 #define LCD_COLOR_DARKBLUE      0xFF000080
00147 #define LCD_COLOR_DARKGREEN     0xFF008000
00148 #define LCD_COLOR_DARKRED       0xFF800000
00149 #define LCD_COLOR_DARKCYAN      0xFF008080
00150 #define LCD_COLOR_DARKMAGENTA   0xFF800080
00151 #define LCD_COLOR_DARKYELLOW    0xFF808000
00152 #define LCD_COLOR_WHITE         0xFFFFFFFF
00153 #define LCD_COLOR_LIGHTGRAY     0xFFD3D3D3
00154 #define LCD_COLOR_GRAY          0xFF808080
00155 #define LCD_COLOR_DARKGRAY      0xFF404040
00156 #define LCD_COLOR_BLACK         0xFF000000
00157 #define LCD_COLOR_BROWN         0xFFA52A2A
00158 #define LCD_COLOR_ORANGE        0xFFFFA500
00159 #define LCD_COLOR_TRANSPARENT   0xFF000000
00160 
00161 /** 
00162   * @brief LCD default font 
00163   */ 
00164 #define LCD_DEFAULT_FONT        Font24     
00165 /**
00166   * @}
00167   */ 
00168 
00169 /** @defgroup STM324x9I_EVAL_LCD_Exported_Functions STM324x9I EVAL LCD Exported Functions
00170   * @{
00171   */
00172 uint8_t  BSP_LCD_Init(void);
00173 uint8_t  BSP_LCD_InitEx(uint32_t PclkConfig);
00174 
00175 uint32_t BSP_LCD_GetXSize(void);
00176 uint32_t BSP_LCD_GetYSize(void);
00177 
00178 /* Functions using the LTDC controller */
00179 void     BSP_LCD_LayerDefaultInit(uint16_t LayerIndex, uint32_t FrameBuffer);
00180 void     BSP_LCD_SetTransparency(uint32_t LayerIndex, uint8_t Transparency);
00181 void     BSP_LCD_SetLayerAddress(uint32_t LayerIndex, uint32_t Address);
00182 void     BSP_LCD_SetColorKeying(uint32_t LayerIndex, uint32_t RGBValue);
00183 void     BSP_LCD_ResetColorKeying(uint32_t LayerIndex);
00184 void     BSP_LCD_SetLayerWindow(uint16_t LayerIndex, uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height);
00185 
00186 void     BSP_LCD_SelectLayer(uint32_t LayerIndex);
00187 void     BSP_LCD_SetLayerVisible(uint32_t LayerIndex, FunctionalState State);
00188 
00189 void     BSP_LCD_SetTextColor(uint32_t Color);
00190 uint32_t BSP_LCD_GetTextColor(void);
00191 void     BSP_LCD_SetBackColor(uint32_t Color);
00192 uint32_t BSP_LCD_GetBackColor(void);
00193 void     BSP_LCD_SetFont(sFONT *fonts);
00194 sFONT    *BSP_LCD_GetFont(void);
00195 
00196 uint32_t BSP_LCD_ReadPixel(uint16_t Xpos, uint16_t Ypos);
00197 void     BSP_LCD_DrawPixel(uint16_t Xpos, uint16_t Ypos, uint32_t pixel);
00198 void     BSP_LCD_Clear(uint32_t Color);
00199 void     BSP_LCD_ClearStringLine(uint32_t Line);
00200 void     BSP_LCD_DisplayStringAtLine(uint16_t Line, uint8_t *ptr);
00201 void     BSP_LCD_DisplayStringAt(uint16_t Xpos, uint16_t Ypos, uint8_t *Text, Text_AlignModeTypdef Mode);
00202 void     BSP_LCD_DisplayChar(uint16_t Xpos, uint16_t Ypos, uint8_t Ascii);
00203 
00204 void     BSP_LCD_DrawHLine(uint16_t Xpos, uint16_t Ypos, uint16_t Length);
00205 void     BSP_LCD_DrawVLine(uint16_t Xpos, uint16_t Ypos, uint16_t Length);
00206 void     BSP_LCD_DrawLine(uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2);
00207 void     BSP_LCD_DrawRect(uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height);
00208 void     BSP_LCD_DrawCircle(uint16_t Xpos, uint16_t Ypos, uint16_t Radius);
00209 void     BSP_LCD_DrawPolygon(pPoint Points, uint16_t PointCount);
00210 void     BSP_LCD_DrawEllipse(int Xpos, int Ypos, int XRadius, int YRadius);
00211 void     BSP_LCD_DrawBitmap(uint32_t Xpos, uint32_t Ypos, uint8_t *pbmp);
00212 
00213 void     BSP_LCD_FillRect(uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height);
00214 void     BSP_LCD_FillCircle(uint16_t Xpos, uint16_t Ypos, uint16_t Radius);
00215 void     BSP_LCD_FillPolygon(pPoint Points, uint16_t PointCount);
00216 void     BSP_LCD_FillEllipse(int Xpos, int Ypos, int XRadius, int YRadius);
00217 
00218 void     BSP_LCD_DisplayOff(void);
00219 void     BSP_LCD_DisplayOn(void);
00220 
00221 void     BSP_LCD_ClockConfig(LTDC_HandleTypeDef *hltdc, void *Params);
00222 /**
00223   * @}
00224   */ 
00225 
00226 /**
00227   * @}
00228   */ 
00229   
00230 /**
00231   * @}
00232   */
00233  
00234 /**
00235   * @}
00236   */ 
00237 
00238 #ifdef __cplusplus
00239 }
00240 #endif
00241 
00242 #endif /* __STM324x9I_EVAL_LCD_H */
00243 
00244 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Generated on Wed Jan 13 2016 15:52:54 for STM324x9I_EVAL BSP User Manual by   doxygen 1.7.6.1