root/drivers/interconnect/qcom/icc-rpmh.c
// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2020, The Linux Foundation. All rights reserved.
 * Copyright (c) 2024 Qualcomm Innovation Center, Inc. All rights reserved.
 */

#include <linux/bitfield.h>
#include <linux/clk.h>
#include <linux/interconnect.h>
#include <linux/interconnect-provider.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/of_platform.h>
#include <linux/slab.h>

#include "bcm-voter.h"
#include "icc-common.h"
#include "icc-rpmh.h"

/* QNOC QoS */
#define QOSGEN_MAINCTL_LO(p, qp)        (0x8 + (p->port_offsets[qp]))
#define QOS_SLV_URG_MSG_EN_MASK         GENMASK(3, 3)
#define QOS_DFLT_PRIO_MASK              GENMASK(6, 4)
#define QOS_DISABLE_MASK                GENMASK(24, 24)

/**
 * qcom_icc_set_qos - initialize static QoS configurations
 * @qp: qcom icc provider to which @node belongs
 * @node: qcom icc node to operate on
 */
static void qcom_icc_set_qos(struct qcom_icc_provider *qp,
                             struct qcom_icc_node *node)
{
        const struct qcom_icc_qosbox *qos = node->qosbox;
        int port;

        for (port = 0; port < qos->num_ports; port++) {
                regmap_update_bits(qp->regmap, QOSGEN_MAINCTL_LO(qos, port),
                                   QOS_DISABLE_MASK,
                                   FIELD_PREP(QOS_DISABLE_MASK, qos->prio_fwd_disable));

                regmap_update_bits(qp->regmap, QOSGEN_MAINCTL_LO(qos, port),
                                   QOS_DFLT_PRIO_MASK,
                                   FIELD_PREP(QOS_DFLT_PRIO_MASK, qos->prio));

                regmap_update_bits(qp->regmap, QOSGEN_MAINCTL_LO(qos, port),
                                   QOS_SLV_URG_MSG_EN_MASK,
                                   FIELD_PREP(QOS_SLV_URG_MSG_EN_MASK, qos->urg_fwd));
        }
}

/**
 * qcom_icc_pre_aggregate - cleans up stale values from prior icc_set
 * @node: icc node to operate on
 */
void qcom_icc_pre_aggregate(struct icc_node *node)
{
        size_t i;
        struct qcom_icc_node *qn;
        struct qcom_icc_provider *qp;

        qn = node->data;
        qp = to_qcom_provider(node->provider);

        for (i = 0; i < QCOM_ICC_NUM_BUCKETS; i++) {
                qn->sum_avg[i] = 0;
                qn->max_peak[i] = 0;
        }

        for (i = 0; i < qn->num_bcms; i++)
                qcom_icc_bcm_voter_add(qp->voter, qn->bcms[i]);
}
EXPORT_SYMBOL_GPL(qcom_icc_pre_aggregate);

/**
 * qcom_icc_aggregate - aggregate bw for buckets indicated by tag
 * @node: node to aggregate
 * @tag: tag to indicate which buckets to aggregate
 * @avg_bw: new bw to sum aggregate
 * @peak_bw: new bw to max aggregate
 * @agg_avg: existing aggregate avg bw val
 * @agg_peak: existing aggregate peak bw val
 */
int qcom_icc_aggregate(struct icc_node *node, u32 tag, u32 avg_bw,
                       u32 peak_bw, u32 *agg_avg, u32 *agg_peak)
{
        size_t i;
        struct qcom_icc_node *qn;

        qn = node->data;

        if (!tag)
                tag = QCOM_ICC_TAG_ALWAYS;

        for (i = 0; i < QCOM_ICC_NUM_BUCKETS; i++) {
                if (tag & BIT(i)) {
                        qn->sum_avg[i] += avg_bw;
                        qn->max_peak[i] = max_t(u32, qn->max_peak[i], peak_bw);
                }

                if (node->init_avg || node->init_peak) {
                        qn->sum_avg[i] = max_t(u64, qn->sum_avg[i], node->init_avg);
                        qn->max_peak[i] = max_t(u64, qn->max_peak[i], node->init_peak);
                }
        }

        *agg_avg += avg_bw;
        *agg_peak = max_t(u32, *agg_peak, peak_bw);

        return 0;
}
EXPORT_SYMBOL_GPL(qcom_icc_aggregate);

/**
 * qcom_icc_set - set the constraints based on path
 * @src: source node for the path to set constraints on
 * @dst: destination node for the path to set constraints on
 *
 * Return: 0 on success, or an error code otherwise
 */
int qcom_icc_set(struct icc_node *src, struct icc_node *dst)
{
        struct qcom_icc_provider *qp;
        struct icc_node *node;

        if (!src)
                node = dst;
        else
                node = src;

        qp = to_qcom_provider(node->provider);

        qcom_icc_bcm_voter_commit(qp->voter);

        return 0;
}
EXPORT_SYMBOL_GPL(qcom_icc_set);

/**
 * qcom_icc_bcm_init - populates bcm aux data and connect qnodes
 * @bcm: bcm to be initialized
 * @dev: associated provider device
 *
 * Return: 0 on success, or an error code otherwise
 */
int qcom_icc_bcm_init(struct qcom_icc_bcm *bcm, struct device *dev)
{
        struct qcom_icc_node *qn;
        const struct bcm_db *data;
        size_t data_count;
        int i;

        /* BCM is already initialised*/
        if (bcm->addr)
                return 0;

        bcm->addr = cmd_db_read_addr(bcm->name);
        if (!bcm->addr) {
                dev_err(dev, "%s could not find RPMh address\n",
                        bcm->name);
                return -EINVAL;
        }

        data = cmd_db_read_aux_data(bcm->name, &data_count);
        if (IS_ERR(data)) {
                dev_err(dev, "%s command db read error (%ld)\n",
                        bcm->name, PTR_ERR(data));
                return PTR_ERR(data);
        }
        if (!data_count) {
                dev_err(dev, "%s command db missing or partial aux data\n",
                        bcm->name);
                return -EINVAL;
        }

        bcm->aux_data.unit = le32_to_cpu(data->unit);
        bcm->aux_data.width = le16_to_cpu(data->width);
        bcm->aux_data.vcd = data->vcd;
        bcm->aux_data.reserved = data->reserved;
        INIT_LIST_HEAD(&bcm->list);
        INIT_LIST_HEAD(&bcm->ws_list);

        if (!bcm->vote_scale)
                bcm->vote_scale = 1000;

        /* Link Qnodes to their respective BCMs */
        for (i = 0; i < bcm->num_nodes; i++) {
                qn = bcm->nodes[i];
                qn->bcms[qn->num_bcms] = bcm;
                qn->num_bcms++;
        }

        return 0;
}
EXPORT_SYMBOL_GPL(qcom_icc_bcm_init);

/**
 * qcom_icc_rpmh_configure_qos - configure QoS parameters
 * @qp: qcom icc provider associated with QoS endpoint nodes
 *
 * Return: 0 on success, or an error code otherwise
 */
static int qcom_icc_rpmh_configure_qos(struct qcom_icc_provider *qp)
{
        struct qcom_icc_node *qnode;
        size_t i;
        int ret;

        ret = clk_bulk_prepare_enable(qp->num_clks, qp->clks);
        if (ret)
                return ret;

        for (i = 0; i < qp->num_nodes; i++) {
                qnode = qp->nodes[i];
                if (!qnode)
                        continue;

                if (qnode->qosbox)
                        qcom_icc_set_qos(qp, qnode);
        }

        clk_bulk_disable_unprepare(qp->num_clks, qp->clks);

        return ret;
}

int qcom_icc_rpmh_probe(struct platform_device *pdev)
{
        const struct qcom_icc_desc *desc;
        struct device *dev = &pdev->dev;
        struct icc_onecell_data *data;
        struct icc_provider *provider;
        struct qcom_icc_node * const *qnodes, *qn;
        struct qcom_icc_provider *qp;
        struct icc_node *node;
        size_t num_nodes, i, j;
        int ret;

        desc = of_device_get_match_data(dev);
        if (!desc)
                return -EINVAL;

        qnodes = desc->nodes;
        num_nodes = desc->num_nodes;

        qp = devm_kzalloc(dev, sizeof(*qp), GFP_KERNEL);
        if (!qp)
                return -ENOMEM;

        data = devm_kzalloc(dev, struct_size(data, nodes, num_nodes), GFP_KERNEL);
        if (!data)
                return -ENOMEM;
        data->num_nodes = num_nodes;

        provider = &qp->provider;
        provider->dev = dev;
        provider->set = qcom_icc_set;
        provider->pre_aggregate = qcom_icc_pre_aggregate;
        provider->aggregate = qcom_icc_aggregate;
        provider->xlate_extended = qcom_icc_xlate_extended;
        provider->data = data;

        icc_provider_init(provider);

        qp->dev = dev;
        qp->bcms = desc->bcms;
        qp->nodes = desc->nodes;
        qp->num_bcms = desc->num_bcms;
        qp->num_nodes = desc->num_nodes;

        qp->voter = of_bcm_voter_get(qp->dev, NULL);
        if (IS_ERR(qp->voter))
                return PTR_ERR(qp->voter);

        for (i = 0; i < qp->num_bcms; i++)
                qcom_icc_bcm_init(qp->bcms[i], dev);

        for (i = 0; i < num_nodes; i++) {
                qn = qnodes[i];
                if (!qn)
                        continue;

                if (!qn->node)
                        qn->node = icc_node_create_dyn();

                node = qn->node;
                if (IS_ERR(node)) {
                        ret = PTR_ERR(node);
                        goto err_remove_nodes;
                }

                ret = icc_node_set_name(node, provider, qn->name);
                if (ret) {
                        icc_node_destroy(node->id);
                        goto err_remove_nodes;
                }

                node->data = qn;
                icc_node_add(node, provider);

                for (j = 0; j < qn->num_links; j++)
                        icc_link_nodes(node, &qn->link_nodes[j]->node);

                data->nodes[i] = node;
        }

        if (desc->config) {
                struct resource *res;
                void __iomem *base;

                /* Try parent's regmap first */
                qp->regmap = dev_get_regmap(dev->parent, NULL);
                if (!qp->regmap) {
                        base = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
                        if (IS_ERR(base))
                                goto skip_qos_config;

                        qp->regmap = devm_regmap_init_mmio(dev, base, desc->config);
                        if (IS_ERR(qp->regmap)) {
                                dev_info(dev, "Skipping QoS, regmap failed; %ld\n",
                                         PTR_ERR(qp->regmap));
                                goto skip_qos_config;
                        }
                }

                qp->num_clks = devm_clk_bulk_get_all(qp->dev, &qp->clks);
                if (qp->num_clks == -EPROBE_DEFER)
                        return dev_err_probe(dev, qp->num_clks, "Failed to get QoS clocks\n");

                if (qp->num_clks < 0 || (!qp->num_clks && desc->qos_requires_clocks)) {
                        dev_info(dev, "Skipping QoS, failed to get clk: %d\n", qp->num_clks);
                        goto skip_qos_config;
                }

                ret = qcom_icc_rpmh_configure_qos(qp);
                if (ret)
                        dev_info(dev, "Failed to program QoS: %d\n", ret);
        }

skip_qos_config:
        ret = icc_provider_register(provider);
        if (ret)
                goto err_remove_nodes;

        platform_set_drvdata(pdev, qp);

        /* Populate child NoC devices if any */
        if (of_get_child_count(dev->of_node) > 0) {
                ret = of_platform_populate(dev->of_node, NULL, NULL, dev);
                if (ret)
                        goto err_deregister_provider;
        }

        return 0;

err_deregister_provider:
        icc_provider_deregister(provider);
err_remove_nodes:
        icc_nodes_remove(provider);

        return ret;
}
EXPORT_SYMBOL_GPL(qcom_icc_rpmh_probe);

void qcom_icc_rpmh_remove(struct platform_device *pdev)
{
        struct qcom_icc_provider *qp = platform_get_drvdata(pdev);

        icc_provider_deregister(&qp->provider);
        icc_nodes_remove(&qp->provider);
}
EXPORT_SYMBOL_GPL(qcom_icc_rpmh_remove);

MODULE_DESCRIPTION("Qualcomm RPMh interconnect driver");
MODULE_LICENSE("GPL v2");