feat(ppa): add low level support for PPA

This commit is contained in:
Song Ruo Jing 2023-11-28 18:31:45 +08:00
parent 4f506a30df
commit 32111c1c4d
7 changed files with 961 additions and 45 deletions

View File

@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
* SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
@ -62,8 +62,6 @@ static inline uint32_t periph_ll_get_rst_en_mask(periph_module_t periph, bool en
return HP_SYS_CLKRST_REG_RST_EN_ISP;
case PERIPH_DMA2D_MODULE:
return HP_SYS_CLKRST_REG_RST_EN_DMA2D;
case PERIPH_PPA_MODULE:
return HP_SYS_CLKRST_REG_RST_EN_PPA;
case PERIPH_UHCI_MODULE:
return HP_SYS_CLKRST_REG_RST_EN_UHCI;
case PERIPH_I3C_MODULE:
@ -145,7 +143,6 @@ static inline uint32_t periph_ll_get_rst_en_reg(periph_module_t periph)
case PERIPH_ISP_MODULE:
case PERIPH_DMA2D_MODULE:
return HP_SYS_CLKRST_HP_RST_EN0_REG;
case PERIPH_PPA_MODULE:
case PERIPH_UHCI_MODULE:
case PERIPH_I3C_MODULE:
case PERIPH_SARADC_MODULE:

View File

@ -0,0 +1,832 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <stdint.h>
#include <stdbool.h>
#include "hal/ppa_types.h"
#include "hal/color_types.h"
#include "soc/ppa_struct.h"
#include "soc/ppa_reg.h"
#include "soc/hp_sys_clkrst_struct.h"
#include "hal/assert.h"
#include "hal/misc.h"
#ifdef __cplusplus
extern "C" {
#endif
#define PPA_LL_GET_HW &PPA
#define PPA_LL_BLEND0_CLUT_MEM_ADDR_OFFSET 0x400
#define PPA_LL_BLEND1_CLUT_MEM_ADDR_OFFSET 0x800
/**
* @brief Enumeration of alpha value transformation mode
*/
typedef enum {
PPA_LL_RX_ALPHA_NO_CHANGE, /*!< Do not replace alpha value. If input format does not contain alpha info, alpha value 255 will be used. */
PPA_LL_RX_ALPHA_FIX_VALUE, /*!< Replace the alpha value in received pixel with a new, fixed alpha value */
PPA_LL_RX_ALPHA_SCALE, /*!< Scale the alpha value in received pixel to be a new alpha value */
PPA_LL_RX_ALPHA_INVERT, /*!< Invert the alpha value in received pixel */
} ppa_ll_rx_alpha_mode_t;
/**
* @brief Enumeration of PPA blending mode
*/
typedef enum {
PPA_LL_BLEND_TRANS_MODE_BLEND, /*!< Blending engine performs blend operation */
PPA_LL_BLEND_TRANS_MODE_FILL, /*!< Blending engine performs fill operation */
PPA_LL_BLEND_TRANS_MODE_BYPASS_BLEND, /*!< Blending engine bypasses blender, background will be output directly. Useful for color space conversion (ARGB). */
} ppa_ll_blend_trans_mode_t;
///////////////////////////////////// Common /////////////////////////////////////////
/**
* @brief Enable or disable the PPA peripheral bus clock
*
* @param enable Set true to enable, false to disable
*/
static inline void ppa_ll_enable_bus_clock(bool enable)
{
HP_SYS_CLKRST.soc_clk_ctrl1.reg_ppa_sys_clk_en = enable;
}
/// use a macro to wrap the function, force the caller to use it in a critical section
/// the critical section needs to declare the __DECLARE_RCC_ATOMIC_ENV variable in advance
#define ppa_ll_enable_bus_clock(...) (void)__DECLARE_RCC_ATOMIC_ENV; ppa_ll_enable_bus_clock(__VA_ARGS__)
/**
* @brief Reset the PPA module
*/
static inline void ppa_ll_reset_register(void)
{
HP_SYS_CLKRST.hp_rst_en1.reg_rst_en_ppa = 1;
HP_SYS_CLKRST.hp_rst_en1.reg_rst_en_ppa = 0;
}
/// use a macro to wrap the function, force the caller to use it in a critical section
/// the critical section needs to declare the __DECLARE_RCC_ATOMIC_ENV variable in advance
#define ppa_ll_reset_register(...) (void)__DECLARE_RCC_ATOMIC_ENV; ppa_ll_reset_register(__VA_ARGS__)
/////////////////////////// Scaling and Rotating (SR) ////////////////////////////////
/**
* @brief Reset PPA scaling and rotating engine
*
* @param dev Peripheral instance address
*/
static inline void ppa_ll_sr_reset(ppa_dev_t *dev)
{
dev->sr_scal_rotate.scal_rotate_rst = 1;
dev->sr_scal_rotate.scal_rotate_rst = 0;
}
/**
* @brief Set PPA scaling coefficient in X direction
*
* @param dev Peripheral instance address
* @param x_int The integrated part of scaling coefficient in X direction, 0 - 255
* @param x_frag The fragment part of scaling coefficient in X direction, 0 - 15. Corresponding fractional value is x_frag/16.
*/
static inline void ppa_ll_sr_set_scaling_x(ppa_dev_t *dev, uint32_t x_int, uint32_t x_frag)
{
HAL_ASSERT(x_int <= PPA_SR_SCAL_X_INT_V && x_frag <= PPA_SR_SCAL_X_FRAG_V);
HAL_FORCE_MODIFY_U32_REG_FIELD(dev->sr_scal_rotate, sr_scal_x_int, x_int);
dev->sr_scal_rotate.sr_scal_x_frag = x_frag;
}
/**
* @brief Set PPA scaling coefficient in Y direction
*
* @param dev Peripheral instance address
* @param y_int The integrated part of scaling coefficient in Y direction, 0 - 255
* @param y_frag The fragment part of scaling coefficient in Y direction, 0 - 15. Corresponding fractional value is y_frag/16.
*/
static inline void ppa_ll_sr_set_scaling_y(ppa_dev_t *dev, uint32_t y_int, uint32_t y_frag)
{
HAL_ASSERT(y_int <= PPA_SR_SCAL_Y_INT_V && y_frag <= PPA_SR_SCAL_Y_FRAG_V);
HAL_FORCE_MODIFY_U32_REG_FIELD(dev->sr_scal_rotate, sr_scal_y_int, y_int);
dev->sr_scal_rotate.sr_scal_y_frag = y_frag;
}
/**
* @brief Set PPA rotation angle (in the counterclockwise direction)
*
* @param dev Peripheral instance address
* @param angle One of the values in ppa_sr_rotation_angle_t
*/
static inline void ppa_ll_sr_set_rotation_angle(ppa_dev_t *dev, ppa_sr_rotation_angle_t angle)
{
uint32_t val = 0;
switch (angle) {
case PPA_SR_ROTATION_ANGLE_0:
val = 0;
break;
case PPA_SR_ROTATION_ANGLE_90:
val = 1;
break;
case PPA_SR_ROTATION_ANGLE_180:
val = 2;
break;
case PPA_SR_ROTATION_ANGLE_270:
val = 3;
break;
default:
// Unsupported rotation angle
abort();
}
dev->sr_scal_rotate.sr_rotate_angle = val;
}
/**
* @brief Enable PPA image mirror in X direction
*
* @param dev Peripheral instance address
* @param enable True to enable; False to disable
*/
static inline void ppa_ll_sr_enable_mirror_x(ppa_dev_t *dev, bool enable)
{
dev->sr_scal_rotate.sr_mirror_x = enable;
}
/**
* @brief Enable PPA image mirror in Y direction
*
* @param dev Peripheral instance address
* @param enable True to enable; False to disable
*/
static inline void ppa_ll_sr_enable_mirror_y(ppa_dev_t *dev, bool enable)
{
dev->sr_scal_rotate.sr_mirror_y = enable;
}
/**
* @brief Start PPA scaling and rotating engine to perform PPA SR
*
* @param dev Peripheral instance address
*/
static inline void ppa_ll_sr_start(ppa_dev_t *dev)
{
dev->sr_scal_rotate.scal_rotate_start = 1;
}
/**
* @brief Set the source image color mode for PPA Scaling and Rotating engine RX
*
* @param dev Peripheral instance address
* @param color_mode One of the values in ppa_sr_color_mode_t
*/
static inline void ppa_ll_sr_set_rx_color_mode(ppa_dev_t *dev, ppa_sr_color_mode_t color_mode)
{
uint32_t val = 0;
switch (color_mode) {
case PPA_SR_COLOR_MODE_ARGB8888:
val = 0;
break;
case PPA_SR_COLOR_MODE_RGB888:
val = 1;
break;
case PPA_SR_COLOR_MODE_RGB565:
val = 2;
break;
case PPA_SR_COLOR_MODE_YUV420:
val = 8;
break;
default:
// Unsupported SR rx color mode
abort();
}
dev->sr_color_mode.sr_rx_cm = val;
}
/**
* @brief Set the destination image color mode for PPA Scaling and Rotating engine TX
*
* @param dev Peripheral instance address
* @param color_mode One of the values in ppa_sr_color_mode_t
*/
static inline void ppa_ll_sr_set_tx_color_mode(ppa_dev_t *dev, ppa_sr_color_mode_t color_mode)
{
uint32_t val = 0;
switch (color_mode) {
case PPA_SR_COLOR_MODE_ARGB8888:
val = 0;
break;
case PPA_SR_COLOR_MODE_RGB888:
val = 1;
break;
case PPA_SR_COLOR_MODE_RGB565:
val = 2;
break;
case PPA_SR_COLOR_MODE_YUV420:
val = 8;
break;
default:
// Unsupported SR tx color mode
abort();
}
dev->sr_color_mode.sr_tx_cm = val;
}
/**
* @brief Set YUV to RGB protocol when PPA SR pixel color space conversion from RX to TX is YUV to RGB
*
* @param dev Peripheral instance address
* @param std One of the RGB-YUV conversion standards in color_conv_std_rgb_yuv_t
*/
static inline void ppa_ll_sr_set_yuv2rgb_std(ppa_dev_t *dev, color_conv_std_rgb_yuv_t std)
{
switch (std) {
case COLOR_CONV_STD_RGB_YUV_BT601:
dev->sr_color_mode.yuv2rgb_protocol = 0;
break;
case COLOR_CONV_STD_RGB_YUV_BT709:
dev->sr_color_mode.yuv2rgb_protocol = 1;
break;
default:
// Unsupported RGB-YUV conversion standard
abort();
}
}
/**
* @brief Set RGB to YUV protocol when PPA SR pixel color space conversion from RX to TX is RGB to YUV
*
* @param dev Peripheral instance address
* @param std One of the RGB-YUV conversion standards in color_conv_std_rgb_yuv_t
*/
static inline void ppa_ll_sr_set_rgb2yuv_std(ppa_dev_t *dev, color_conv_std_rgb_yuv_t std)
{
switch (std) {
case COLOR_CONV_STD_RGB_YUV_BT601:
dev->sr_color_mode.rgb2yuv_protocol = 0;
break;
case COLOR_CONV_STD_RGB_YUV_BT709:
dev->sr_color_mode.rgb2yuv_protocol = 1;
break;
default:
// Unsupported RGB-YUV conversion standard
abort();
}
}
/**
* @brief Set PPA SR YUV input range
*
* @param dev Peripheral instance address
* @param range One of color range options in color_range_t
*/
static inline void ppa_ll_sr_set_rx_yuv_range(ppa_dev_t *dev, color_range_t range)
{
switch (range) {
case COLOR_RANGE_LIMIT:
dev->sr_color_mode.yuv_rx_range = 0;
break;
case COLOR_RANGE_FULL:
dev->sr_color_mode.yuv_rx_range = 1;
break;
default:
// Unsupported color range
abort();
}
}
/**
* @brief Set PPA SR YUV output range
*
* @param dev Peripheral instance address
* @param range One of color range options in color_range_t
*/
static inline void ppa_ll_sr_set_tx_yuv_range(ppa_dev_t *dev, color_range_t range)
{
switch (range) {
case COLOR_RANGE_LIMIT:
dev->sr_color_mode.yuv_tx_range = 0;
break;
case COLOR_RANGE_FULL:
dev->sr_color_mode.yuv_tx_range = 1;
break;
default:
// Unsupported color range
abort();
}
}
/**
* @brief Enable PPA SR input data wrap in RGB (e.g. ARGB becomes BGRA, RGB becomes BGR)
*
* @param dev Peripheral instance address
* @param enable True to enable; False to disable
*/
static inline void ppa_ll_sr_enable_rx_rgb_swap(ppa_dev_t *dev, bool enable)
{
dev->sr_byte_order.sr_rx_rgb_swap_en = enable;
}
/**
* @brief Enable PPA SR input data swap in byte (The Byte0 and Byte1 would be swapped while byte 2 and byte 3 would be swappped)
*
* Only supported when input color mode is ARGB8888 or RGB565.
*
* @param dev Peripheral instance address
* @param enable True to enable; False to disable
*/
static inline void ppa_ll_sr_enable_rx_byte_swap(ppa_dev_t *dev, bool enable)
{
dev->sr_byte_order.sr_rx_byte_swap_en = enable;
}
/**
* @brief Configure PPA SR alpha value transformation mode
*
* @param dev Peripheral instance address
* @param mode Alpha value transformation mode, one of the values in ppa_ll_rx_alpha_mode_t
* @param val When PPA_LL_RX_ALPHA_FIX_VALUE mode is selected, val is the alpha value to be replaced with (output_alpha = val)
* When PPA_LL_RX_ALPHA_SCALE mode is selected, val/256 is the multiplier to the input alpha value (output_alpha = input_alpha * val / 256)
* When other modes are selected, this field is not used
*/
static inline void ppa_ll_sr_configure_rx_alpha(ppa_dev_t *dev, ppa_ll_rx_alpha_mode_t mode, uint32_t val)
{
switch (mode) {
case PPA_LL_RX_ALPHA_NO_CHANGE:
dev->sr_fix_alpha.sr_rx_alpha_mod = 0;
dev->sr_fix_alpha.sr_rx_alpha_inv = 0;
break;
case PPA_LL_RX_ALPHA_FIX_VALUE:
dev->sr_fix_alpha.sr_rx_alpha_mod = 1;
HAL_FORCE_MODIFY_U32_REG_FIELD(dev->sr_fix_alpha, sr_rx_fix_alpha, val);
dev->sr_fix_alpha.sr_rx_alpha_inv = 0;
break;
case PPA_LL_RX_ALPHA_SCALE:
dev->sr_fix_alpha.sr_rx_alpha_mod = 2;
HAL_FORCE_MODIFY_U32_REG_FIELD(dev->sr_fix_alpha, sr_rx_fix_alpha, val);
dev->sr_fix_alpha.sr_rx_alpha_inv = 0;
break;
case PPA_LL_RX_ALPHA_INVERT:
dev->sr_fix_alpha.sr_rx_alpha_mod = 0;
dev->sr_fix_alpha.sr_rx_alpha_inv = 1;
default:
// Unsupported alpha transformation mode
abort();
}
}
//////////////////////////////////// Blending ////////////////////////////////////////
/*
* Alpha Blending Calculation:
* 1. A_bg, A_fg first convert to A_bg', A_fg' according to blend_fix_alpha register configuration
* 2. Then do blending
* A_out = A_bg' + A_fg' - A_bg' * A_fg'
* C_out_r/g/b = (C_bg_r/g/b * A_bg' * (1 - A_fg') + C_fg_r/g/b * A_fg') / A_out
*/
/**
* @brief Reset PPA blending engine
*
* @param dev Peripheral instance address
*/
static inline void ppa_ll_blend_reset(ppa_dev_t *dev)
{
dev->blend_trans_mode.blend_rst = 1;
dev->blend_trans_mode.blend_rst = 0;
}
/**
* @brief Start PPA blending engine to perform PPA Blending
*
* @param dev Peripheral instance address
* @param trans_mode Blending engine transfer mode, one of the values in ppa_ll_blend_trans_mode_t
*/
static inline void ppa_ll_blend_start(ppa_dev_t *dev, ppa_ll_blend_trans_mode_t trans_mode)
{
switch (trans_mode) {
case PPA_LL_BLEND_TRANS_MODE_BLEND:
dev->blend_trans_mode.blend_bypass = 0;
dev->blend_trans_mode.blend_fix_pixel_fill_en = 0;
break;
case PPA_LL_BLEND_TRANS_MODE_FILL:
dev->blend_trans_mode.blend_bypass = 0;
dev->blend_trans_mode.blend_fix_pixel_fill_en = 1;
break;
case PPA_LL_BLEND_TRANS_MODE_BYPASS_BLEND:
dev->blend_trans_mode.blend_bypass = 1;
dev->blend_trans_mode.blend_fix_pixel_fill_en = 0;
break;
default:
// Unsupported blending trans mode
abort();
}
dev->blend_trans_mode.blend_en = 1;
dev->blend_trans_mode.blend_trans_mode_update = 1;
}
/**
* @brief Set the source image color mode for background for PPA blending engine RX
*
* @param dev Peripheral instance address
* @param color_mode One of the values in ppa_blend_color_mode_t (some color modes may not be applicable to rx bg)
*/
static inline void ppa_ll_blend_set_rx_bg_color_mode(ppa_dev_t *dev, ppa_blend_color_mode_t color_mode)
{
uint32_t val = 0;
switch (color_mode) {
case PPA_BLEND_COLOR_MODE_ARGB8888:
val = 0;
break;
case PPA_BLEND_COLOR_MODE_RGB888:
val = 1;
break;
case PPA_BLEND_COLOR_MODE_RGB565:
val = 2;
break;
case PPA_BLEND_COLOR_MODE_L8:
val = 4;
break;
case PPA_BLEND_COLOR_MODE_L4:
val = 5;
break;
default:
// Unsupported blending rx background color mode
abort();
}
dev->blend_color_mode.blend0_rx_cm = val;
}
/**
* @brief Set the source image color mode for foreground for PPA blending engine RX
*
* @param dev Peripheral instance address
* @param color_mode One of the values in ppa_blend_color_mode_t
*/
static inline void ppa_ll_blend_set_rx_fg_color_mode(ppa_dev_t *dev, ppa_blend_color_mode_t color_mode)
{
uint32_t val = 0;
switch (color_mode) {
case PPA_BLEND_COLOR_MODE_ARGB8888:
val = 0;
break;
case PPA_BLEND_COLOR_MODE_RGB888:
val = 1;
break;
case PPA_BLEND_COLOR_MODE_RGB565:
val = 2;
break;
case PPA_BLEND_COLOR_MODE_L8:
val = 4;
break;
case PPA_BLEND_COLOR_MODE_L4:
val = 5;
break;
case PPA_BLEND_COLOR_MODE_A8:
val = 6;
break;
case PPA_BLEND_COLOR_MODE_A4:
val = 7;
break;
default:
// Unsupported blending rx foreground color mode
abort();
}
dev->blend_color_mode.blend1_rx_cm = val;
}
/**
* @brief Set the destination image color mode for PPA blending engine TX
*
* @param dev Peripheral instance address
* @param color_mode One of the values in ppa_blend_color_mode_t (some color modes may not be applicable to tx)
*/
static inline void ppa_ll_blend_set_tx_color_mode(ppa_dev_t *dev, ppa_blend_color_mode_t color_mode)
{
uint32_t val = 0;
switch (color_mode) {
case PPA_BLEND_COLOR_MODE_ARGB8888:
val = 0;
break;
case PPA_BLEND_COLOR_MODE_RGB888:
val = 1;
break;
case PPA_BLEND_COLOR_MODE_RGB565:
val = 2;
break;
default:
// Unsupported blending tx color mode
abort();
}
dev->blend_color_mode.blend_tx_cm = val;
}
/**
* @brief Enable PPA blending input background data wrap in RGB (e.g. ARGB becomes BGRA, RGB becomes BGR)
*
* @param dev Peripheral instance address
* @param enable True to enable; False to disable
*/
static inline void ppa_ll_blend_enable_rx_bg_rgb_swap(ppa_dev_t *dev, bool enable)
{
dev->blend_byte_order.blend0_rx_rgb_swap_en = enable;
}
/**
* @brief Enable PPA blending input foreground data wrap in RGB (e.g. ARGB becomes BGRA, RGB becomes BGR)
*
* @param dev Peripheral instance address
* @param enable True to enable; False to disable
*/
static inline void ppa_ll_blend_enable_rx_fg_rgb_swap(ppa_dev_t *dev, bool enable)
{
dev->blend_byte_order.blend1_rx_rgb_swap_en = enable;
}
/**
* @brief Enable PPA blending input background data swap in byte (The Byte0 and Byte1 would be swapped while byte 2 and byte 3 would be swappped)
*
* Only supported when input color mode is ARGB8888 or RGB565.
*
* @param dev Peripheral instance address
* @param enable True to enable; False to disable
*/
static inline void ppa_ll_blend_enable_rx_bg_byte_swap(ppa_dev_t *dev, bool enable)
{
dev->blend_byte_order.blend0_rx_byte_swap_en = enable;
}
/**
* @brief Enable PPA blending input foreground data swap in byte (The Byte0 and Byte1 would be swapped while byte 2 and byte 3 would be swappped)
*
* Only supported when input color mode is ARGB8888 or RGB565.
*
* @param dev Peripheral instance address
* @param enable True to enable; False to disable
*/
static inline void ppa_ll_blend_enable_rx_fg_byte_swap(ppa_dev_t *dev, bool enable)
{
dev->blend_byte_order.blend1_rx_byte_swap_en = enable;
}
/**
* @brief Configure PPA blending input background alpha value transformation mode
*
* @param dev Peripheral instance address
* @param mode Alpha value transformation mode, one of the values in ppa_ll_rx_alpha_mode_t
* @param val When PPA_LL_RX_ALPHA_FIX_VALUE mode is selected, val is the alpha value to be replaced with (output_alpha = val)
* When PPA_LL_RX_ALPHA_SCALE mode is selected, val/256 is the multiplier to the input alpha value (output_alpha = input_alpha * val / 256)
* When other modes are selected, this field is not used
*/
static inline void ppa_ll_blend_configure_rx_bg_alpha(ppa_dev_t *dev, ppa_ll_rx_alpha_mode_t mode, uint32_t val)
{
switch (mode) {
case PPA_LL_RX_ALPHA_NO_CHANGE:
dev->blend_fix_alpha.blend0_rx_alpha_mod = 0;
dev->blend_fix_alpha.blend0_rx_alpha_inv = 0;
break;
case PPA_LL_RX_ALPHA_FIX_VALUE:
dev->blend_fix_alpha.blend0_rx_alpha_mod = 1;
HAL_FORCE_MODIFY_U32_REG_FIELD(dev->blend_fix_alpha, blend0_rx_fix_alpha, val);
dev->blend_fix_alpha.blend0_rx_alpha_inv = 0;
break;
case PPA_LL_RX_ALPHA_SCALE:
dev->blend_fix_alpha.blend0_rx_alpha_mod = 2;
HAL_FORCE_MODIFY_U32_REG_FIELD(dev->blend_fix_alpha, blend0_rx_fix_alpha, val);
dev->blend_fix_alpha.blend0_rx_alpha_inv = 0;
break;
case PPA_LL_RX_ALPHA_INVERT:
dev->blend_fix_alpha.blend0_rx_alpha_mod = 0;
dev->blend_fix_alpha.blend0_rx_alpha_inv = 1;
default:
// Unsupported alpha transformation mode
abort();
}
}
/**
* @brief Configure PPA blending input foreground alpha value transformation mode
*
* @param dev Peripheral instance address
* @param mode Alpha value transformation mode, one of the values in ppa_ll_rx_alpha_mode_t
* @param val When PPA_LL_RX_ALPHA_FIX_VALUE mode is selected, val is the alpha value to be replaced with (output_alpha = val)
* When PPA_LL_RX_ALPHA_SCALE mode is selected, val/256 is the multiplier to the input alpha value (output_alpha = input_alpha * val / 256)
* When other modes are selected, this field is not used
*/
static inline void ppa_ll_blend_configure_rx_fg_alpha(ppa_dev_t *dev, ppa_ll_rx_alpha_mode_t mode, uint32_t val)
{
switch (mode) {
case PPA_LL_RX_ALPHA_NO_CHANGE:
dev->blend_fix_alpha.blend1_rx_alpha_mod = 0;
dev->blend_fix_alpha.blend1_rx_alpha_inv = 0;
break;
case PPA_LL_RX_ALPHA_FIX_VALUE:
dev->blend_fix_alpha.blend1_rx_alpha_mod = 1;
HAL_FORCE_MODIFY_U32_REG_FIELD(dev->blend_fix_alpha, blend1_rx_fix_alpha, val);
dev->blend_fix_alpha.blend1_rx_alpha_inv = 0;
break;
case PPA_LL_RX_ALPHA_SCALE:
dev->blend_fix_alpha.blend1_rx_alpha_mod = 2;
HAL_FORCE_MODIFY_U32_REG_FIELD(dev->blend_fix_alpha, blend1_rx_fix_alpha, val);
dev->blend_fix_alpha.blend1_rx_alpha_inv = 0;
break;
case PPA_LL_RX_ALPHA_INVERT:
dev->blend_fix_alpha.blend1_rx_alpha_mod = 0;
dev->blend_fix_alpha.blend1_rx_alpha_inv = 1;
default:
// Unsupported alpha transformation mode
abort();
}
}
/**
* @brief Configure PPA blending pixel filling image block
*
* @param dev Peripheral instance address
* @param data The fix data to be filled to the image block pixels in ARGB8888 format
* @param hb The horizontal width of image block that would be filled in fix pixel filling mode. The unit is pixel.
* @param vb The vertical width of image block that would be filled in fix pixel filling mode. The unit is pixel.
*/
static inline void ppa_ll_blend_configure_filling_block(ppa_dev_t *dev, uint32_t data, uint32_t hb, uint32_t vb)
{
HAL_ASSERT(hb <= PPA_BLEND_HB_V && vb <= PPA_BLEND_VB_V);
dev->blend_fix_pixel.blend_tx_fix_pixel = data;
dev->blend_tx_size.blend_hb = hb;
dev->blend_tx_size.blend_vb = vb;
}
/**
* @brief Configure PPA blending input foreground fixed RGB color for A4/A8 color mode
*
* @param dev Peripheral instance address
* @param rgb RGB color for A4/A8 mode in RGB888 format
*/
static inline void ppa_ll_blend_set_rx_fg_fix_rgb(ppa_dev_t *dev, uint32_t rgb)
{
dev->blend_rgb.val = rgb;
}
/*
* Color-key Calculation:
* 1) When FG in ck range, but BG not in ck range, then outputs BG pixel value.
* 2) When BG in ck range, but FG not in ck range, then depends on FG_BG_REVERSE value: if FG_BG_REVERSE = 0, outputs BG pixel value; otherwise, outputs FG pixel value.
* 3) When FG and BG both in their ck ranges, then outputs ck default color.
* 4) When FG and BG both not in their ck ranges, then it goes through normal Alpha Blending calculation.
*/
/**
* @brief Configure PPA blending input background color-key threshold
*
* @param dev Peripheral instance address
* @param rgb_thres_low Color-key lower threshold of background in RGB888 format
* @param rgb_thres_high Color-key higher threshold of background in RGB888 format
*/
static inline void ppa_ll_blend_configure_rx_bg_ck_range(ppa_dev_t *dev, uint32_t rgb_thres_low, uint32_t rgb_thres_high)
{
dev->ck_bg_low.val = rgb_thres_low;
dev->ck_bg_high.val = rgb_thres_high;
}
/**
* @brief Configure PPA blending input foreground color-key threshold
*
* @param dev Peripheral instance address
* @param rgb_thres_low Color-key lower threshold of foreground in RGB888 format
* @param rgb_thres_high Color-key higher threshold of foreground in RGB888 format
*/
static inline void ppa_ll_blend_configure_rx_fg_ck_range(ppa_dev_t *dev, uint32_t rgb_thres_low, uint32_t rgb_thres_high)
{
dev->ck_fg_low.val = rgb_thres_low;
dev->ck_fg_high.val = rgb_thres_high;
}
/**
* @brief Configure PPA blending default RGB value when foreground and background both in color-key range
*
* @param dev Peripheral instance address
* @param rgb Default RGB value in RGB888 format
*/
static inline void ppa_ll_blend_set_ck_default_rgb(ppa_dev_t *dev, uint32_t rgb)
{
dev->ck_default.val = (dev->ck_default.colorkey_fg_bg_reverse << PPA_COLORKEY_FG_BG_REVERSE_S) | rgb;
}
/**
* @brief Configure whether to reverse the output when PPA blending pixel in background color-key range but not in foreground color-key range
*
* @param dev Peripheral instance address
* @param enable True then output the foreground pixel value; False then output the background pixel value
*/
static inline void ppa_ll_blend_enable_ck_fg_bg_reverse(ppa_dev_t *dev, bool enable)
{
dev->ck_default.colorkey_fg_bg_reverse = enable;
}
/////////////////////////// Color Look-Up Table (CLUT) ///////////////////////////////
/**
* @brief Configure PPA CLUT mem access mode
*
* @param dev Peripheral instance address
* @param fifo_mode True to access through fifo mode; False to access through memory mode
*/
static inline void ppa_ll_configure_clut_access_mode(ppa_dev_t *dev, bool fifo_mode)
{
dev->clut_conf.apb_fifo_mask = !fifo_mode;
}
/**
* @brief Force clock and power on for PPA blending BLEND CLUT mem
*
* @param dev Peripheral instance address
*/
static inline void ppa_ll_blend_enable_clut_mem(ppa_dev_t *dev)
{
dev->clut_conf.blend_clut_mem_clk_ena = 1;
dev->clut_conf.blend_clut_mem_force_pu = 1; // force clut mem remain power when memory domain PD
}
/**
* @brief Force clock and power off for PPA blending BLEND CLUT mem
*
* @param dev Peripheral instance address
*/
static inline void ppa_ll_blend_disable_clut_mem(ppa_dev_t *dev)
{
dev->clut_conf.blend_clut_mem_clk_ena = 0;
dev->clut_conf.blend_clut_mem_force_pu = 0;
}
/**
* @brief Reset PPA blending BLEND0 CLUT mem and read address
*
* @param dev Peripheral instance address
*/
static inline void ppa_ll_blend_reset_rx_bg_clut_mem(ppa_dev_t *dev)
{
dev->clut_conf.blend0_clut_mem_rst = 1;
dev->clut_conf.blend0_clut_mem_rst = 0;
dev->clut_conf.blend0_clut_mem_rdaddr_rst = 1;
dev->clut_conf.blend0_clut_mem_rdaddr_rst = 0;
}
/**
* @brief Reset PPA blending BLEND1 CLUT mem and read address
*
* @param dev Peripheral instance address
*/
static inline void ppa_ll_blend_reset_rx_fg_clut_mem(ppa_dev_t *dev)
{
dev->clut_conf.blend1_clut_mem_rst = 1;
dev->clut_conf.blend1_clut_mem_rst = 0;
dev->clut_conf.blend1_clut_mem_rdaddr_rst = 1;
dev->clut_conf.blend1_clut_mem_rdaddr_rst = 0;
}
/**
* @brief Write PPA blending BLEND0 CLUT mem entry through FIFO mode
*
* @param dev Peripheral instance address
* @param data The data to be written into BLEND0 CLUT entry in ARGB8888 format
*/
static inline void ppa_ll_blend_wr_rx_bg_clut_data_by_fifo(ppa_dev_t *dev, uint32_t data)
{
dev->blend0_clut_data.rdwr_word_blend0_clut = data;
}
/**
* @brief Write PPA blending BLEND1 CLUT mem entry through FIFO mode
*
* @param dev Peripheral instance address
* @param data The data to be written into BLEND1 CLUT entry in ARGB8888 format
*/
static inline void ppa_ll_blend_wr_rx_fg_clut_data_by_fifo(ppa_dev_t *dev, uint32_t data)
{
dev->blend1_clut_data.rdwr_word_blend1_clut = data;
}
/**
* @brief Write PPA blending BLEND0 CLUT mem entry through memory mode
*
* @param dev Peripheral instance address
* @param idx Entry index to the CLUT mem
* @param data The data to be written into BLEND0 CLUT entry in ARGB8888 format
*/
static inline void ppa_ll_blend_wr_rx_bg_clut_data_by_mem(ppa_dev_t *dev, uint32_t idx, uint32_t data)
{
volatile uint32_t *blend0_clut_mem = (uint32_t *)((uint32_t)dev + PPA_LL_BLEND0_CLUT_MEM_ADDR_OFFSET);
blend0_clut_mem[idx] = data;
}
/**
* @brief Write PPA blending BLEND1 CLUT mem entry through memory mode
*
* @param dev Peripheral instance address
* @param idx Entry index to the CLUT mem
* @param data The data to be written into BLEND1 CLUT entry in ARGB8888 format
*/
static inline void ppa_ll_blend_wr_rx_fg_clut_data_by_mem(ppa_dev_t *dev, uint32_t idx, uint32_t data)
{
volatile uint32_t *blend1_clut_mem = (uint32_t *)((uint32_t)dev + PPA_LL_BLEND1_CLUT_MEM_ADDR_OFFSET);
blend1_clut_mem[idx] = data;
}
#ifdef __cplusplus
}
#endif

View File

@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
@ -17,12 +17,17 @@ extern "C" {
---------------------------------------------------------------*/
/**
* @brief Color Space
*
* @note Save enum 0 for special purpose
*/
typedef enum {
COLOR_SPACE_RAW, ///< Color space raw
COLOR_SPACE_RGB, ///< Color space rgb
COLOR_SPACE_YUV, ///< Color space yuv
COLOR_SPACE_GRAY, ///< Color space gray
COLOR_SPACE_RAW = 1, ///< Color space raw
COLOR_SPACE_RGB, ///< Color space rgb
COLOR_SPACE_YUV, ///< Color space yuv
COLOR_SPACE_GRAY, ///< Color space gray
COLOR_SPACE_ARGB, ///< Color space argb
COLOR_SPACE_ALPHA, ///< Color space alpha (A)
COLOR_SPACE_CLUT, ///< Color look-up table (L)
} color_space_t;
/*---------------------------------------------------------------
@ -64,6 +69,29 @@ typedef enum {
COLOR_PIXEL_GRAY8, ///< 8 bits, grayscale
} color_pixel_gray_format_t;
/**
* @brief ARGB Format
*/
typedef enum {
COLOR_PIXEL_ARGB8888, ///< 32 bits, 8 bits per A(alpha)/R/G/B value
} color_pixel_argb_format_t;
/**
* @brief Alpha(A) Format
*/
typedef enum {
COLOR_PIXEL_A4, ///< 4 bits, opacity only
COLOR_PIXEL_A8, ///< 8 bits, opacity only
} color_pixel_alpha_format_t;
/**
* @brief CLUT(L) Format
*/
typedef enum {
COLOR_PIXEL_L4, ///< 4 bits, color look-up table
COLOR_PIXEL_L8, ///< 8 bits, color look-up table
} color_pixel_clut_format_t;
/*---------------------------------------------------------------
Color Space Pixel Struct Type
---------------------------------------------------------------*/

View File

@ -0,0 +1,59 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <stdint.h>
#include "hal/color_types.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Enumeration of engines in PPA modules
*/
typedef enum {
PPA_ENGINE_TYPE_SR, /*!< PPA Scaling and Rotating (SR) engine, used to perform scale_and_rotate */
PPA_ENGINE_TYPE_BLEND, /*!< PPA Blending engine, used to perform blend or fill */
} ppa_engine_type_t;
/**
* @brief Enumeration of PPA Scaling and Rotating available rotation angle (in the counterclockwise direction)
*/
typedef enum {
PPA_SR_ROTATION_ANGLE_0, /*!< Picture does no rotation */
PPA_SR_ROTATION_ANGLE_90, /*!< Picture rotates 90 degrees CCW */
PPA_SR_ROTATION_ANGLE_180, /*!< Picture rotates 180 degrees CCW */
PPA_SR_ROTATION_ANGLE_270, /*!< Picture rotates 270 degrees CCW */
} ppa_sr_rotation_angle_t;
/**
* @brief Enumeration of PPA Scaling and Rotating available color mode
*/
typedef enum {
PPA_SR_COLOR_MODE_ARGB8888 = COLOR_TYPE_ID(COLOR_SPACE_ARGB, COLOR_PIXEL_ARGB8888), /*!< PPA SR color mode: ARGB8888 */
PPA_SR_COLOR_MODE_RGB888 = COLOR_TYPE_ID(COLOR_SPACE_RGB, COLOR_PIXEL_RGB888), /*!< PPA SR color mode: RGB888 */
PPA_SR_COLOR_MODE_RGB565 = COLOR_TYPE_ID(COLOR_SPACE_RGB, COLOR_PIXEL_RGB565), /*!< PPA SR color mode: RGB565 */
PPA_SR_COLOR_MODE_YUV420 = COLOR_TYPE_ID(COLOR_SPACE_YUV, COLOR_PIXEL_YUV420), /*!< PPA SR color mode: YUV420 */
} ppa_sr_color_mode_t;
/**
* @brief Enumeration of PPA Blending available color mode
*/
typedef enum {
PPA_BLEND_COLOR_MODE_ARGB8888 = COLOR_TYPE_ID(COLOR_SPACE_ARGB, COLOR_PIXEL_ARGB8888), /*!< PPA Blending color mode: ARGB8888 */
PPA_BLEND_COLOR_MODE_RGB888 = COLOR_TYPE_ID(COLOR_SPACE_RGB, COLOR_PIXEL_RGB888), /*!< PPA Blending color mode: RGB888 */
PPA_BLEND_COLOR_MODE_RGB565 = COLOR_TYPE_ID(COLOR_SPACE_RGB, COLOR_PIXEL_RGB565), /*!< PPA Blending color mode: RGB565 */
PPA_BLEND_COLOR_MODE_L8 = COLOR_TYPE_ID(COLOR_SPACE_CLUT, COLOR_PIXEL_L8), /*!< PPA Blending color mode: L8, only available on blending inputs */
PPA_BLEND_COLOR_MODE_L4 = COLOR_TYPE_ID(COLOR_SPACE_CLUT, COLOR_PIXEL_L4), /*!< PPA Blending color mode: L4, only available on blending inputs */
PPA_BLEND_COLOR_MODE_A8 = COLOR_TYPE_ID(COLOR_SPACE_ALPHA, COLOR_PIXEL_A8), /*!< PPA Blending color mode: A8, only available on blending foreground input */
PPA_BLEND_COLOR_MODE_A4 = COLOR_TYPE_ID(COLOR_SPACE_ALPHA, COLOR_PIXEL_A4), /*!< PPA Blending color mode: A4, only available on blending foreground input */
} ppa_blend_color_mode_t;
#ifdef __cplusplus
}
#endif

View File

@ -1,5 +1,5 @@
/**
* SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
@ -43,10 +43,9 @@ extern "C" {
#define PPA_CLUT_CONF_REG (DR_REG_PPA_BASE + 0xc)
/** PPA_APB_FIFO_MASK : R/W; bitpos: [0]; default: 0;
* 1'b0: fifo mode to wr/rd clut0/clut1 RAM through register
* PPA_SR_CLUT_DATA_REG/PPA_BLEND0_CLUT_DATA_REG/PPA_BLEND1_CLUT_DATA_REG. 1'b1:
* memory mode to wr/rd sr/blend0/blend1 clut RAM. The bit 11 and 10 of the waddr
* should be 01 to access sr clut and should be 10 to access blend0 clut and should be
* 11 to access blend 1 clut in memory mode.
* PPA_BLEND0_CLUT_DATA_REG/PPA_BLEND1_CLUT_DATA_REG. 1'b1:
* memory mode to wr/rd blend0/blend1 clut RAM. The bit 11 and 10 of the waddr
* should be 01 to access blend0 clut and should be 10 to access blend1 clut in memory mode.
*/
#define PPA_APB_FIFO_MASK (BIT(0))
#define PPA_APB_FIFO_MASK_M (PPA_APB_FIFO_MASK_V << PPA_APB_FIFO_MASK_S)
@ -244,20 +243,20 @@ extern "C" {
#define PPA_YUV_TX_RANGE_M (PPA_YUV_TX_RANGE_V << PPA_YUV_TX_RANGE_S)
#define PPA_YUV_TX_RANGE_V 0x00000001U
#define PPA_YUV_TX_RANGE_S 9
/** PPA_YUV2RGB_PROTOCAL : R/W; bitpos: [10]; default: 0;
* YUV to RGB protocal when reg_sr_rx_cm is 4'd8. 0: BT601. 1: BT709
/** PPA_YUV2RGB_PROTOCOL : R/W; bitpos: [10]; default: 0;
* YUV to RGB protocol when reg_sr_rx_cm is 4'd8. 0: BT601. 1: BT709
*/
#define PPA_YUV2RGB_PROTOCAL (BIT(10))
#define PPA_YUV2RGB_PROTOCAL_M (PPA_YUV2RGB_PROTOCAL_V << PPA_YUV2RGB_PROTOCAL_S)
#define PPA_YUV2RGB_PROTOCAL_V 0x00000001U
#define PPA_YUV2RGB_PROTOCAL_S 10
/** PPA_RGB2YUV_PROTOCAL : R/W; bitpos: [11]; default: 0;
* RGB to YUV protocal when reg_sr_tx_cm is 4'd8. 0: BT601. 1: BT709
#define PPA_YUV2RGB_PROTOCOL (BIT(10))
#define PPA_YUV2RGB_PROTOCOL_M (PPA_YUV2RGB_PROTOCOL_V << PPA_YUV2RGB_PROTOCOL_S)
#define PPA_YUV2RGB_PROTOCOL_V 0x00000001U
#define PPA_YUV2RGB_PROTOCOL_S 10
/** PPA_RGB2YUV_PROTOCOL : R/W; bitpos: [11]; default: 0;
* RGB to YUV protocol when reg_sr_tx_cm is 4'd8. 0: BT601. 1: BT709
*/
#define PPA_RGB2YUV_PROTOCAL (BIT(11))
#define PPA_RGB2YUV_PROTOCAL_M (PPA_RGB2YUV_PROTOCAL_V << PPA_RGB2YUV_PROTOCAL_S)
#define PPA_RGB2YUV_PROTOCAL_V 0x00000001U
#define PPA_RGB2YUV_PROTOCAL_S 11
#define PPA_RGB2YUV_PROTOCOL (BIT(11))
#define PPA_RGB2YUV_PROTOCOL_M (PPA_RGB2YUV_PROTOCOL_V << PPA_RGB2YUV_PROTOCOL_S)
#define PPA_RGB2YUV_PROTOCOL_V 0x00000001U
#define PPA_RGB2YUV_PROTOCOL_S 11
/** PPA_BLEND_COLOR_MODE_REG register
* blending engine color mode register

View File

@ -1,5 +1,5 @@
/**
* SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
@ -46,10 +46,9 @@ typedef union {
struct {
/** apb_fifo_mask : R/W; bitpos: [0]; default: 0;
* 1'b0: fifo mode to wr/rd clut0/clut1 RAM through register
* PPA_SR_CLUT_DATA_REG/PPA_BLEND0_CLUT_DATA_REG/PPA_BLEND1_CLUT_DATA_REG. 1'b1:
* memory mode to wr/rd sr/blend0/blend1 clut RAM. The bit 11 and 10 of the waddr
* should be 01 to access sr clut and should be 10 to access blend0 clut and should be
* 11 to access blend 1 clut in memory mode.
* PPA_BLEND0_CLUT_DATA_REG/PPA_BLEND1_CLUT_DATA_REG. 1'b1:
* memory mode to wr/rd blend0/blend1 clut RAM. The bit 11 and 10 of the waddr
* should be 01 to access blend0 clut and should be 10 to access blend1 clut in memory mode.
*/
uint32_t apb_fifo_mask:1;
/** blend0_clut_mem_rst : R/W; bitpos: [1]; default: 0;
@ -68,18 +67,18 @@ typedef union {
* Write 1 then write 0 to reset the read address of BLEND1 CLUT in fifo mode.
*/
uint32_t blend1_clut_mem_rdaddr_rst:1;
/** blend0_clut_mem_force_pd : R/W; bitpos: [5]; default: 0;
/** blend_clut_mem_force_pd : R/W; bitpos: [5]; default: 0;
* 1: force power down BLEND CLUT memory.
*/
uint32_t blend0_clut_mem_force_pd:1;
/** blend0_clut_mem_force_pu : R/W; bitpos: [6]; default: 0;
uint32_t blend_clut_mem_force_pd:1;
/** blend_clut_mem_force_pu : R/W; bitpos: [6]; default: 0;
* 1: force power up BLEND CLUT memory.
*/
uint32_t blend0_clut_mem_force_pu:1;
/** blend0_clut_mem_clk_ena : R/W; bitpos: [7]; default: 0;
uint32_t blend_clut_mem_force_pu:1;
/** blend_clut_mem_clk_ena : R/W; bitpos: [7]; default: 0;
* 1: Force clock on for BLEND CLUT memory.
*/
uint32_t blend0_clut_mem_clk_ena:1;
uint32_t blend_clut_mem_clk_ena:1;
uint32_t reserved_8:24;
};
uint32_t val;
@ -108,14 +107,14 @@ typedef union {
* YUV output range when reg_sr_tx_cm is 4'd8. 0: limit range. 1: full range
*/
uint32_t yuv_tx_range:1;
/** yuv2rgb_protocal : R/W; bitpos: [10]; default: 0;
* YUV to RGB protocal when reg_sr_rx_cm is 4'd8. 0: BT601. 1: BT709
/** yuv2rgb_protocol : R/W; bitpos: [10]; default: 0;
* YUV to RGB protocol when reg_sr_rx_cm is 4'd8. 0: BT601. 1: BT709
*/
uint32_t yuv2rgb_protocal:1;
/** rgb2yuv_protocal : R/W; bitpos: [11]; default: 0;
* RGB to YUV protocal when reg_sr_tx_cm is 4'd8. 0: BT601. 1: BT709
uint32_t yuv2rgb_protocol:1;
/** rgb2yuv_protocol : R/W; bitpos: [11]; default: 0;
* RGB to YUV protocol when reg_sr_tx_cm is 4'd8. 0: BT601. 1: BT709
*/
uint32_t rgb2yuv_protocal:1;
uint32_t rgb2yuv_protocol:1;
uint32_t reserved_12:20;
};
uint32_t val;
@ -857,7 +856,7 @@ typedef union {
} ppa_date_reg_t;
typedef struct {
typedef struct ppa_dev_t {
volatile ppa_blend0_clut_data_reg_t blend0_clut_data;
volatile ppa_blend1_clut_data_reg_t blend1_clut_data;
uint32_t reserved_008;
@ -898,6 +897,7 @@ typedef struct {
volatile ppa_date_reg_t date;
} ppa_dev_t;
extern ppa_dev_t PPA;
#ifndef __cplusplus
_Static_assert(sizeof(ppa_dev_t) == 0x104, "Invalid size of ppa_dev_t structure");

View File

@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
* SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
@ -81,6 +81,7 @@
// #define SOC_TOUCH_SENSOR_SUPPORTED 1 //TODO: IDF-7477
// #define SOC_RNG_SUPPORTED 1 //TODO: IDF-6522
#define SOC_MULTI_USAGE_LDO_SUPPORTED 1
// #define SOC_PPA_SUPPORTED 1 //TODO: IDF-6878
/*-------------------------- XTAL CAPS ---------------------------------------*/
#define SOC_XTAL_SUPPORT_40M 1