epd_bw_spi.h

Go to the documentation of this file.

/*
 * Copyright (C) 2019 Silke Hofstra
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef EPD_BW_SPI_H
#define EPD_BW_SPI_H
 
#include "periph/spi.h"
#include "periph/gpio.h"
 
#ifdef MODULE_DISP_DEV
#include "disp_dev.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define EPD_BW_SPI_COLOR_WHITE (0xFF)   
#define EPD_BW_SPI_COLOR_BLACK (0x00)   
typedef enum {
    EPD_BW_SPI_Y_DEC_X_DEC  = 0x0, 
    EPD_BW_SPI_Y_DEC_X_INC  = 0x1, 
    EPD_BW_SPI_Y_INC_X_DEC  = 0x2, 
    EPD_BW_SPI_Y_INC_X_INC  = 0x3, 
} epd_bw_spi_entry_mode_t;
 
enum {
    EPD_BW_SPI_DC_FAIL      = -5,
    EPD_BW_SPI_RST_FAIL     = -6,
    EPD_BW_SPI_BUSY_FAIL    = -7,
};
 
typedef struct {
    uint8_t vcom;               
    const uint16_t size_x;      
    const uint16_t size_y;      
    const uint8_t lut_size;     
    const uint8_t *lut_full;    
    const uint8_t *lut_part;    
} epd_bw_spi_controller_t;
 
typedef struct {
    spi_t spi;                              
    spi_clk_t spi_clk;                      
    gpio_t cs_pin;                          
    gpio_t dc_pin;                          
    gpio_t rst_pin;                         
    gpio_t busy_pin;                        
    bool busy_value;                        
    bool dummy;                             
    epd_bw_spi_controller_t controller;     
    epd_bw_spi_entry_mode_t entry_mode;     
    uint16_t size_x;                        
    uint16_t size_y;                        
    uint16_t partial_refresh_max;           
} epd_bw_spi_params_t;
 
typedef struct {
    #ifdef MODULE_DISP_DEV
    disp_dev_t *dev;                    
    #endif
    epd_bw_spi_params_t params;         
    uint16_t partial_refresh_count;     
} epd_bw_spi_t;
 
int epd_bw_spi_init(epd_bw_spi_t *dev, const epd_bw_spi_params_t *params);
 
void epd_bw_spi_activate(epd_bw_spi_t *dev);
 
void epd_bw_spi_deactivate(epd_bw_spi_t *dev);
 
void epd_bw_spi_init_full(epd_bw_spi_t *dev);
 
void epd_bw_spi_update_full(epd_bw_spi_t *dev);
 
void epd_bw_spi_init_part(epd_bw_spi_t *dev);
 
void epd_bw_spi_update_part(epd_bw_spi_t *dev);
 
void epd_bw_spi_init_auto(epd_bw_spi_t *dev);
 
void epd_bw_spi_update_auto(epd_bw_spi_t *dev);
 
void epd_bw_spi_clear(epd_bw_spi_t *dev);
 
void epd_bw_spi_fill(epd_bw_spi_t *dev, uint8_t x1, uint8_t x2, uint16_t y1,
                     uint16_t y2,
                     uint8_t color);
 
void epd_bw_spi_fill_pixels(epd_bw_spi_t *dev, uint8_t x1, uint8_t x2,
                            uint16_t y1, uint16_t y2,
                            uint8_t *px);
 
void epd_bw_spi_set_area(epd_bw_spi_t *dev, uint8_t x1, uint8_t x2, uint16_t y1,
                         uint16_t y2);
 
void epd_bw_spi_write_buffer(epd_bw_spi_t *dev, const uint8_t *buf, size_t len);
 
void epd_bw_spi_sleep(epd_bw_spi_t *dev);
 
void epd_bw_spi_wake(epd_bw_spi_t *dev);
 
void epd_bw_spi_swreset(epd_bw_spi_t *dev);
 
#ifdef __cplusplus
}
#endif
#endif /* EPD_BW_SPI_H */