drivers_uc8151.h

Go to the documentation of this file.

#pragma once
#include <runtime-hw/hw.h>
#include <stdbool.h>
#include <stdint.h>

// TYPES

typedef enum {
  DRIVER_UC8151_UPDATE_SPEED_DEFAULT = 0, 
  DRIVER_UC8151_UPDATE_SPEED_MEDIUM = 1,  
  DRIVER_UC8151_UPDATE_SPEED_FAST = 2,    
  DRIVER_UC8151_UPDATE_SPEED_TURBO = 3    
} driver_uc8151_update_speed_t;

typedef enum {
  DRIVER_UC8151_ROTATION_0 = 0,  
  DRIVER_UC8151_ROTATION_180 = 1 
} driver_uc8151_rotation_t;

typedef struct {
  uint16_t x;      
  uint16_t y;      
  uint16_t width;  
  uint16_t height; 
} driver_uc8151_rect_t;

typedef struct driver_uc8151_t {
  hw_spi_t *spi;                             
  hw_gpio_t dc;                              
  hw_gpio_t reset;                           
  hw_gpio_t busy;                            
  uint16_t width;                            
  uint16_t height;                           
  driver_uc8151_update_speed_t update_speed; 
  driver_uc8151_rotation_t rotation;         
  bool inverted;                             
  bool blocking;                             
} driver_uc8151_t;

// LIFECYCLE

driver_uc8151_t driver_uc8151_init(hw_spi_t *spi, uint8_t dc_pin,
                                   uint8_t reset_pin, uint8_t busy_pin,
                                   uint16_t width, uint16_t height);

void driver_uc8151_finalize(driver_uc8151_t *uc8151);

// PROPERTIES

static inline bool driver_uc8151_valid(driver_uc8151_t *uc8151) {
  return uc8151 && uc8151->spi && hw_spi_valid(uc8151->spi) &&
         uc8151->width > 0 && uc8151->height > 0;
}

// CONFIGURATION

bool driver_uc8151_set_update_speed(driver_uc8151_t *uc8151,
                                    driver_uc8151_update_speed_t speed);

bool driver_uc8151_set_rotation(driver_uc8151_t *uc8151,
                                driver_uc8151_rotation_t rotation);

bool driver_uc8151_set_inverted(driver_uc8151_t *uc8151, bool inverted);

bool driver_uc8151_set_blocking(driver_uc8151_t *uc8151, bool blocking);

uint32_t driver_uc8151_get_update_time(driver_uc8151_t *uc8151);

// DISPLAY OPERATIONS

bool driver_uc8151_is_busy(driver_uc8151_t *uc8151);

void driver_uc8151_busy_wait(driver_uc8151_t *uc8151);

void driver_uc8151_reset(driver_uc8151_t *uc8151);

void driver_uc8151_power_off(driver_uc8151_t *uc8151);

bool driver_uc8151_update(driver_uc8151_t *uc8151, const void *data,
                          size_t size);

bool driver_uc8151_partial_update(driver_uc8151_t *uc8151, const uint8_t *data,
                                  size_t size, driver_uc8151_rect_t rect);