ra8_epaper.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_spi_bus_ops.h"

typedef enum : uint8_t {
  k_ra8_epaper_wf_init = 0U, 
  k_ra8_epaper_wf_du   = 1U, 
  k_ra8_epaper_wf_gc16 = 2U, 
  k_ra8_epaper_wf_a2   = 3U, 
} ra8_epaper_waveform_t;

typedef struct {
  uint8_t init; 
  uint8_t du;   
  uint8_t gc16; 
  uint8_t a2;   
} ra8_epaper_waveform_cfg_t;

typedef enum : uint8_t {
  k_ra8_epaper_pf_1bpp = 0U, 
  k_ra8_epaper_pf_2bpp = 1U, 
  k_ra8_epaper_pf_4bpp = 2U, 
  k_ra8_epaper_pf_8bpp = 3U, 
} ra8_epaper_pixel_format_t;

typedef enum : uint16_t {
  k_ra8_epaper_align_1bpp_px = 32U, 
  k_ra8_epaper_wf_mode_max   = 7U,  
} ra8_epaper_geom_limits_t;

typedef enum : uint8_t {
  k_ra8_epaper_ver_chars = 16U, 
} ra8_epaper_dev_info_limits_t;

typedef struct {
  uint16_t panel_width;                              
  uint16_t panel_height;                             
  uint32_t image_buf_base;                           
  char     fw_version[k_ra8_epaper_ver_chars + 1U];  
  char     lut_version[k_ra8_epaper_ver_chars + 1U]; 
} ra8_epaper_dev_info_t;

typedef enum : uint8_t {
  k_ra8_epaper_endian_little = 0U, 
  k_ra8_epaper_endian_big    = 1U, 
} ra8_epaper_endian_t;

typedef struct {
  ra8_spi_bus_ops_t         bus;          
  ra8_epaper_waveform_cfg_t waveform;     
  uint16_t                  reset_pin;    
  uint16_t                  busy_pin;     
  uint16_t                  panel_width;  
  uint16_t                  panel_height; 
} ra8_epaper_cfg_t;

typedef struct {
  uint16_t x;      
  uint16_t y;      
  uint16_t width;  
  uint16_t height; 
} ra8_epaper_area_t;
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_epaper_init(const ra8_epaper_cfg_t* cfg);

[[nodiscard]] uint8_t ra8_epaper_bits_per_pixel(ra8_epaper_pixel_format_t pf);

[[nodiscard]] ra8_err_t ra8_epaper_image_bytes(const ra8_epaper_area_t*  area,
                                               ra8_epaper_pixel_format_t pf,
                                               size_t*                   out_bytes);

[[nodiscard]] bool ra8_epaper_area_is_aligned(const ra8_epaper_area_t*  area,
                                              ra8_epaper_pixel_format_t pf);

[[nodiscard]] ra8_err_t
ra8_epaper_align_area(ra8_epaper_area_t* area, ra8_epaper_pixel_format_t pf, uint16_t panel_width);

[[nodiscard]] ra8_err_t ra8_epaper_waveform_cfg_for_lut(const char*                lut_version,
                                                        ra8_epaper_waveform_cfg_t* out_cfg);

[[nodiscard]] ra8_err_t ra8_epaper_validate_cfg(const ra8_epaper_cfg_t* cfg);

[[nodiscard]] bool ra8_epaper_geometry_agrees(const ra8_epaper_dev_info_t* info,
                                              const ra8_epaper_cfg_t*      cfg);

[[nodiscard]] ra8_err_t ra8_epaper_dev_info(ra8_epaper_dev_info_t* out_info);

[[nodiscard]] ra8_err_t
ra8_epaper_decode_dev_info(const uint16_t* words, size_t count, ra8_epaper_dev_info_t* out_info);

[[nodiscard]] ra8_err_t ra8_epaper_get_vcom(uint16_t* out_mv);

[[nodiscard]] ra8_err_t ra8_epaper_set_vcom(uint16_t mv);

[[nodiscard]] bool ra8_epaper_vcom_verified(void);

[[nodiscard]] ra8_err_t ra8_epaper_load_image(const ra8_epaper_area_t*  area,
                                              const uint8_t*            buf,
                                              size_t                    buf_len,
                                              ra8_epaper_pixel_format_t pf,
                                              ra8_epaper_endian_t       endian);

[[nodiscard]] ra8_err_t ra8_epaper_display_area(const ra8_epaper_area_t* area,
                                                ra8_epaper_waveform_t    waveform);

[[nodiscard]] ra8_err_t ra8_epaper_sleep(void);
 
#ifdef __cplusplus
}
#endif