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.
00011   * All rights reserved.</center></h2>
00012   *
00013   * This software component is licensed by ST under BSD 3-Clause license,
00014   * the "License"; You may not use this file except in compliance with the
00015   * License. You may obtain a copy of the License at:
00016   *                        opensource.org/licenses/BSD-3-Clause
00017   *
00018   ******************************************************************************
00019   */ 
00020 
00021 /* Define to prevent recursive inclusion -------------------------------------*/
00022 #ifndef __EPD_H
00023 #define __EPD_H
00024 
00025 #ifdef __cplusplus
00026  extern "C" {
00027 #endif
00028 
00029 /* Includes ------------------------------------------------------------------*/
00030 #include <stdint.h>
00031 
00032 /** @addtogroup BSP
00033   * @{
00034   */
00035 
00036 /** @addtogroup Components
00037   * @{
00038   */
00039   
00040 /** @addtogroup Common
00041   * @{
00042   */
00043 
00044 /** @addtogroup EPD
00045   * @{
00046   */
00047 
00048 /** @defgroup EPD_Exported_Types
00049   * @{
00050   */
00051 
00052 /** @defgroup EPD_Driver_structure  E Paper Display Driver structure
00053   * @{
00054   */
00055 typedef struct
00056 {
00057   void     (*Init)(void);
00058   void     (*WritePixel)(uint8_t);
00059 
00060   /* Optimized operation */
00061   void     (*SetDisplayWindow)(uint16_t, uint16_t, uint16_t, uint16_t);
00062   void     (*RefreshDisplay)(void);
00063   void     (*CloseChargePump)(void);
00064 
00065   uint16_t (*GetEpdPixelWidth)(void);
00066   uint16_t (*GetEpdPixelHeight)(void);
00067   void     (*DrawImage)(uint16_t, uint16_t, uint16_t, uint16_t, uint8_t*);
00068 }
00069 EPD_DrvTypeDef;
00070 /**
00071   * @}
00072   */
00073 
00074 /**
00075   * @}
00076   */
00077 
00078 /**
00079   * @}
00080   */
00081 
00082 /**
00083   * @}
00084   */
00085 
00086 /**
00087   * @}
00088   */
00089 
00090 
00091 #ifdef __cplusplus
00092 }
00093 #endif
00094 
00095 #endif /* EPD_H */
00096 
00097 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/