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 #define IRQF_MODIFY_MASK        \
  76         (IRQ_TYPE_SENSE_MASK | IRQ_NOPROBE | IRQ_NOREQUEST | \
  77          IRQ_NOAUTOEN | IRQ_MOVE_PCNTXT | IRQ_LEVEL | IRQ_NO_BALANCING | \
  78          IRQ_PER_CPU)
  79
  80 #ifdef CONFIG_IRQ_PER_CPU
  81 # define CHECK_IRQ_PER_CPU(var) ((var) & IRQ_PER_CPU)
  82 # define IRQ_NO_BALANCING_MASK  (IRQ_PER_CPU | IRQ_NO_BALANCING)
  83 #else
  84 # define CHECK_IRQ_PER_CPU(var) 0
  85 # define IRQ_NO_BALANCING_MASK  IRQ_NO_BALANCING
  86 #endif
  87
  88 struct msi_desc;
  89
  90 /**
  91  * struct irq_data - per irq and irq chip data passed down to chip functions
  92  * @irq:                interrupt number
  93  * @node:               node index useful for balancing
  94  * @chip:               low level interrupt hardware access
  95  * @handler_data:       per-IRQ data for the irq_chip methods
  96  * @chip_data:          platform-specific per-chip private data for the chip
  97  *                      methods, to allow shared chip implementations
  98  * @msi_desc:           MSI descriptor
  99  * @affinity:           IRQ affinity on SMP
 100  *
 101  * The fields here need to overlay the ones in irq_desc until we
 102  * cleaned up the direct references and switched everything over to
 103  * irq_data.
 104  */
 105 struct irq_data {
 106         unsigned int            irq;
 107         unsigned int            node;
 108         struct irq_chip         *chip;
 109         void                    *handler_data;
 110         void                    *chip_data;
 111         struct msi_desc         *msi_desc;
 112 #ifdef CONFIG_SMP
 113         cpumask_var_t           affinity;
 114 #endif
 115 };
 116
 117 /**
 118  * struct irq_chip - hardware interrupt chip descriptor
 119  *
 120  * @name:               name for /proc/interrupts
 121  * @startup:            deprecated, replaced by irq_startup
 122  * @shutdown:           deprecated, replaced by irq_shutdown
 123  * @enable:             deprecated, replaced by irq_enable
 124  * @disable:            deprecated, replaced by irq_disable
 125  * @ack:                deprecated, replaced by irq_ack
 126  * @mask:               deprecated, replaced by irq_mask
 127  * @mask_ack:           deprecated, replaced by irq_mask_ack
 128  * @unmask:             deprecated, replaced by irq_unmask
 129  * @eoi:                deprecated, replaced by irq_eoi
 130  * @end:                deprecated, will go away with __do_IRQ()
 131  * @set_affinity:       deprecated, replaced by irq_set_affinity
 132  * @retrigger:          deprecated, replaced by irq_retrigger
 133  * @set_type:           deprecated, replaced by irq_set_type
 134  * @set_wake:           deprecated, replaced by irq_wake
 135  * @bus_lock:           deprecated, replaced by irq_bus_lock
 136  * @bus_sync_unlock:    deprecated, replaced by irq_bus_sync_unlock
 137  *
 138  * @irq_startup:        start up the interrupt (defaults to ->enable if NULL)
 139  * @irq_shutdown:       shut down the interrupt (defaults to ->disable if NULL)
 140  * @irq_enable:         enable the interrupt (defaults to chip->unmask if NULL)
 141  * @irq_disable:        disable the interrupt
 142  * @irq_ack:            start of a new interrupt
 143  * @irq_mask:           mask an interrupt source
 144  * @irq_mask_ack:       ack and mask an interrupt source
 145  * @irq_unmask:         unmask an interrupt source
 146  * @irq_eoi:            end of interrupt
 147  * @irq_set_affinity:   set the CPU affinity on SMP machines
 148  * @irq_retrigger:      resend an IRQ to the CPU
 149  * @irq_set_type:       set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
 150  * @irq_set_wake:       enable/disable power-management wake-on of an IRQ
 151  * @irq_bus_lock:       function to lock access to slow bus (i2c) chips
 152  * @irq_bus_sync_unlock:function to sync and unlock slow bus (i2c) chips
 153  *
 154  * @release:            release function solely used by UML
 155  */
 156 struct irq_chip {
 157         const char      *name;
 158 #ifndef CONFIG_GENERIC_HARDIRQS_NO_DEPRECATED
 159         unsigned int    (*startup)(unsigned int irq);
 160         void            (*shutdown)(unsigned int irq);
 161         void            (*enable)(unsigned int irq);
 162         void            (*disable)(unsigned int irq);
 163
 164         void            (*ack)(unsigned int irq);
 165         void            (*mask)(unsigned int irq);
 166         void            (*mask_ack)(unsigned int irq);
 167         void            (*unmask)(unsigned int irq);
 168         void            (*eoi)(unsigned int irq);
 169
 170         void            (*end)(unsigned int irq);
 171         int             (*set_affinity)(unsigned int irq,
 172                                         const struct cpumask *dest);
 173         int             (*retrigger)(unsigned int irq);
 174         int             (*set_type)(unsigned int irq, unsigned int flow_type);
 175         int             (*set_wake)(unsigned int irq, unsigned int on);
 176
 177         void            (*bus_lock)(unsigned int irq);
 178         void            (*bus_sync_unlock)(unsigned int irq);
 179 #endif
 180         unsigned int    (*irq_startup)(struct irq_data *data);
 181         void            (*irq_shutdown)(struct irq_data *data);
 182         void            (*irq_enable)(struct irq_data *data);
 183         void            (*irq_disable)(struct irq_data *data);
 184
 185         void            (*irq_ack)(struct irq_data *data);
 186         void            (*irq_mask)(struct irq_data *data);
 187         void            (*irq_mask_ack)(struct irq_data *data);
 188         void            (*irq_unmask)(struct irq_data *data);
 189         void            (*irq_eoi)(struct irq_data *data);
 190
 191         int             (*irq_set_affinity)(struct irq_data *data, const struct cpumask *dest, bool force);
 192         int             (*irq_retrigger)(struct irq_data *data);
 193         int             (*irq_set_type)(struct irq_data *data, unsigned int flow_type);
 194         int             (*irq_set_wake)(struct irq_data *data, unsigned int on);
 195
 196         void            (*irq_bus_lock)(struct irq_data *data);
 197         void            (*irq_bus_sync_unlock)(struct irq_data *data);
 198
 199         /* Currently used only by UML, might disappear one day.*/
 200 #ifdef CONFIG_IRQ_RELEASE_METHOD
 201         void            (*release)(unsigned int irq, void *dev_id);
 202 #endif
 203 };
 204
 205 /* This include will go away once we isolated irq_desc usage to core code */
 206 #include <linux/irqdesc.h>
 207
 208 /*
 209  * Pick up the arch-dependent methods:
 210  */
 211 #include <asm/hw_irq.h>
 212
 213 #ifndef NR_IRQS_LEGACY
 214 # define NR_IRQS_LEGACY 0
 215 #endif
 216
 217 #ifndef ARCH_IRQ_INIT_FLAGS
 218 # define ARCH_IRQ_INIT_FLAGS    0
 219 #endif
 220
 221 #define IRQ_DEFAULT_INIT_FLAGS  (IRQ_DISABLED | ARCH_IRQ_INIT_FLAGS)
 222
 223 struct irqaction;
 224 extern int setup_irq(unsigned int irq, struct irqaction *new);
 225 extern void remove_irq(unsigned int irq, struct irqaction *act);
 226
 227 #ifdef CONFIG_GENERIC_HARDIRQS
 228
 229 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_PENDING_IRQ)
 230 void move_native_irq(int irq);
 231 void move_masked_irq(int irq);
 232 #else
 233 static inline void move_native_irq(int irq) { }
 234 static inline void move_masked_irq(int irq) { }
 235 #endif
 236
 237 extern int no_irq_affinity;
 238
 239 /* Handle irq action chains: */
 240 extern irqreturn_t handle_IRQ_event(unsigned int irq, struct irqaction *action);
 241
 242 /*
 243  * Built-in IRQ handlers for various IRQ types,
 244  * callable via desc->handle_irq()
 245  */
 246 extern void handle_level_irq(unsigned int irq, struct irq_desc *desc);
 247 extern void handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
 248 extern void handle_edge_irq(unsigned int irq, struct irq_desc *desc);
 249 extern void handle_simple_irq(unsigned int irq, struct irq_desc *desc);
 250 extern void handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
 251 extern void handle_bad_irq(unsigned int irq, struct irq_desc *desc);
 252 extern void handle_nested_irq(unsigned int irq);
 253
 254 /* Handling of unhandled and spurious interrupts: */
 255 extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
 256                            irqreturn_t action_ret);
 257
 258
 259 /* Enable/disable irq debugging output: */
 260 extern int noirqdebug_setup(char *str);
 261
 262 /* Checks whether the interrupt can be requested by request_irq(): */
 263 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
 264
 265 /* Dummy irq-chip implementations: */
 266 extern struct irq_chip no_irq_chip;
 267 extern struct irq_chip dummy_irq_chip;
 268
 269 extern void
 270 set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
 271                          irq_flow_handler_t handle);
 272 extern void
 273 set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
 274                               irq_flow_handler_t handle, const char *name);
 275
 276 extern void
 277 __set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
 278                   const char *name);
 279
 280 /*
 281  * Set a highlevel flow handler for a given IRQ:
 282  */
 283 static inline void
 284 set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
 285 {
 286         __set_irq_handler(irq, handle, 0, NULL);
 287 }
 288
 289 /*
 290  * Set a highlevel chained flow handler for a given IRQ.
 291  * (a chained handler is automatically enabled and set to
 292  *  IRQ_NOREQUEST and IRQ_NOPROBE)
 293  */
 294 static inline void
 295 set_irq_chained_handler(unsigned int irq,
 296                         irq_flow_handler_t handle)
 297 {
 298         __set_irq_handler(irq, handle, 1, NULL);
 299 }
 300
 301 extern void set_irq_nested_thread(unsigned int irq, int nest);
 302
 303 void irq_modify_status(unsigned int irq, unsigned long clr, unsigned long set);
 304
 305 static inline void irq_set_status_flags(unsigned int irq, unsigned long set)
 306 {
 307         irq_modify_status(irq, 0, set);
 308 }
 309
 310 static inline void irq_clear_status_flags(unsigned int irq, unsigned long clr)
 311 {
 312         irq_modify_status(irq, clr, 0);
 313 }
 314
 315 static inline void set_irq_noprobe(unsigned int irq)
 316 {
 317         irq_modify_status(irq, 0, IRQ_NOPROBE);
 318 }
 319
 320 static inline void set_irq_probe(unsigned int irq)
 321 {
 322         irq_modify_status(irq, IRQ_NOPROBE, 0);
 323 }
 324
 325 /* Handle dynamic irq creation and destruction */
 326 extern unsigned int create_irq_nr(unsigned int irq_want, int node);
 327 extern int create_irq(void);
 328 extern void destroy_irq(unsigned int irq);
 329
 330 /*
 331  * Dynamic irq helper functions. Obsolete. Use irq_alloc_desc* and
 332  * irq_free_desc instead.
 333  */
 334 extern void dynamic_irq_cleanup(unsigned int irq);
 335 static inline void dynamic_irq_init(unsigned int irq)
 336 {
 337         dynamic_irq_cleanup(irq);
 338 }
 339
 340 /* Set/get chip/data for an IRQ: */
 341 extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
 342 extern int set_irq_data(unsigned int irq, void *data);
 343 extern int set_irq_chip_data(unsigned int irq, void *data);
 344 extern int set_irq_type(unsigned int irq, unsigned int type);
 345 extern int set_irq_msi(unsigned int irq, struct msi_desc *entry);
 346 extern struct irq_data *irq_get_irq_data(unsigned int irq);
 347
 348 static inline struct irq_chip *get_irq_chip(unsigned int irq)
 349 {
 350         struct irq_data *d = irq_get_irq_data(irq);
 351         return d ? d->chip : NULL;
 352 }
 353
 354 static inline struct irq_chip *irq_data_get_irq_chip(struct irq_data *d)
 355 {
 356         return d->chip;
 357 }
 358
 359 static inline void *get_irq_chip_data(unsigned int irq)
 360 {
 361         struct irq_data *d = irq_get_irq_data(irq);
 362         return d ? d->chip_data : NULL;
 363 }
 364
 365 static inline void *irq_data_get_irq_chip_data(struct irq_data *d)
 366 {
 367         return d->chip_data;
 368 }
 369
 370 static inline void *get_irq_data(unsigned int irq)
 371 {
 372         struct irq_data *d = irq_get_irq_data(irq);
 373         return d ? d->handler_data : NULL;
 374 }
 375
 376 static inline void *irq_data_get_irq_data(struct irq_data *d)
 377 {
 378         return d->handler_data;
 379 }
 380
 381 static inline struct msi_desc *get_irq_msi(unsigned int irq)
 382 {
 383         struct irq_data *d = irq_get_irq_data(irq);
 384         return d ? d->msi_desc : NULL;
 385 }
 386
 387 static inline struct msi_desc *irq_data_get_msi(struct irq_data *d)
 388 {
 389         return d->msi_desc;
 390 }
 391
 392 int irq_alloc_descs(int irq, unsigned int from, unsigned int cnt, int node);
 393 void irq_free_descs(unsigned int irq, unsigned int cnt);
 394 int irq_reserve_irqs(unsigned int from, unsigned int cnt);
 395
 396 static inline int irq_alloc_desc(int node)
 397 {
 398         return irq_alloc_descs(-1, 0, 1, node);
 399 }
 400
 401 static inline int irq_alloc_desc_at(unsigned int at, int node)
 402 {
 403         return irq_alloc_descs(at, at, 1, node);
 404 }
 405
 406 static inline int irq_alloc_desc_from(unsigned int from, int node)
 407 {
 408         return irq_alloc_descs(-1, from, 1, node);
 409 }
 410
 411 static inline void irq_free_desc(unsigned int irq)
 412 {
 413         irq_free_descs(irq, 1);
 414 }
 415
 416 static inline int irq_reserve_irq(unsigned int irq)
 417 {
 418         return irq_reserve_irqs(irq, 1);
 419 }
 420
 421 #endif /* CONFIG_GENERIC_HARDIRQS */
 422
 423 #endif /* !CONFIG_S390 */
 424
 425 #endif /* _LINUX_IRQ_H */