vsf_disp.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
#ifndef __VSF_DISP_H__
#define __VSF_DISP_H__
 
/*============================ INCLUDES ======================================*/
 
#include "component/ui/vsf_ui_cfg.h"
 
#if VSF_USE_UI == ENABLED
 
#include "utilities/vsf_utilities.h"
#include "kernel/vsf_kernel.h"
 
#if     defined(__VSF_DISP_CLASS_IMPLEMENT)
#   define __VSF_CLASS_IMPLEMENT__
#elif   defined(__VSF_DISP_CLASS_INHERIT__)
#   define __VSF_CLASS_INHERIT__
#endif
 
#include "utilities/ooc_class.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
 
#define VSF_DISP_COLOR_IDX_DEF(__NAME)                                          \
            VSF_DISP_COLOR_IDX_##__NAME
 
// bit0 - 7:    index
// bit8 - 12:   bitlen - 1
// bit13 - 14:  bytelen - 1
// bit15:       has_alpha
#define VSF_DISP_COLOR_VALUE(__INDEX, __BITLEN, __BYTELEN, __HAS_ALPHA)         \
                                (       (__INDEX)                               \
                                    |   ((((__BITLEN) - 1) & 0x1F) << 8)        \
                                    |   ((((__BYTELEN) - 1) & 0x03) << 13)      \
                                    |   ((__HAS_ALPHA) ? 1 << 15 : 0)           \
                                )
 
#define VSF_DISP_COLOR_DEF(__NAME, __BITLEN, __BYTELEN, __HAS_ALPHA)            \
            VSF_DISP_COLOR_##__NAME = VSF_DISP_COLOR_VALUE(                     \
                (VSF_DISP_COLOR_IDX_##__NAME), __BITLEN, __BYTELEN, __HAS_ALPHA)
 
#define vsf_disp_get_pixel_format_bytesize(__color_format)                      \
            ((((__color_format) >> 13) & 0x03) + 1)
#define vsf_disp_get_pixel_format_bitsize(__color_format)                       \
            ((((__color_format) >> 8) & 0x1F) + 1)
#define vsf_disp_get_pixel_format_has_alpha(__color_format)                     \
            ((__color_format) & (1 << 15))
 
#define vsf_disp_get_pixel_format(__disp)                                       \
            ((vk_disp_t *)(__disp))->param.color
 
#define vsf_disp_get_width(__disp)  ((__disp)->param.width)
#define vsf_disp_get_height(__disp) ((__disp)->param.height)
#define vsf_disp_get_pixel_bitsize(__disp)                                      \
            vsf_disp_get_pixel_format_bitsize(vsf_disp_get_pixel_format(__disp))
#define vsf_disp_get_pixel_bytesize(__disp)                                     \
            vsf_disp_get_pixel_format_bytesize(vsf_disp_get_pixel_format(__disp))
#define vsf_disp_get_has_alpha(__disp)                                          \
            vsf_disp_get_pixel_format_has_alpha(vsf_disp_get_pixel_format(__disp))
#define vsf_disp_get_pitch(__disp)                                              \
            ((__disp)->param.width * vsf_disp_get_pixel_bytesize(__disp))
#define vsf_disp_get_frame_size(__disp)                                         \
            ((__disp)->param.height * vsf_disp_get_pitch(__disp))
 
#ifndef vk_disp_coord_t
// use signed value so that in some coord calculations, value < 0 is acceptable
#   define vk_disp_coord_t          int16_t
#endif
#ifndef vk_disp_fast_coord_t
#   define vk_disp_fast_coord_t     uint_fast16_t
#endif
 
/*============================ MACROFIED FUNCTIONS ===========================*/
/*============================ TYPES =========================================*/
 
vsf_dcl_class(vk_disp_t)
vsf_dcl_class(vk_disp_drv_t)
 
typedef enum vk_disp_color_idx_t {
    VSF_DISP_COLOR_IDX_DEF(INVALID),
    VSF_DISP_COLOR_IDX_DEF(PALETTE),
    VSF_DISP_COLOR_IDX_DEF(RGB332),
    VSF_DISP_COLOR_IDX_DEF(RGB565),
    VSF_DISP_COLOR_IDX_DEF(RGB888),
    VSF_DISP_COLOR_IDX_DEF(RGBA8888),
    VSF_DISP_COLOR_IDX_DEF(ARGB8888),
    VSF_DISP_COLOR_IDX_DEF(ABGR8888),
    VSF_DISP_COLOR_IDX_DEF(BGRA8888),
 
    VSF_DISP_COLOR_IDX_DEF(RGB666_32),
 
    VSF_DISP_COLOR_IDX_DEF(RGB888_32),
    VSF_DISP_COLOR_IDX_DEF(RGB888_24),
 
    VSF_DISP_COLOR_IDX_DEF(BGR888_32),
    VSF_DISP_COLOR_IDX_DEF(BGR888_24),
    VSF_DISP_COLOR_IDX_DEF(MONO),
} vk_disp_color_idx_t;
 
typedef enum vk_disp_color_type_t {
    // avoid vk_disp_color_type_t to be optimized to 8bit
    __VSF_DISP_COLOR_LEAST_MAX  = INT16_MAX,
    __VSF_DISP_COLOR_LEAST_MIN  = INT16_MIN,
    VSF_DISP_COLOR_DEF(INVALID, 0, 0, 0),
    VSF_DISP_COLOR_DEF(PALETTE, 8, 1, 0),
    VSF_DISP_COLOR_DEF(RGB332, 8, 1, 0),
    VSF_DISP_COLOR_DEF(RGB565, 16, 2, 0),
    VSF_DISP_COLOR_DEF(RGB888, 24, 3, 0),
    VSF_DISP_COLOR_DEF(RGBA8888, 32, 4, 1),
    VSF_DISP_COLOR_DEF(ARGB8888, 32, 4, 1),
    VSF_DISP_COLOR_DEF(ABGR8888, 32, 4, 1),
    VSF_DISP_COLOR_DEF(BGRA8888, 32, 4, 1),
 
    VSF_DISP_COLOR_DEF(RGB666_32, 18, 4, 0),
 
    VSF_DISP_COLOR_DEF(RGB888_32, 32, 4, 0),
    VSF_DISP_COLOR_DEF(RGB888_24, 24, 3, 0),
 
    VSF_DISP_COLOR_DEF(BGR888_32, 32, 4, 0),
    VSF_DISP_COLOR_DEF(BGR888_24, 24, 3, 0),
 
    VSF_DISP_COLOR_DEF(MONO, 1, 1, 0),
} vk_disp_color_type_t;
 
typedef struct vk_disp_point_t {
    vk_disp_coord_t x;
    vk_disp_coord_t y;
} vk_disp_point_t;
 
typedef struct vk_disp_area_t {
    vk_disp_point_t pos;
    vk_disp_point_t size;
} vk_disp_area_t;
 
vsf_class(vk_disp_drv_t) {
    protected_member(
        vsf_err_t (*init)(vk_disp_t *pthis);
        void (*fini)(vk_disp_t *pthis);
        vsf_err_t (*refresh)(vk_disp_t *pthis, vk_disp_area_t *area, void *disp_buff);
 
        // interfaces for gpu acceleration
#if VSF_DISP_USE_GPU == ENABLED
        void (*blend)(vk_disp_t *pthis, void *target_buff, vk_disp_fast_coord_t target_width,
                        vk_disp_area_t *area, void *disp_buff);
        void (*fill)(vk_disp_t *pthis, void *target_buff, vk_disp_fast_coord_t target_width,
                        vk_disp_area_t *area, uint_fast32_t color);
#endif
    )
};
 
typedef struct vk_disp_param_t {
    const vk_disp_drv_t *drv;
    uint16_t width;
    uint16_t height;
    vk_disp_color_type_t color;
} vk_disp_param_t;
 
typedef void (*vk_disp_on_ready_t)(vk_disp_t *disp);
 
// ui_data  -- opaque context pointer, set by caller before init / refresh /
//             fini.  Retrieved by ui_on_ready callback to wake the waiting
//             task when the operation completes.
// ui_on_ready -- completion callback, invoked by driver via vk_disp_on_ready()
//             when init, refresh, or fini finishes.
vsf_class(vk_disp_t) {
    public_member(
        const vk_disp_param_t   param;
        void                    *ui_data;
    )
    protected_member(
        vk_disp_on_ready_t      ui_on_ready;
    )
};
 
#if VSF_KERNEL_CFG_SUPPORT_SYNC == ENABLED
// vk_disp_reentrant_t can be used to make a vk_disp_t reentrant
//  by implementint multiple vk_disp_reentrant_t with same mutex
vsf_class(vk_disp_reentrant_t) {
    public_member(
        implement(vk_disp_t)
 
        // disp should be already initialized
        vk_disp_t *disp;
        // same initialized mutex MUST be used for the same disp above
        vsf_mutex_t *mutex;
        vk_disp_point_t pos;
    )
    private_member(
        vsf_eda_t eda;
 
        void *buffer;
        vk_disp_area_t area;
    )
};
#endif
 
vsf_class(vk_disp_dummy_t) {
    public_member(
        implement(vk_disp_t)
    )
};
 
// vk_disp_cvrt_t/vk_disp_cvrt_drv is used to convert color format
vsf_class(vk_disp_cvrt_t) {
    public_member(
        implement(vk_disp_t)
        vk_disp_t *disp_real;
        void *pixel_buffer;
        uint32_t pixel_buffer_size;
    )
};
 
/*============================ GLOBAL VARIABLES ==============================*/
 
#if VSF_KERNEL_CFG_SUPPORT_SYNC == ENABLED
extern const vk_disp_drv_t vk_disp_reentrant_drv;
#endif
 
extern const vk_disp_drv_t vk_disp_dummy_drv;
// vk_disp_cvrt_t/vk_disp_cvrt_drv is used to convert color format
extern const vk_disp_drv_t vk_disp_cvrt_drv;
 
/*============================ PROTOTYPES ====================================*/
 
/*
 * vk_disp_init / vk_disp_fini / vk_disp_refresh are asynchronous.
 * The driver signals completion by calling vk_disp_on_ready(pthis),
 * which invokes the ui_on_ready callback registered on the vk_disp_t.
 *
 * NOTE: The ui_on_ready callback may fire either synchronously (within
 * the call to vk_disp_init/refresh itself) or asynchronously (after the
 * call returns), depending on the driver implementation.  Callers must
 * handle both cases.
 *
 * Typical usage pattern:
 *   1. Set disp->ui_data = <your context pointer>
 *   2. Set disp->ui_on_ready = <your callback>
 *   3. Call vk_disp_init(disp)
 *   4. Wait disp->ui_on_ready being called
 *   5. Set disp->ui_on_ready if necessary
 *   6. Call vk_disp_refresh(disp, ...)
 *   7. Wait disp->ui_on_ready being called
 *
 * The ui_on_ready callback receives the vk_disp_t * and can retrieve
 * the waiting context from disp->ui_data, and will never be changed by display driver.
 */
 
extern vsf_err_t vk_disp_init(vk_disp_t *pthis);
extern void vk_disp_fini(vk_disp_t *pthis);
extern vsf_err_t vk_disp_refresh(vk_disp_t *pthis, vk_disp_area_t *area, void *disp_buff);
 
#ifdef __VSF_DISP_CLASS_INHERIT__
extern void vk_disp_on_ready(vk_disp_t *pthis);
#endif
 
#ifdef __cplusplus
}
#endif
 
/*============================ INCLUDES ======================================*/
 
#include "./driver/sdl2/vsf_disp_sdl2.h"
#include "./driver/usbd_uvc/vsf_disp_usbd_uvc.h"
#include "./driver/sitronix/st7789/vsf_disp_st7789.h"
#include "./driver/sitronix/st7735/vsf_disp_st7735.h"
#include "./driver/solomon-systech/ssd1306/vsf_disp_ssd1306.h"
#include "./driver/vga/m480/vsf_disp_vga_m480.h"
#include "./driver/fb/vsf_disp_fb.h"
#if VSF_DISP_USE_MIPI_SPI_LCD == ENABLED
#   define VSF_DISP_USE_MIPI_LCD            ENABLED
#endif
#if VSF_DISP_USE_MIPI_LCD == ENABLED
#   include "./driver/mipi_lcd/vsf_disp_mipi_lcd_dcs.h"
#endif
#include "./driver/mipi_lcd/vsf_disp_mipi_spi_lcd.h"
#include "./driver/did/vsf_disp_did.h"
#if VSF_DISP_USE_WINGDI == ENABLED && defined(__WIN__)
#   include "./driver/wingdi/vsf_disp_wingdi.h"
#endif
 
#undef __VSF_DISP_CLASS_IMPLEMENT
#undef __VSF_DISP_CLASS_INHERIT__
 
#endif  // VSF_USE_UI
#endif  // __VSF_DISP_H__