intr.h revision 301263
1/*- 2 * Copyright (c) 2015-2016 Svatopluk Kraus 3 * Copyright (c) 2015-2016 Michal Meloun 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 * 27 * $FreeBSD: head/sys/sys/intr.h 301263 2016-06-03 10:13:18Z andrew $ 28 */ 29 30#ifndef _SYS_INTR_H_ 31#define _SYS_INTR_H_ 32 33#include <sys/systm.h> 34 35#define INTR_IRQ_INVALID 0xFFFFFFFF 36 37enum intr_map_data_type { 38 INTR_MAP_DATA_ACPI, 39 INTR_MAP_DATA_FDT, 40 INTR_MAP_DATA_GPIO, 41}; 42 43struct intr_map_data { 44 enum intr_map_data_type type; 45 size_t size; 46}; 47 48#ifdef DEV_ACPI 49struct intr_map_data_acpi { 50 struct intr_map_data hdr; 51 u_int irq; 52 enum intr_polarity pol; 53 enum intr_trigger trig; 54}; 55#endif 56#ifdef FDT 57struct intr_map_data_fdt { 58 struct intr_map_data hdr; 59 u_int ncells; 60 pcell_t cells[0]; 61}; 62#endif 63 64struct intr_map_data_gpio { 65 struct intr_map_data hdr; 66 u_int gpio_pin_num; 67 u_int gpio_pin_flags; 68 u_int gpio_intr_mode; 69}; 70 71#ifdef notyet 72#define INTR_SOLO INTR_MD1 73typedef int intr_irq_filter_t(void *arg, struct trapframe *tf); 74#else 75typedef int intr_irq_filter_t(void *arg); 76#endif 77typedef int intr_child_irq_filter_t(void *arg, uintptr_t irq); 78 79#define INTR_ISRC_NAMELEN (MAXCOMLEN + 1) 80 81#define INTR_ISRCF_IPI 0x01 /* IPI interrupt */ 82#define INTR_ISRCF_PPI 0x02 /* PPI interrupt */ 83#define INTR_ISRCF_BOUND 0x04 /* bound to a CPU */ 84 85struct intr_pic; 86 87/* Interrupt source definition. */ 88struct intr_irqsrc { 89 device_t isrc_dev; /* where isrc is mapped */ 90 u_int isrc_irq; /* unique identificator */ 91 u_int isrc_flags; 92 char isrc_name[INTR_ISRC_NAMELEN]; 93 cpuset_t isrc_cpu; /* on which CPUs is enabled */ 94 u_int isrc_index; 95 u_long * isrc_count; 96 u_int isrc_handlers; 97 struct intr_event * isrc_event; 98#ifdef INTR_SOLO 99 intr_irq_filter_t * isrc_filter; 100 void * isrc_arg; 101#endif 102}; 103 104/* Intr interface for PIC. */ 105int intr_isrc_deregister(struct intr_irqsrc *); 106int intr_isrc_register(struct intr_irqsrc *, device_t, u_int, const char *, ...) 107 __printflike(4, 5); 108 109#ifdef SMP 110bool intr_isrc_init_on_cpu(struct intr_irqsrc *isrc, u_int cpu); 111#endif 112 113int intr_isrc_dispatch(struct intr_irqsrc *, struct trapframe *); 114u_int intr_irq_next_cpu(u_int current_cpu, cpuset_t *cpumask); 115 116struct intr_pic *intr_pic_register(device_t, intptr_t); 117int intr_pic_deregister(device_t, intptr_t); 118int intr_pic_claim_root(device_t, intptr_t, intr_irq_filter_t *, void *, u_int); 119struct intr_pic *intr_pic_add_handler(device_t, struct intr_pic *, 120 intr_child_irq_filter_t *, void *, uintptr_t, uintptr_t); 121 122extern device_t intr_irq_root_dev; 123 124/* Intr interface for BUS. */ 125int intr_map_irq(device_t, intptr_t, struct intr_map_data *, u_int *); 126 127int intr_alloc_irq(device_t, struct resource *); 128int intr_release_irq(device_t, struct resource *); 129 130int intr_setup_irq(device_t, struct resource *, driver_filter_t, driver_intr_t, 131 void *, int, void **); 132int intr_teardown_irq(device_t, struct resource *, void *); 133 134int intr_describe_irq(device_t, struct resource *, void *, const char *); 135int intr_child_irq_handler(struct intr_pic *, uintptr_t); 136 137/* MSI/MSI-X handling */ 138int intr_msi_register(device_t, intptr_t); 139int intr_alloc_msi(device_t, device_t, intptr_t, int, int, int *); 140int intr_release_msi(device_t, device_t, intptr_t, int, int *); 141int intr_map_msi(device_t, device_t, intptr_t, int, uint64_t *, uint32_t *); 142int intr_alloc_msix(device_t, device_t, intptr_t, int *); 143int intr_release_msix(device_t, device_t, intptr_t, int); 144 145#ifdef DEV_ACPI 146u_int intr_acpi_map_irq(device_t, u_int, enum intr_polarity, 147 enum intr_trigger); 148#endif 149#ifdef FDT 150u_int intr_fdt_map_irq(phandle_t, pcell_t *, u_int); 151#endif 152u_int intr_gpio_map_irq(device_t dev, u_int pin_num, u_int pin_flags, 153 u_int intr_mode); 154 155#ifdef SMP 156int intr_bind_irq(device_t, struct resource *, int); 157 158void intr_pic_init_secondary(void); 159 160/* Virtualization for interrupt source IPI counter increment. */ 161static inline void 162intr_ipi_increment_count(u_long *counter, u_int cpu) 163{ 164 165 KASSERT(cpu < MAXCPU, ("%s: too big cpu %u", __func__, cpu)); 166 counter[cpu]++; 167} 168 169/* Virtualization for interrupt source IPI counters setup. */ 170u_long * intr_ipi_setup_counters(const char *name); 171 172#endif 173#endif /* _SYS_INTR_H */ 174