xref: /freebsd/sys/powerpc/include/openpicvar.h (revision 9137c66c2ea6cc09e3a6f8a042ecdc5a62e0f39e)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (C) 2002 Benno Rice.
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 Benno Rice ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef	_POWERPC_OPENPICVAR_H_
29 #define	_POWERPC_OPENPICVAR_H_
30 
31 #include <sys/kobj.h>
32 
33 #define OPENPIC_DEVSTR	"OpenPIC Interrupt Controller"
34 
35 #define OPENPIC_IRQMAX	512	/* h/w allows more */
36 
37 #define	OPENPIC_QUIRK_SINGLE_BIND	1	/* Bind interrupts to only 1 CPU */
38 #define	OPENPIC_QUIRK_HIDDEN_IRQS	2	/* May have IRQs beyond FRR[NIRQ] */
39 #define	OPENPIC_QUIRK_WHOAMI_WORKS	4	/* WHOAMI register is present */
40 
41 /* Names match the macros in openpicreg.h. */
42 struct openpic_timer {
43     	uint32_t	tcnt;
44     	uint32_t	tbase;
45     	uint32_t	tvec;
46     	uint32_t	tdst;
47 };
48 
49 struct openpic_softc {
50 	device_t	sc_dev;
51 	struct resource	*sc_memr;
52 	struct resource	*sc_intr;
53 	bus_space_tag_t sc_bt;
54 	bus_space_handle_t sc_bh;
55 	char		*sc_version;
56 	int		sc_rid;
57 	int		sc_irq;
58 	void		*sc_icookie;
59 	u_int		sc_ncpu;
60 	u_int		sc_nirq;
61 	int		sc_psim;
62 	u_int		sc_quirks;
63 	uint32_t	sc_vec_mask;
64 
65 	/* Saved states. */
66 	uint32_t		sc_saved_config;
67 	uint32_t		sc_saved_ipis[4];
68 	uint32_t		sc_saved_prios[4];
69 	struct openpic_timer	sc_saved_timers[OPENPIC_TIMERS];
70 	uint32_t		sc_saved_vectors[OPENPIC_SRC_VECTOR_COUNT];
71 
72 };
73 
74 /*
75  * Bus-independent attach i/f
76  */
77 int	openpic_common_attach(device_t, uint32_t);
78 
79 /*
80  * PIC interface.
81  */
82 void	openpic_config(device_t, u_int, enum intr_trigger, enum intr_polarity);
83 void	openpic_enable(device_t, u_int, u_int, void **);
84 void	openpic_eoi(device_t, u_int, void *);
85 void	openpic_unmask(device_t, u_int, void *);
86 
87 DECLARE_CLASS(openpic_class);
88 
89 #endif /* _POWERPC_OPENPICVAR_H_ */
90