Quelle  imx.h   Sprache: C

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Interconnect framework driver for i.MX SoC
 *
 * Copyright (c) 2019, BayLibre
 * Copyright (c) 2019-2020, NXP
 * Author: Alexandre Bailon <abailon@baylibre.com>
 * Author: Leonard Crestez <leonard.crestez@nxp.com>
 */
#ifndef __DRIVERS_INTERCONNECT_IMX_H
#define __DRIVERS_INTERCONNECT_IMX_H

#include <linux/args.h>
#include <linux/bits.h>
#include <linux/types.h>

#include <linux/interconnect-provider.h>

struct platform_device;

#define IMX_ICC_MAX_LINKS 4

/*
 * High throughput priority level in Regulator mode
 * Read Priority in Fixed/Limiter mode
 */
#define PRIORITY0_SHIFT 0
/*
 * Low throughput priority level in Regulator mode
 * Write Priority in Fixed/Limiter mode
 */
#define PRIORITY1_SHIFT 8
#define PRIORITY_MASK  0x7

#define PRIORITY_COMP_MARK BIT(31) /* Must set */

#define IMX_NOC_MODE_FIXED  0
#define IMX_NOC_MODE_LIMITER  1
#define IMX_NOC_MODE_BYPASS  2
#define IMX_NOC_MODE_REGULATOR  3
#define IMX_NOC_MODE_UNCONFIGURED 0xFF

#define IMX_NOC_PRIO_REG 0x8
#define IMX_NOC_MODE_REG 0xC
#define IMX_NOC_BANDWIDTH_REG 0x10
#define IMX_NOC_SATURATION 0x14
#define IMX_NOC_EXT_CTL_REG 0x18

struct imx_icc_provider {
 void __iomem *noc_base;
 struct icc_provider provider;
};

/*
 * struct imx_icc_node_adj - Describe a dynamic adjustable node
 */
struct imx_icc_node_adj_desc {
 unsigned int bw_mul, bw_div;
 const char *phandle_name;
 bool main_noc;
};

/*
 * struct imx_icc_node - Describe an interconnect node
 * @name: name of the node
 * @id: an unique id to identify the node
 * @links: an array of slaves' node id
 * @num_links: number of id defined in links
 */
struct imx_icc_node_desc {
 const char *name;
 u16 id;
 u16 links[IMX_ICC_MAX_LINKS];
 u16 num_links;
 const struct imx_icc_node_adj_desc *adj;
};

/*
 * struct imx_icc_noc_setting - Describe an interconnect node setting
 * @reg: register offset inside the NoC
 * @prio_level: priority level
 * @mode: functional mode
 * @ext_control: external input control
 */
struct imx_icc_noc_setting {
 u32 reg;
 u32 prio_level;
 u32 mode;
 u32 ext_control;
};

#define DEFINE_BUS_INTERCONNECT(_name, _id, _adj, ...)   \
 {        \
  .id = _id,      \
  .name = _name,      \
  .adj = _adj,      \
  .num_links = COUNT_ARGS(__VA_ARGS__),   \
  .links = { __VA_ARGS__ },    \
 }

#define DEFINE_BUS_MASTER(_name, _id, _dest_id)    \
 DEFINE_BUS_INTERCONNECT(_name, _id, NULL, _dest_id)

#define DEFINE_BUS_SLAVE(_name, _id, _adj)    \
 DEFINE_BUS_INTERCONNECT(_name, _id, _adj)

int imx_icc_register(struct platform_device *pdev,
       struct imx_icc_node_desc *nodes,
       int nodes_count,
       struct imx_icc_noc_setting *noc_settings);
void imx_icc_unregister(struct platform_device *pdev);

#endif /* __DRIVERS_INTERCONNECT_IMX_H */