lcd.h

00001 /**
00002   ******************************************************************************
00003   * @file    lcd.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains all the functions prototypes for the LCD driver.   
00006   ******************************************************************************
00007   * @attention
00008   *
00009   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
00010   *
00011   * Redistribution and use in source and binary forms, with or without modification,
00012   * are permitted provided that the following conditions are met:
00013   *   1. Redistributions of source code must retain the above copyright notice,
00014   *      this list of conditions and the following disclaimer.
00015   *   2. Redistributions in binary form must reproduce the above copyright notice,
00016   *      this list of conditions and the following disclaimer in the documentation
00017   *      and/or other materials provided with the distribution.
00018   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00019   *      may be used to endorse or promote products derived from this software
00020   *      without specific prior written permission.
00021   *
00022   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00023   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00024   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00025   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00026   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00027   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00028   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00030   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00031   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00032   *
00033   ******************************************************************************
00034   */ 
00035 
00036 /* Define to prevent recursive inclusion -------------------------------------*/
00037 #ifndef __LCD_H
00038 #define __LCD_H
00039 
00040 #ifdef __cplusplus
00041  extern "C" {
00042 #endif 
00043 
00044 /* Includes ------------------------------------------------------------------*/
00045 #include <stdint.h>
00046    
00047 /** @addtogroup BSP
00048   * @{
00049   */
00050 
00051 /** @addtogroup Components
00052   * @{
00053   */
00054 
00055 /** @addtogroup LCD
00056   * @{
00057   */
00058  
00059 /** @defgroup LCD_Exported_Types
00060   * @{
00061   */
00062 
00063 /** @defgroup LCD_Driver_structure  LCD Driver structure
00064   * @{
00065   */
00066 typedef struct
00067 {
00068   void     (*Init)(void);
00069   uint16_t (*ReadID)(void);
00070   void     (*DisplayOn)(void);
00071   void     (*DisplayOff)(void);
00072   void     (*SetCursor)(uint16_t, uint16_t);
00073   void     (*WritePixel)(uint16_t, uint16_t, uint16_t);
00074   uint16_t (*ReadPixel)(uint16_t, uint16_t);
00075   
00076    /* Optimized operation */
00077   void     (*SetDisplayWindow)(uint16_t, uint16_t, uint16_t, uint16_t);
00078   void     (*DrawHLine)(uint16_t, uint16_t, uint16_t, uint16_t);
00079   void     (*DrawVLine)(uint16_t, uint16_t, uint16_t, uint16_t);
00080   
00081   uint16_t (*GetLcdPixelWidth)(void);
00082   uint16_t (*GetLcdPixelHeight)(void);
00083   void     (*DrawBitmap)(uint16_t, uint16_t, uint8_t*);
00084   void     (*DrawRGBImage)(uint16_t, uint16_t, uint16_t, uint16_t, uint8_t*);
00085 }LCD_DrvTypeDef;    
00086 /**
00087   * @}
00088   */
00089 
00090 /**
00091   * @}
00092   */
00093 
00094 /**
00095   * @}
00096   */
00097 
00098 /**
00099   * @}
00100   */
00101 
00102 /**
00103   * @}
00104   */
00105 
00106 #ifdef __cplusplus
00107 }
00108 #endif
00109 
00110 #endif /* __LCD_H */
00111 
00112 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/