irqdesc.h 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. #ifndef _LINUX_IRQDESC_H
  3. #define _LINUX_IRQDESC_H
  4. #include <linux/rcupdate.h>
  5. #include <linux/kobject.h>
  6. #include <linux/mutex.h>
  7. #include <linux/android_vendor.h>
  8. /*
  9. * Core internal functions to deal with irq descriptors
  10. */
  11. struct irq_affinity_notify;
  12. struct proc_dir_entry;
  13. struct module;
  14. struct irq_desc;
  15. struct irq_domain;
  16. struct pt_regs;
  17. /**
  18. * struct irq_desc - interrupt descriptor
  19. * @irq_common_data: per irq and chip data passed down to chip functions
  20. * @kstat_irqs: irq stats per cpu
  21. * @handle_irq: highlevel irq-events handler
  22. * @action: the irq action chain
  23. * @status_use_accessors: status information
  24. * @core_internal_state__do_not_mess_with_it: core internal status information
  25. * @depth: disable-depth, for nested irq_disable() calls
  26. * @wake_depth: enable depth, for multiple irq_set_irq_wake() callers
  27. * @tot_count: stats field for non-percpu irqs
  28. * @irq_count: stats field to detect stalled irqs
  29. * @last_unhandled: aging timer for unhandled count
  30. * @irqs_unhandled: stats field for spurious unhandled interrupts
  31. * @threads_handled: stats field for deferred spurious detection of threaded handlers
  32. * @threads_handled_last: comparator field for deferred spurious detection of threaded handlers
  33. * @lock: locking for SMP
  34. * @affinity_hint: hint to user space for preferred irq affinity
  35. * @affinity_notify: context for notification of affinity changes
  36. * @pending_mask: pending rebalanced interrupts
  37. * @threads_oneshot: bitfield to handle shared oneshot threads
  38. * @threads_active: number of irqaction threads currently running
  39. * @wait_for_threads: wait queue for sync_irq to wait for threaded handlers
  40. * @nr_actions: number of installed actions on this descriptor
  41. * @no_suspend_depth: number of irqactions on a irq descriptor with
  42. * IRQF_NO_SUSPEND set
  43. * @force_resume_depth: number of irqactions on a irq descriptor with
  44. * IRQF_FORCE_RESUME set
  45. * @rcu: rcu head for delayed free
  46. * @kobj: kobject used to represent this struct in sysfs
  47. * @request_mutex: mutex to protect request/free before locking desc->lock
  48. * @dir: /proc/irq/ procfs entry
  49. * @debugfs_file: dentry for the debugfs file
  50. * @name: flow handler name for /proc/interrupts output
  51. */
  52. struct irq_desc {
  53. struct irq_common_data irq_common_data;
  54. struct irq_data irq_data;
  55. unsigned int __percpu *kstat_irqs;
  56. irq_flow_handler_t handle_irq;
  57. struct irqaction *action; /* IRQ action list */
  58. unsigned int status_use_accessors;
  59. unsigned int core_internal_state__do_not_mess_with_it;
  60. unsigned int depth; /* nested irq disables */
  61. unsigned int wake_depth; /* nested wake enables */
  62. unsigned int tot_count;
  63. unsigned int irq_count; /* For detecting broken IRQs */
  64. unsigned long last_unhandled; /* Aging timer for unhandled count */
  65. unsigned int irqs_unhandled;
  66. atomic_t threads_handled;
  67. int threads_handled_last;
  68. raw_spinlock_t lock;
  69. struct cpumask *percpu_enabled;
  70. const struct cpumask *percpu_affinity;
  71. #ifdef CONFIG_SMP
  72. const struct cpumask *affinity_hint;
  73. struct irq_affinity_notify *affinity_notify;
  74. #ifdef CONFIG_GENERIC_PENDING_IRQ
  75. cpumask_var_t pending_mask;
  76. #endif
  77. #endif
  78. unsigned long threads_oneshot;
  79. atomic_t threads_active;
  80. wait_queue_head_t wait_for_threads;
  81. #ifdef CONFIG_PM_SLEEP
  82. unsigned int nr_actions;
  83. unsigned int no_suspend_depth;
  84. unsigned int cond_suspend_depth;
  85. unsigned int force_resume_depth;
  86. #endif
  87. #ifdef CONFIG_PROC_FS
  88. struct proc_dir_entry *dir;
  89. #endif
  90. #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
  91. struct dentry *debugfs_file;
  92. const char *dev_name;
  93. #endif
  94. #ifdef CONFIG_SPARSE_IRQ
  95. struct rcu_head rcu;
  96. struct kobject kobj;
  97. #endif
  98. struct mutex request_mutex;
  99. int parent_irq;
  100. struct module *owner;
  101. const char *name;
  102. ANDROID_VENDOR_DATA(1);
  103. } ____cacheline_internodealigned_in_smp;
  104. #ifdef CONFIG_SPARSE_IRQ
  105. extern void irq_lock_sparse(void);
  106. extern void irq_unlock_sparse(void);
  107. #else
  108. static inline void irq_lock_sparse(void) { }
  109. static inline void irq_unlock_sparse(void) { }
  110. extern struct irq_desc irq_desc[NR_IRQS];
  111. #endif
  112. static inline unsigned int irq_desc_kstat_cpu(struct irq_desc *desc,
  113. unsigned int cpu)
  114. {
  115. return desc->kstat_irqs ? *per_cpu_ptr(desc->kstat_irqs, cpu) : 0;
  116. }
  117. static inline struct irq_desc *irq_data_to_desc(struct irq_data *data)
  118. {
  119. return container_of(data->common, struct irq_desc, irq_common_data);
  120. }
  121. static inline unsigned int irq_desc_get_irq(struct irq_desc *desc)
  122. {
  123. return desc->irq_data.irq;
  124. }
  125. static inline struct irq_data *irq_desc_get_irq_data(struct irq_desc *desc)
  126. {
  127. return &desc->irq_data;
  128. }
  129. static inline struct irq_chip *irq_desc_get_chip(struct irq_desc *desc)
  130. {
  131. return desc->irq_data.chip;
  132. }
  133. static inline void *irq_desc_get_chip_data(struct irq_desc *desc)
  134. {
  135. return desc->irq_data.chip_data;
  136. }
  137. static inline void *irq_desc_get_handler_data(struct irq_desc *desc)
  138. {
  139. return desc->irq_common_data.handler_data;
  140. }
  141. /*
  142. * Architectures call this to let the generic IRQ layer
  143. * handle an interrupt.
  144. */
  145. static inline void generic_handle_irq_desc(struct irq_desc *desc)
  146. {
  147. desc->handle_irq(desc);
  148. }
  149. int handle_irq_desc(struct irq_desc *desc);
  150. int generic_handle_irq(unsigned int irq);
  151. int generic_handle_irq_safe(unsigned int irq);
  152. #ifdef CONFIG_IRQ_DOMAIN
  153. /*
  154. * Convert a HW interrupt number to a logical one using a IRQ domain,
  155. * and handle the result interrupt number. Return -EINVAL if
  156. * conversion failed.
  157. */
  158. int generic_handle_domain_irq(struct irq_domain *domain, unsigned int hwirq);
  159. int generic_handle_domain_irq_safe(struct irq_domain *domain, unsigned int hwirq);
  160. int generic_handle_domain_nmi(struct irq_domain *domain, unsigned int hwirq);
  161. #endif
  162. /* Test to see if a driver has successfully requested an irq */
  163. static inline int irq_desc_has_action(struct irq_desc *desc)
  164. {
  165. return desc && desc->action != NULL;
  166. }
  167. /**
  168. * irq_set_handler_locked - Set irq handler from a locked region
  169. * @data: Pointer to the irq_data structure which identifies the irq
  170. * @handler: Flow control handler function for this interrupt
  171. *
  172. * Sets the handler in the irq descriptor associated to @data.
  173. *
  174. * Must be called with irq_desc locked and valid parameters. Typical
  175. * call site is the irq_set_type() callback.
  176. */
  177. static inline void irq_set_handler_locked(struct irq_data *data,
  178. irq_flow_handler_t handler)
  179. {
  180. struct irq_desc *desc = irq_data_to_desc(data);
  181. desc->handle_irq = handler;
  182. }
  183. /**
  184. * irq_set_chip_handler_name_locked - Set chip, handler and name from a locked region
  185. * @data: Pointer to the irq_data structure for which the chip is set
  186. * @chip: Pointer to the new irq chip
  187. * @handler: Flow control handler function for this interrupt
  188. * @name: Name of the interrupt
  189. *
  190. * Replace the irq chip at the proper hierarchy level in @data and
  191. * sets the handler and name in the associated irq descriptor.
  192. *
  193. * Must be called with irq_desc locked and valid parameters.
  194. */
  195. static inline void
  196. irq_set_chip_handler_name_locked(struct irq_data *data,
  197. const struct irq_chip *chip,
  198. irq_flow_handler_t handler, const char *name)
  199. {
  200. struct irq_desc *desc = irq_data_to_desc(data);
  201. desc->handle_irq = handler;
  202. desc->name = name;
  203. data->chip = (struct irq_chip *)chip;
  204. }
  205. bool irq_check_status_bit(unsigned int irq, unsigned int bitmask);
  206. static inline bool irq_balancing_disabled(unsigned int irq)
  207. {
  208. return irq_check_status_bit(irq, IRQ_NO_BALANCING_MASK);
  209. }
  210. static inline bool irq_is_percpu(unsigned int irq)
  211. {
  212. return irq_check_status_bit(irq, IRQ_PER_CPU);
  213. }
  214. static inline bool irq_is_percpu_devid(unsigned int irq)
  215. {
  216. return irq_check_status_bit(irq, IRQ_PER_CPU_DEVID);
  217. }
  218. void __irq_set_lockdep_class(unsigned int irq, struct lock_class_key *lock_class,
  219. struct lock_class_key *request_class);
  220. static inline void
  221. irq_set_lockdep_class(unsigned int irq, struct lock_class_key *lock_class,
  222. struct lock_class_key *request_class)
  223. {
  224. if (IS_ENABLED(CONFIG_LOCKDEP))
  225. __irq_set_lockdep_class(irq, lock_class, request_class);
  226. }
  227. #endif