[PATCH RFT v3 01/14] soc: qcom: Add UBWC config provider

Dmitry Baryshkov dmitry.baryshkov at oss.qualcomm.com
Sun May 18 08:08:03 UTC 2025


On Sat, May 17, 2025 at 07:32:35PM +0200, Konrad Dybcio wrote:
> From: Konrad Dybcio <konrad.dybcio at oss.qualcomm.com>
> 
> Add a file that will serve as a single source of truth for UBWC
> configuration data for various multimedia blocks.
> 
> Signed-off-by: Konrad Dybcio <konrad.dybcio at oss.qualcomm.com>
> ---
>  drivers/soc/qcom/Kconfig       |   8 ++
>  drivers/soc/qcom/Makefile      |   1 +
>  drivers/soc/qcom/ubwc_config.c | 236 +++++++++++++++++++++++++++++++++++++++++
>  include/linux/soc/qcom/ubwc.h  |  57 ++++++++++
>  4 files changed, 302 insertions(+)
> 
> diff --git a/drivers/soc/qcom/Kconfig b/drivers/soc/qcom/Kconfig
> index 58e63cf0036ba8554e4082da5184a620ca807a9e..2caadbbcf8307ff94f5afbdd1481e5e5e291749f 100644
> --- a/drivers/soc/qcom/Kconfig
> +++ b/drivers/soc/qcom/Kconfig
> @@ -296,3 +296,11 @@ config QCOM_PBS
>  	  PBS trigger event to the PBS RAM.
>  
>  endmenu
> +
> +config QCOM_UBWC_CONFIG
> +	tristate
> +	help
> +	  Most Qualcomm SoCs feature a number of Universal Bandwidth Compression
> +	  (UBWC) engines across various IP blocks, which need to be initialized
> +	  with coherent configuration data. This module functions as a single
> +	  source of truth for that information.
> diff --git a/drivers/soc/qcom/Makefile b/drivers/soc/qcom/Makefile
> index acbca2ab5cc2a9ab3dce1ff38efd048ba2fab31e..b7f1d2a5736748b8772c090fd24462fa91f321c6 100644
> --- a/drivers/soc/qcom/Makefile
> +++ b/drivers/soc/qcom/Makefile
> @@ -39,3 +39,4 @@ obj-$(CONFIG_QCOM_ICC_BWMON)	+= icc-bwmon.o
>  qcom_ice-objs			+= ice.o
>  obj-$(CONFIG_QCOM_INLINE_CRYPTO_ENGINE)	+= qcom_ice.o
>  obj-$(CONFIG_QCOM_PBS) +=	qcom-pbs.o
> +obj-$(CONFIG_QCOM_UBWC_CONFIG) += ubwc_config.o
> diff --git a/drivers/soc/qcom/ubwc_config.c b/drivers/soc/qcom/ubwc_config.c
> new file mode 100644
> index 0000000000000000000000000000000000000000..7d220259829f0e57268f30b323ae985cf44672f4
> --- /dev/null
> +++ b/drivers/soc/qcom/ubwc_config.c
> @@ -0,0 +1,236 @@
> +// SPDX-License-Identifier: GPL-2.0-only
> +/*
> + * Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
> + */
> +
> +#include <linux/debugfs.h>
> +#include <linux/io.h>
> +#include <linux/module.h>
> +#include <linux/of.h>
> +#include <linux/of_address.h>
> +#include <linux/platform_device.h>
> +
> +#include <linux/soc/qcom/ubwc.h>
> +
> +static const struct qcom_ubwc_cfg_data msm8937_data = {
> +	.ubwc_enc_version = UBWC_1_0,
> +	.ubwc_dec_version = UBWC_1_0,
> +	.highest_bank_bit = 14,
> +};
> +
> +static const struct qcom_ubwc_cfg_data msm8998_data = {
> +	.ubwc_enc_version = UBWC_1_0,
> +	.ubwc_dec_version = UBWC_1_0,
> +	.highest_bank_bit = 15,
> +};
> +
> +static const struct qcom_ubwc_cfg_data qcm2290_data = {
> +	/* no UBWC */
> +	.highest_bank_bit = 15,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sa8775p_data = {
> +	.ubwc_enc_version = UBWC_4_0,
> +	.ubwc_dec_version = UBWC_4_0,
> +	.ubwc_swizzle = 4,
> +	.ubwc_bank_spread = true,
> +	.highest_bank_bit = 13,
> +	.macrotile_mode = true,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sar2130p_data = {
> +	.ubwc_enc_version = UBWC_3_0, /* 4.0.2 in hw */
> +	.ubwc_dec_version = UBWC_4_3,
> +	.ubwc_swizzle = 6,
> +	.ubwc_bank_spread = true,
> +	.highest_bank_bit = 13,
> +	.macrotile_mode = true,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sc7180_data = {
> +	.ubwc_enc_version = UBWC_2_0,
> +	.ubwc_dec_version = UBWC_2_0,
> +	.ubwc_swizzle = 6,
> +	.ubwc_bank_spread = true,
> +	.highest_bank_bit = 14,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sc7280_data = {
> +	.ubwc_enc_version = UBWC_3_0,
> +	.ubwc_dec_version = UBWC_4_0,
> +	.ubwc_swizzle = 6,
> +	.ubwc_bank_spread = true,
> +	.highest_bank_bit = 14,
> +	.macrotile_mode = true,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sc8180x_data = {
> +	.ubwc_enc_version = UBWC_3_0,
> +	.ubwc_dec_version = UBWC_3_0,
> +	.highest_bank_bit = 16,
> +	.macrotile_mode = true,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sc8280xp_data = {
> +	.ubwc_enc_version = UBWC_4_0,
> +	.ubwc_dec_version = UBWC_4_0,
> +	.ubwc_swizzle = 6,
> +	.ubwc_bank_spread = true,
> +	.highest_bank_bit = 16,
> +	.macrotile_mode = true,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sdm670_data = {
> +	.ubwc_enc_version = UBWC_2_0,
> +	.ubwc_dec_version = UBWC_2_0,
> +	.highest_bank_bit = 14,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sdm845_data = {
> +	.ubwc_enc_version = UBWC_2_0,
> +	.ubwc_dec_version = UBWC_2_0,
> +	.highest_bank_bit = 15,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sm6115_data = {
> +	.ubwc_enc_version = UBWC_1_0,
> +	.ubwc_dec_version = UBWC_2_0,
> +	.ubwc_swizzle = 7,
> +	.ubwc_bank_spread = true,
> +	.highest_bank_bit = 14,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sm6125_data = {
> +	.ubwc_enc_version = UBWC_1_0,
> +	.ubwc_dec_version = UBWC_3_0,
> +	.ubwc_swizzle = 1,
> +	.highest_bank_bit = 14,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sm6150_data = {
> +	.ubwc_enc_version = UBWC_2_0,
> +	.ubwc_dec_version = UBWC_2_0,
> +	.highest_bank_bit = 14,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sm6350_data = {
> +	.ubwc_enc_version = UBWC_2_0,
> +	.ubwc_dec_version = UBWC_2_0,
> +	.ubwc_swizzle = 6,
> +	.ubwc_bank_spread = true,
> +	.highest_bank_bit = 14,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sm7150_data = {
> +	.ubwc_enc_version = UBWC_2_0,
> +	.ubwc_dec_version = UBWC_2_0,
> +	.highest_bank_bit = 14,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sm8150_data = {
> +	.ubwc_enc_version = UBWC_3_0,
> +	.ubwc_dec_version = UBWC_3_0,
> +	.highest_bank_bit = 15,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sm8250_data = {
> +	.ubwc_enc_version = UBWC_4_0,
> +	.ubwc_dec_version = UBWC_4_0,
> +	.ubwc_swizzle = 6,
> +	.ubwc_bank_spread = true,
> +	/* TODO: highest_bank_bit = 15 for LP_DDR4 */
> +	.highest_bank_bit = 16,
> +	.macrotile_mode = true,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sm8350_data = {
> +	.ubwc_enc_version = UBWC_4_0,
> +	.ubwc_dec_version = UBWC_4_0,
> +	.ubwc_swizzle = 6,
> +	.ubwc_bank_spread = true,
> +	/* TODO: highest_bank_bit = 15 for LP_DDR4 */
> +	.highest_bank_bit = 16,
> +	.macrotile_mode = true,
> +};
> +
> +static const struct qcom_ubwc_cfg_data sm8550_data = {
> +	.ubwc_enc_version = UBWC_4_0,
> +	.ubwc_dec_version = UBWC_4_3,
> +	.ubwc_swizzle = 6,
> +	.ubwc_bank_spread = true,
> +	/* TODO: highest_bank_bit = 15 for LP_DDR4 */
> +	.highest_bank_bit = 16,
> +	.macrotile_mode = true,
> +};
> +
> +static const struct qcom_ubwc_cfg_data x1e80100_data = {
> +	.ubwc_enc_version = UBWC_4_0,
> +	.ubwc_dec_version = UBWC_4_3,
> +	.ubwc_swizzle = 6,
> +	.ubwc_bank_spread = true,
> +	/* TODO: highest_bank_bit = 15 for LP_DDR4 */
> +	.highest_bank_bit = 16,
> +	.macrotile_mode = true,
> +};
> +
> +static const struct of_device_id qcom_ubwc_configs[] __maybe_unused = {
> +	{ .compatible = "qcom,apq8096", .data = &msm8998_data },
> +	{ .compatible = "qcom,msm8917", .data = &msm8937_data },
> +	{ .compatible = "qcom,msm8937", .data = &msm8937_data },
> +	{ .compatible = "qcom,msm8953", .data = &msm8937_data },
> +	{ .compatible = "qcom,msm8956", .data = &msm8937_data },
> +	{ .compatible = "qcom,msm8976", .data = &msm8937_data },
> +	{ .compatible = "qcom,msm8996", .data = &msm8998_data },
> +	{ .compatible = "qcom,msm8998", .data = &msm8998_data },
> +	{ .compatible = "qcom,qcm2290", .data = &qcm2290_data, },
> +	{ .compatible = "qcom,qcm6490", .data = &sc7280_data, },
> +	{ .compatible = "qcom,sa8155p", .data = &sm8150_data, },
> +	{ .compatible = "qcom,sa8540p", .data = &sc8280xp_data, },
> +	{ .compatible = "qcom,sa8775p", .data = &sa8775p_data, },
> +	{ .compatible = "qcom,sar2130p", .data = &sar2130p_data },
> +	{ .compatible = "qcom,sc7180", .data = &sc7180_data },
> +	{ .compatible = "qcom,sc7280", .data = &sc7280_data, },
> +	{ .compatible = "qcom,sc8180x", .data = &sc8180x_data, },
> +	{ .compatible = "qcom,sc8280xp", .data = &sc8280xp_data, },
> +	{ .compatible = "qcom,sdm630", .data = &msm8937_data },
> +	{ .compatible = "qcom,sdm636", .data = &msm8937_data },
> +	{ .compatible = "qcom,sdm660", .data = &msm8937_data },
> +	{ .compatible = "qcom,sdm670", .data = &sdm670_data, },
> +	{ .compatible = "qcom,sdm845", .data = &sdm845_data, },
> +	{ .compatible = "qcom,sm4250", .data = &sm6115_data, },
> +	{ .compatible = "qcom,sm6115", .data = &sm6115_data, },
> +	{ .compatible = "qcom,sm6125", .data = &sm6125_data, },
> +	{ .compatible = "qcom,sm6150", .data = &sm6150_data, },
> +	{ .compatible = "qcom,sm6350", .data = &sm6350_data, },
> +	{ .compatible = "qcom,sm6375", .data = &sm6350_data, },
> +	{ .compatible = "qcom,sm7125", .data = &sc7180_data },
> +	{ .compatible = "qcom,sm7150", .data = &sm7150_data, },
> +	{ .compatible = "qcom,sm8150", .data = &sm8150_data, },
> +	{ .compatible = "qcom,sm8250", .data = &sm8250_data, },
> +	{ .compatible = "qcom,sm8350", .data = &sm8350_data, },
> +	{ .compatible = "qcom,sm8450", .data = &sm8350_data, },
> +	{ .compatible = "qcom,sm8550", .data = &sm8550_data, },
> +	{ .compatible = "qcom,sm8650", .data = &sm8550_data, },
> +	{ .compatible = "qcom,x1e80100", .data = &x1e80100_data, },
> +	{ .compatible = "qcom,x1p42100", .data = &x1e80100_data, },
> +	{ }
> +};
> +
> +const struct qcom_ubwc_cfg_data *qcom_ubwc_config_get_data(void)
> +{
> +	const struct of_device_id *match;
> +	struct device_node *root;
> +
> +	root = of_find_node_by_path("/");
> +	if (!root)
> +		return ERR_PTR(-ENODEV);
> +
> +	match = of_match_node(qcom_ubwc_configs, root);
> +	of_node_put(root);
> +	if (!match) {
> +		pr_err("Couldn't find UBWC config data for this platform!\n");
> +		return ERR_PTR(-EINVAL);
> +	}
> +
> +	return match->data;
> +}
> diff --git a/include/linux/soc/qcom/ubwc.h b/include/linux/soc/qcom/ubwc.h
> new file mode 100644
> index 0000000000000000000000000000000000000000..4309787f7b6c8df3bbc37c3abd1a3f900398c1e7
> --- /dev/null
> +++ b/include/linux/soc/qcom/ubwc.h
> @@ -0,0 +1,57 @@
> +/* SPDX-License-Identifier: GPL-2.0-only */
> +/*
> + * Copyright (c) 2018, The Linux Foundation
> + * Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
> + */
> +
> +#ifndef __QCOM_UBWC_H__
> +#define __QCOM_UBWC_H__
> +
> +#include <linux/bits.h>
> +#include <linux/types.h>
> +
> +struct qcom_ubwc_cfg_data {
> +	u32 ubwc_enc_version;
> +	/* Can be read from MDSS_BASE + 0x58 */
> +	u32 ubwc_dec_version;
> +
> +	/**
> +	 * @ubwc_swizzle: Whether to enable level 1, 2 & 3 bank swizzling.
> +	 *
> +	 * UBWC 1.0 always enables all three levels.
> +	 * UBWC 2.0 removes level 1 bank swizzling, leaving levels 2 & 3.
> +	 * UBWC 4.0 adds the optional ability to disable levels 2 & 3.
> +	 *
> +	 * This is a bitmask where BIT(0) enables level 1, BIT(1)
> +	 * controls level 2, and BIT(2) enables level 3.
> +	 */
> +	u32 ubwc_swizzle;
> +
> +	/**
> +	 * @highest_bank_bit: Highest Bank Bit
> +	 *
> +	 * The Highest Bank Bit value represents the bit of the highest
> +	 * DDR bank.  This should ideally use DRAM type detection.
> +	 */
> +	int highest_bank_bit;
> +	bool ubwc_bank_spread;
> +
> +	/**
> +	 * @macrotile_mode: Macrotile Mode
> +	 *
> +	 * Whether to use 4-channel macrotiling mode or the newer
> +	 * 8-channel macrotiling mode introduced in UBWC 3.1. 0 is
> +	 * 4-channel and 1 is 8-channel.
> +	 */
> +	bool macrotile_mode;
> +};
> +
> +#define UBWC_1_0 0x10000000
> +#define UBWC_2_0 0x20000000
> +#define UBWC_3_0 0x30000000
> +#define UBWC_4_0 0x40000000
> +#define UBWC_4_3 0x40030000
> +
> +const struct qcom_ubwc_cfg_data *qcom_ubwc_config_get_data(void);

Looking at the LKP report for the Adreno patch... Should we provide a
stub here for the platforms like iMX5 (it has a2xx, so it doesn't make
sense to pull this driver in, a stub will be enough).

> +
> +#endif /* __QCOM_UBWC_H__ */
> 
> -- 
> 2.49.0
> 

-- 
With best wishes
Dmitry


More information about the dri-devel mailing list