STM32L073Z_EVAL BSP User Manual: stm32l073z_eval_lcd.h Source File

STM32L073Z EVAL BSP Drivers

stm32l073z_eval_lcd.h
Go to the documentation of this file.
00001 /**
00002   ******************************************************************************
00003   * @file    stm32l073z_eval_lcd.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains all the functions prototypes for the 
00006   *          stm32l073z_eval_lcd.c driver.
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
00011   *
00012   * Redistribution and use in source and binary forms, with or without modification,
00013   * are permitted provided that the following conditions are met:
00014   *   1. Redistributions of source code must retain the above copyright notice,
00015   *      this list of conditions and the following disclaimer.
00016   *   2. Redistributions in binary form must reproduce the above copyright notice,
00017   *      this list of conditions and the following disclaimer in the documentation
00018   *      and/or other materials provided with the distribution.
00019   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00020   *      may be used to endorse or promote products derived from this software
00021   *      without specific prior written permission.
00022   *
00023   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00026   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00027   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00028   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00029   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00030   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00031   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00032   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033   *
00034   ******************************************************************************
00035   */ 
00036 
00037 /* Define to prevent recursive inclusion -------------------------------------*/
00038 #ifndef __STM32L073Z_EVAL_LCD_H
00039 #define __STM32L073Z_EVAL_LCD_H
00040 
00041 #ifdef __cplusplus
00042  extern "C" {
00043 #endif 
00044 
00045 /* Includes ------------------------------------------------------------------*/
00046 #include "stm32l073z_eval.h" 
00047 /* Include LCD component Driver */
00048 #include "../Components/hx8347d/hx8347d.h"   
00049 #include "../../../Utilities/Fonts/fonts.h"   
00050 
00051 /** @addtogroup BSP
00052   * @{
00053   */
00054 
00055 /** @addtogroup STM32L073Z_EVAL
00056   * @{
00057   */
00058 
00059 /** @addtogroup STM32L073Z_EVAL_LCD
00060   * @{
00061   */
00062 
00063 /** @defgroup STM32L073Z_EVAL_LCD_Exported_Types
00064   * @{
00065   */
00066 typedef struct 
00067 { 
00068   uint32_t TextColor; 
00069   uint32_t BackColor;  
00070   sFONT    *pFont; 
00071 
00072 }LCD_DrawPropTypeDef;   
00073 /**
00074   * @}
00075   */ 
00076 
00077 /** @defgroup STM32L073Z_EVAL_LCD_Exported_Constants
00078   * @{
00079   */
00080 /** 
00081   * @brief  LCD status structure definition  
00082   */     
00083 #define   LCD_OK         0x00
00084 #define   LCD_ERROR      0x01
00085 #define   LCD_TIMEOUT    0x02
00086     
00087 typedef struct 
00088 {
00089   int16_t X;
00090   int16_t Y;
00091 
00092 }Point, * pPoint; 
00093 
00094 /** 
00095   * @brief  Line mode structures definition  
00096   */ 
00097 typedef enum
00098 {
00099   CENTER_MODE             = 0x01,    /*!< Center mode */
00100   RIGHT_MODE              = 0x02,    /*!< Right mode  */     
00101   LEFT_MODE               = 0x03,    /*!< Left mode   */                                                                              
00102   NO_MODE
00103 }Line_ModeTypdef;
00104 
00105 /** 
00106   * @brief  LCD color  
00107   */ 
00108 #define LCD_COLOR_BLUE          0x001F
00109 #define LCD_COLOR_GREEN         0x07E0
00110 #define LCD_COLOR_RED           0xF800
00111 #define LCD_COLOR_CYAN          0x07FF
00112 #define LCD_COLOR_MAGENTA       0xF81F
00113 #define LCD_COLOR_YELLOW        0xFFE0
00114 #define LCD_COLOR_LIGHTBLUE     0x841F
00115 #define LCD_COLOR_LIGHTGREEN    0x87F0
00116 #define LCD_COLOR_LIGHTRED      0xFC10
00117 #define LCD_COLOR_LIGHTCYAN     0x87FF
00118 #define LCD_COLOR_LIGHTMAGENTA  0xFC1F
00119 #define LCD_COLOR_LIGHTYELLOW   0xFFF0
00120 #define LCD_COLOR_DARKBLUE      0x0010
00121 #define LCD_COLOR_DARKGREEN     0x0400
00122 #define LCD_COLOR_DARKRED       0x8000
00123 #define LCD_COLOR_DARKCYAN      0x0410
00124 #define LCD_COLOR_DARKMAGENTA   0x8010
00125 #define LCD_COLOR_DARKYELLOW    0x8400
00126 #define LCD_COLOR_WHITE         0xFFFF
00127 #define LCD_COLOR_LIGHTGRAY     0xD69A
00128 #define LCD_COLOR_GRAY          0x8410
00129 #define LCD_COLOR_DARKGRAY      0x4208
00130 #define LCD_COLOR_BLACK         0x0000
00131 #define LCD_COLOR_BROWN         0xA145
00132 #define LCD_COLOR_ORANGE        0xFD20
00133 
00134 /** 
00135   * @brief LCD default font 
00136   */ 
00137 #define LCD_DEFAULT_FONT         Font24
00138 
00139 /**
00140   * @}
00141   */
00142 
00143 /** @defgroup STM32L073Z_EVAL_LCD_Exported_Functions
00144   * @{
00145   */   
00146 uint8_t  BSP_LCD_Init(void);
00147 uint32_t BSP_LCD_GetXSize(void);
00148 uint32_t BSP_LCD_GetYSize(void);
00149  
00150 uint16_t BSP_LCD_GetTextColor(void);
00151 uint16_t BSP_LCD_GetBackColor(void);
00152 void     BSP_LCD_SetTextColor(__IO uint16_t Color);
00153 void     BSP_LCD_SetBackColor(__IO uint16_t Color);
00154 void     BSP_LCD_SetFont(sFONT *pFonts);
00155 sFONT    *BSP_LCD_GetFont(void);
00156 
00157 void     BSP_LCD_Clear(uint16_t Color);
00158 void     BSP_LCD_ClearStringLine(uint16_t Line);
00159 void     BSP_LCD_DisplayStringAtLine(uint16_t Line, uint8_t *pText);
00160 void     BSP_LCD_DisplayStringAt(uint16_t Xpos, uint16_t Ypos, uint8_t *pText, Line_ModeTypdef Mode);
00161 void     BSP_LCD_DisplayChar(uint16_t Xpos, uint16_t Ypos, uint8_t Ascii);
00162 
00163 uint16_t BSP_LCD_ReadPixel(uint16_t Xpos, uint16_t Ypos);
00164 void     BSP_LCD_DrawPixel(uint16_t Xpos, uint16_t Ypos);
00165 void     BSP_LCD_DrawHLine(uint16_t Xpos, uint16_t Ypos, uint16_t Length);
00166 void     BSP_LCD_DrawVLine(uint16_t Xpos, uint16_t Ypos, uint16_t Length);
00167 void     BSP_LCD_DrawLine(uint16_t X1, uint16_t Y1, uint16_t X2, uint16_t Y2);
00168 void     BSP_LCD_DrawRect(uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height);
00169 void     BSP_LCD_DrawCircle(uint16_t Xpos, uint16_t Ypos, uint16_t Radius);
00170 void     BSP_LCD_DrawPolygon(pPoint pPoints, uint16_t PointCount);
00171 void     BSP_LCD_DrawEllipse(int Xpos, int Ypos, int XRadius, int YRadius);
00172 void     BSP_LCD_DrawBitmap(uint16_t Xpos, uint16_t Ypos, uint8_t *pBmp);
00173 
00174 void     BSP_LCD_FillRect(uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height);
00175 void     BSP_LCD_FillCircle(uint16_t Xpos, uint16_t Ypos, uint16_t Radius);
00176 void     BSP_LCD_FillEllipse(int Xpos, int Ypos, int XRadius, int YRadius);
00177 
00178 void     BSP_LCD_DisplayOff(void);
00179 void     BSP_LCD_DisplayOn(void);
00180 
00181 /**
00182   * @}
00183   */
00184 
00185 /**
00186   * @}
00187   */
00188 
00189 /**
00190   * @}
00191   */
00192 
00193 /**
00194   * @}
00195   */
00196 
00197 #ifdef __cplusplus
00198 }
00199 #endif
00200 
00201 #endif /* __STM32L073Z_EVAL_LCD_H */
00202 
00203 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Generated on Mon Aug 28 2017 14:54:25 for STM32L073Z_EVAL BSP User Manual by   doxygen 1.7.6.1