hpm_panel.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023-2025 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
 
#ifndef _HPM_PANEL_H
#define _HPM_PANEL_H
 
#include <stdint.h>
#include <string.h>
#include <stdbool.h>
 
struct hpm_panel;
typedef struct hpm_panel hpm_panel_t;
 
typedef struct hpm_panel_timing {
    uint16_t fps_hz;           
    uint32_t pixel_clock_khz;  
    uint32_t hactive;          
    uint32_t hfront_porch;     
    uint32_t hback_porch;      
    uint32_t hsync_len;        
    uint32_t vactive;          
    uint32_t vfront_porch;     
    uint32_t vback_porch;      
    uint32_t vsync_len;        
    uint32_t hsync_pol :1;     
    uint32_t vsync_pol :1;     
    uint32_t de_pol :1;        
    uint32_t pixel_clk_pol :1; 
    uint32_t pixel_data_pol :1;
} hpm_panel_timing_t;
 
typedef enum hpm_panel_mipi_format {
    HPM_PANEL_MIPI_FORMAT_RGB888,
    HPM_PANEL_MIPI_FORMAT_RGB666,
    HPM_PANEL_MIPI_FORMAT_RGB666_PACKED,
    HPM_PANEL_MIPI_FORMAT_RGB565
} hpm_panel_mipi_format;
 
typedef struct hpm_panel_hw_interface {
    uint32_t lcdc_pixel_clk_khz;
    void (*set_reset_pin_level)(uint8_t level);
    void (*set_backlight)(uint16_t percent);
    void (*set_video_router)(void);
    union {
        struct {
            hpm_panel_mipi_format format;
            void *mipi_host_base;
            void *mipi_phy_base;
        } mipi;
        struct {
            uint32_t channel_di_index :8;
            uint32_t channel_index :8;
            void *lvb_base;
        } lvds;
    } video;
} hpm_panel_hw_interface_t;
 
typedef struct hpm_panel_funcs {
    void (*reset)(hpm_panel_t *panel);
    void (*init)(hpm_panel_t *panel, const hpm_panel_timing_t *timing);
    void (*power_on)(hpm_panel_t *panel);
    void (*power_off)(hpm_panel_t *panel);
} hpm_panel_funcs_t;
 
typedef enum hpm_panel_if_type {
    HPM_PANEL_IF_TYPE_RGB,
    HPM_PANEL_IF_TYPE_LVDS_SINGLE,
    HPM_PANEL_IF_TYPE_LVDS_SPLIT,
    HPM_PANEL_IF_TYPE_MIPI,
} hpm_panel_if_type_t;
 
typedef enum hpm_panel_mem_type {
    HPM_PANEL_MEM_TYPE_NONCACHEABLE = 0,
    HPM_PANEL_MEM_TYPE_CACHEABLE,
    HPM_PANEL_MEM_TYPE_MAX,
    HPM_PANEL_MEM_TYPE_UNKNOWN,
} hpm_panel_mem_type_t;
 
typedef enum hpm_panel_state_power {
    HPM_PANEL_STATE_POWER_OFF,
    HPM_PANEL_STATE_POWER_ON
} hpm_panel_power_state_t;
 
typedef struct hpm_panel_state {
    uint8_t backlight_percent;
    uint8_t power_state;
} hpm_panel_state_t;
 
struct hpm_panel {
    const char *name;
    hpm_panel_if_type_t if_type;
    const hpm_panel_timing_t *timing_list;
    uint16_t timing_list_num;
    hpm_panel_state_t state;
    hpm_panel_hw_interface_t hw_if;
    hpm_panel_funcs_t funcs;
};
 
#ifdef __cplusplus
extern "C" {
#endif
 
hpm_panel_t *hpm_panel_find_device_default(void);
 
hpm_panel_t *hpm_panel_find_device(const char *name);
 
const char *hpm_panel_get_name(hpm_panel_t *panel);
 
const hpm_panel_timing_t *hpm_panel_get_timing(hpm_panel_t *panel);
 
int hpm_panel_get_timing_list(hpm_panel_t *panel, const hpm_panel_timing_t **timing_list, uint16_t *timing_list_num);
 
const hpm_panel_timing_t *hpm_panel_get_timing_by_fps(hpm_panel_t *panel, uint16_t fps_hz);
 
hpm_panel_if_type_t hpm_panel_get_if_type(hpm_panel_t *panel);
 
void hpm_panel_register_interface(hpm_panel_t *panel, hpm_panel_hw_interface_t *hw_if);
 
void hpm_panel_reset(hpm_panel_t *panel);
 
void hpm_panel_init(hpm_panel_t *panel);
 
void hpm_panel_init_by_timing(hpm_panel_t *panel, const hpm_panel_timing_t *timing);
 
void hpm_panel_power_on(hpm_panel_t *panel);
 
void hpm_panel_power_off(hpm_panel_t *panel);
 
void hpm_panel_set_backlight(hpm_panel_t *panel, uint16_t percent);
 
uint8_t hpm_panel_get_backlight(hpm_panel_t *panel);
 
void hpm_panel_delay_ms(uint32_t ms);
 
void hpm_panel_delay_us(uint32_t us);
 
void *hpm_panel_memory_alloc(hpm_panel_mem_type_t type, uint32_t size);
 
void hpm_panel_memory_free(void *addr);
 
hpm_panel_mem_type_t hpm_panel_memory_get_type(void *addr);
 
int hpm_panel_memory_register(hpm_panel_mem_type_t type, void *addr, uint32_t size);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _HPM_PANEL_H */