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: stable/11/sys/sys/intr.h 308333 2016-11-05 10:23:02Z mmel $ 28295459Sadrian */ 29295459Sadrian 30295459Sadrian#ifndef _SYS_INTR_H_ 31295459Sadrian#define _SYS_INTR_H_ 32308333Smmel#ifndef INTRNG 33308333Smmel#error Need INTRNG for this file 34308333Smmel#endif 35295459Sadrian 36296138Sskra#include <sys/systm.h> 37296138Sskra 38298739Smmel#define INTR_IRQ_INVALID 0xFFFFFFFF 39298739Smmel 40308333Smmelenum intr_map_data_type { 41308333Smmel INTR_MAP_DATA_ACPI = 0, 42308333Smmel INTR_MAP_DATA_FDT, 43308333Smmel INTR_MAP_DATA_GPIO, 44308333Smmel INTR_MAP_DATA_MSI, 45308333Smmel 46308333Smmel /* Placeholders for platform specific types */ 47308333Smmel INTR_MAP_DATA_PLAT_1 = 1000, 48308333Smmel INTR_MAP_DATA_PLAT_2, 49308333Smmel INTR_MAP_DATA_PLAT_3, 50308333Smmel INTR_MAP_DATA_PLAT_4, 51308333Smmel INTR_MAP_DATA_PLAT_5, 52308333Smmel}; 53308333Smmel 54308333Smmelstruct intr_map_data { 55308333Smmel size_t len; 56308333Smmel enum intr_map_data_type type; 57308333Smmel}; 58308333Smmel 59308333Smmelstruct intr_map_data_msi { 60308333Smmel struct intr_map_data hdr; 61308333Smmel struct intr_irqsrc *isrc; 62308333Smmel}; 63308333Smmel 64295459Sadrian#ifdef notyet 65295459Sadrian#define INTR_SOLO INTR_MD1 66295459Sadriantypedef int intr_irq_filter_t(void *arg, struct trapframe *tf); 67295459Sadrian#else 68295459Sadriantypedef int intr_irq_filter_t(void *arg); 69295459Sadrian#endif 70301263Sandrewtypedef int intr_child_irq_filter_t(void *arg, uintptr_t irq); 71295459Sadrian 72295459Sadrian#define INTR_ISRC_NAMELEN (MAXCOMLEN + 1) 73295459Sadrian 74297539Sskra#define INTR_ISRCF_IPI 0x01 /* IPI interrupt */ 75297539Sskra#define INTR_ISRCF_PPI 0x02 /* PPI interrupt */ 76295459Sadrian#define INTR_ISRCF_BOUND 0x04 /* bound to a CPU */ 77295459Sadrian 78301263Sandrewstruct intr_pic; 79301263Sandrew 80295459Sadrian/* Interrupt source definition. */ 81295459Sadrianstruct intr_irqsrc { 82295459Sadrian device_t isrc_dev; /* where isrc is mapped */ 83295459Sadrian u_int isrc_irq; /* unique identificator */ 84295459Sadrian u_int isrc_flags; 85295459Sadrian char isrc_name[INTR_ISRC_NAMELEN]; 86295459Sadrian cpuset_t isrc_cpu; /* on which CPUs is enabled */ 87295459Sadrian u_int isrc_index; 88295459Sadrian u_long * isrc_count; 89295459Sadrian u_int isrc_handlers; 90295459Sadrian struct intr_event * isrc_event; 91296261Sskra#ifdef INTR_SOLO 92295459Sadrian intr_irq_filter_t * isrc_filter; 93297230Sskra void * isrc_arg; 94296261Sskra#endif 95295459Sadrian}; 96295459Sadrian 97297539Sskra/* Intr interface for PIC. */ 98297539Sskraint intr_isrc_deregister(struct intr_irqsrc *); 99297539Sskraint intr_isrc_register(struct intr_irqsrc *, device_t, u_int, const char *, ...) 100297539Sskra __printflike(4, 5); 101297230Sskra 102297674Sskra#ifdef SMP 103297674Sskrabool intr_isrc_init_on_cpu(struct intr_irqsrc *isrc, u_int cpu); 104297674Sskra#endif 105297674Sskra 106297539Sskraint intr_isrc_dispatch(struct intr_irqsrc *, struct trapframe *); 107297539Sskrau_int intr_irq_next_cpu(u_int current_cpu, cpuset_t *cpumask); 108295459Sadrian 109300149Sandrewstruct intr_pic *intr_pic_register(device_t, intptr_t); 110297539Sskraint intr_pic_deregister(device_t, intptr_t); 111297539Sskraint intr_pic_claim_root(device_t, intptr_t, intr_irq_filter_t *, void *, u_int); 112301263Sandrewstruct intr_pic *intr_pic_add_handler(device_t, struct intr_pic *, 113301263Sandrew intr_child_irq_filter_t *, void *, uintptr_t, uintptr_t); 114295459Sadrian 115297539Sskraextern device_t intr_irq_root_dev; 116295459Sadrian 117297539Sskra/* Intr interface for BUS. */ 118295459Sadrian 119308333Smmelint intr_activate_irq(device_t, struct resource *); 120308333Smmelint intr_deactivate_irq(device_t, struct resource *); 121296138Sskra 122297539Sskraint intr_setup_irq(device_t, struct resource *, driver_filter_t, driver_intr_t, 123297539Sskra void *, int, void **); 124297539Sskraint intr_teardown_irq(device_t, struct resource *, void *); 125295459Sadrian 126297539Sskraint intr_describe_irq(device_t, struct resource *, void *, const char *); 127301263Sandrewint intr_child_irq_handler(struct intr_pic *, uintptr_t); 128295459Sadrian 129308333Smmel/* Intr resources mapping. */ 130308333Smmelstruct intr_map_data *intr_alloc_map_data(enum intr_map_data_type, size_t, int); 131308333Smmelvoid intr_free_intr_map_data(struct intr_map_data *); 132308333Smmelu_int intr_map_irq(device_t, intptr_t, struct intr_map_data *); 133308333Smmelvoid intr_unmap_irq(u_int ); 134308333Smmelu_int intr_map_clone_irq(u_int ); 135308333Smmel 136299928Sandrew/* MSI/MSI-X handling */ 137299928Sandrewint intr_msi_register(device_t, intptr_t); 138299928Sandrewint intr_alloc_msi(device_t, device_t, intptr_t, int, int, int *); 139299928Sandrewint intr_release_msi(device_t, device_t, intptr_t, int, int *); 140299928Sandrewint intr_map_msi(device_t, device_t, intptr_t, int, uint64_t *, uint32_t *); 141299928Sandrewint intr_alloc_msix(device_t, device_t, intptr_t, int *); 142299928Sandrewint intr_release_msix(device_t, device_t, intptr_t, int); 143299928Sandrew 144295459Sadrian#ifdef SMP 145297539Sskraint intr_bind_irq(device_t, struct resource *, int); 146295459Sadrian 147296138Sskravoid intr_pic_init_secondary(void); 148295459Sadrian 149296138Sskra/* Virtualization for interrupt source IPI counter increment. */ 150296138Sskrastatic inline void 151296138Sskraintr_ipi_increment_count(u_long *counter, u_int cpu) 152296138Sskra{ 153295459Sadrian 154296138Sskra KASSERT(cpu < MAXCPU, ("%s: too big cpu %u", __func__, cpu)); 155296138Sskra counter[cpu]++; 156296138Sskra} 157295459Sadrian 158296138Sskra/* Virtualization for interrupt source IPI counters setup. */ 159296138Sskrau_long * intr_ipi_setup_counters(const char *name); 160295459Sadrian 161295459Sadrian#endif 162295459Sadrian#endif /* _SYS_INTR_H */ 163