intr.h revision 301263
1295459Sadrian/*- 2297539Sskra * Copyright (c) 2015-2016 Svatopluk Kraus 3297539Sskra * Copyright (c) 2015-2016 Michal Meloun 4295459Sadrian * All rights reserved. 5295459Sadrian * 6295459Sadrian * Redistribution and use in source and binary forms, with or without 7295459Sadrian * modification, are permitted provided that the following conditions 8295459Sadrian * are met: 9295459Sadrian * 1. Redistributions of source code must retain the above copyright 10295459Sadrian * notice, this list of conditions and the following disclaimer. 11295459Sadrian * 2. Redistributions in binary form must reproduce the above copyright 12295459Sadrian * notice, this list of conditions and the following disclaimer in the 13295459Sadrian * documentation and/or other materials provided with the distribution. 14295459Sadrian * 15297539Sskra * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16297539Sskra * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17297539Sskra * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18297539Sskra * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19297539Sskra * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20297539Sskra * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21297539Sskra * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22295459Sadrian * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23295459Sadrian * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24295459Sadrian * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25295459Sadrian * SUCH DAMAGE. 26295459Sadrian * 27295459Sadrian * $FreeBSD: head/sys/sys/intr.h 301263 2016-06-03 10:13:18Z andrew $ 28295459Sadrian */ 29295459Sadrian 30295459Sadrian#ifndef _SYS_INTR_H_ 31295459Sadrian#define _SYS_INTR_H_ 32295459Sadrian 33296138Sskra#include <sys/systm.h> 34296138Sskra 35298739Smmel#define INTR_IRQ_INVALID 0xFFFFFFFF 36298739Smmel 37297539Sskraenum intr_map_data_type { 38297539Sskra INTR_MAP_DATA_ACPI, 39297539Sskra INTR_MAP_DATA_FDT, 40298738Smmel INTR_MAP_DATA_GPIO, 41297539Sskra}; 42297539Sskra 43299117Sskrastruct intr_map_data { 44299117Sskra enum intr_map_data_type type; 45299117Sskra size_t size; 46299117Sskra}; 47299117Sskra 48297539Sskra#ifdef DEV_ACPI 49297539Sskrastruct intr_map_data_acpi { 50299117Sskra struct intr_map_data hdr; 51297539Sskra u_int irq; 52297539Sskra enum intr_polarity pol; 53297539Sskra enum intr_trigger trig; 54297539Sskra}; 55297539Sskra#endif 56297539Sskra#ifdef FDT 57297539Sskrastruct intr_map_data_fdt { 58299117Sskra struct intr_map_data hdr; 59299117Sskra u_int ncells; 60299117Sskra pcell_t cells[0]; 61297539Sskra}; 62297539Sskra#endif 63297539Sskra 64298738Smmelstruct intr_map_data_gpio { 65299117Sskra struct intr_map_data hdr; 66298738Smmel u_int gpio_pin_num; 67298738Smmel u_int gpio_pin_flags; 68298738Smmel u_int gpio_intr_mode; 69298738Smmel}; 70298738Smmel 71295459Sadrian#ifdef notyet 72295459Sadrian#define INTR_SOLO INTR_MD1 73295459Sadriantypedef int intr_irq_filter_t(void *arg, struct trapframe *tf); 74295459Sadrian#else 75295459Sadriantypedef int intr_irq_filter_t(void *arg); 76295459Sadrian#endif 77301263Sandrewtypedef int intr_child_irq_filter_t(void *arg, uintptr_t irq); 78295459Sadrian 79295459Sadrian#define INTR_ISRC_NAMELEN (MAXCOMLEN + 1) 80295459Sadrian 81297539Sskra#define INTR_ISRCF_IPI 0x01 /* IPI interrupt */ 82297539Sskra#define INTR_ISRCF_PPI 0x02 /* PPI interrupt */ 83295459Sadrian#define INTR_ISRCF_BOUND 0x04 /* bound to a CPU */ 84295459Sadrian 85301263Sandrewstruct intr_pic; 86301263Sandrew 87295459Sadrian/* Interrupt source definition. */ 88295459Sadrianstruct intr_irqsrc { 89295459Sadrian device_t isrc_dev; /* where isrc is mapped */ 90295459Sadrian u_int isrc_irq; /* unique identificator */ 91295459Sadrian u_int isrc_flags; 92295459Sadrian char isrc_name[INTR_ISRC_NAMELEN]; 93295459Sadrian cpuset_t isrc_cpu; /* on which CPUs is enabled */ 94295459Sadrian u_int isrc_index; 95295459Sadrian u_long * isrc_count; 96295459Sadrian u_int isrc_handlers; 97295459Sadrian struct intr_event * isrc_event; 98296261Sskra#ifdef INTR_SOLO 99295459Sadrian intr_irq_filter_t * isrc_filter; 100297230Sskra void * isrc_arg; 101296261Sskra#endif 102295459Sadrian}; 103295459Sadrian 104297539Sskra/* Intr interface for PIC. */ 105297539Sskraint intr_isrc_deregister(struct intr_irqsrc *); 106297539Sskraint intr_isrc_register(struct intr_irqsrc *, device_t, u_int, const char *, ...) 107297539Sskra __printflike(4, 5); 108297230Sskra 109297674Sskra#ifdef SMP 110297674Sskrabool intr_isrc_init_on_cpu(struct intr_irqsrc *isrc, u_int cpu); 111297674Sskra#endif 112297674Sskra 113297539Sskraint intr_isrc_dispatch(struct intr_irqsrc *, struct trapframe *); 114297539Sskrau_int intr_irq_next_cpu(u_int current_cpu, cpuset_t *cpumask); 115295459Sadrian 116300149Sandrewstruct intr_pic *intr_pic_register(device_t, intptr_t); 117297539Sskraint intr_pic_deregister(device_t, intptr_t); 118297539Sskraint intr_pic_claim_root(device_t, intptr_t, intr_irq_filter_t *, void *, u_int); 119301263Sandrewstruct intr_pic *intr_pic_add_handler(device_t, struct intr_pic *, 120301263Sandrew intr_child_irq_filter_t *, void *, uintptr_t, uintptr_t); 121295459Sadrian 122297539Sskraextern device_t intr_irq_root_dev; 123295459Sadrian 124297539Sskra/* Intr interface for BUS. */ 125297539Sskraint intr_map_irq(device_t, intptr_t, struct intr_map_data *, u_int *); 126295459Sadrian 127297539Sskraint intr_alloc_irq(device_t, struct resource *); 128297539Sskraint intr_release_irq(device_t, struct resource *); 129296138Sskra 130297539Sskraint intr_setup_irq(device_t, struct resource *, driver_filter_t, driver_intr_t, 131297539Sskra void *, int, void **); 132297539Sskraint intr_teardown_irq(device_t, struct resource *, void *); 133295459Sadrian 134297539Sskraint intr_describe_irq(device_t, struct resource *, void *, const char *); 135301263Sandrewint intr_child_irq_handler(struct intr_pic *, uintptr_t); 136295459Sadrian 137299928Sandrew/* MSI/MSI-X handling */ 138299928Sandrewint intr_msi_register(device_t, intptr_t); 139299928Sandrewint intr_alloc_msi(device_t, device_t, intptr_t, int, int, int *); 140299928Sandrewint intr_release_msi(device_t, device_t, intptr_t, int, int *); 141299928Sandrewint intr_map_msi(device_t, device_t, intptr_t, int, uint64_t *, uint32_t *); 142299928Sandrewint intr_alloc_msix(device_t, device_t, intptr_t, int *); 143299928Sandrewint intr_release_msix(device_t, device_t, intptr_t, int); 144299928Sandrew 145297539Sskra#ifdef DEV_ACPI 146297539Sskrau_int intr_acpi_map_irq(device_t, u_int, enum intr_polarity, 147297539Sskra enum intr_trigger); 148297539Sskra#endif 149297539Sskra#ifdef FDT 150297539Sskrau_int intr_fdt_map_irq(phandle_t, pcell_t *, u_int); 151297539Sskra#endif 152298738Smmelu_int intr_gpio_map_irq(device_t dev, u_int pin_num, u_int pin_flags, 153298738Smmel u_int intr_mode); 154295459Sadrian 155295459Sadrian#ifdef SMP 156297539Sskraint intr_bind_irq(device_t, struct resource *, int); 157295459Sadrian 158296138Sskravoid intr_pic_init_secondary(void); 159295459Sadrian 160296138Sskra/* Virtualization for interrupt source IPI counter increment. */ 161296138Sskrastatic inline void 162296138Sskraintr_ipi_increment_count(u_long *counter, u_int cpu) 163296138Sskra{ 164295459Sadrian 165296138Sskra KASSERT(cpu < MAXCPU, ("%s: too big cpu %u", __func__, cpu)); 166296138Sskra counter[cpu]++; 167296138Sskra} 168295459Sadrian 169296138Sskra/* Virtualization for interrupt source IPI counters setup. */ 170296138Sskrau_long * intr_ipi_setup_counters(const char *name); 171295459Sadrian 172295459Sadrian#endif 173295459Sadrian#endif /* _SYS_INTR_H */ 174