1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2020 Linaro Ltd
7 #include <linux/device.h>
8 #include <linux/interconnect-provider.h>
10 #include <linux/module.h>
11 #include <linux/of_device.h>
12 #include <linux/of_platform.h>
13 #include <linux/platform_device.h>
14 #include <linux/pm_domain.h>
15 #include <linux/regmap.h>
16 #include <linux/slab.h>
19 #include "icc-common.h"
23 #define QNOC_QOS_MCTL_LOWn_ADDR(n) (0x8 + (n * 0x1000))
24 #define QNOC_QOS_MCTL_DFLT_PRIO_MASK 0x70
25 #define QNOC_QOS_MCTL_DFLT_PRIO_SHIFT 4
26 #define QNOC_QOS_MCTL_URGFWD_EN_MASK 0x8
27 #define QNOC_QOS_MCTL_URGFWD_EN_SHIFT 3
30 #define M_BKE_REG_BASE(n) (0x300 + (0x4000 * n))
31 #define M_BKE_EN_ADDR(n) (M_BKE_REG_BASE(n))
32 #define M_BKE_HEALTH_CFG_ADDR(i, n) (M_BKE_REG_BASE(n) + 0x40 + (0x4 * i))
34 #define M_BKE_HEALTH_CFG_LIMITCMDS_MASK 0x80000000
35 #define M_BKE_HEALTH_CFG_AREQPRIO_MASK 0x300
36 #define M_BKE_HEALTH_CFG_PRIOLVL_MASK 0x3
37 #define M_BKE_HEALTH_CFG_AREQPRIO_SHIFT 0x8
38 #define M_BKE_HEALTH_CFG_LIMITCMDS_SHIFT 0x1f
40 #define M_BKE_EN_EN_BMASK 0x1
43 #define NOC_QOS_PRIORITYn_ADDR(n) (0x8 + (n * 0x1000))
44 #define NOC_QOS_PRIORITY_P1_MASK 0xc
45 #define NOC_QOS_PRIORITY_P0_MASK 0x3
46 #define NOC_QOS_PRIORITY_P1_SHIFT 0x2
48 #define NOC_QOS_MODEn_ADDR(n) (0xc + (n * 0x1000))
49 #define NOC_QOS_MODEn_MASK 0x3
51 static int qcom_icc_set_qnoc_qos(struct icc_node *src, u64 max_bw)
53 struct icc_provider *provider = src->provider;
54 struct qcom_icc_provider *qp = to_qcom_provider(provider);
55 struct qcom_icc_node *qn = src->data;
56 struct qcom_icc_qos *qos = &qn->qos;
59 rc = regmap_update_bits(qp->regmap,
60 qp->qos_offset + QNOC_QOS_MCTL_LOWn_ADDR(qos->qos_port),
61 QNOC_QOS_MCTL_DFLT_PRIO_MASK,
62 qos->areq_prio << QNOC_QOS_MCTL_DFLT_PRIO_SHIFT);
66 return regmap_update_bits(qp->regmap,
67 qp->qos_offset + QNOC_QOS_MCTL_LOWn_ADDR(qos->qos_port),
68 QNOC_QOS_MCTL_URGFWD_EN_MASK,
69 !!qos->urg_fwd_en << QNOC_QOS_MCTL_URGFWD_EN_SHIFT);
72 static int qcom_icc_bimc_set_qos_health(struct qcom_icc_provider *qp,
73 struct qcom_icc_qos *qos,
79 val = qos->prio_level;
80 mask = M_BKE_HEALTH_CFG_PRIOLVL_MASK;
82 val |= qos->areq_prio << M_BKE_HEALTH_CFG_AREQPRIO_SHIFT;
83 mask |= M_BKE_HEALTH_CFG_AREQPRIO_MASK;
85 /* LIMITCMDS is not present on M_BKE_HEALTH_3 */
87 val |= qos->limit_commands << M_BKE_HEALTH_CFG_LIMITCMDS_SHIFT;
88 mask |= M_BKE_HEALTH_CFG_LIMITCMDS_MASK;
91 return regmap_update_bits(qp->regmap,
92 qp->qos_offset + M_BKE_HEALTH_CFG_ADDR(regnum, qos->qos_port),
96 static int qcom_icc_set_bimc_qos(struct icc_node *src, u64 max_bw)
98 struct qcom_icc_provider *qp;
99 struct qcom_icc_node *qn;
100 struct icc_provider *provider;
101 u32 mode = NOC_QOS_MODE_BYPASS;
106 provider = src->provider;
107 qp = to_qcom_provider(provider);
109 if (qn->qos.qos_mode != NOC_QOS_MODE_INVALID)
110 mode = qn->qos.qos_mode;
112 /* QoS Priority: The QoS Health parameters are getting considered
113 * only if we are NOT in Bypass Mode.
115 if (mode != NOC_QOS_MODE_BYPASS) {
116 for (i = 3; i >= 0; i--) {
117 rc = qcom_icc_bimc_set_qos_health(qp,
123 /* Set BKE_EN to 1 when Fixed, Regulator or Limiter Mode */
127 return regmap_update_bits(qp->regmap,
128 qp->qos_offset + M_BKE_EN_ADDR(qn->qos.qos_port),
129 M_BKE_EN_EN_BMASK, val);
132 static int qcom_icc_noc_set_qos_priority(struct qcom_icc_provider *qp,
133 struct qcom_icc_qos *qos)
138 /* Must be updated one at a time, P1 first, P0 last */
139 val = qos->areq_prio << NOC_QOS_PRIORITY_P1_SHIFT;
140 rc = regmap_update_bits(qp->regmap,
141 qp->qos_offset + NOC_QOS_PRIORITYn_ADDR(qos->qos_port),
142 NOC_QOS_PRIORITY_P1_MASK, val);
146 return regmap_update_bits(qp->regmap,
147 qp->qos_offset + NOC_QOS_PRIORITYn_ADDR(qos->qos_port),
148 NOC_QOS_PRIORITY_P0_MASK, qos->prio_level);
151 static int qcom_icc_set_noc_qos(struct icc_node *src, u64 max_bw)
153 struct qcom_icc_provider *qp;
154 struct qcom_icc_node *qn;
155 struct icc_provider *provider;
156 u32 mode = NOC_QOS_MODE_BYPASS;
160 provider = src->provider;
161 qp = to_qcom_provider(provider);
163 if (qn->qos.qos_port < 0) {
164 dev_dbg(src->provider->dev,
165 "NoC QoS: Skipping %s: vote aggregated on parent.\n",
170 if (qn->qos.qos_mode != NOC_QOS_MODE_INVALID)
171 mode = qn->qos.qos_mode;
173 if (mode == NOC_QOS_MODE_FIXED) {
174 dev_dbg(src->provider->dev, "NoC QoS: %s: Set Fixed mode\n",
176 rc = qcom_icc_noc_set_qos_priority(qp, &qn->qos);
179 } else if (mode == NOC_QOS_MODE_BYPASS) {
180 dev_dbg(src->provider->dev, "NoC QoS: %s: Set Bypass mode\n",
184 return regmap_update_bits(qp->regmap,
185 qp->qos_offset + NOC_QOS_MODEn_ADDR(qn->qos.qos_port),
186 NOC_QOS_MODEn_MASK, mode);
189 static int qcom_icc_qos_set(struct icc_node *node, u64 sum_bw)
191 struct qcom_icc_provider *qp = to_qcom_provider(node->provider);
192 struct qcom_icc_node *qn = node->data;
194 dev_dbg(node->provider->dev, "Setting QoS for %s\n", qn->name);
198 return qcom_icc_set_bimc_qos(node, sum_bw);
200 return qcom_icc_set_qnoc_qos(node, sum_bw);
202 return qcom_icc_set_noc_qos(node, sum_bw);
206 static int qcom_icc_rpm_set(int mas_rpm_id, int slv_rpm_id, u64 sum_bw)
210 if (mas_rpm_id != -1) {
211 ret = qcom_icc_rpm_smd_send(QCOM_SMD_RPM_ACTIVE_STATE,
216 pr_err("qcom_icc_rpm_smd_send mas %d error %d\n",
222 if (slv_rpm_id != -1) {
223 ret = qcom_icc_rpm_smd_send(QCOM_SMD_RPM_ACTIVE_STATE,
228 pr_err("qcom_icc_rpm_smd_send slv %d error %d\n",
237 static int __qcom_icc_set(struct icc_node *n, struct qcom_icc_node *qn,
242 if (!qn->qos.ap_owned) {
243 /* send bandwidth request message to the RPM processor */
244 ret = qcom_icc_rpm_set(qn->mas_rpm_id, qn->slv_rpm_id, sum_bw);
247 } else if (qn->qos.qos_mode != -1) {
248 /* set bandwidth directly from the AP */
249 ret = qcom_icc_qos_set(n, sum_bw);
258 * qcom_icc_pre_bw_aggregate - cleans up values before re-aggregate requests
259 * @node: icc node to operate on
261 static void qcom_icc_pre_bw_aggregate(struct icc_node *node)
263 struct qcom_icc_node *qn;
267 for (i = 0; i < QCOM_ICC_NUM_BUCKETS; i++) {
274 * qcom_icc_bw_aggregate - aggregate bw for buckets indicated by tag
275 * @node: node to aggregate
276 * @tag: tag to indicate which buckets to aggregate
277 * @avg_bw: new bw to sum aggregate
278 * @peak_bw: new bw to max aggregate
279 * @agg_avg: existing aggregate avg bw val
280 * @agg_peak: existing aggregate peak bw val
282 static int qcom_icc_bw_aggregate(struct icc_node *node, u32 tag, u32 avg_bw,
283 u32 peak_bw, u32 *agg_avg, u32 *agg_peak)
286 struct qcom_icc_node *qn;
291 tag = QCOM_ICC_TAG_ALWAYS;
293 for (i = 0; i < QCOM_ICC_NUM_BUCKETS; i++) {
295 qn->sum_avg[i] += avg_bw;
296 qn->max_peak[i] = max_t(u32, qn->max_peak[i], peak_bw);
301 *agg_peak = max_t(u32, *agg_peak, peak_bw);
306 * qcom_icc_bus_aggregate - aggregate bandwidth by traversing all nodes
307 * @provider: generic interconnect provider
308 * @agg_avg: an array for aggregated average bandwidth of buckets
309 * @agg_peak: an array for aggregated peak bandwidth of buckets
310 * @max_agg_avg: pointer to max value of aggregated average bandwidth
312 static void qcom_icc_bus_aggregate(struct icc_provider *provider,
313 u64 *agg_avg, u64 *agg_peak,
316 struct icc_node *node;
317 struct qcom_icc_node *qn;
320 /* Initialise aggregate values */
321 for (i = 0; i < QCOM_ICC_NUM_BUCKETS; i++) {
329 * Iterate nodes on the interconnect and aggregate bandwidth
330 * requests for every bucket.
332 list_for_each_entry(node, &provider->nodes, node_list) {
334 for (i = 0; i < QCOM_ICC_NUM_BUCKETS; i++) {
335 agg_avg[i] += qn->sum_avg[i];
336 agg_peak[i] = max_t(u64, agg_peak[i], qn->max_peak[i]);
340 /* Find maximum values across all buckets */
341 for (i = 0; i < QCOM_ICC_NUM_BUCKETS; i++)
342 *max_agg_avg = max_t(u64, *max_agg_avg, agg_avg[i]);
345 static int qcom_icc_set(struct icc_node *src, struct icc_node *dst)
347 struct qcom_icc_provider *qp;
348 struct qcom_icc_node *src_qn = NULL, *dst_qn = NULL;
349 struct icc_provider *provider;
352 u64 agg_avg[QCOM_ICC_NUM_BUCKETS], agg_peak[QCOM_ICC_NUM_BUCKETS];
360 provider = src->provider;
361 qp = to_qcom_provider(provider);
363 qcom_icc_bus_aggregate(provider, agg_avg, agg_peak, &max_agg_avg);
365 sum_bw = icc_units_to_bps(max_agg_avg);
367 ret = __qcom_icc_set(src, src_qn, sum_bw);
371 ret = __qcom_icc_set(dst, dst_qn, sum_bw);
376 for (i = 0; i < qp->num_clks; i++) {
378 * Use WAKE bucket for active clock, otherwise, use SLEEP bucket
379 * for other clocks. If a platform doesn't set interconnect
380 * path tags, by default use sleep bucket for all clocks.
382 * Note, AMC bucket is not supported yet.
384 if (!strcmp(qp->bus_clks[i].id, "bus_a"))
385 bucket = QCOM_ICC_BUCKET_WAKE;
387 bucket = QCOM_ICC_BUCKET_SLEEP;
389 rate = icc_units_to_bps(max(agg_avg[bucket], agg_peak[bucket]));
390 do_div(rate, src_qn->buswidth);
391 rate = min_t(u64, rate, LONG_MAX);
393 if (qp->bus_clk_rate[i] == rate)
396 ret = clk_set_rate(qp->bus_clks[i].clk, rate);
398 pr_err("%s clk_set_rate error: %d\n",
399 qp->bus_clks[i].id, ret);
402 qp->bus_clk_rate[i] = rate;
408 static const char * const bus_clocks[] = {
412 int qnoc_probe(struct platform_device *pdev)
414 struct device *dev = &pdev->dev;
415 const struct qcom_icc_desc *desc;
416 struct icc_onecell_data *data;
417 struct icc_provider *provider;
418 struct qcom_icc_node * const *qnodes;
419 struct qcom_icc_provider *qp;
420 struct icc_node *node;
422 const char * const *cds;
426 /* wait for the RPM proxy */
427 if (!qcom_icc_rpm_smd_available())
428 return -EPROBE_DEFER;
430 desc = of_device_get_match_data(dev);
434 qnodes = desc->nodes;
435 num_nodes = desc->num_nodes;
437 if (desc->num_clocks) {
439 cd_num = desc->num_clocks;
442 cd_num = ARRAY_SIZE(bus_clocks);
445 qp = devm_kzalloc(dev, struct_size(qp, bus_clks, cd_num), GFP_KERNEL);
449 qp->bus_clk_rate = devm_kcalloc(dev, cd_num, sizeof(*qp->bus_clk_rate),
451 if (!qp->bus_clk_rate)
454 data = devm_kzalloc(dev, struct_size(data, nodes, num_nodes),
459 for (i = 0; i < cd_num; i++)
460 qp->bus_clks[i].id = cds[i];
461 qp->num_clks = cd_num;
463 qp->type = desc->type;
464 qp->qos_offset = desc->qos_offset;
466 if (desc->regmap_cfg) {
467 struct resource *res;
470 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
472 /* Try parent's regmap */
473 qp->regmap = dev_get_regmap(dev->parent, NULL);
479 mmio = devm_ioremap_resource(dev, res);
482 dev_err(dev, "Cannot ioremap interconnect bus resource\n");
483 return PTR_ERR(mmio);
486 qp->regmap = devm_regmap_init_mmio(dev, mmio, desc->regmap_cfg);
487 if (IS_ERR(qp->regmap)) {
488 dev_err(dev, "Cannot regmap interconnect bus resource\n");
489 return PTR_ERR(qp->regmap);
494 ret = devm_clk_bulk_get(dev, qp->num_clks, qp->bus_clks);
498 ret = clk_bulk_prepare_enable(qp->num_clks, qp->bus_clks);
502 if (desc->has_bus_pd) {
503 ret = dev_pm_domain_attach(dev, true);
508 provider = &qp->provider;
509 INIT_LIST_HEAD(&provider->nodes);
511 provider->set = qcom_icc_set;
512 provider->pre_aggregate = qcom_icc_pre_bw_aggregate;
513 provider->aggregate = qcom_icc_bw_aggregate;
514 provider->xlate_extended = qcom_icc_xlate_extended;
515 provider->data = data;
517 ret = icc_provider_add(provider);
519 dev_err(dev, "error adding interconnect provider: %d\n", ret);
520 clk_bulk_disable_unprepare(qp->num_clks, qp->bus_clks);
524 for (i = 0; i < num_nodes; i++) {
527 node = icc_node_create(qnodes[i]->id);
533 node->name = qnodes[i]->name;
534 node->data = qnodes[i];
535 icc_node_add(node, provider);
537 for (j = 0; j < qnodes[i]->num_links; j++)
538 icc_link_create(node, qnodes[i]->links[j]);
540 data->nodes[i] = node;
542 data->num_nodes = num_nodes;
544 platform_set_drvdata(pdev, qp);
546 /* Populate child NoC devices if any */
547 if (of_get_child_count(dev->of_node) > 0)
548 return of_platform_populate(dev->of_node, NULL, NULL, dev);
552 icc_nodes_remove(provider);
553 clk_bulk_disable_unprepare(qp->num_clks, qp->bus_clks);
554 icc_provider_del(provider);
558 EXPORT_SYMBOL(qnoc_probe);
560 int qnoc_remove(struct platform_device *pdev)
562 struct qcom_icc_provider *qp = platform_get_drvdata(pdev);
564 icc_nodes_remove(&qp->provider);
565 clk_bulk_disable_unprepare(qp->num_clks, qp->bus_clks);
566 icc_provider_del(&qp->provider);
570 EXPORT_SYMBOL(qnoc_remove);