text: /* SPDX-License-Identifier: GPL-2.0 */
  /*
   * irq_domain - IRQ translation domains
   *
   * Translation infrastructure between hw and linux irq numbers.  This is
   * helpful for interrupt controllers to implement mapping between hardware
   * irq numbers and the Linux irq number space.
   *
   * irq_domains also have hooks for translating device tree or other
   * firmware interrupt representations into a hardware irq number that
   * can be mapped back to a Linux irq number without any extra platform
   * support code.
   *
   * Interrupt controller "domain" data structure. This could be defined as a
   * irq domain controller. That is, it handles the mapping between hardware
   * and virtual interrupt numbers for a given interrupt domain. The domain
   * structure is generally created by the PIC code for a given PIC instance
   * (though a domain can cover more than one PIC if they have a flat number
   * model). It's the domain callbacks that are responsible for setting the
   * irq_chip on a given irq_desc after it's been mapped.
   *
   * The host code and data structures use a fwnode_handle pointer to
   * identify the domain. In some cases, and in order to preserve source
   * code compatibility, this fwnode pointer is "upgraded" to a DT
   * device_node. For those firmware infrastructures that do not provide
   * a unique identifier for an interrupt controller, the irq_domain
   * code offers a fwnode allocator.
   */
  
  #ifndef _LINUX_IRQDOMAIN_H
  #define _LINUX_IRQDOMAIN_H
  
  #include <linux/types.h>
  #include <linux/irqhandler.h>
  #include <linux/of.h>
  #include <linux/mutex.h>
  #include <linux/radix-tree.h>
  
  struct device_node;
  struct irq_domain;
  struct of_device_id;
  struct irq_chip;
  struct irq_data;
  struct cpumask;
  struct seq_file;
  struct irq_affinity_desc;
  
  /* Number of irqs reserved for a legacy isa controller */
  #define NUM_ISA_INTERRUPTS	16
  
  #define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16
  
  /**
   * struct irq_fwspec - generic IRQ specifier structure
   *
   * @fwnode:		Pointer to a firmware-specific descriptor
   * @param_count:	Number of device-specific parameters
   * @param:		Device-specific parameters
   *
   * This structure, directly modeled after of_phandle_args, is used to
   * pass a device-specific description of an interrupt.
   */
  struct irq_fwspec {
  	struct fwnode_handle *fwnode;
  	int param_count;
  	u32 param[IRQ_DOMAIN_IRQ_SPEC_PARAMS];
  };
  
  /*
   * Should several domains have the same device node, but serve
   * different purposes (for example one domain is for PCI/MSI, and the
   * other for wired IRQs), they can be distinguished using a
   * bus-specific token. Most domains are expected to only carry
   * DOMAIN_BUS_ANY.
   */
  enum irq_domain_bus_token {
  	DOMAIN_BUS_ANY		= 0,
  	DOMAIN_BUS_WIRED,
  	DOMAIN_BUS_GENERIC_MSI,
  	DOMAIN_BUS_PCI_MSI,
  	DOMAIN_BUS_PLATFORM_MSI,
  	DOMAIN_BUS_NEXUS,
  	DOMAIN_BUS_IPI,
  	DOMAIN_BUS_FSL_MC_MSI,
  };
  
  /**
   * struct irq_domain_ops - Methods for irq_domain objects
   * @match: Match an interrupt controller device node to a host, returns
   *         1 on a match
   * @map: Create or update a mapping between a virtual irq number and a hw
   *       irq number. This is called only once for a given mapping.
   * @unmap: Dispose of such a mapping
   * @xlate: Given a device tree node and interrupt specifier, decode
   *         the hardware irq number and linux irq type value.
   *
   * Functions below are provided by the driver and called whenever a new mapping
   * is created or an old mapping is disposed. The driver can then proceed to
   * whatever internal data structures management is required. It also needs
   * to setup the irq_desc when returning from map().
   */
  struct irq_domain_ops {
  	int (*match)(struct irq_domain *d, struct device_node *node,
  		     enum irq_domain_bus_token bus_token);
  	int (*select)(struct irq_domain *d, struct irq_fwspec *fwspec,
  		      enum irq_domain_bus_token bus_token);
  	int (*map)(struct irq_domain *d, unsigned int virq, irq_hw_number_t hw);
  	void (*unmap)(struct irq_domain *d, unsigned int virq);
  	int (*xlate)(struct irq_domain *d, struct device_node *node,
  		     const u32 *intspec, unsigned int intsize,
  		     unsigned long *out_hwirq, unsigned int *out_type);
  #ifdef	CONFIG_IRQ_DOMAIN_HIERARCHY
  	/* extended V2 interfaces to support hierarchy irq_domains */
  	int (*alloc)(struct irq_domain *d, unsigned int virq,
  		     unsigned int nr_irqs, void *arg);
  	void (*free)(struct irq_domain *d, unsigned int virq,
  		     unsigned int nr_irqs);
  	int (*activate)(struct irq_domain *d, struct irq_data *irqd, bool reserve);
  	void (*deactivate)(struct irq_domain *d, struct irq_data *irq_data);
  	int (*translate)(struct irq_domain *d, struct irq_fwspec *fwspec,
  			 unsigned long *out_hwirq, unsigned int *out_type);
  #endif
  #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
  	void (*debug_show)(struct seq_file *m, struct irq_domain *d,
  			   struct irq_data *irqd, int ind);
  #endif
  };
  
  extern struct irq_domain_ops irq_generic_chip_ops;
  
  struct irq_domain_chip_generic;
  
  /**
   * struct irq_domain - Hardware interrupt number translation object
   * @link: Element in global irq_domain list.
   * @name: Name of interrupt domain
   * @ops: pointer to irq_domain methods
   * @host_data: private data pointer for use by owner.  Not touched by irq_domain
   *             core code.
   * @flags: host per irq_domain flags
   * @mapcount: The number of mapped interrupts
   *
   * Optional elements
   * @fwnode: Pointer to firmware node associated with the irq_domain. Pretty easy
   *          to swap it for the of_node via the irq_domain_get_of_node accessor
   * @gc: Pointer to a list of generic chips. There is a helper function for
   *      setting up one or more generic chips for interrupt controllers
   *      drivers using the generic chip library which uses this pointer.
   * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
   * @debugfs_file: dentry for the domain debugfs file
   *
   * Revmap data, used internally by irq_domain
   * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that
   *                         support direct mapping
   * @revmap_size: Size of the linear map table @linear_revmap[]
   * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
   * @linear_revmap: Linear table of hwirq->virq reverse mappings
   */
  struct irq_domain {
  	struct list_head link;
  	const char *name;
  	const struct irq_domain_ops *ops;
  	void *host_data;
  	unsigned int flags;
  	unsigned int mapcount;
  
  	/* Optional data */
  	struct fwnode_handle *fwnode;
  	enum irq_domain_bus_token bus_token;
  	struct irq_domain_chip_generic *gc;
  #ifdef	CONFIG_IRQ_DOMAIN_HIERARCHY
  	struct irq_domain *parent;
  #endif
  #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
  	struct dentry		*debugfs_file;
  #endif
  
  	/* reverse map data. The linear map gets appended to the irq_domain */
  	irq_hw_number_t hwirq_max;
  	unsigned int revmap_direct_max_irq;
  	unsigned int revmap_size;
  	struct radix_tree_root revmap_tree;
  	struct mutex revmap_tree_mutex;
  	unsigned int linear_revmap[];
  };
  
  /* Irq domain flags */
  enum {
  	/* Irq domain is hierarchical */
  	IRQ_DOMAIN_FLAG_HIERARCHY	= (1 << 0),
  
  	/* Irq domain name was allocated in __irq_domain_add() */
  	IRQ_DOMAIN_NAME_ALLOCATED	= (1 << 6),
  
  	/* Irq domain is an IPI domain with virq per cpu */
  	IRQ_DOMAIN_FLAG_IPI_PER_CPU	= (1 << 2),
  
  	/* Irq domain is an IPI domain with single virq */
  	IRQ_DOMAIN_FLAG_IPI_SINGLE	= (1 << 3),
  
  	/* Irq domain implements MSIs */
  	IRQ_DOMAIN_FLAG_MSI		= (1 << 4),
  
  	/* Irq domain implements MSI remapping */
  	IRQ_DOMAIN_FLAG_MSI_REMAP	= (1 << 5),
  
  	/*
  	 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
  	 * for implementation specific purposes and ignored by the
  	 * core code.
  	 */
  	IRQ_DOMAIN_FLAG_NONCORE		= (1 << 16),
  };
  
  static inline struct device_node *irq_domain_get_of_node(struct irq_domain *d)
  {
  	return to_of_node(d->fwnode);
  }
  
  #ifdef CONFIG_IRQ_DOMAIN
  struct fwnode_handle *__irq_domain_alloc_fwnode(unsigned int type, int id,
  						const char *name, void *data);
  
  enum {
  	IRQCHIP_FWNODE_REAL,
  	IRQCHIP_FWNODE_NAMED,
  	IRQCHIP_FWNODE_NAMED_ID,
  };
  
  static inline
  struct fwnode_handle *irq_domain_alloc_named_fwnode(const char *name)
  {
  	return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED, 0, name, NULL);
  }
  
  static inline
  struct fwnode_handle *irq_domain_alloc_named_id_fwnode(const char *name, int id)
  {
  	return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED_ID, id, name,
  					 NULL);
  }
  
  static inline struct fwnode_handle *irq_domain_alloc_fwnode(void *data)
  {
  	return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_REAL, 0, NULL, data);
  }
  
  void irq_domain_free_fwnode(struct fwnode_handle *fwnode);
  struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size,
  				    irq_hw_number_t hwirq_max, int direct_max,
  				    const struct irq_domain_ops *ops,
  				    void *host_data);
  struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
  					 unsigned int size,
  					 unsigned int first_irq,
  					 const struct irq_domain_ops *ops,
  					 void *host_data);
  struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
  					 unsigned int size,
  					 unsigned int first_irq,
  					 irq_hw_number_t first_hwirq,
  					 const struct irq_domain_ops *ops,
  					 void *host_data);
  extern struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec,
  						   enum irq_domain_bus_token bus_token);
  extern bool irq_domain_check_msi_remap(void);
  extern void irq_set_default_host(struct irq_domain *host);
  extern int irq_domain_alloc_descs(int virq, unsigned int nr_irqs,
  				  irq_hw_number_t hwirq, int node,
  				  const struct irq_affinity_desc *affinity);
  
  static inline struct fwnode_handle *of_node_to_fwnode(struct device_node *node)
  {
  	return node ? &node->fwnode : NULL;
  }
  
  extern const struct fwnode_operations irqchip_fwnode_ops;
  
  static inline bool is_fwnode_irqchip(struct fwnode_handle *fwnode)
  {
  	return fwnode && fwnode->ops == &irqchip_fwnode_ops;
  }
  
  extern void irq_domain_update_bus_token(struct irq_domain *domain,
  					enum irq_domain_bus_token bus_token);
  
  static inline
  struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode,
  					    enum irq_domain_bus_token bus_token)
  {
  	struct irq_fwspec fwspec = {
  		.fwnode = fwnode,
  	};
  
  	return irq_find_matching_fwspec(&fwspec, bus_token);
  }
  
  static inline struct irq_domain *irq_find_matching_host(struct device_node *node,
  							enum irq_domain_bus_token bus_token)
  {
  	return irq_find_matching_fwnode(of_node_to_fwnode(node), bus_token);
  }
  
  static inline struct irq_domain *irq_find_host(struct device_node *node)
  {
  	struct irq_domain *d;
  
  	d = irq_find_matching_host(node, DOMAIN_BUS_WIRED);
  	if (!d)
  		d = irq_find_matching_host(node, DOMAIN_BUS_ANY);
  
  	return d;
  }
  
  /**
   * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
   * @of_node: pointer to interrupt controller's device tree node.
   * @size: Number of interrupts in the domain.
   * @ops: map/unmap domain callbacks
   * @host_data: Controller private data pointer
   */
  static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
  					 unsigned int size,
  					 const struct irq_domain_ops *ops,
  					 void *host_data)
  {
  	return __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data);
  }
  static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
  					 unsigned int max_irq,
  					 const struct irq_domain_ops *ops,
  					 void *host_data)
  {
  	return __irq_domain_add(of_node_to_fwnode(of_node), 0, max_irq, max_irq, ops, host_data);
  }
  static inline struct irq_domain *irq_domain_add_legacy_isa(
  				struct device_node *of_node,
  				const struct irq_domain_ops *ops,
  				void *host_data)
  {
  	return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops,
  				     host_data);
  }
  static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
  					 const struct irq_domain_ops *ops,
  					 void *host_data)
  {
  	return __irq_domain_add(of_node_to_fwnode(of_node), 0, ~0, 0, ops, host_data);
  }
  
  static inline struct irq_domain *irq_domain_create_linear(struct fwnode_handle *fwnode,
  					 unsigned int size,
  					 const struct irq_domain_ops *ops,
  					 void *host_data)
  {
  	return __irq_domain_add(fwnode, size, size, 0, ops, host_data);
  }
  
  static inline struct irq_domain *irq_domain_create_tree(struct fwnode_handle *fwnode,
  					 const struct irq_domain_ops *ops,
  					 void *host_data)
  {
  	return __irq_domain_add(fwnode, 0, ~0, 0, ops, host_data);
  }
  
  extern void irq_domain_remove(struct irq_domain *host);
  
  extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq,
  					irq_hw_number_t hwirq);
  extern void irq_domain_associate_many(struct irq_domain *domain,
  				      unsigned int irq_base,
  				      irq_hw_number_t hwirq_base, int count);
  extern void irq_domain_disassociate(struct irq_domain *domain,
  				    unsigned int irq);
  
  extern unsigned int irq_create_mapping(struct irq_domain *host,
  				       irq_hw_number_t hwirq);
  extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec);
  extern void irq_dispose_mapping(unsigned int virq);
  
  /**
   * irq_linear_revmap() - Find a linux irq from a hw irq number.
   * @domain: domain owning this hardware interrupt
   * @hwirq: hardware irq number in that domain space
   *
   * This is a fast path alternative to irq_find_mapping() that can be
   * called directly by irq controller code to save a handful of
   * instructions. It is always safe to call, but won't find irqs mapped
   * using the radix tree.
   */
  static inline unsigned int irq_linear_revmap(struct irq_domain *domain,
  					     irq_hw_number_t hwirq)
  {
  	return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0;
  }
  extern unsigned int irq_find_mapping(struct irq_domain *host,
  				     irq_hw_number_t hwirq);
  extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
  extern int irq_create_strict_mappings(struct irq_domain *domain,
  				      unsigned int irq_base,
  				      irq_hw_number_t hwirq_base, int count);
  
  static inline int irq_create_identity_mapping(struct irq_domain *host,
  					      irq_hw_number_t hwirq)
  {
  	return irq_create_strict_mappings(host, hwirq, hwirq, 1);
  }
  
  extern const struct irq_domain_ops irq_domain_simple_ops;
  
  /* stock xlate functions */
  int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
  			const u32 *intspec, unsigned int intsize,
  			irq_hw_number_t *out_hwirq, unsigned int *out_type);
  int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
  			const u32 *intspec, unsigned int intsize,
  			irq_hw_number_t *out_hwirq, unsigned int *out_type);
  int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr,
  			const u32 *intspec, unsigned int intsize,
  			irq_hw_number_t *out_hwirq, unsigned int *out_type);
  
  /* IPI functions */
  int irq_reserve_ipi(struct irq_domain *domain, const struct cpumask *dest);
  int irq_destroy_ipi(unsigned int irq, const struct cpumask *dest);
  
  /* V2 interfaces to support hierarchy IRQ domains. */
  extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
  						unsigned int virq);
  extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
  				irq_hw_number_t hwirq, struct irq_chip *chip,
  				void *chip_data, irq_flow_handler_t handler,
  				void *handler_data, const char *handler_name);
  #ifdef	CONFIG_IRQ_DOMAIN_HIERARCHY
  extern struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
  			unsigned int flags, unsigned int size,
  			struct fwnode_handle *fwnode,
  			const struct irq_domain_ops *ops, void *host_data);
  
  static inline struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent,
  					    unsigned int flags,
  					    unsigned int size,
  					    struct device_node *node,
  					    const struct irq_domain_ops *ops,
  					    void *host_data)
  {
  	return irq_domain_create_hierarchy(parent, flags, size,
  					   of_node_to_fwnode(node),
  					   ops, host_data);
  }
  
  extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
  				   unsigned int nr_irqs, int node, void *arg,
  				   bool realloc,
  				   const struct irq_affinity_desc *affinity);
  extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs);
  extern int irq_domain_activate_irq(struct irq_data *irq_data, bool early);
  extern void irq_domain_deactivate_irq(struct irq_data *irq_data);
  
  static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
  			unsigned int nr_irqs, int node, void *arg)
  {
  	return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false,
  				       NULL);
  }
  
  extern int irq_domain_alloc_irqs_hierarchy(struct irq_domain *domain,
  					   unsigned int irq_base,
  					   unsigned int nr_irqs, void *arg);
  extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain,
  					 unsigned int virq,
  					 irq_hw_number_t hwirq,
  					 struct irq_chip *chip,
  					 void *chip_data);
  extern void irq_domain_reset_irq_data(struct irq_data *irq_data);
  extern void irq_domain_free_irqs_common(struct irq_domain *domain,
  					unsigned int virq,
  					unsigned int nr_irqs);
  extern void irq_domain_free_irqs_top(struct irq_domain *domain,
  				     unsigned int virq, unsigned int nr_irqs);
  
  extern int irq_domain_push_irq(struct irq_domain *domain, int virq, void *arg);
  extern int irq_domain_pop_irq(struct irq_domain *domain, int virq);
  
  extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
  					unsigned int irq_base,
  					unsigned int nr_irqs, void *arg);
  
  extern void irq_domain_free_irqs_parent(struct irq_domain *domain,
  					unsigned int irq_base,
  					unsigned int nr_irqs);
  
  static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
  {
  	return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY;
  }
  
  static inline bool irq_domain_is_ipi(struct irq_domain *domain)
  {
  	return domain->flags &
  		(IRQ_DOMAIN_FLAG_IPI_PER_CPU | IRQ_DOMAIN_FLAG_IPI_SINGLE);
  }
  
  static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
  {
  	return domain->flags & IRQ_DOMAIN_FLAG_IPI_PER_CPU;
  }
  
  static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
  {
  	return domain->flags & IRQ_DOMAIN_FLAG_IPI_SINGLE;
  }
  
  static inline bool irq_domain_is_msi(struct irq_domain *domain)
  {
  	return domain->flags & IRQ_DOMAIN_FLAG_MSI;
  }
  
  static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
  {
  	return domain->flags & IRQ_DOMAIN_FLAG_MSI_REMAP;
  }
  
  extern bool irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain);
  
  #else	/* CONFIG_IRQ_DOMAIN_HIERARCHY */
  static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
  			unsigned int nr_irqs, int node, void *arg)
  {
  	return -1;
  }
  
  static inline void irq_domain_free_irqs(unsigned int virq,
  					unsigned int nr_irqs) { }
  
  static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
  {
  	return false;
  }
  
  static inline bool irq_domain_is_ipi(struct irq_domain *domain)
  {
  	return false;
  }
  
  static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
  {
  	return false;
  }
  
  static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
  {
  	return false;
  }
  
  static inline bool irq_domain_is_msi(struct irq_domain *domain)
  {
  	return false;
  }
  
  static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
  {
  	return false;
  }
  
  static inline bool
  irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain)
  {
  	return false;
  }
  #endif	/* CONFIG_IRQ_DOMAIN_HIERARCHY */
  
  #else /* CONFIG_IRQ_DOMAIN */
  static inline void irq_dispose_mapping(unsigned int virq) { }
  static inline struct irq_domain *irq_find_matching_fwnode(
  	struct fwnode_handle *fwnode, enum irq_domain_bus_token bus_token)
  {
  	return NULL;
  }
  static inline bool irq_domain_check_msi_remap(void)
  {
  	return false;
  }
  #endif /* !CONFIG_IRQ_DOMAIN */
  
  #endif /* _LINUX_IRQDOMAIN_H */
  