xref: /titanic_41/usr/src/uts/i86pc/sys/psm_common.h (revision 2df1fe9ca32bb227b9158c67f5c00b54c20b10fd)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_SYS_PSM_COMMON_H
27 #define	_SYS_PSM_COMMON_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #include <sys/types.h>
32 #include <sys/param.h>
33 #include <sys/cmn_err.h>
34 #include <sys/acpi/acpi.h>
35 #include <sys/acpica.h>
36 
37 #include <sys/sunddi.h>
38 #include <sys/ddi.h>
39 #include <sys/ddi_impldefs.h>
40 #include <sys/pci.h>
41 #include <sys/debug.h>
42 
43 #ifdef	__cplusplus
44 extern "C" {
45 #endif
46 
47 
48 /* private data used in psm_common */
49 typedef struct acpi_prs_private {
50 	uchar_t		prs_irqflags;
51 	uchar_t		prs_type;
52 } acpi_prs_private_t;
53 
54 
55 typedef struct acpi_psm_lnk {
56 	ACPI_HANDLE	lnkobj;
57 	acpi_prs_private_t acpi_prs_prv;
58 	uchar_t		device_status;
59 } acpi_psm_lnk_t;
60 
61 typedef void (*intr_exit_fn_t)(int prev_ipl, int irq);
62 
63 /*
64  * status definition for device_status (as returned by _STA)
65  */
66 #define	STA_PRESENT	0x1
67 #define	STA_ENABLE	0x2
68 
69 
70 /*
71  * irq_cache_t: Entry for irq cache to map pci bus/dev/ipin or ACPI object
72  * referencing an interrupt link device the configured irq for the device.
73  * It is assumed that the acpi object that references the link device is
74  * the same for all devices that reference the same link device.
75  */
76 typedef struct irq_cache {
77 	uchar_t bus, dev;
78 	uchar_t ipin;
79 	uchar_t irq;
80 	iflag_t flags;
81 	ACPI_HANDLE	lnkobj;
82 } irq_cache_t;
83 
84 
85 typedef struct acpi_irqlist {
86 	acpi_prs_private_t acpi_prs_prv;
87 	iflag_t intr_flags;
88 	uint32_t *irqs;
89 	int num_irqs;
90 	struct acpi_irqlist *next;
91 } acpi_irqlist_t;
92 
93 
94 #define	MAX_ISA_IRQ 15
95 
96 #define	ELCR_PORT1	0x4D0
97 #define	ELCR_PORT2	0x4D1
98 
99 #define	ELCR_LEVEL(elcrval, irq)	(elcrval & (0x1 << irq))
100 #define	ELCR_EDGE(elcrval, irq)		((elcrval & (0x1 << irq)) == 0)
101 
102 
103 #define	ACPI_PSM_SUCCESS	0
104 #define	ACPI_PSM_FAILURE	-1
105 #define	ACPI_PSM_PARTIAL 	-2
106 
107 /* verbose flags definitions */
108 #define	PSM_VERBOSE_IRQ_FLAG			0x00000001
109 #define	PSM_VERBOSE_POWEROFF_FLAG		0x00000002
110 #define	PSM_VERBOSE_POWEROFF_PAUSE_FLAG		0x00000004
111 
112 extern int acpi_psm_init(char *module_name, int verbose_flags);
113 
114 extern void build_reserved_irqlist(uchar_t *reserved_irqs_table);
115 
116 extern int acpi_translate_pci_irq(dev_info_t *dip, int ipin, int *pci_irqp,
117     iflag_t *intr_flagp, acpi_psm_lnk_t *acpipsmlnkp);
118 
119 extern int acpi_set_irq_resource(acpi_psm_lnk_t *acpipsmlnkp, int irq);
120 
121 extern int acpi_get_current_irq_resource(acpi_psm_lnk_t *acpipsmlnkp,
122     int *pci_irqp, iflag_t *intr_flagp);
123 
124 extern int acpi_irqlist_find_irq(acpi_irqlist_t *irqlistp, int irq,
125     iflag_t *intr_flagp);
126 
127 extern void acpi_free_irqlist(acpi_irqlist_t *irqlistp);
128 
129 extern int acpi_get_possible_irq_resources(acpi_psm_lnk_t *acpipsmlnkp,
130     acpi_irqlist_t **irqlistp);
131 
132 extern void acpi_new_irq_cache_ent(int bus, int dev, int ipin, int pci_irq,
133     iflag_t *intr_flagp, acpi_psm_lnk_t *acpipsmlnkp);
134 
135 extern int acpi_get_irq_cache_ent(uchar_t bus, uchar_t dev, int ipin,
136     int *pci_irqp, iflag_t *intr_flagp);
137 
138 extern void acpi_restore_link_devices(void);
139 
140 extern int acpi_poweroff(void);
141 
142 extern void psm_set_elcr(int vecno, int val);
143 extern int psm_get_elcr(int vecno);
144 extern intr_exit_fn_t psm_intr_exit_fn(void);
145 
146 #ifdef	__cplusplus
147 }
148 #endif
149 
150 #endif	/* _SYS_PSM_COMMON_H */
151