1 /* $NetBSD: picvar.h,v 1.13 2021/03/22 01:36:10 rin Exp $ */ 2 3 /*- 4 * Copyright (c) 2007 Michael Lorenz 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 17 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 18 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 19 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 #include <sys/cdefs.h> 30 __KERNEL_RCSID(0, "$NetBSD: picvar.h,v 1.13 2021/03/22 01:36:10 rin Exp $"); 31 32 #ifndef PIC_VAR_H 33 #define PIC_VAR_H 34 35 #include <sys/intr.h> 36 37 struct pic_ops { 38 void *pic_cookie; /* private stuff / hardware info */ 39 int pic_intrbase; /* global number of the 1st IRQ we handle */ 40 int pic_numintrs; /* how many IRQs do we handle? */ 41 /* 42 * all functions that take an IRQ number as argument need a local 43 * interrupt number 44 */ 45 void (*pic_enable_irq)(struct pic_ops *, int, int); 46 void (*pic_reenable_irq)(struct pic_ops *, int, int); 47 void (*pic_disable_irq)(struct pic_ops *, int); 48 int (*pic_get_irq)(struct pic_ops *, int); /* PIC_GET_* */ 49 void (*pic_ack_irq)(struct pic_ops *, int); /* IRQ numbner */ 50 /* IRQ number, type, priority */ 51 void (*pic_establish_irq)(struct pic_ops *, int, int, int); 52 /* finish setup after CPUs are attached */ 53 void (*pic_finish_setup)(struct pic_ops *); 54 char pic_name[16]; 55 }; 56 57 struct intr_source { 58 int is_type; 59 int is_ipl; 60 int is_hwirq; 61 imask_t is_mask; 62 struct intrhand *is_hand; 63 struct pic_ops *is_pic; 64 struct evcnt is_ev; 65 char is_evname[16]; 66 char is_intrid[INTRIDBUF]; 67 }; 68 69 #define OPENPIC_MAX_ISUS 4 70 #define OPENPIC_FLAG_DIST (1<<0) 71 #define OPENPIC_FLAG_LE (1<<1) 72 73 struct openpic_ops { 74 struct pic_ops pic; 75 uint32_t flags; 76 int nrofisus; 77 volatile unsigned char **isu; 78 uint8_t *irq_per; 79 }; 80 81 struct i8259_ops { 82 struct pic_ops pic; 83 uint32_t pending_events; 84 uint32_t enable_mask; 85 uint32_t irqs; 86 }; 87 88 /* 89 * add a pic, fill in pic_intrbase, return pic_intrbase on success, 90 * -1 otherwise 91 * the PIC must be initialized and ready for use 92 */ 93 int pic_add(struct pic_ops *); 94 95 void pic_do_pending_int(void); 96 void pic_enable_irq(int); 97 void pic_disable_irq(int); 98 int pic_handle_intr(void *); 99 void pic_mark_pending(int); 100 void pic_ext_intr(void); 101 void pic_init(void); 102 const char *intr_typename(int); 103 void dummy_pic_establish_intr(struct pic_ops *, int, int, int); 104 105 /* this is called after attaching CPUs so PICs can setup interrupt routing */ 106 void pic_finish_setup(void); 107 108 /* address, enable passthrough */ 109 #define PIC_IVR_IBM 0 110 #define PIC_IVR_MOT 1 111 #define PIC_GET_IRQ 0 112 #define PIC_GET_RECHECK 1 113 struct pic_ops *setup_openpic(void *, int); 114 struct pic_ops *setup_distributed_openpic(void *, int, void **, int *); 115 struct pic_ops *setup_prepivr(int); 116 struct pic_ops *setup_i8259(void); 117 struct pic_ops *setup_mpcpic(void *); 118 void mpcpic_reserv16(void); 119 120 /* i8259 common decls */ 121 void i8259_initialize(void); 122 void i8259_enable_irq(struct pic_ops *, int, int); 123 void i8259_disable_irq(struct pic_ops *, int); 124 void i8259_ack_irq(struct pic_ops *, int); 125 int i8259_get_irq(struct pic_ops *, int); 126 127 /* openpic common decls */ 128 void opic_finish_setup(struct pic_ops *pic); 129 void openpic_set_priority(int cpu, int pri); 130 int opic_get_irq(struct pic_ops *pic, int mode); 131 void opic_ack_irq(struct pic_ops *pic, int irq); 132 133 /* IPI handler */ 134 int cpuintr(void *); 135 /* XXX - may need to be PIC specific */ 136 #define IPI_VECTOR 128 137 138 #endif /* PIC_VAR_H */ 139