ra8_glcdc.h

Go to the documentation of this file.

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

typedef struct {
  uint16_t h_active; 
  uint16_t h_front;  
  uint16_t h_back;   
  uint16_t h_sync;   
  uint16_t v_active; 
  uint16_t v_front;  
  uint16_t v_back;   
  uint16_t v_sync;   
} ra8_glcdc_timing_t;

typedef struct {
  uint32_t              framebuffer_addr; 
  uint16_t              width_px;         
  uint16_t              height_px;        
  ra8_glcdc_pixel_fmt_t format;           
  ra8_glcdc_timing_t    timing;           
} ra8_glcdc_config_t;

typedef struct {
  uint32_t              framebuffer_addr;  
  uint32_t              line_stride_bytes; 
  uint16_t              width_px;          
  uint16_t              height_px;         
  uint16_t              pos_x;             
  uint16_t              pos_y;             
  ra8_glcdc_pixel_fmt_t format;            
  uint8_t               alpha;             
} ra8_glcdc_layer2_cfg_t;

typedef enum : uint8_t {
  k_ra8_blend_overwrite = 0U, 
  k_ra8_blend_normal    = 1U, 
  k_ra8_blend_alpha     = 2U, 
} ra8_glcdc_blend_mode_t;

typedef enum : uint8_t {
  k_ra8_dither_off      = 0U, 
  k_ra8_dither_truncate = 1U, 
  k_ra8_dither_2x2      = 2U, 
} ra8_glcdc_dither_mode_t;

[[nodiscard]] ra8_err_t ra8_glcdc_init(const ra8_glcdc_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_glcdc_start(bool enable);

typedef void (*ra8_glcdc_event_fn_t)(void* ctx, uint32_t status_mask);

[[nodiscard]] ra8_err_t ra8_glcdc_deinit(void);

[[nodiscard]] ra8_err_t ra8_glcdc_get_status(uint32_t* out_mask);

[[nodiscard]] ra8_err_t ra8_glcdc_clear_status(uint32_t mask);

[[nodiscard]] ra8_err_t ra8_glcdc_attach_handler(ra8_glcdc_event_fn_t fn, void* ctx);

void ra8_glcdc_dispatch(void);

[[nodiscard]] ra8_err_t ra8_glcdc_enter_stop(void);

[[nodiscard]] ra8_err_t ra8_glcdc_exit_stop(void);

[[nodiscard]] ra8_err_t ra8_glcdc_set_layer2(const ra8_glcdc_layer2_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_glcdc_layer1_show(uintptr_t fb_addr);

[[nodiscard]] ra8_err_t ra8_glcdc_layer2_show(uintptr_t fb_addr,
                                              uint16_t  panel_x,
                                              uint16_t  panel_y,
                                              uint16_t  fb_w,
                                              uint16_t  fb_h);

[[nodiscard]] ra8_err_t ra8_glcdc_layer2_chroma_key_enable(uint32_t key_rgb888);

[[nodiscard]] ra8_err_t ra8_glcdc_set_blend(ra8_glcdc_blend_mode_t mode, uint8_t global_alpha);

[[nodiscard]] ra8_err_t ra8_glcdc_set_background_color(uint32_t argb);

[[nodiscard]] ra8_err_t ra8_glcdc_set_clut_double_buffered(uint8_t         layer,
                                                           const uint32_t* clut,
                                                           uint32_t        entries,
                                                           bool            swap_now);

[[nodiscard]] ra8_err_t ra8_glcdc_set_dithering(ra8_glcdc_dither_mode_t mode);

[[nodiscard]] ra8_err_t ra8_glcdc_set_brightness(uint8_t r, uint8_t g, uint8_t b);

[[nodiscard]] ra8_err_t ra8_glcdc_set_contrast(uint8_t r, uint8_t g, uint8_t b);
 
/* =============================================================================
 * Gamma correction (piecewise-linear LUT per colour channel)
 * Implemented in libs/ra8_hal/src/ra8_glcdc_gamma.c
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_glcdc_ch_r     = 0U, 
  k_ra8_glcdc_ch_g     = 1U, 
  k_ra8_glcdc_ch_b     = 2U, 
  k_ra8_glcdc_ch_count = 3U, 
} ra8_glcdc_color_channel_t;

typedef enum : uint8_t {
  k_ra8_glcdc_gamma_lut_depth = 16U, 
} ra8_glcdc_gamma_lut_const_t;

[[nodiscard]] ra8_err_t ra8_glcdc_set_gamma(ra8_glcdc_color_channel_t channel,
                                            const uint16_t*           gain,
                                            const uint16_t*           threshold,
                                            uint8_t                   count);

[[nodiscard]] ra8_err_t ra8_glcdc_gamma_enable(bool enable);
 
#ifdef __cplusplus
}
#endif