epd.h

00001 /**
00002   ******************************************************************************
00003   * @file    epd.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains all the functions prototypes for the 
00006   *          EPD (E Paper Display) driver.   
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; COPYRIGHT(c) 2017 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 __EPD_H
00039 #define __EPD_H
00040 
00041 #ifdef __cplusplus
00042  extern "C" {
00043 #endif
00044 
00045 /* Includes ------------------------------------------------------------------*/
00046 #include <stdint.h>
00047 
00048 /** @addtogroup BSP
00049   * @{
00050   */
00051 
00052 /** @addtogroup Components
00053   * @{
00054   */
00055   
00056 /** @addtogroup Common
00057   * @{
00058   */
00059 
00060 /** @addtogroup EPD
00061   * @{
00062   */
00063 
00064 /** @defgroup EPD_Exported_Types
00065   * @{
00066   */
00067 
00068 /** @defgroup EPD_Driver_structure  E Paper Display Driver structure
00069   * @{
00070   */
00071 typedef struct
00072 {
00073   void     (*Init)(void);
00074   void     (*WritePixel)(uint8_t);
00075 
00076   /* Optimized operation */
00077   void     (*SetDisplayWindow)(uint16_t, uint16_t, uint16_t, uint16_t);
00078   void     (*RefreshDisplay)(void);
00079   void     (*CloseChargePump)(void);
00080 
00081   uint16_t (*GetEpdPixelWidth)(void);
00082   uint16_t (*GetEpdPixelHeight)(void);
00083   void     (*DrawImage)(uint16_t, uint16_t, uint16_t, uint16_t, uint8_t*);
00084 }
00085 EPD_DrvTypeDef;
00086 /**
00087   * @}
00088   */
00089 
00090 /**
00091   * @}
00092   */
00093 
00094 /**
00095   * @}
00096   */
00097 
00098 /**
00099   * @}
00100   */
00101 
00102 /**
00103   * @}
00104   */
00105 
00106 
00107 #ifdef __cplusplus
00108 }
00109 #endif
00110 
00111 #endif /* EPD_H */
00112 
00113 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/