include/linux/irq.h

   1 #ifndef _LINUX_IRQ_H
   2 #define _LINUX_IRQ_H
   3
   4 /*
   5  * Please do not include this file in generic code.  There is currently
   6  * no requirement for any architecture to implement anything held
   7  * within this file.
   8  *
   9  * Thanks. --rmk
  10  */
  11
  12 #include <linux/smp.h>
  13
  14 #ifndef CONFIG_S390
  15
  16 #include <linux/linkage.h>
  17 #include <linux/cache.h>
  18 #include <linux/spinlock.h>
  19 #include <linux/cpumask.h>
  20 #include <linux/gfp.h>
  21 #include <linux/irqreturn.h>
  22 #include <linux/irqnr.h>
  23 #include <linux/errno.h>
  24 #include <linux/topology.h>
  25 #include <linux/wait.h>
  26
  27 #include <asm/irq.h>
  28 #include <asm/ptrace.h>
  29 #include <asm/irq_regs.h>
  30
  31 struct irq_desc;
  32 typedef void (*irq_flow_handler_t)(unsigned int irq,
  33                                             struct irq_desc *desc);
  34
  35
  36 /*
  37  * IRQ line status.
  38  *
  39  * Bits 0-7 are reserved for the IRQF_* bits in linux/interrupt.h
  40  *
  41  * IRQ types
  42  */
  43 #define IRQ_TYPE_NONE           0x00000000      /* Default, unspecified type */
  44 #define IRQ_TYPE_EDGE_RISING    0x00000001      /* Edge rising type */
  45 #define IRQ_TYPE_EDGE_FALLING   0x00000002      /* Edge falling type */
  46 #define IRQ_TYPE_EDGE_BOTH (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING)
  47 #define IRQ_TYPE_LEVEL_HIGH     0x00000004      /* Level high type */
  48 #define IRQ_TYPE_LEVEL_LOW      0x00000008      /* Level low type */
  49 #define IRQ_TYPE_SENSE_MASK     0x0000000f      /* Mask of the above */
  50 #define IRQ_TYPE_PROBE          0x00000010      /* Probing in progress */
  51
  52 /* Internal flags */
  53 #define IRQ_INPROGRESS          0x00000100      /* IRQ handler active - do not enter! */
  54 #define IRQ_DISABLED            0x00000200      /* IRQ disabled - do not enter! */
  55 #define IRQ_PENDING             0x00000400      /* IRQ pending - replay on enable */
  56 #define IRQ_REPLAY              0x00000800      /* IRQ has been replayed but not acked yet */
  57 #define IRQ_AUTODETECT          0x00001000      /* IRQ is being autodetected */
  58 #define IRQ_WAITING             0x00002000      /* IRQ not yet seen - for autodetection */
  59 #define IRQ_LEVEL               0x00004000      /* IRQ level triggered */
  60 #define IRQ_MASKED              0x00008000      /* IRQ masked - shouldn't be seen again */
  61 #define IRQ_PER_CPU             0x00010000      /* IRQ is per CPU */
  62 #define IRQ_NOPROBE             0x00020000      /* IRQ is not valid for probing */
  63 #define IRQ_NOREQUEST           0x00040000      /* IRQ cannot be requested */
  64 #define IRQ_NOAUTOEN            0x00080000      /* IRQ will not be enabled on request irq */
  65 #define IRQ_WAKEUP              0x00100000      /* IRQ triggers system wakeup */
  66 #define IRQ_MOVE_PENDING        0x00200000      /* need to re-target IRQ destination */
  67 #define IRQ_NO_BALANCING        0x00400000      /* IRQ is excluded from balancing */
  68 #define IRQ_SPURIOUS_DISABLED   0x00800000      /* IRQ was disabled by the spurious trap */
  69 #define IRQ_MOVE_PCNTXT         0x01000000      /* IRQ migration from process context */
  70 #define IRQ_AFFINITY_SET        0x02000000      /* IRQ affinity was set from userspace*/
  71 #define IRQ_SUSPENDED           0x04000000      /* IRQ has gone through suspend sequence */
  72 #define IRQ_ONESHOT             0x08000000      /* IRQ is not unmasked after hardirq */
  73 #define IRQ_NESTED_THREAD       0x10000000      /* IRQ is nested into another, no own handler thread */
  74
  75 #ifdef CONFIG_IRQ_PER_CPU
  76 # define CHECK_IRQ_PER_CPU(var) ((var) & IRQ_PER_CPU)
  77 # define IRQ_NO_BALANCING_MASK  (IRQ_PER_CPU | IRQ_NO_BALANCING)
  78 #else
  79 # define CHECK_IRQ_PER_CPU(var) 0
  80 # define IRQ_NO_BALANCING_MASK  IRQ_NO_BALANCING
  81 #endif
  82
  83 struct msi_desc;
  84
  85 /**
  86  * struct irq_data - per irq and irq chip data passed down to chip functions
  87  * @irq:                interrupt number
  88  * @node:               node index useful for balancing
  89  * @chip:               low level interrupt hardware access
  90  * @handler_data:       per-IRQ data for the irq_chip methods
  91  * @chip_data:          platform-specific per-chip private data for the chip
  92  *                      methods, to allow shared chip implementations
  93  * @msi_desc:           MSI descriptor
  94  * @affinity:           IRQ affinity on SMP
  95  * @irq_2_iommu:        iommu with this irq
  96  *
  97  * The fields here need to overlay the ones in irq_desc until we
  98  * cleaned up the direct references and switched everything over to
  99  * irq_data.
 100  */
 101 struct irq_data {
 102         unsigned int            irq;
 103         unsigned int            node;
 104         struct irq_chip         *chip;
 105         void                    *handler_data;
 106         void                    *chip_data;
 107         struct msi_desc         *msi_desc;
 108 #ifdef CONFIG_SMP
 109         cpumask_var_t           affinity;
 110 #endif
 111 #ifdef CONFIG_INTR_REMAP
 112         struct irq_2_iommu      *irq_2_iommu;
 113 #endif
 114 };
 115
 116 /**
 117  * struct irq_chip - hardware interrupt chip descriptor
 118  *
 119  * @name:               name for /proc/interrupts
 120  * @startup:            deprecated, replaced by irq_startup
 121  * @shutdown:           deprecated, replaced by irq_shutdown
 122  * @enable:             deprecated, replaced by irq_enable
 123  * @disable:            deprecated, replaced by irq_disable
 124  * @ack:                deprecated, replaced by irq_ack
 125  * @mask:               deprecated, replaced by irq_mask
 126  * @mask_ack:           deprecated, replaced by irq_mask_ack
 127  * @unmask:             deprecated, replaced by irq_unmask
 128  * @eoi:                deprecated, replaced by irq_eoi
 129  * @end:                deprecated, will go away with __do_IRQ()
 130  * @set_affinity:       deprecated, replaced by irq_set_affinity
 131  * @retrigger:          deprecated, replaced by irq_retrigger
 132  * @set_type:           deprecated, replaced by irq_set_type
 133  * @set_wake:           deprecated, replaced by irq_wake
 134  * @bus_lock:           deprecated, replaced by irq_bus_lock
 135  * @bus_sync_unlock:    deprecated, replaced by irq_bus_sync_unlock
 136  *
 137  * @irq_startup:        start up the interrupt (defaults to ->enable if NULL)
 138  * @irq_shutdown:       shut down the interrupt (defaults to ->disable if NULL)
 139  * @irq_enable:         enable the interrupt (defaults to chip->unmask if NULL)
 140  * @irq_disable:        disable the interrupt
 141  * @irq_ack:            start of a new interrupt
 142  * @irq_mask:           mask an interrupt source
 143  * @irq_mask_ack:       ack and mask an interrupt source
 144  * @irq_unmask:         unmask an interrupt source
 145  * @irq_eoi:            end of interrupt
 146  * @irq_set_affinity:   set the CPU affinity on SMP machines
 147  * @irq_retrigger:      resend an IRQ to the CPU
 148  * @irq_set_type:       set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
 149  * @irq_set_wake:       enable/disable power-management wake-on of an IRQ
 150  * @irq_bus_lock:       function to lock access to slow bus (i2c) chips
 151  * @irq_bus_sync_unlock:function to sync and unlock slow bus (i2c) chips
 152  *
 153  * @release:            release function solely used by UML
 154  */
 155 struct irq_chip {
 156         const char      *name;
 157 #ifndef CONFIG_GENERIC_HARDIRQS_NO_DEPRECATED
 158         unsigned int    (*startup)(unsigned int irq);
 159         void            (*shutdown)(unsigned int irq);
 160         void            (*enable)(unsigned int irq);
 161         void            (*disable)(unsigned int irq);
 162
 163         void            (*ack)(unsigned int irq);
 164         void            (*mask)(unsigned int irq);
 165         void            (*mask_ack)(unsigned int irq);
 166         void            (*unmask)(unsigned int irq);
 167         void            (*eoi)(unsigned int irq);
 168
 169         void            (*end)(unsigned int irq);
 170         int             (*set_affinity)(unsigned int irq,
 171                                         const struct cpumask *dest);
 172         int             (*retrigger)(unsigned int irq);
 173         int             (*set_type)(unsigned int irq, unsigned int flow_type);
 174         int             (*set_wake)(unsigned int irq, unsigned int on);
 175
 176         void            (*bus_lock)(unsigned int irq);
 177         void            (*bus_sync_unlock)(unsigned int irq);
 178 #endif
 179         unsigned int    (*irq_startup)(struct irq_data *data);
 180         void            (*irq_shutdown)(struct irq_data *data);
 181         void            (*irq_enable)(struct irq_data *data);
 182         void            (*irq_disable)(struct irq_data *data);
 183
 184         void            (*irq_ack)(struct irq_data *data);
 185         void            (*irq_mask)(struct irq_data *data);
 186         void            (*irq_mask_ack)(struct irq_data *data);
 187         void            (*irq_unmask)(struct irq_data *data);
 188         void            (*irq_eoi)(struct irq_data *data);
 189
 190         int             (*irq_set_affinity)(struct irq_data *data, const struct cpumask *dest, bool force);
 191         int             (*irq_retrigger)(struct irq_data *data);
 192         int             (*irq_set_type)(struct irq_data *data, unsigned int flow_type);
 193         int             (*irq_set_wake)(struct irq_data *data, unsigned int on);
 194
 195         void            (*irq_bus_lock)(struct irq_data *data);
 196         void            (*irq_bus_sync_unlock)(struct irq_data *data);
 197
 198         /* Currently used only by UML, might disappear one day.*/
 199 #ifdef CONFIG_IRQ_RELEASE_METHOD
 200         void            (*release)(unsigned int irq, void *dev_id);
 201 #endif
 202 };
 203
 204 /* This include will go away once we isolated irq_desc usage to core code */
 205 #include <linux/irqdesc.h>
 206
 207 /*
 208  * Pick up the arch-dependent methods:
 209  */
 210 #include <asm/hw_irq.h>
 211
 212 struct irqaction;
 213 extern int setup_irq(unsigned int irq, struct irqaction *new);
 214 extern void remove_irq(unsigned int irq, struct irqaction *act);
 215
 216 #ifdef CONFIG_GENERIC_HARDIRQS
 217
 218 #ifdef CONFIG_SMP
 219 # ifdef CONFIG_GENERIC_PENDING_IRQ
 220 void move_native_irq(int irq);
 221 void move_masked_irq(int irq);
 222 # else
 223 static inline void move_irq(int irq) { }
 224 static inline void move_native_irq(int irq) { }
 225 static inline void move_masked_irq(int irq) { }
 226 # endif
 227 #else
 228 static inline void move_native_irq(int irq) { }
 229 static inline void move_masked_irq(int irq) { }
 230 #endif
 231
 232 extern int no_irq_affinity;
 233
 234 /* Handle irq action chains: */
 235 extern irqreturn_t handle_IRQ_event(unsigned int irq, struct irqaction *action);
 236
 237 /*
 238  * Built-in IRQ handlers for various IRQ types,
 239  * callable via desc->handle_irq()
 240  */
 241 extern void handle_level_irq(unsigned int irq, struct irq_desc *desc);
 242 extern void handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
 243 extern void handle_edge_irq(unsigned int irq, struct irq_desc *desc);
 244 extern void handle_simple_irq(unsigned int irq, struct irq_desc *desc);
 245 extern void handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
 246 extern void handle_bad_irq(unsigned int irq, struct irq_desc *desc);
 247 extern void handle_nested_irq(unsigned int irq);
 248
 249 /* Handling of unhandled and spurious interrupts: */
 250 extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
 251                            irqreturn_t action_ret);
 252
 253
 254 /* Enable/disable irq debugging output: */
 255 extern int noirqdebug_setup(char *str);
 256
 257 /* Checks whether the interrupt can be requested by request_irq(): */
 258 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
 259
 260 /* Dummy irq-chip implementations: */
 261 extern struct irq_chip no_irq_chip;
 262 extern struct irq_chip dummy_irq_chip;
 263
 264 extern void
 265 set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
 266                          irq_flow_handler_t handle);
 267 extern void
 268 set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
 269                               irq_flow_handler_t handle, const char *name);
 270
 271 extern void
 272 __set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
 273                   const char *name);
 274
 275 /*
 276  * Set a highlevel flow handler for a given IRQ:
 277  */
 278 static inline void
 279 set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
 280 {
 281         __set_irq_handler(irq, handle, 0, NULL);
 282 }
 283
 284 /*
 285  * Set a highlevel chained flow handler for a given IRQ.
 286  * (a chained handler is automatically enabled and set to
 287  *  IRQ_NOREQUEST and IRQ_NOPROBE)
 288  */
 289 static inline void
 290 set_irq_chained_handler(unsigned int irq,
 291                         irq_flow_handler_t handle)
 292 {
 293         __set_irq_handler(irq, handle, 1, NULL);
 294 }
 295
 296 extern void set_irq_nested_thread(unsigned int irq, int nest);
 297
 298 extern void set_irq_noprobe(unsigned int irq);
 299 extern void set_irq_probe(unsigned int irq);
 300
 301 /* Handle dynamic irq creation and destruction */
 302 extern unsigned int create_irq_nr(unsigned int irq_want, int node);
 303 extern int create_irq(void);
 304 extern void destroy_irq(unsigned int irq);
 305
 306 /* Dynamic irq helper functions */
 307 extern void dynamic_irq_init(unsigned int irq);
 308 void dynamic_irq_init_keep_chip_data(unsigned int irq);
 309 extern void dynamic_irq_cleanup(unsigned int irq);
 310 void dynamic_irq_cleanup_keep_chip_data(unsigned int irq);
 311
 312 /* Set/get chip/data for an IRQ: */
 313 extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
 314 extern int set_irq_data(unsigned int irq, void *data);
 315 extern int set_irq_chip_data(unsigned int irq, void *data);
 316 extern int set_irq_type(unsigned int irq, unsigned int type);
 317 extern int set_irq_msi(unsigned int irq, struct msi_desc *entry);
 318
 319 #define get_irq_chip(irq)       (irq_to_desc(irq)->irq_data.chip)
 320 #define get_irq_chip_data(irq)  (irq_to_desc(irq)->irq_data.chip_data)
 321 #define get_irq_data(irq)       (irq_to_desc(irq)->irq_data.handler_data)
 322 #define get_irq_msi(irq)        (irq_to_desc(irq)->irq_data.msi_desc)
 323
 324 #endif /* CONFIG_GENERIC_HARDIRQS */
 325
 326 #endif /* !CONFIG_S390 */
 327
 328 #endif /* _LINUX_IRQ_H */