include/xen/evtchn.h

   1 /******************************************************************************
   2  * evtchn.h
   3  *
   4  * Communication via Xen event channels.
   5  * Also definitions for the device that demuxes notifications to userspace.
   6  *
   7  * Copyright (c) 2004-2005, K A Fraser
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License version 2
  11  * as published by the Free Software Foundation; or, when distributed
  12  * separately from the Linux kernel or incorporated into other
  13  * software packages, subject to the following license:
  14  *
  15  * Permission is hereby granted, free of charge, to any person obtaining a copy
  16  * of this source file (the "Software"), to deal in the Software without
  17  * restriction, including without limitation the rights to use, copy, modify,
  18  * merge, publish, distribute, sublicense, and/or sell copies of the Software,
  19  * and to permit persons to whom the Software is furnished to do so, subject to
  20  * the following conditions:
  21  *
  22  * The above copyright notice and this permission notice shall be included in
  23  * all copies or substantial portions of the Software.
  24  *
  25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  26  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  27  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  28  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  29  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  30  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  31  * IN THE SOFTWARE.
  32  */
  33
  34 #ifndef __ASM_EVTCHN_H__
  35 #define __ASM_EVTCHN_H__
  36
  37 #include <linux/config.h>
  38 #include <linux/interrupt.h>
  39 #include <asm/hypervisor.h>
  40 #include <asm/ptrace.h>
  41 #include <asm/synch_bitops.h>
  42 #include <xen/interface/event_channel.h>
  43 #include <linux/smp.h>
  44
  45 /*
  46  * LOW-LEVEL DEFINITIONS
  47  */
  48
  49 /*
  50  * Dynamically bind an event source to an IRQ-like callback handler.
  51  * On some platforms this may not be implemented via the Linux IRQ subsystem.
  52  * The IRQ argument passed to the callback handler is the same as returned
  53  * from the bind call. It may not correspond to a Linux IRQ number.
  54  * Returns IRQ or negative errno.
  55  * UNBIND: Takes IRQ to unbind from; automatically closes the event channel.
  56  */
  57 extern int bind_evtchn_to_irqhandler(
  58         unsigned int evtchn,
  59         irqreturn_t (*handler)(int, void *, struct pt_regs *),
  60         unsigned long irqflags,
  61         const char *devname,
  62         void *dev_id);
  63 extern int bind_virq_to_irqhandler(
  64         unsigned int virq,
  65         unsigned int cpu,
  66         irqreturn_t (*handler)(int, void *, struct pt_regs *),
  67         unsigned long irqflags,
  68         const char *devname,
  69         void *dev_id);
  70 extern int bind_ipi_to_irqhandler(
  71         unsigned int ipi,
  72         unsigned int cpu,
  73         irqreturn_t (*handler)(int, void *, struct pt_regs *),
  74         unsigned long irqflags,
  75         const char *devname,
  76         void *dev_id);
  77
  78 /*
  79  * Common unbind function for all event sources. Takes IRQ to unbind from.
  80  * Automatically closes the underlying event channel (even for bindings
  81  * made with bind_evtchn_to_irqhandler()).
  82  */
  83 extern void unbind_from_irqhandler(unsigned int irq, void *dev_id);
  84
  85 extern void irq_resume(void);
  86
  87 /* Entry point for notifications into Linux subsystems. */
  88 asmlinkage void evtchn_do_upcall(struct pt_regs *regs);
  89
  90 /* Entry point for notifications into the userland character device. */
  91 extern void evtchn_device_upcall(int port);
  92
  93 extern void mask_evtchn(int port);
  94 extern void unmask_evtchn(int port);
  95
  96 static inline void clear_evtchn(int port)
  97 {
  98         shared_info_t *s = HYPERVISOR_shared_info;
  99         synch_clear_bit(port, &s->evtchn_pending[0]);
 100 }
 101
 102 static inline void notify_remote_via_evtchn(int port)
 103 {
 104         struct evtchn_send send = { .port = port };
 105         (void)HYPERVISOR_event_channel_op(EVTCHNOP_send, &send);
 106 }
 107
 108 /*
 109  * Unlike notify_remote_via_evtchn(), this is safe to use across
 110  * save/restore. Notifications on a broken connection are silently dropped.
 111  */
 112 extern void notify_remote_via_irq(int irq);
 113
 114 #endif /* __ASM_EVTCHN_H__ */