cfb.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 PHYTEC Messtechnik GmbH
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DISPLAY_CFB_H_
#define ZEPHYR_INCLUDE_DISPLAY_CFB_H_
 
#include <zephyr/device.h>
#include <zephyr/drivers/display.h>
#include <zephyr/sys/iterable_sections.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum cfb_display_param {
        CFB_DISPLAY_HEIGH               = 0,
        CFB_DISPLAY_WIDTH,
        CFB_DISPLAY_PPT,
        CFB_DISPLAY_ROWS,
        CFB_DISPLAY_COLS,
};
 
enum cfb_font_caps {
        CFB_FONT_MONO_VPACKED           = BIT(0),
        CFB_FONT_MONO_HPACKED           = BIT(1),
        CFB_FONT_MSB_FIRST              = BIT(2),
};
 
struct cfb_font {
        const void *data;
        enum cfb_font_caps caps;
        uint8_t width;
        uint8_t height;
        uint8_t first_char;
        uint8_t last_char;
};
 
struct cfb_position {
        uint16_t x;
        uint16_t y;
};
 
#define FONT_ENTRY_DEFINE(_name, _width, _height, _caps, _data, _fc, _lc)      \
        static const STRUCT_SECTION_ITERABLE(cfb_font, _name) = {              \
                .data = _data,                                                 \
                .caps = _caps,                                                 \
                .width = _width,                                               \
                .height = _height,                                             \
                .first_char = _fc,                                             \
                .last_char = _lc,                                              \
        }
 
int cfb_print(const struct device *dev, const char *const str, uint16_t x, uint16_t y);
 
int cfb_draw_text(const struct device *dev, const char *const str, int16_t x, int16_t y);
 
int cfb_draw_point(const struct device *dev, const struct cfb_position *pos);
 
int cfb_draw_line(const struct device *dev, const struct cfb_position *start,
                  const struct cfb_position *end);
 
int cfb_draw_rect(const struct device *dev, const struct cfb_position *start,
                  const struct cfb_position *end);
 
int cfb_framebuffer_clear(const struct device *dev, bool clear_display);
 
int cfb_framebuffer_invert(const struct device *dev);
 
int cfb_invert_area(const struct device *dev, uint16_t x, uint16_t y,
                    uint16_t width, uint16_t height);
 
int cfb_framebuffer_finalize(const struct device *dev);
 
int cfb_get_display_parameter(const struct device *dev,
                              enum cfb_display_param);
 
int cfb_framebuffer_set_font(const struct device *dev, uint8_t idx);
 
int cfb_set_kerning(const struct device *dev, int8_t kerning);
 
int cfb_get_font_size(const struct device *dev, uint8_t idx, uint8_t *width,
                      uint8_t *height);
 
int cfb_get_numof_fonts(const struct device *dev);
 
int cfb_framebuffer_init(const struct device *dev);
 
void cfb_framebuffer_deinit(const struct device *dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DISPLAY_CFB_H_ */